Class: Writexlsx::Chart

Inherits:
Object
  • Object
show all
Includes:
Utility
Defined in:
lib/write_xlsx/chart.rb,
lib/write_xlsx/chart/bar.rb,
lib/write_xlsx/chart/pie.rb,
lib/write_xlsx/chart/area.rb,
lib/write_xlsx/chart/axis.rb,
lib/write_xlsx/chart/line.rb,
lib/write_xlsx/chart/radar.rb,
lib/write_xlsx/chart/stock.rb,
lib/write_xlsx/chart/column.rb,
lib/write_xlsx/chart/scatter.rb

Overview

SYNOPSIS

To create a simple Excel file with a chart using WriteXLSX:

require 'rubygems'
require 'write_xlsx'

workbook  = WriteXLSX.new('chart.xlsx')
worksheet = workbook.add_worksheet

# 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 )

# Add a worksheet chart.
chart = workbook.add_chart( type => 'column' )

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

workbook.close

DESCRIPTION

The Chart is an abstract base class for modules that implement charts in WriteXLSX. The information below is applicable to all of the available subclasses.

The Chart isn’t used directly. A chart object is created via the WriteXLXS#add_chart() method where the chart type is specified:

chart = workbook.add_chart( :type => 'column' )

Currently the supported chart types are:

area

Creates an Area (filled line) style chart. See Writexlsx::Chart::Area.

bar

Creates a Bar style (transposed histogram) chart. See Writexlsx::Chart::Bar.

column

Creates a Column style (histogram) chart. See Writexlsx::Chart::Column.

line

Creates a Line style chart. See Writexlsx::Chart::Line.

pie

Creates a Pie style chart. See Writexlsx::Chart::Pie.

scatter

Creates a Scatter style chart. See Writexlsx::Chart::Scatter.

stock

Creates a Stock style chart. See Writexlsx::Chart::Stock.

radar

Creates a Radar style chart. See Writexlsx::Chart::Radar.

Chart subtypes are also supported in some cases:

workbook.add_chart(:type => 'bar', :subtype => 'stacked')

The currently available subtypes are:

area
    stacked
    percent_stacked

bar
    stacked
    percent_stacked

column
    stacked
    percent_stacked

scatter
    straight_with_markers
    straight
    smooth_with_markers
    smooth

radar
    with_markers
    filled

CHART FORMATTING

The following chart formatting properties can be set for any chart object that they apply to (and that are supported by WriteXLSX) such as chart lines, column fill areas, plot area borders, markers and other chart elements documented above.

line
border
fill
marker
trendline
data_labels

Chart formatting properties are generally set using hash refs.

chart.add_series(
    :values     => '=Sheet1!$B$1:$B$5',
    :line       => { color => 'blue' }
)

In some cases the format properties can be nested. For example a marker may contain border and fill sub-properties.

chart.add_series(
    :values     => '=Sheet1!$B$1:$B$5',
    :line       => { color => 'blue' },
    :marker     => {
        :type    => 'square',
        :size    => 5,
        :border  => { color => 'red' },
        :fill    => { color => 'yellow' }
    }
)

Line

The line format is used to specify properties of line objects that appear in a chart such as a plotted line on a chart or a border.

The following properties can be set for line formats in a chart.

none
color
width
dash_type

The none property is uses to turn the line off (it is always on by default except in Scatter charts). This is useful if you wish to plot a series with markers but without a line.

chart.add_series(
    :values     => '=Sheet1!$B$1:$B$5',
    :line       => { none => 1 }
)

The color property sets the color of the line.

chart.add_series(
    :values     => '=Sheet1!$B$1:$B$5',
    :line       => { color => 'red' }
)

The available colors are shown in the main WriteXLSX documentation. It is also possible to set the color of a line with a HTML style RGB color:

chart.add_series(
    :line       => { color => '#FF0000' }
)

The width property sets the width of the line. It should be specified in increments of 0.25 of a point as in Excel.

chart.add_series(
    :values     => '=Sheet1!$B$1:$B$5',
    :line       => { width => 3.25 }
)

The dash_type property sets the dash style of the line.

chart->add_series(
    :values     => '=Sheet1!$B$1:$B$5',
    :line       => { dash_type => 'dash_dot' }
)

The following dash_type values are available. They are shown in the order that they appear in the Excel dialog.

solid
round_dot
square_dot
dash
dash_dot
long_dash
long_dash_dot
long_dash_dot_dot

The default line style is solid.

More than one line property can be specified at time:

chart.add_series(
    :values     => '=Sheet1!$B$1:$B$5',
    :line       => {
        :color     => 'red',
        :width     => 1.25,
        :dash_type => 'square_dot'
    }
)

Border

The border property is a synonym for line.

It can be used as a descriptive substitute for line in chart types such as Bar and Column that have a border and fill style rather than a line style. In general chart objects with a border property will also have a fill property.

Fill

The fill format is used to specify filled areas of chart objects such as the interior of a column or the background of the chart itself.

The following properties can be set for fill formats in a chart.

none
color

The none property is uses to turn the fill property off (it is generally on by default).

chart.add_series(
    :values     => '=Sheet1!$B$1:$B$5',
    :fill       => { none => 1 }
)

The color property sets the color of the fill area.

chart.add_series(
    :values     => '=Sheet1!$B$1:$B$5',
    :fill       => { color => 'red' }
)

The available colors are shown in the main WriteXLSX documentation. It is also possible to set the color of a fill with a HTML style RGB color:

chart.add_series(
    :fill       => { color => '#FF0000' }
)

The fill format is generally used in conjunction with a border format which has the same properties as a line format.

chart.add_series(
    :values     => '=Sheet1!$B$1:$B$5',
    :border     => { color => 'red' },
    :fill       => { color => 'yellow' }
)

Marker

The marker format specifies the properties of the markers used to distinguish series on a chart. In general only Line and Scatter chart types and trendlines use markers.

The following properties can be set for marker formats in a chart.

type
size
border
fill

The type property sets the type of marker that is used with a series.

chart.add_series(
    :values     => '=Sheet1!$B$1:$B$5',
    :marker     => { type => 'diamond' }
)

The following type properties can be set for marker formats in a chart. These are shown in the same order as in the Excel format dialog.

automatic
none
square
diamond
triangle
x
star
short_dash
long_dash
circle
plus

The automatic type is a special case which turns on a marker using the default marker style for the particular series number.

chart.add_series(
    :values     => '=Sheet1!$B$1:$B$5',
    :marker     => { type => 'automatic' }
)

If automatic is on then other marker properties such as size, border or fill cannot be set.

The size property sets the size of the marker and is generally used in conjunction with type.

chart.add_series(
    :values     => '=Sheet1!$B$1:$B$5',
    :marker     => { type => 'diamond', size => 7 }
)

Nested border and fill properties can also be set for a marker. These have the same sub-properties as shown above.

chart.add_series(
    :values     => '=Sheet1!$B$1:$B$5',
    :marker     => {
        :type    => 'square',
        :size    => 5,
        :border  => { color => 'red' },
        :fill    => { color => 'yellow' }
    }
)

Trendline

A trendline can be added to a chart series to indicate trends in the data such as a moving average or a polynomial fit.

The following properties can be set for trendline formats in a chart.

type
order       (for polynomial trends)
period      (for moving average)
forward     (for all except moving average)
backward    (for all except moving average)
name
line

The type property sets the type of trendline in the series.

chart.add_series(
    :values     => '=Sheet1!$B$1:$B$5',
    :trendline  => { type => 'linear' }
)

The available trendline types are:

exponential
linear
log
moving_average
polynomial
power

A polynomial trendline can also specify the order of the polynomial. The default value is 2.

chart.add_series(
    :values    => '=Sheet1!$B$1:$B$5',
    :trendline => {
        :type  => 'polynomial',
        :order => 3
    }
)

A moving_average trendline can also the period of the moving average. The default value is 2.

chart.add_series(
    :values     => '=Sheet1!$B$1:$B$5',
    :trendline  => {
        :type   => 'moving_average',
        :period => 3
    }
)

The forward and backward properties set the forecast period of the trendline.

chart.add_series(
    :values    => '=Sheet1!$B$1:$B$5',
    :trendline => {
        :type     => 'linear',
        :forward  => 0.5,
        :backward => 0.5
    }
)

The name property sets an optional name for the trendline that will appear in the chart legend. If it isn’t specified the Excel default name will be displayed. This is usually a combination of the trendline type and the series name.

chart.add_series(
    :values    => '=Sheet1!$B$1:$B$5',
    :trendline => {
        :type => 'linear',
        :name => 'Interpolated trend'
    }
)

Several of these properties can be set in one go:

chart.add_series(
    :values     => '=Sheet1!$B$1:$B$5',
    :trendline  => {
        :type     => 'linear',
        :name     => 'My trend name',
        :forward  => 0.5,
        :backward => 0.5,
        :line     => {
            :color     => 'red',
            :width     => 1,
            :dash_type => 'long_dash'
        }
    }
)

Trendlines cannot be added to series in a stacked chart or pie chart or (when implemented) to 3-D, radar, surface, or doughnut charts.

Data Labels

Data labels can be added to a chart series to indicate the values of the plotted data points.

The following properties can be set for data_labels formats in a chart.

:value
:category
:series_name
:position
:leader_lines
:percentage

The value property turns on the Value data label for a series.

chart.add_series(
    :values      => '=Sheet1!$B$1:$B$5',
    :data_labels => { :value => 1 }
)

The category property turns on the Category Name data label for a series.

chart.add_series(
    :values      => '=Sheet1!$B$1:$B$5',
    :data_labels => { :category => 1 }
)

The series_name property turns on the Series Name data label for a series.

chart.add_series(
    :values      => '=Sheet1!$B$1:$B$5',
    :data_labels => { :series_name => 1 }
)

The C<position> property is used to position the data label for a series.

chart.add_series(
    :values      => '=Sheet1!$B$1:$B$5',
    :data_labels => { :value => 1, :position => 'center' }
)

Valid positions are:

:center
:right
:left
:top
:bottom
:above           # Same as top
:below           # Same as bottom
:inside_end      # Pie chart mainly.
:outside_end     # Pie chart mainly.
:best_fit        # Pie chart mainly.

The C<percentage> property is used to turn on the I<Percentage> for the data label for a series. It is mainly used for pie charts.

chart.add_series(
     :values      => '=Sheet1!$B$1:$B$5',
     :data_labels => { :percentage => 1 }
)

The C<leader_lines> property is used to turn on I<Leader Lines> for the data label for a series. It is mainly used for pie charts.

chart.add_series(
     :values      => '=Sheet1!$B$1:$B$5',
     :data_labels => { :value => 1, :leader_lines => 1 }
)

Direct Known Subclasses

Area, Bar, Column, Line, Pie, Radar, Scatter, Stock

Defined Under Namespace

Classes: Area, Axis, Bar, Column, Line, Pie, Radar, Scatter, Stock

Constant Summary

Constants included from Utility

Utility::COL_MAX, Utility::ROW_MAX, Utility::SHEETNAME_MAX, Utility::STR_MAX

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Utility

#absolute_char, #check_dimensions, #check_dimensions_and_update_max_min_values, #check_parameter, #convert_date_time, delete_files, #float_to_str, #pixels_to_points, #ptrue?, #put_deprecate_message, #row_col_notation, #shape_style_base, #store_col_max_min_values, #store_row_max_min_values, #substitute_cellref, #underline_attributes, #v_shape_attributes_base, #v_shape_style_base, #write_anchor, #write_auto_fill, #write_color, #write_comment_path, #write_div, #write_fill, #write_font, #write_stroke, #xl_cell_to_rowcol, #xl_col_to_name, #xl_range, #xl_range_formula, #xl_rowcol_to_cell, #xml_str

Constructor Details

#initialize(subtype) ⇒ Chart

:nodoc:



538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
 
# File 'lib/write_xlsx/chart.rb', line 538

def initialize(subtype)   # :nodoc:
  @writer = Package::XMLWriterSimple.new

  @subtype           = subtype
  @sheet_type        = 0x0200
  @orientation       = 0x0
  @series            = []
  @embedded          = 0
  @id                = ''
  @series_index      = 0
  @style_id          = 2
  @axis_ids          = []
  @axis2_ids         = []
  @cat_has_num_fmt   = false
  @requires_category = 0
  @legend_position   = 'right'
  @cat_axis_position = 'b'
  @val_axis_position = 'l'
  @formula_ids       = {}
  @formula_data      = []
  @horiz_cat_axis    = 0
  @horiz_val_axis    = 1
  @protection        = 0
  @chartarea         = {}
  @plotarea          = {}
  @x_axis            = Axis.new
  @y_axis            = Axis.new
  @x2_axis           = Axis.new
  @y2_axis           = Axis.new
  @name              = ''
  @show_blanks       = 'gap'
  @show_hidden_data  = false
  @show_crosses      = true
  @width             = 480
  @height            = 288
  @x_scale           = 1
  @y_scale           = 1
  @x_offset          = 0
  @y_offset          = 0
  @table             = nil

  set_default_properties
end

Instance Attribute Details

#embedded ⇒ Object (readonly)

:nodoc:



502
503
504
 
# File 'lib/write_xlsx/chart.rb', line 502

def embedded
  @embedded
end

#formula_data ⇒ Object (readonly)

:nodoc:



502
503
504
 
# File 'lib/write_xlsx/chart.rb', line 502

def formula_data
  @formula_data
end

#formula_ids ⇒ Object (readonly)

:nodoc:



502
503
504
 
# File 'lib/write_xlsx/chart.rb', line 502

def formula_ids
  @formula_ids
end

#height ⇒ Object (readonly)

:nodoc:



504
505
506
 
# File 'lib/write_xlsx/chart.rb', line 504

def height
  @height
end

#id ⇒ Object

:nodoc:



500
501
502
 
# File 'lib/write_xlsx/chart.rb', line 500

def id
  @id
end

#index=(value) ⇒ Object (writeonly)

:nodoc:



501
502
503
 
# File 'lib/write_xlsx/chart.rb', line 501

def index=(value)
  @index = value
end

#name ⇒ Object

:nodoc:



500
501
502
 
# File 'lib/write_xlsx/chart.rb', line 500

def name
  @name
end

#palette=(value) ⇒ Object (writeonly)

:nodoc:



501
502
503
 
# File 'lib/write_xlsx/chart.rb', line 501

def palette=(value)
  @palette = value
end

#protection=(value) ⇒ Object (writeonly)

:nodoc:



501
502
503
 
# File 'lib/write_xlsx/chart.rb', line 501

def protection=(value)
  @protection = value
end

#width ⇒ Object (readonly)

:nodoc:



504
505
506
 
# File 'lib/write_xlsx/chart.rb', line 504

def width
  @width
end

#x_offset ⇒ Object (readonly)

:nodoc:



503
504
505
 
# File 'lib/write_xlsx/chart.rb', line 503

def x_offset
  @x_offset
end

#x_scale ⇒ Object (readonly)

:nodoc:



503
504
505
 
# File 'lib/write_xlsx/chart.rb', line 503

def x_scale
  @x_scale
end

#y_offset ⇒ Object (readonly)

:nodoc:



503
504
505
 
# File 'lib/write_xlsx/chart.rb', line 503

def y_offset
  @y_offset
end

#y_scale ⇒ Object (readonly)

:nodoc:



503
504
505
 
# File 'lib/write_xlsx/chart.rb', line 503

def y_scale
  @y_scale
end

Class Method Details

.factory(current_subclass, subtype = nil) ⇒ Object

Factory method for returning chart objects based on their class type.



509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
 
# File 'lib/write_xlsx/chart.rb', line 509

def self.factory(current_subclass, subtype = nil) # :nodoc:
  case current_subclass.downcase.capitalize
  when 'Area'
    require 'write_xlsx/chart/area'
    Chart::Area.new(subtype)
  when 'Bar'
    require 'write_xlsx/chart/bar'
    Chart::Bar.new(subtype)
  when 'Column'
    require 'write_xlsx/chart/column'
    Chart::Column.new(subtype)
  when 'Line'
    require 'write_xlsx/chart/line'
    Chart::Line.new(subtype)
  when 'Pie'
    require 'write_xlsx/chart/pie'
    Chart::Pie.new(subtype)
  when 'Radar'
    require 'write_xlsx/chart/radar'
    Chart::Radar.new(subtype)
  when 'Scatter'
    require 'write_xlsx/chart/scatter'
    Chart::Scatter.new(subtype)
  when 'Stock'
    require 'write_xlsx/chart/stock'
    Chart::Stock.new(subtype)
  end
end

Instance Method Details

#add_series(params) ⇒ Object

Add a series and it’s properties to a chart.

In an Excel chart a “series” is a collection of information such as values, x-axis labels and the formatting that define which data is plotted.

With a WriteXLSX chart object the add_series() method is used to set the properties for a series:

chart.add_series(
    :categories => '=Sheet1!$A$2:$A$10', # Optional.
    :values     => '=Sheet1!$B$2:$B$10', # Required.
    :line       => { :color => 'blue' }
)

The properties that can be set are:

:values

This is the most important property of a series and must be set
for every chart object. It links the chart with the worksheet data
that it displays. A formula or array ref can be used for the
data range, see below.

:categories

This sets the chart category labels. The category is more or less
the same as the X-axis. In most chart types the categories property
is optional and the chart will just assume a sequential series
from 1 .. n.

:name

Set the name for the series. The name is displayed in the chart
legend and in the formula bar. The name property is optional and
if it isn't supplied it will default to Series 1 .. n.

:line

Set the properties of the series line type such as colour and
width. See the "CHART FORMATTING" section below.

:border

Set the border properties of the series such as colour and style.
See the "CHART FORMATTING" section below.

:fill

Set the fill properties of the series such as colour. See the
"CHART FORMATTING"
section below.

:marker

Set the properties of the series marker such as style and color.
See the "CHART FORMATTING" section below.

:trendline

Set the properties of the series trendline such as linear,
polynomial and moving average types. See the "CHART FORMATTING"
section below.

:data_labels

Set data labels for the series. See the "CHART FORMATTING"
section below.

:invert_if_negative

Invert the fill colour for negative values. Usually only applicable
to column and bar charts.

:overlap

Set the overlap between series in a Bar/Column chart. The range is +/- 100. Default is 0.

:overlap => 20

Note, it is only necessary to apply this property to one series of the chart.

:gap

Set the gap between series in a Bar/Column chart. The range is 0 to 500. Default is 150.

:gap => 200,

Note, it is only necessary to apply this property to one series of the chart.

The categories and values can take either a range formula such as =Sheet1!$A$2:$A$7 or, more usefully when generating the range programmatically, an array ref with zero indexed row/column values:

[ sheetname, row_start, row_end, col_start, col_end ]

The following are equivalent:

chart.add_series( categories => '=Sheet1!$A$2:$A$7'      ) # Same as ...
chart.add_series( categories => [ 'Sheet1', 1, 6, 0, 0 ] ) # Zero-indexed.

You can add more than one series to a chart. In fact, some chart types such as stock require it. The series numbering and order in the Excel chart will be the same as the order in which that are added in WriteXLSX.

# Add the first series.
chart.add_series(
    :categories => '=Sheet1!$A$2:$A$7',
    :values     => '=Sheet1!$B$2:$B$7',
    :name       => 'Test data series 1'
)

# Add another series. Same categories. Different range values.
chart.add_series(
    :categories => '=Sheet1!$A$2:$A$7',
    :values     => '=Sheet1!$C$2:$C$7',
    :name       => 'Test data series 2'
)

SERIES OPTIONS

This section details the following properties of add_series() in more detail:

marker
trendline
y_error_bars
x_error_bars
data_labels
points

Marker

The marker format specifies the properties of the markers used to distinguish series on a chart. In general only Line and Scatter chart types and trendlines use markers.

The following properties can be set for marker formats in a chart.

type
size
border
fill

The type property sets the type of marker that is used with a series.

chart.add_series(
    :values     => '=Sheet1!$B$1:$B$5',
    :marker     => { :type => 'diamond' }
)

The following type properties can be set for marker formats in a chart. These are shown in the same order as in the Excel format dialog.

automatic
none
square
diamond
triangle
x
star
short_dash
long_dash
circle
plus

The automatic type is a special case which turns on a marker using the default marker style for the particular series number.

chart.add_series(
    :values     => '=Sheet1!$B$1:$B$5',
    :marker     => { :type => 'automatic' }
)

If automatic is on then other marker properties such as size, border or fill cannot be set.

The size property sets the size of the marker and is generally used in conjunction with type.

chart.add_series(
    :values     => '=Sheet1!$B$1:$B$5',
    :marker     => { :type => 'diamond', :size => 7 }
)

Nested border and fill properties can also be set for a marker. See the “CHART FORMATTING” section below.

chart.add_series(
    :values     => '=Sheet1!$B$1:$B$5',
    :marker     => {
        :type    => 'square',
        :size    => 5,
        :border  => { :color => 'red' },
        :fill    => { :color => 'yellow' }
    }
)

Trendline

A trendline can be added to a chart series to indicate trends in the data such as a moving average or a polynomial fit.

The following properties can be set for trendlines in a chart series.

type
order       (for polynomial trends)
period      (for moving average)
forward     (for all except moving average)
backward    (for all except moving average)
name
line

The type property sets the type of trendline in the series.

chart.add_series(
    :values     => '=Sheet1!$B$1:$B$5',
    :trendline  => { :type => 'linear' }
)

The available trendline types are:

exponential
linear
log
moving_average
polynomial
power

A polynomial trendline can also specify the order of the polynomial. The default value is 2.

chart.add_series(
    :values    => '=Sheet1!$B$1:$B$5',
    :trendline => {
        :type  => 'polynomial',
        :order => 3
    }
)

A moving_average trendline can also specify the period of the moving average. The default value is 2.

chart.add_series(
    :values     => '=Sheet1!$B$1:$B$5',
    :trendline  => {
        :type   => 'moving_average',
        :period => 3,
    }
)

The forward and backward properties set the forecast period of the trendline.

chart.add_series(
    :values    => '=Sheet1!$B$1:$B$5',
    :trendline => {
        :type     => 'linear',
        :forward  => 0.5,
        :backward => 0.5
    }
)

The name property sets an optional name for the trendline that will appear in the chart legend. If it isn’t specified the Excel default name will be displayed. This is usually a combination of the trendline type and the series name.

chart.add_series(
    :values    => '=Sheet1!$B$1:$B$5',
    :trendline => {
        :type => 'linear',
        :name => 'Interpolated trend'
    }
)

Several of these properties can be set in one go:

chart.add_series(
    :values     => '=Sheet1!$B$1:$B$5',
    :trendline  => {
        :type     => 'linear',
        :name     => 'My trend name',
        :forward  => 0.5,
        :backward => 0.5,
        :line     => {
            :color     => 'red',
            :width     => 1,
            :dash_type => 'long_dash'
        }
    }
)

Trendlines cannot be added to series in a stacked chart or pie chart, radar chart or (when implemented) to 3D, surface, or doughnut charts.

Error Bars

Error bars can be added to a chart series to indicate error bounds in the data. The error bars can be vertical y_error_bars (the most common type) or horizontal x_error_bars (for Bar and Scatter charts only).

The following properties can be set for error bars in a chart series.

type
value       (for all types except standard error)
direction
end_style
line

The type property sets the type of error bars in the series.

chart.add_series(
    :values       => '=Sheet1!$B$1:$B$5',
    :y_error_bars => { :type => 'standard_error' }
)

The available error bars types are available:

fixed
percentage
standard_deviation
standard_error

Note, the “custom” error bars type is not supported.

All error bar types, except for standard_error must also have a value associated with it for the error bounds:

chart.add_series(
    :values       => '=Sheet1!$B$1:$B$5',
    :y_error_bars => {
        :type  => 'percentage',
        :value => 5
    }
)

The direction property sets the direction of the error bars. It should be one of the following:

plus    # Positive direction only.
minus   # Negative direction only.
both    # Plus and minus directions, The default.

The end_style property sets the style of the error bar end cap. The options are 1 (the default) or 0 (for no end cap):

chart.add_series(
    :values       => '=Sheet1!$B$1:$B$5',
    :y_error_bars => {
        :type      => 'fixed',
        :value     => 2,
        :end_style => 0,
        :direction => 'minus'
    }
)

Data Labels

Data labels can be added to a chart series to indicate the values of the plotted data points.

The following properties can be set for data_labels formats in a chart.

value
category
series_name
position
leader_lines
percentage

The value property turns on the Value data label for a series.

chart.add_series(
    :values      => '=Sheet1!$B$1:$B$5',
    :data_labels => { :value => 1 }
)

The category property turns on the Category Name data label for a series.

chart.add_series(
    :values      => '=Sheet1!$B$1:$B$5',
    :data_labels => { :category => 1 }
)

The series_name property turns on the Series Name data label for a series.

chart.add_series(
    :values      => '=Sheet1!$B$1:$B$5',
    :data_labels => { :series_name => 1 }
)

The position property is used to position the data label for a series.

chart.add_series(
    :values      => '=Sheet1!$B$1:$B$5',
    :data_labels => { :value => 1, :position => 'center' },
)

Valid positions are:

center
right
left
top
bottom
above           # Same as top
below           # Same as bottom
inside_end      # Pie chart mainly.
outside_end     # Pie chart mainly.
best_fit        # Pie chart mainly.

The percentage property is used to turn on the display of data labels as a Percentage for a series. It is mainly used for pie charts.

chart.add_series(
    :values      => '=Sheet1!$B$1:$B$5',
    :data_labels => { :percentage => 1 }
)

The leader_lines property is used to turn on Leader Lines for the data label for a series. It is mainly used for pie charts.

chart.add_series(
    :values      => '=Sheet1!$B$1:$B$5',
    :data_labels => { :value => 1, :leader_lines => 1 }
)

Note: Even when leader lines are turned on they aren’t automatically visible in Excel or Excel::Writer::XLSX. Due to an Excel limitation (or design) leader lines only appear if the data label is moved manually or if the data labels are very close and need to be adjusted automatically.

Points

In general formatting is applied to an entire series in a chart. However, it is occasionally required to format individual points in a series. In particular this is required for Pie charts where each segment is represented by a point.

In these cases it is possible to use the points property of add_series():

chart.add_series(
    :values => '=Sheet1!$A$1:$A$3',
    :points => [
        { :fill => { :color => '#FF0000' } },
        { :fill => { ?color => '#CC0000' } },
        { :fill => { :color => '#990000' } }
    ]
)

The points property takes an array ref of format options (see the “CHART FORMATTING” section below). To assign default properties to points in a series pass nil values in the array ref:

# Format point 3 of 3 only.
chart.add_series(
    :values => '=Sheet1!$A$1:$A$3',
    :points => [
        nil,
        nil,
        { :fill => { :color => '#990000' } }
    ]
)

# Format the first point only.
chart.add_series(
    :values => '=Sheet1!$A$1:$A$3',
    :points => [ { :fill => { :color => '#FF0000' } } ]
                   )



1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
 
# File 'lib/write_xlsx/chart.rb', line 1084

def add_series(params)
  # Check that the required input has been specified.
  unless params.has_key?(:values)
    raise "Must specify ':values' in add_series"
  end

  if @requires_category != 0 && !params.has_key?(:categories)
    raise  "Must specify ':categories' in add_series for this chart type"
  end

  # Convert aref params into a formula string.
  values     = aref_to_formula(params[:values])
  categories = aref_to_formula(params[:categories])

  # Switch name and name_formula parameters if required.
  name, name_formula = process_names(params[:name], params[:name_formula])

  # Get an id for the data equivalent to the range formula.
  cat_id  = get_data_id(categories,   params[:categories_data])
  val_id  = get_data_id(values,       params[:values_data])
  name_id = get_data_id(name_formula, params[:name_data])

  # Set the line properties for the series.
  line = line_properties(params[:line])

  # Allow 'border' as a synonym for 'line' in bar/column style charts.
  line = line_properties(params[:border]) if params[:border]

  # Set the fill properties for the series.
  fill = fill_properties(params[:fill])

  # Set the marker properties for the series.
  marker = marker_properties(params[:marker])

  # Set the trendline properties for the series.
  trendline = trendline_properties(params[:trendline])

  # Set the error bars properties for the series.
  y_error_bars = error_bars_properties(params[:y_error_bars])
  x_error_bars = error_bars_properties(params[:x_error_bars])

  # Set the point properties for the series.
  points = points_properties(params[:points])

  # Set the labels properties for the series.
  labels = labels_properties(params[:data_labels])

  # Set the "invert if negative" fill property.
  invert_if_neg = params[:invert_if_negative]

  # Set the gap for Bar/Column charts.
  if params[:gap]
    @series_gap = params[:gap]
  end

  # Set the overlap for Bar/Column charts.
  if params[:overlap]
    @series_overlap = params[:overlap]
  end

  # Set the secondary axis properties.
  x2_axis = params[:x2_axis]
  y2_axis = params[:y2_axis]

  # Add the user supplied data to the internal structures.
  @series << {
    :_values        => values,
    :_categories    => categories,
    :_name          => name,
    :_name_formula  => name_formula,
    :_name_id       => name_id,
    :_val_data_id   => val_id,
    :_cat_data_id   => cat_id,
    :_line          => line,
    :_fill          => fill,
    :_marker        => marker,
    :_trendline     => trendline,
    :_labels        => labels,
    :_invert_if_neg => invert_if_neg,
    :_x2_axis       => x2_axis,
    :_y2_axis       => y2_axis,
    :_points        => points,
    :_error_bars    => {
      :_x_error_bars => x_error_bars,
      :_y_error_bars => y_error_bars
    }
  }
end

#assemble_xml_file ⇒ Object

Assemble and write the XML file.



589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
 
# File 'lib/write_xlsx/chart.rb', line 589

def assemble_xml_file   # :nodoc:
  @writer.xml_decl

  # Write the c:chartSpace element.
  write_chart_space do

    # Write the c:lang element.
    write_lang

    # Write the c:style element.
    write_style

    # Write the c:protection element.
    write_protection

    # Write the c:chart element.
    write_chart

    # Write the c:spPr element for the chartarea formatting.
    write_sp_pr(@chartarea)

    # Write the c:printSettings element.
    write_print_settings if @embedded && @embedded != 0
  end

  # Close the XML writer object and filehandle.
  @writer.crlf
  @writer.close
end

#convert_font_args(params) ⇒ Object

Convert user defined font values into private hash values.



1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
 
# File 'lib/write_xlsx/chart.rb', line 1782

def convert_font_args(params)
  return unless params
  font = {
    :_name         => params[:name],
    :_color        => params[:color],
    :_size         => params[:size],
    :_bold         => params[:bold],
    :_italic       => params[:italic],
    :_underline    => params[:underline],
    :_pitch_family => params[:pitch_family],
    :_charset      => params[:charset],
    :_baseline     => params[:baseline] || 0
  }

  # Convert font size units.
  font[:_size] *= 100 if font[:_size] && font[:_size] != 0

  font
end

#get_data_id(formula, data) ⇒ Object

Assign an id to a each unique series formula or title/axis formula. Repeated formulas such as for categories get the same id. If the series or title has user specified data associated with it then that is also stored. This data is used to populate cached Excel data when creating a chart. If there is no user defined data then it will be populated by the parent workbook in Workbook::_add_chart_data



1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
 
# File 'lib/write_xlsx/chart.rb', line 1753

def get_data_id(formula, data) # :nodoc:
  # Ignore series without a range formula.
  return unless formula

  # Strip the leading '=' from the formula.
  formula = formula.sub(/^=/, '')

  # Store the data id in a hash keyed by the formula and store the data
  # in a separate array with the same id.
  if !@formula_ids.has_key?(formula)
    # Haven't seen this formula before.
    id = @formula_data.size

    @formula_data << data
    @formula_ids[formula] = id
  else
    # Formula already seen. Return existing id.
    id = @formula_ids[formula]

    # Store user defined data if it isn't already there.
    @formula_data[id] = data unless @formula_data[id]
  end

  id
end

#line_properties(line) ⇒ Object

Convert user defined line properties to the structure required internally.



1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
 
# File 'lib/write_xlsx/chart.rb', line 1805

def line_properties(line) # :nodoc:
  return { :_defined => 0 } unless line

  dash_types = {
    :solid               => 'solid',
    :round_dot           => 'sysDot',
    :square_dot          => 'sysDash',
    :dash                => 'dash',
    :dash_dot            => 'dashDot',
    :long_dash           => 'lgDash',
    :long_dash_dot       => 'lgDashDot',
    :long_dash_dot_dot   => 'lgDashDotDot',
    :dot                 => 'dot',
    :system_dash_dot     => 'sysDashDot',
    :system_dash_dot_dot => 'sysDashDotDot'
  }

  # Check the dash type.
  dash_type = line[:dash_type]

  if dash_type
    line[:dash_type] = value_or_raise(dash_types, dash_type, 'dash type')
  end

  line[:_defined] = 1

  line
end

#process_names(name = nil, name_formula = nil) ⇒ Object

Switch name and name_formula parameters if required.



1735
1736
1737
1738
1739
1740
1741
1742
1743
 
# File 'lib/write_xlsx/chart.rb', line 1735

def process_names(name = nil, name_formula = nil) # :nodoc:
  # Name looks like a formula, use it to set name_formula.
  if name && name =~ /^=[^!]+!\$/
    name_formula = name
    name         = ''
  end

  [name, name_formula]
end

#set_chartarea(params) ⇒ Object

Set the properties of the chart chartarea.

The set_chartarea() method is used to set the properties of the chart area.

chart.set_chartarea(
    :border => { :none  => 1 },
    :fill   => { :color => 'red' }
)

The properties that can be set are:

:border

Set the border properties of the chartarea such as colour and style. See the “CHART FORMATTING” section.

:fill

Set the fill properties of the plotarea such as colour. See the “CHART FORMATTING” section.



1487
1488
1489
1490
 
# File 'lib/write_xlsx/chart.rb', line 1487

def set_chartarea(params)
  # Convert the user defined properties to internal properties.
  @chartarea = area_properties(params)
end

#set_drop_lines(params = {}) ⇒ Object

Set properties for the chart drop lines.

The set_drop_lines() method adds Drop Lines to charts to show the Category value of points in the data.

chart.set_drop_lines

It is possible to format the Drop Line line properties if required. See the “CHART FORMATTING” section below.

chart.set_drop_lines(:line => { :color => 'red', :dash_type => 'square_dot' } )

Drop Lines are only available in Line, Area and Stock charts.



1655
1656
1657
1658
1659
1660
 
# File 'lib/write_xlsx/chart.rb', line 1655

def set_drop_lines(params = {})
  # Set the drop line properties.
  line = line_properties(params[:line])

  @drop_lines = { :_line => line }
end

#set_embedded_config_data ⇒ Object

Setup the default configuration data for an embedded chart.



1687
1688
1689
 
# File 'lib/write_xlsx/chart.rb', line 1687

def set_embedded_config_data
  @embedded = 1
end

#set_high_low_lines(params = {}) ⇒ Object

Set properties for the chart high-low lines.

The set_high_low_lines() method adds High-Low lines to charts to show the maximum and minimum values of points in a Category.

chart.set_high_low_lines

It is possible to format the High-Low Line line properties if required. See the “CHART FORMATTING” section below.

chart.set_high_low_lines( :line => { :color => 'red' } )

High-Low Lines are only available in Line and Stock charts.



1677
1678
1679
1680
1681
1682
 
# File 'lib/write_xlsx/chart.rb', line 1677

def set_high_low_lines(params = {})
  # Set the drop line properties.
  line = line_properties(params[:line])

  @hi_low_lines = { :_line => line }
end

#set_legend(params) ⇒ Object

Set the properties of the chart legend.

The set_legend() method is used to set properties of the chart legend.

chart.set_legend( :position => 'none' )

The properties that can be set are:

:position

Set the position of the chart legend.

chart.set_legend( :position => 'bottom' )

The default legend position is right. The available positions are:

none
top
bottom
left
right
overlay_left
overlay_right

:delete_series

This allows you to remove 1 or more series from the the legend (the series will still display on the chart). This property takes an array ref as an argument and the series are zero indexed:

# Delete/hide series index 0 and 2 from the legend.
chart.set_legend(:delete_series => [0, 2])



1448
1449
1450
1451
 
# File 'lib/write_xlsx/chart.rb', line 1448

def set_legend(params)
  @legend_position = params[:position] || 'right'
  @legend_delete_series = params[:delete_series]
end

#set_plotarea(params) ⇒ Object

Set the properties of the chart plotarea.

The set_plotarea() method is used to set properties of the plot area of a chart.

This method isn’t implemented yet and is only available in writeexcel gem. However, it can be simulated using the set_style() method.



1463
1464
1465
1466
 
# File 'lib/write_xlsx/chart.rb', line 1463

def set_plotarea(params)
  # Convert the user defined properties to internal properties.
  @plotarea = area_properties(params)
end

#set_size(params = {}) ⇒ Object Also known as: size

Set dimensions for scale for the chart.

The set_size() method is used to set the dimensions of the chart. The size properties that can be set are:

width
height
x_scale
y_scale
x_offset
y_offset

The width and height are in pixels. The default chart width is 480 pixels and the default height is 288 pixels. The size of the chart can be modified by setting the width and height or by setting the :x_scale and :y_scale:

chart.set_size( :width => 720, :height => 576 )

# Same as:

chart.set_size( :x_scale => 1.5, :y_scale => 2 )

The :x_offset and :y_offset position the top left corner of the chart in the cell that it is inserted into.

Note: the :x_scale, :y_scale, :x_offset and :y_offset parameters can also be set via the insert_chart() method:

worksheet.insert_chart( 'E2', chart, 2, 4, 1.5, 2 )



1569
1570
1571
1572
1573
1574
1575
1576
 
# File 'lib/write_xlsx/chart.rb', line 1569

def set_size(params = {})
  @width    = params[:width]    if params[:width]
  @height   = params[:height]   if params[:height]
  @x_scale  = params[:x_scale]  if params[:x_scale]
  @y_scale  = params[:y_scale]  if params[:y_scale]
  @x_offset = params[:x_offset] if params[:x_offset]
  @y_offset = params[:y_offset] if params[:y_offset]
end

#set_style(style_id = 2) ⇒ Object

Set on of the 42 built-in Excel chart styles. The default style is 2.

The set_style() method is used to set the style of the chart to one of the 42 built-in styles available on the ‘Design’ tab in Excel:

chart.set_style( 4 )

The default style is 2.



1502
1503
1504
1505
 
# File 'lib/write_xlsx/chart.rb', line 1502

def set_style(style_id = 2)
  style_id = 2 if style_id < 0 || style_id > 42
  @style_id = style_id
end

#set_table(params = {}) ⇒ Object

The set_table method adds a data table below the horizontal axis with the data used to plot the chart.

chart.set_table

The available options, with default values are:

:vertical   => true    # Display vertical lines in the table.
:horizontal => true    # Display horizontal lines in the table.
:outline    => true    # Display an outline in the table.
:show_keys  => false   # Show the legend keys with the table data.

The data table can only be shown with Bar, Column, Line, Area and Stock charts.



1596
1597
1598
 
# File 'lib/write_xlsx/chart.rb', line 1596

def set_table(params = {})
  @table = Table.new(params)
end

#set_title(params) ⇒ Object

Set the properties of the chart title.

The set_title() method is used to set properties of the chart title.

chart.set_title( :name => 'Year End Results' )

The properties that can be set are:

:name

Set the name (title) for the chart. The name is displayed above the chart. The name can also be a formula such as =Sheet1!$A$1. The name property is optional. The default is to have no chart title.

:name_font

Set the font properties for the chart title. See the “CHART FONTS” section.



1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
 
# File 'lib/write_xlsx/chart.rb', line 1403

def set_title(params)
  name, name_formula = process_names(params[:name], params[:name_formula])
  data_id = get_data_id(name_formula, params[:data])

  @title_name    = name
  @title_formula = name_formula
  @title_data_id = data_id

  # Set the font properties if present.
  @title_font = convert_font_args(params[:name_font])
end

#set_up_down_bars(params = {}) ⇒ Object

Set properties for the chart up-down bars.

The set_up_down_bars() method adds Up-Down bars to Line charts to indicate the difference between the first and last data series.

chart.set_up_down_bars

It is possible to format the up and down bars to add fill and border properties if required. See the “CHART FORMATTING” section below.

chart.set_up_down_bars(
    :up   => { :fill => { :color => 'green' } },
    :down => { :fill => { :color => 'red' } }
)

Up-down bars can only be applied to Line charts and to Stock charts (by default).



1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
 
# File 'lib/write_xlsx/chart.rb', line 1617

def set_up_down_bars(params = {})
  # Map border to line.
  [:up, :down].each do |up_down|
    if params[up_down]
      params[up_down][:line] = params[up_down][:border] if params[up_down][:border]
    else
      params[up_down] = {}
    end
  end

  # Set the up and down bar properties.
  @up_down_bars = {
    :_up => {
      :_line => line_properties(params[:up][:line]),
      :_fill => line_properties(params[:up][:fill])
    },
    :_down => {
      :_line => line_properties(params[:down][:line]),
      :_fill => line_properties(params[:down][:fill])
    }
  }
end

#set_x2_axis(params = {}) ⇒ Object

Set the properties of the secondary X-axis.



1375
1376
1377
 
# File 'lib/write_xlsx/chart.rb', line 1375

def set_x2_axis(params = {})
  @x2_axis.merge_with_hash(self, params)
end

#set_x_axis(params = {}) ⇒ Object

Set the properties of the X-axis.

The set_x_axis() method is used to set properties of the X axis.

chart.set_x_axis( :name => 'Quarterly results' )

The properties that can be set are:

:name
:min
:max
:minor_unit
:major_unit
:crossing
:reverse
:log_base
:label_position
:major_gridlines
:minor_gridlines
:visible

These are explained below. Some properties are only applicable to value or category axes, as indicated. See “Value and Category Axes” for an explanation of Excel’s distinction between the axis types.

:name

Set the name (title or caption) for the axis. The name is displayed below the X axis. The name property is optional. The default is to have no axis name. (Applicable to category and value axes).

chart.set_x_axis( :name => 'Quarterly results' )

The name can also be a formula such as =Sheet1!$A$1.

:min

Set the minimum value for the axis range. (Applicable to value axes only).

chart.set_x_axis( :min => 20 )

:max

Set the maximum value for the axis range. (Applicable to value axes only).

chart.set_x_axis( :max => 80 )

:minor_unit

Set the increment of the minor units in the axis range. (Applicable to value axes only).

chart.set_x_axis( :minor_unit => 0.4 )

:major_unit

Set the increment of the major units in the axis range. (Applicable to value axes only).

chart.set_x_axis( :major_unit => 2 )

:crossing

Set the position where the y axis will cross the x axis. (Applicable to category and value axes).

The crossing value can either be the string ‘max’ to set the crossing at the maximum axis value or a numeric value.

chart.set_x_axis( :crossing => 3 )
# or
chart.set_x_axis( :crossing => 'max' )

For category axes the numeric value must be an integer to represent the category number that the axis crosses at. For value axes it can have any value associated with the axis.

If crossing is omitted (the default) the crossing will be set automatically by Excel based on the chart data.

:reverse

Reverse the order of the axis categories or values. (Applicable to category and value axes).

chart.set_x_axis( :reverse => 1 )

:log_base

Set the log base of the axis range. (Applicable to value axes only).

chart.set_x_axis( :log_base => 10 )

:label_position

Set the “Axis labels” position for the axis. The following positions are available:

next_to (the default)
high
low
none

More than one property can be set in a call to set_x_axis:

chart.set_x_axis(
    :name => 'Quarterly results',
    :min  => 10,
    :max  => 80
)

CHART FONTS

The following font properties can be set for any chart object that they apply to (and that are supported by WriteXLSX) such as chart titles, axis labels and axis numbering. They correspond to the equivalent Worksheet cell Format object properties. See “FORMAT_METHODS” for more information.

name
size
bold
italic
underline
color

The following explains the available font properties:

name

Set the font name:

chart.set_x_axis( :num_font => { :name => 'Arial' } )

size

Set the font size:

chart.set_x_axis( :num_font => { :name => 'Arial', :size => 10 } )

bold

Set the font bold property, should be 0 or 1:

chart.set_x_axis( :num_font => { :bold => 1 } )

italic

Set the font italic property, should be 0 or 1:

chart.set_x_axis( :num_font => { :italic => 1 } )

underline

Set the font underline property, should be 0 or 1:

chart.set_x_axis( :num_font => { :underline => 1 } )

color

Set the font color property. Can be a color index, a color name or HTML style RGB colour:

chart.set_x_axis( :num_font => { :color => 'red' } )
chart.set_y_axis( :num_font => { :color => '#92D050' } )

Here is an example of Font formatting in a Chart program:

# Format the chart title.
chart.set_title(
    :name      => 'Sales Results Chart',
    :name_font => {
        :name  => 'Calibri',
        :color => 'yellow'
    }
)

# Format the X-axis.
chart.set_x_axis(
    :name      => 'Month',
    :name_font => {
        :name  => 'Arial',
        :color => '#92D050'
    },
    :num_font => {
        :name  => 'Courier New',
        :color => '#00B0F0'
    }
)

# Format the Y-axis.
chart.set_y_axis(
    :name      => 'Sales (1000 units)',
    :name_font => {
        :name      => 'Century',
        :underline => 1,
        :color     => 'red'
    },
    :num_font => {
        :bold   => 1,
        :italic => 1,
        :color  => '#7030A0'
    }
)



1358
1359
1360
 
# File 'lib/write_xlsx/chart.rb', line 1358

def set_x_axis(params = {})
  @x_axis.merge_with_hash(self, params)
end

#set_xml_writer(filename) ⇒ Object

:nodoc:



582
583
584
 
# File 'lib/write_xlsx/chart.rb', line 582

def set_xml_writer(filename)   # :nodoc:
  @writer.set_xml_writer(filename)
end

#set_y2_axis(params = {}) ⇒ Object

Set the properties of the secondary Y-axis.



1382
1383
1384
 
# File 'lib/write_xlsx/chart.rb', line 1382

def set_y2_axis(params = {})
  @y2_axis.merge_with_hash(self, params)
end

#set_y_axis(params = {}) ⇒ Object

Set the properties of the Y-axis.

The set_y_axis() method is used to set properties of the Y axis. The properties that can be set are the same as for set_x_axis,



1368
1369
1370
 
# File 'lib/write_xlsx/chart.rb', line 1368

def set_y_axis(params = {})
  @y_axis.merge_with_hash(self, params)
end

#show_blanks_as(option) ⇒ Object

Set the option for displaying blank data in a chart. The default is ‘gap’.

The show_blanks_as method controls how blank data is displayed in a chart.

chart.show_blanks_as('span')

The available options are:

gap    # Blank data is show as a gap. The default.
zero   # Blank data is displayed as zero.
span   # Blank data is connected with a line.



1520
1521
1522
1523
1524
1525
1526
1527
1528
 
# File 'lib/write_xlsx/chart.rb', line 1520

def show_blanks_as(option)
  return unless option

  unless [:gap, :zero, :span].include?(option.to_sym)
    raise "Unknown show_blanks_as() option '#{option}'\n"
  end

  @show_blanks = option
end

#show_hidden_data ⇒ Object

Display data in hidden rows or columns on the chart.



1533
1534
1535
 
# File 'lib/write_xlsx/chart.rb', line 1533

def show_hidden_data
  @show_hidden_data = true
end

#write_bar_chart(params) ⇒ Object

Write the <c:barChart> element.



1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
 
# File 'lib/write_xlsx/chart.rb', line 1694

def write_bar_chart(params)   # :nodoc:
  if ptrue?(params[:primary_axes])
    series = get_primary_axes_series
  else
    series = get_secondary_axes_series
  end
  return if series.empty?

  subtype = @subtype
  subtype = 'percentStacked' if subtype == 'percent_stacked'

  # Set a default overlap for stacked charts.
  if @subtype =~ /stacked/
    @series_overlap = 100 unless @series_overlap
  end

  @writer.tag_elements('c:barChart') do
    # Write the c:barDir element.
    write_bar_dir
    # Write the c:grouping element.
    write_grouping(subtype)
    # Write the c:ser elements.
    series.each {|s| write_ser(s)}

    # write the c:marker element.
    write_marker_value

    # Write the c:gapWidth element.
    write_gap_width(@series_gap)

    # write the c:overlap element.
    write_overlap(@series_overlap)

    # Write the c:axId elements
    write_axis_ids(params)
  end
end