Class: Writeexcel::Chart::Pie

Inherits:
Writeexcel::Chart show all
Defined in:
lib/writeexcel/charts/pie.rb

Overview

SYNOPSIS

To create a simple Excel file with a Pie chart using WriteExcel:

 #!/usr/bin/ruby -w

 require 'writeexcel'

 workbook  = WriteExcel.new('chart.xls')
 worksheet = workbook.add_worksheet

 chart     = workbook.add_chart(:type => 'Chart::Pie')

 # Configure the chart.
 chart.add_series(
   :categories => '=Sheet1!$A$2:$A$7',
   :values     => '=Sheet1!$B$2:$B$7'
)

 # Add the worksheet data the chart refers to.
 data = [
     [ 'Category', 2, 3, 4, 5, 6, 7 ],
     [ 'Value',    1, 4, 5, 2, 1, 5 ]
 ]

 worksheet.write('A1', data)

 workbook.close

DESCRIPTION

This module implements Pie charts for WriteExcel. The chart object is created via the Workbook add_chart() method:

chart = workbook.add_chart(:type => 'Chart::Pie')

Once the object is created it can be configured via the following methods that are common to all chart classes:

chart.add_series
chart.set_title

These methods are explained in detail in Chart section of WriteExcel. Class specific methods or settings, if any, are explained below.

Pie Chart Methods

There aren't currently any pie chart specific methods. See the TODO section of Chart section in WriteExcel.

A Pie chart doesn't have an X or Y axis so the following common chart methods are ignored.

chart.set_x_axis
chart.set_y_axis

EXAMPLE

Here is a complete example that demonstrates most of the available features when creating a chart.

 #!/usr/bin/ruby -w

 require 'writeexcel'

 workbook  = WriteExcel.new('chart_pie.xls')
 worksheet = workbook.add_worksheet
 bold      = workbook.add_format(:bold => 1)

 # Add the worksheet data that the charts will refer to.
 headings = [ 'Category', 'Values' ]
 data = [
     [ 'Apple', 'Cherry', 'Pecan' ],
     [ 60,       30,       10     ],
 ]

 worksheet.write('A1', headings, bold)
 worksheet.write('A2', data)

 # Create a new chart object. In this case an embedded chart.
 chart = workbook.add_chart(:type => 'Chart::Pie', :embedded => 1)

 # Configure the series.
 chart.add_series(
   :name       => 'Pie sales data',
   :categories => '=Sheet1!$A$2:$A$4',
   :values     => '=Sheet1!$B$2:$B$4',
)

 # Add a title.
 chart.set_title(:name => 'Popular Pie Types')

 # Insert the chart into the worksheet (with an offset).
 worksheet.insert_chart('C2', chart, 25, 10)

 workbook.close

Constant Summary

Constants inherited from Worksheet

Worksheet::Buffer, Worksheet::ColMax, Worksheet::RowMax, Worksheet::StrMax

Constants inherited from BIFFWriter

BIFFWriter::BIFF_Version, BIFFWriter::BigEndian

Instance Attribute Summary

Attributes inherited from Worksheet

#filter_area, #object_ids, #print_range, #title_range

Attributes inherited from BIFFWriter

#data, #datasize

Instance Method Summary collapse

Methods inherited from Writeexcel::Chart

#add_series, #close, #data=, #embedded, #embedded=, factory, #set_chartarea, #set_embedded_config_data, #set_legend, #set_plotarea, #set_title, #set_x_axis, #set_y_axis, #using_tmpfile=

Methods inherited from Worksheet

#activate, #autofilter, #autofilter_name_record_short, #boundsheet, #center_horizontally, #center_vertically, #charts_size, #cleanup, #close, #comments_size, #comments_visible?, #data_validation, #filter_column, #filter_count, #fit_to_pages, #freeze_panes, #hidden=, #hidden?, #hide, #hide_gridlines, #hide_zero, #image_mso_size, #image_mso_size=, #images_array, #images_size, #index, #insert_chart, #insert_image, #is_name_utf16be?, #keep_leading_zeros, #merge_range, #merge_range_with_date_time, #name, #name_record_short, #num_images, #num_images=, #num_shapes, #offset, #offset=, #outline_settings, #position_object, #print_across, #print_area, #print_area_name_record_short, #print_row_col_headers, #print_title_name_record_long, #print_title_name_record_short, #protect, #push_cluster, #push_object_ids, #repeat_columns, #repeat_formula, #repeat_rows, #right_to_left, #select, #selected=, #selected?, #set_column, #set_first_row_column, #set_first_sheet, #set_footer, #set_h_pagebreaks, #set_header, #set_landscape, #set_margin_bottom, #set_margin_left, #set_margin_right, #set_margin_top, #set_margins, #set_margins_LR, #set_margins_TB, #set_page_view, #set_paper, #set_portrait, #set_print_scale, #set_row, #set_selection, #set_start_page, #set_tab_color, #set_v_pagebreaks, #set_zoom, #show_comments, #split_panes, #store_formula, #store_mso_client_anchor, #store_mso_client_data, #store_mso_opt_image, #store_mso_sp, #store_mso_sp_container, #store_parent_mso_record, #type, #write, #write_blank, #write_col, #write_comment, #write_date_time, #write_formula, #write_number, #write_row, #write_string, #write_url, #write_url_range, #write_utf16be_string, #write_utf16le_string

Methods included from ConvertDateTime

#convert_date_time

Methods inherited from BIFFWriter

#add_continue, #add_mso_generic, #append, #cleanup, #clear_data_for_test, #get_data, #inspect, #not_using_tmpfile, #prepend, #print_caller_info, #set_byte_order, #store_bof, #store_eof, #unpack_record

Methods included from CallerInfo

#caller_info

Methods inherited from WriteFile

#append, #prepend

Constructor Details

#initialize(*args) ⇒ Pie

new()


126
127
128
129
# File 'lib/writeexcel/charts/pie.rb', line 126

def initialize(*args)   # :nodoc:
  super
  @vary_data_color = 1
end

Instance Method Details

#store_axisparent_streamObject

_store_axisparent_stream(). Overridden.

Write the AXISPARENT chart substream.

A Pie chart has no X or Y axis so we override this method to remove them.


157
158
159
160
161
162
163
164
165
# File 'lib/writeexcel/charts/pie.rb', line 157

def store_axisparent_stream   # :nodoc:
  store_axisparent(*@config[:axisparent])

  store_begin
  store_pos(*@config[:axisparent_pos])

  store_chartformat_stream
  store_end
end

#store_chart_typeObject

_store_chart_type()

Implementation of the abstract method from the specific chart class.

Write the Pie chart BIFF record.


139
140
141
142
143
144
145
146
147
# File 'lib/writeexcel/charts/pie.rb', line 139

def store_chart_type   # :nodoc:
  record = 0x1019     # Record identifier.
  length = 0x0006     # Number of bytes to follow.
  angle  = 0x0000     # Angle.
  donut  = 0x0000     # Donut hole size.
  grbit  = 0x0002     # Option flags.

  store_simple(record, length, angle, donut, grbit)
end