Class: Axlsx::BarChart

Inherits:
Chart
  • Object
show all
Defined in:
lib/axlsx/drawing/bar_chart.rb

Overview

The BarChart is a two dimensional barchart that you can add to your worksheet.

See Also:

Instance Attribute Summary

Attributes inherited from Chart

#bg_color, #display_blanks_as, #graphic_frame, #legend_position, #plot_visible_only, #rounded_corners, #series, #series_type, #show_legend, #style, #title, #vary_colors, #view_3D

Instance Method Summary collapse

Methods inherited from Chart

#add_series, #d_lbls, #end_at, #from, #index, #pn, #relationship, #start_at, #title_size=, #to

Methods included from OptionsParser

#parse_options

Constructor Details

#initialize(frame, options = {}) ⇒ BarChart

Creates a new bar chart object

Parameters:

  • frame (GraphicFrame) —

    The workbook that owns this chart.

  • options (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (options):

  • title (Cell, String)
  • show_legend (Boolean)
  • bar_dir (Symbol)
  • grouping (Symbol)
  • gap_width (String)
  • shape (Symbol)

See Also:



68
69
70
71
72
73
74
 
# File 'lib/axlsx/drawing/bar_chart.rb', line 68

def initialize(frame, options = {})
  @vary_colors = true
  @gap_width, @overlap, @shape = nil, nil, nil
  super
  @series_type = BarSeries
  @d_lbls = nil
end

Instance Method Details

#axes ⇒ Axes

A hash of axes used by this chart. Bar charts have a value and category axes specified via axes[:val_axes] and axes[:cat_axis]

Returns:



133
134
135
 
# File 'lib/axlsx/drawing/bar_chart.rb', line 133

def axes
  @axes ||= Axes.new(cat_axis: CatAxis, val_axis: ValAxis)
end

#bar_dir ⇒ Symbol Also known as: barDir

The direction of the bars in the chart must be one of [:bar, :col]

Returns:

  • (Symbol) 


27
28
29
 
# File 'lib/axlsx/drawing/bar_chart.rb', line 27

def bar_dir
  @bar_dir ||= :bar
end

#bar_dir=(v) ⇒ Object Also known as: barDir=

The direction of the bars in the chart must be one of [:bar, :col]



78
79
80
81
 
# File 'lib/axlsx/drawing/bar_chart.rb', line 78

def bar_dir=(v)
  RestrictionValidator.validate "BarChart.bar_dir", [:bar, :col], v
  @bar_dir = v
end

#cat_axis ⇒ CatAxis Also known as: catAxis

the category axis

Returns:



12
13
14
 
# File 'lib/axlsx/drawing/bar_chart.rb', line 12

def cat_axis
  axes[:cat_axis]
end

#gap_width ⇒ Integer Also known as: gapWidth

space between bar or column clusters, as a percentage of the bar or column width.

Returns:

  • (Integer) 


34
35
36
 
# File 'lib/axlsx/drawing/bar_chart.rb', line 34

def gap_width
  @gap_width ||= 150
end

#gap_width=(v) ⇒ Object Also known as: gapWidth=

space between bar or column clusters, as a percentage of the bar or column width.



92
93
94
95
 
# File 'lib/axlsx/drawing/bar_chart.rb', line 92

def gap_width=(v)
  RangeValidator.validate "BarChart.gap_width", 0, 500, v
  @gap_width = v
end

#grouping ⇒ Symbol

grouping for a column, line, or area chart. must be one of [:percentStacked, :clustered, :standard, :stacked]

Returns:

  • (Symbol) 


42
43
44
 
# File 'lib/axlsx/drawing/bar_chart.rb', line 42

def grouping
  @grouping ||= :clustered
end

#grouping=(v) ⇒ Object

grouping for a column, line, or area chart. must be one of [:percentStacked, :clustered, :standard, :stacked]



86
87
88
89
 
# File 'lib/axlsx/drawing/bar_chart.rb', line 86

def grouping=(v)
  RestrictionValidator.validate "BarChart.grouping", [:percentStacked, :clustered, :standard, :stacked], v
  @grouping = v
end

#overlap ⇒ Integer

Overlap between series

Returns:

  • (Integer) 


48
49
50
 
# File 'lib/axlsx/drawing/bar_chart.rb', line 48

def overlap
  @overlap ||= 0
end

#overlap=(v) ⇒ Object 



98
99
100
101
 
# File 'lib/axlsx/drawing/bar_chart.rb', line 98

def overlap=(v)
  RangeValidator.validate "BarChart.overlap", -100, 100, v
  @overlap = v
end

#shape ⇒ Symbol

The shape of the bars or columns must be one of [:cone, :coneToMax, :box, :cylinder, :pyramid, :pyramidToMax]

Returns:

  • (Symbol) 


55
56
57
 
# File 'lib/axlsx/drawing/bar_chart.rb', line 55

def shape
  @shape ||= :box
end

#shape=(v) ⇒ Object

The shape of the bars or columns must be one of [:cone, :coneToMax, :box, :cylinder, :pyramid, :pyramidToMax]



105
106
107
108
 
# File 'lib/axlsx/drawing/bar_chart.rb', line 105

def shape=(v)
  RestrictionValidator.validate "BarChart.shape", [:cone, :coneToMax, :box, :cylinder, :pyramid, :pyramidToMax], v
  @shape = v
end

#to_xml_string(str = +'')) ⇒ String

Serializes the object

Parameters:

  • str (String) (defaults to: +''))

Returns:

  • (String) 


113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/axlsx/drawing/bar_chart.rb', line 113

def to_xml_string(str = +'')
  super do
    str << '<c:barChart>'
    str << '<c:barDir val="' << bar_dir.to_s << '"/>'
    str << '<c:grouping val="' << grouping.to_s << '"/>'
    str << '<c:varyColors val="' << vary_colors.to_s << '"/>'
    @series.each { |ser| ser.to_xml_string(str) }
    @d_lbls.to_xml_string(str) if @d_lbls
    str << '<c:overlap val="' << @overlap.to_s << '"/>' unless @overlap.nil?
    str << '<c:gapWidth val="' << @gap_width.to_s << '"/>' unless @gap_width.nil?
    str << '<c:shape val="' << @shape.to_s << '"/>' unless @shape.nil?
    axes.to_xml_string(str, ids: true)
    str << '</c:barChart>'
    axes.to_xml_string(str)
  end
end

#val_axis ⇒ ValAxis Also known as: valAxis

the value axis

Returns:



19
20
21
 
# File 'lib/axlsx/drawing/bar_chart.rb', line 19

def val_axis
  axes[:val_axis]
end