Class: Axlsx::Chart

Inherits:
Object
  • Object
show all
Includes:
OptionsParser
Defined in:
lib/axlsx/drawing/chart.rb

Overview

Note:

Worksheet#add_chart is the recommended way to create charts for your worksheets.

A Chart is the superclass for specific charts

See Also:

  • for examples

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from OptionsParser

#parse_options

Constructor Details

#initialize(frame, options = {}) {|_self| ... } ⇒ Chart

Creates a new chart object

Parameters:

  • frame (GraphicalFrame) —

    The frame that holds this chart.

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

    a customizable set of options

Options Hash (options):

  • title (Cell, String)
  • show_legend (Boolean)
  • legend_position (Symbol)
  • start_at (Array|String|Cell) —

    The X, Y coordinates defining the top left corner of the chart.

  • end_at (Array|String|Cell) —

    The X, Y coordinates defining the bottom right corner of the chart.

  • plot_visible_only (Boolean) — default: true —

    Whether only data from visible cells should be plotted.

  • rounded_corners (Boolean) — default: true —

    Whether the chart area shall have rounded corners.

Yields:

  • (_self)

Yield Parameters:

  • _self (Axlsx::Chart) —

    the object that the method was called on



16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
 
# File 'lib/axlsx/drawing/chart.rb', line 16

def initialize(frame, options = {})
  @style = 18
  @view_3D = nil
  @graphic_frame = frame
  @graphic_frame.anchor.drawing.worksheet.workbook.charts << self
  @series = SimpleTypedList.new Series
  @show_legend = true
  @legend_position = :r
  @display_blanks_as = :gap
  @series_type = Series
  @title = Title.new
  @bg_color = nil
  @plot_visible_only = true
  @rounded_corners = true
  parse_options options
  start_at(*options[:start_at]) if options[:start_at]
  end_at(*options[:end_at]) if options[:end_at]
  yield self if block_given?
end

Instance Attribute Details

#bg_color ⇒ String

Background color for the chart

Returns:

  • (String) 


100
101
102
 
# File 'lib/axlsx/drawing/chart.rb', line 100

def bg_color
  @bg_color
end

#display_blanks_as ⇒ Symbol

How to display blank values Options are

  • gap: Display nothing
  • span: Not sure what this does
  • zero: Display as if the value were zero, not blank Default :gap (although this really should vary by chart type and grouping)

Returns:

  • (Symbol) 


96
97
98
 
# File 'lib/axlsx/drawing/chart.rb', line 96

def display_blanks_as
  @display_blanks_as
end

#graphic_frame ⇒ GraphicFrame (readonly)

A reference to the graphic frame that owns this chart

Returns:



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

def graphic_frame
  @graphic_frame
end

#legend_position ⇒ Symbol

Note:

The following are allowed :b :l :r :t :tr

Set the location of the chart's legend

Returns:

  • (Symbol) —

    The position of this legend



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

def legend_position
  @legend_position
end

#plot_visible_only ⇒ Boolean

Whether only data from visible cells should be plotted.

Returns:

  • (Boolean) 


104
105
106
 
# File 'lib/axlsx/drawing/chart.rb', line 104

def plot_visible_only
  @plot_visible_only
end

#rounded_corners ⇒ Boolean

Whether the chart area shall have rounded corners.

Returns:

  • (Boolean) 


108
109
110
 
# File 'lib/axlsx/drawing/chart.rb', line 108

def rounded_corners
  @rounded_corners
end

#series ⇒ SimpleTypedList (readonly)

A collection of series objects that are applied to the chart

Returns:

  • (SimpleTypedList) 


46
47
48
 
# File 'lib/axlsx/drawing/chart.rb', line 46

def series
  @series
end

#series_type ⇒ Series (readonly)

The type of series to use for this chart.

Returns:



50
51
52
 
# File 'lib/axlsx/drawing/chart.rb', line 50

def series_type
  @series_type
end

#show_legend ⇒ Boolean

Show the legend in the chart

Returns:

  • (Boolean) 


76
77
78
 
# File 'lib/axlsx/drawing/chart.rb', line 76

def show_legend
  @show_legend
end

#style ⇒ Integer

The style for the chart. see ECMA Part 1 §21.2.2.196

Returns:

  • (Integer) 


72
73
74
 
# File 'lib/axlsx/drawing/chart.rb', line 72

def style
  @style
end

#title ⇒ Title

The title object for the chart.

Returns:



67
68
69
 
# File 'lib/axlsx/drawing/chart.rb', line 67

def title
  @title
end

#vary_colors ⇒ Boolean

Indicates that colors should be varied by datum

Returns:

  • (Boolean) 


59
60
61
 
# File 'lib/axlsx/drawing/chart.rb', line 59

def vary_colors
  @vary_colors
end

#view_3D ⇒ Object Also known as: view3D

The 3D view properties for the chart



37
38
39
 
# File 'lib/axlsx/drawing/chart.rb', line 37

def view_3D
  @view_3D
end

Instance Method Details

#add_series(options = {}) ⇒ Series

Adds a new series to the chart's series collection.

Returns:

See Also:



181
182
183
184
 
# File 'lib/axlsx/drawing/chart.rb', line 181

def add_series(options = {})
  @series_type.new(self, options)
  @series.last
end

#d_lbls ⇒ Object

TODO data labels!



53
54
55
 
# File 'lib/axlsx/drawing/chart.rb', line 53

def d_lbls
  @d_lbls ||= DLbls.new(self.class)
end

#end_at(x = 10, y = 10) ⇒ Marker

This is a short cut method to set the end anchor position If you need finer granularity in positioning use graphic_frame.anchor.to.colOff / rowOff

Parameters:

  • x (Integer) (defaults to: 10) —

    The column - default 10

  • y (Integer) (defaults to: 10) —

    The row - default 10

Returns:

See Also:



286
287
288
 
# File 'lib/axlsx/drawing/chart.rb', line 286

def end_at(x = 10, y = 10)
  @graphic_frame.anchor.end_at(x, y)
end

#from ⇒ Object

Note:

This will be disconinued in version 2.0.0. please use the start_at method

backwards compatibility to allow chart.to and chart.from access to anchor markers



174
175
176
 
# File 'lib/axlsx/drawing/chart.rb', line 174

def from
  @graphic_frame.anchor.from
end

#index ⇒ Integer

The index of this chart in the workbooks charts collection

Returns:

  • (Integer) 


118
119
120
 
# File 'lib/axlsx/drawing/chart.rb', line 118

def index
  @graphic_frame.anchor.drawing.worksheet.workbook.charts.index(self)
end

#pn ⇒ String

The part name for this chart

Returns:

  • (String) 


124
125
126
 
# File 'lib/axlsx/drawing/chart.rb', line 124

def pn
  "#{CHART_PN % (index + 1)}"
end

#relationship ⇒ Relationship

The relationship object for this chart.

Returns:



112
113
114
 
# File 'lib/axlsx/drawing/chart.rb', line 112

def relationship
  Relationship.new(self, CHART_R, "../#{pn}")
end

#start_at(x = 0, y = 0) ⇒ Marker

This is a short cut method to set the anchor start marker position If you need finer granularity in positioning use

This helper method acceps a fairly wide range of inputs exampled below

reference or cell to use in setting the start marker position.

Examples:


start_at 0, 5 # The anchor start marker is set to 6th row of
the first column

start_at [0, 5] # The anchor start marker is set to start on the 6th row
of the first column

start_at "C1" # The anchor start marker is set to start on the first row
of the third column

start_at sheet.rows.first.cells.last # The anchor start
marker is set to the location of a specific cell.

Parameters:

  • x (Array|String|Cell) (defaults to: 0) —

    the column, coordinates, string

  • y (Integer) (defaults to: 0) —

    The row

Returns:



275
276
277
 
# File 'lib/axlsx/drawing/chart.rb', line 275

def start_at(x = 0, y = 0)
  @graphic_frame.anchor.start_at(x, y)
end

#title_size=(v) ⇒ Object

The size of the Title object of the chart.

Parameters:

  • v (String) —

    The size for the title object

See Also:



143
144
145
 
# File 'lib/axlsx/drawing/chart.rb', line 143

def title_size=(v)
  @title.text_size = v unless v.to_s.empty?
end

#to ⇒ Object

Note:

This will be disconinued in version 2.0.0. Please use the end_at method

backwards compatibility to allow chart.to and chart.from access to anchor markers



168
169
170
 
# File 'lib/axlsx/drawing/chart.rb', line 168

def to
  @graphic_frame.anchor.to
end

#to_xml_string(str = '') ⇒ String

Serializes the object

Parameters:

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

Returns:

  • (String) 


205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/axlsx/drawing/chart.rb', line 205

def to_xml_string(str = '')
  str << '<?xml version="1.0" encoding="UTF-8"?>'
  str << ('<c:chartSpace xmlns:c="' << XML_NS_C << '" xmlns:a="' << XML_NS_A << '" xmlns:r="' << XML_NS_R << '">')
  str << ('<c:date1904 val="' << Axlsx::Workbook.date1904.to_s << '"/>')
  str << ('<c:roundedCorners val="' << rounded_corners.to_s << '"/>')
  str << ('<c:style val="' << style.to_s << '"/>')
  str << '<c:chart>'
  @title.to_xml_string(str) unless @title.empty?
  str << ('<c:autoTitleDeleted val="' << (@title == nil).to_s << '"/>')
  @view_3D.to_xml_string(str) if @view_3D
  str << '<c:floor><c:thickness val="0"/></c:floor>'
  str << '<c:sideWall><c:thickness val="0"/></c:sideWall>'
  str << '<c:backWall><c:thickness val="0"/></c:backWall>'
  str << '<c:plotArea>'
  str << '<c:layout/>'
  yield if block_given?
  str << '</c:plotArea>'
  if @show_legend
    str << '<c:legend>'
    str << ('<c:legendPos val="' << @legend_position.to_s << '"/>')
    str << '<c:layout/>'
    str << '<c:overlay val="0"/>'
    str << '</c:legend>'
  end
  str << ('<c:plotVisOnly val="' << @plot_visible_only.to_s << '"/>')
  str << ('<c:dispBlanksAs val="' << display_blanks_as.to_s << '"/>')
  str << '<c:showDLblsOverMax val="1"/>'
  str << '</c:chart>'
  if bg_color
    str << '<c:spPr>'
    str << '<a:solidFill>'
    str << '<a:srgbClr val="' << bg_color << '"/>'
    str << '</a:solidFill>'
    str << '<a:ln>'
    str << '<a:noFill/>'
    str << '</a:ln>'
    str << '</c:spPr>'
  end
  str << '<c:printSettings>'
  str << '<c:headerFooter/>'
  str << '<c:pageMargins b="1.0" l="0.75" r="0.75" t="1.0" header="0.5" footer="0.5"/>'
  str << '<c:pageSetup/>'
  str << '</c:printSettings>'
  str << '</c:chartSpace>'
end