1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
|
# frozen_string_literal: true
module Axlsx
# There are more elements in the dLbls spec that allow for
# customizations and formatting. For now, I am just implementing the
# basics.
# The DLbls class manages serialization of data labels
# showLeaderLines and leaderLines are not currently implemented
class DLbls
include Axlsx::Accessors
include Axlsx::OptionsParser
# creates a new DLbls object
def initialize(chart_type, options = {})
raise ArgumentError, 'chart_type must inherit from Chart' unless [Chart, LineChart].include?(chart_type.superclass)
@chart_type = chart_type
initialize_defaults
parse_options options
end
# These attributes are all boolean so I'm doing a bit of a hand
# waving magic show to set up the attriubte accessors
# @note
# not all charts support all methods!
# Bar3DChart and Line3DChart and ScatterChart do not support d_lbl_pos or show_leader_lines
#
boolean_attr_accessor :show_legend_key,
:show_val,
:show_cat_name,
:show_ser_name,
:show_percent,
:show_bubble_size,
:show_leader_lines
# Initialize all the values to false as Excel requires them to
# explicitly be disabled or all will show.
def initialize_defaults
[:show_legend_key, :show_val, :show_cat_name,
:show_ser_name, :show_percent, :show_bubble_size,
:show_leader_lines].each do |attr|
send("#{attr}=", false)
end
end
# The chart type that is using this data lables instance.
# This affects the xml output as not all chart types support the
# same data label attributes.
attr_reader :chart_type
# The position of the data labels in the chart
# @see d_lbl_pos= for a list of allowed values
# @return [Symbol]
def d_lbl_pos
return unless [Pie3DChart, LineChart].include? @chart_type
@d_lbl_pos ||= :bestFit
end
# @see DLbls#d_lbl_pos
# Assigns the label postion for this data labels on this chart.
# Allowed positions are :bestFit, :b, :ctr, :inBase, :inEnd, :l,
# :outEnd, :r and :t
# The default is :bestFit
# @param [Symbol] label_position the postion you want to use.
def d_lbl_pos=(label_position)
return unless [Pie3DChart, LineChart].include? @chart_type
Axlsx::RestrictionValidator.validate 'DLbls#d_lbl_pos', [:bestFit, :b, :ctr, :inBase, :inEnd, :l, :outEnd, :r, :t], label_position
@d_lbl_pos = label_position
end
# serializes the data labels
# @return [String]
def to_xml_string(str = +'')
validate_attributes_for_chart_type
str << '<c:dLbls>'
instance_vals = Axlsx.instance_values_for(self)
%w(d_lbl_pos show_legend_key show_val show_cat_name show_ser_name show_percent show_bubble_size show_leader_lines).each do |key|
next unless instance_vals.key?(key) && !instance_vals[key].nil?
str << "<c:#{Axlsx.camel(key, false)} val='#{instance_vals[key]}' />"
end
str << '</c:dLbls>'
end
# nills out d_lbl_pos and show_leader_lines as these attributes, while valid in the spec actually crash Excel for any chart type other than pie charts.
def validate_attributes_for_chart_type
return if [Pie3DChart, LineChart].include? @chart_type
@d_lbl_pos = nil
@show_leader_lines = nil
end
end
end
|
