Class: MicrosoftGraph::Models::WorkbookChartDataLabels

Inherits:
Entity
  • Object
show all
Includes:
MicrosoftKiotaAbstractions::Parsable
Defined in:
lib/models/workbook_chart_data_labels.rb

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Entity

#additional_data, #additional_data=, #id, #id=, #odata_type, #odata_type=

Constructor Details

#initialize ⇒ Object

Instantiates a new workbookChartDataLabels and sets the default values.



40
41
42
 
# File 'lib/models/workbook_chart_data_labels.rb', line 40

def initialize()
    super
end

Class Method Details

.create_from_discriminator_value(parse_node) ⇒ Object

Creates a new instance of the appropriate class based on discriminator value

Parameters:

  • parse_node —

    The parse node to use to read the discriminator value and create the object

Returns:

  • a workbook_chart_data_labels

Raises:

  • (StandardError) 


48
49
50
51
 
# File 'lib/models/workbook_chart_data_labels.rb', line 48

def self.create_from_discriminator_value(parse_node)
    raise StandardError, 'parse_node cannot be null' if parse_node.nil?
    return WorkbookChartDataLabels.new
end

Instance Method Details

#format ⇒ Object

Gets the format property value. Represents the format of chart data labels, which includes fill and font formatting. Read-only.

Returns:

  • a workbook_chart_data_label_format



56
57
58
 
# File 'lib/models/workbook_chart_data_labels.rb', line 56

def format
    return @format
end

#format=(value) ⇒ Object

Sets the format property value. Represents the format of chart data labels, which includes fill and font formatting. Read-only.

Parameters:

  • value —

    Value to set for the format property.

Returns:

  • a void



64
65
66
 
# File 'lib/models/workbook_chart_data_labels.rb', line 64

def format=(value)
    @format = value
end

#get_field_deserializers ⇒ Object

The deserialization information for the current model

Returns:

  • a i_dictionary



71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/models/workbook_chart_data_labels.rb', line 71

def get_field_deserializers()
    return super.merge({
        "format" => lambda {|n| @format = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::WorkbookChartDataLabelFormat.create_from_discriminator_value(pn) }) },
        "position" => lambda {|n| @position = n.get_string_value() },
        "separator" => lambda {|n| @separator = n.get_string_value() },
        "showBubbleSize" => lambda {|n| @show_bubble_size = n.get_boolean_value() },
        "showCategoryName" => lambda {|n| @show_category_name = n.get_boolean_value() },
        "showLegendKey" => lambda {|n| @show_legend_key = n.get_boolean_value() },
        "showPercentage" => lambda {|n| @show_percentage = n.get_boolean_value() },
        "showSeriesName" => lambda {|n| @show_series_name = n.get_boolean_value() },
        "showValue" => lambda {|n| @show_value = n.get_boolean_value() },
    })
end

#position ⇒ Object

Gets the position property value. DataLabelPosition value that represents the position of the data label. The possible values are: None, Center, InsideEnd, InsideBase, OutsideEnd, Left, Right, Top, Bottom, BestFit, Callout.

Returns:

  • a string



88
89
90
 
# File 'lib/models/workbook_chart_data_labels.rb', line 88

def position
    return @position
end

#position=(value) ⇒ Object

Sets the position property value. DataLabelPosition value that represents the position of the data label. The possible values are: None, Center, InsideEnd, InsideBase, OutsideEnd, Left, Right, Top, Bottom, BestFit, Callout.

Parameters:

  • value —

    Value to set for the position property.

Returns:

  • a void



96
97
98
 
# File 'lib/models/workbook_chart_data_labels.rb', line 96

def position=(value)
    @position = value
end

#separator ⇒ Object

Gets the separator property value. String representing the separator used for the data labels on a chart.

Returns:

  • a string



103
104
105
 
# File 'lib/models/workbook_chart_data_labels.rb', line 103

def separator
    return @separator
end

#separator=(value) ⇒ Object

Sets the separator property value. String representing the separator used for the data labels on a chart.

Parameters:

  • value —

    Value to set for the separator property.

Returns:

  • a void



111
112
113
 
# File 'lib/models/workbook_chart_data_labels.rb', line 111

def separator=(value)
    @separator = value
end

#serialize(writer) ⇒ Object

Serializes information the current object

Parameters:

  • writer —

    Serialization writer to use to serialize this model

Returns:

  • a void

Raises:

  • (StandardError) 


119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/models/workbook_chart_data_labels.rb', line 119

def serialize(writer)
    raise StandardError, 'writer cannot be null' if writer.nil?
    super
    writer.write_object_value("format", @format)
    writer.write_string_value("position", @position)
    writer.write_string_value("separator", @separator)
    writer.write_boolean_value("showBubbleSize", @show_bubble_size)
    writer.write_boolean_value("showCategoryName", @show_category_name)
    writer.write_boolean_value("showLegendKey", @show_legend_key)
    writer.write_boolean_value("showPercentage", @show_percentage)
    writer.write_boolean_value("showSeriesName", @show_series_name)
    writer.write_boolean_value("showValue", @show_value)
end

#show_bubble_size ⇒ Object

Gets the showBubbleSize property value. Boolean value representing if the data label bubble size is visible or not.

Returns:

  • a boolean



136
137
138
 
# File 'lib/models/workbook_chart_data_labels.rb', line 136

def show_bubble_size
    return @show_bubble_size
end

#show_bubble_size=(value) ⇒ Object

Sets the showBubbleSize property value. Boolean value representing if the data label bubble size is visible or not.

Parameters:

  • value —

    Value to set for the showBubbleSize property.

Returns:

  • a void



144
145
146
 
# File 'lib/models/workbook_chart_data_labels.rb', line 144

def show_bubble_size=(value)
    @show_bubble_size = value
end

#show_category_name ⇒ Object

Gets the showCategoryName property value. Boolean value representing if the data label category name is visible or not.

Returns:

  • a boolean



151
152
153
 
# File 'lib/models/workbook_chart_data_labels.rb', line 151

def show_category_name
    return @show_category_name
end

#show_category_name=(value) ⇒ Object

Sets the showCategoryName property value. Boolean value representing if the data label category name is visible or not.

Parameters:

  • value —

    Value to set for the showCategoryName property.

Returns:

  • a void



159
160
161
 
# File 'lib/models/workbook_chart_data_labels.rb', line 159

def show_category_name=(value)
    @show_category_name = value
end

#show_legend_key ⇒ Object

Gets the showLegendKey property value. Boolean value representing if the data label legend key is visible or not.

Returns:

  • a boolean



166
167
168
 
# File 'lib/models/workbook_chart_data_labels.rb', line 166

def show_legend_key
    return @show_legend_key
end

#show_legend_key=(value) ⇒ Object

Sets the showLegendKey property value. Boolean value representing if the data label legend key is visible or not.

Parameters:

  • value —

    Value to set for the showLegendKey property.

Returns:

  • a void



174
175
176
 
# File 'lib/models/workbook_chart_data_labels.rb', line 174

def show_legend_key=(value)
    @show_legend_key = value
end

#show_percentage ⇒ Object

Gets the showPercentage property value. Boolean value representing if the data label percentage is visible or not.

Returns:

  • a boolean



181
182
183
 
# File 'lib/models/workbook_chart_data_labels.rb', line 181

def show_percentage
    return @show_percentage
end

#show_percentage=(value) ⇒ Object

Sets the showPercentage property value. Boolean value representing if the data label percentage is visible or not.

Parameters:

  • value —

    Value to set for the showPercentage property.

Returns:

  • a void



189
190
191
 
# File 'lib/models/workbook_chart_data_labels.rb', line 189

def show_percentage=(value)
    @show_percentage = value
end

#show_series_name ⇒ Object

Gets the showSeriesName property value. Boolean value representing if the data label series name is visible or not.

Returns:

  • a boolean



196
197
198
 
# File 'lib/models/workbook_chart_data_labels.rb', line 196

def show_series_name
    return @show_series_name
end

#show_series_name=(value) ⇒ Object

Sets the showSeriesName property value. Boolean value representing if the data label series name is visible or not.

Parameters:

  • value —

    Value to set for the showSeriesName property.

Returns:

  • a void



204
205
206
 
# File 'lib/models/workbook_chart_data_labels.rb', line 204

def show_series_name=(value)
    @show_series_name = value
end

#show_value ⇒ Object

Gets the showValue property value. Boolean value representing if the data label value is visible or not.

Returns:

  • a boolean



211
212
213
 
# File 'lib/models/workbook_chart_data_labels.rb', line 211

def show_value
    return @show_value
end

#show_value=(value) ⇒ Object

Sets the showValue property value. Boolean value representing if the data label value is visible or not.

Parameters:

  • value —

    Value to set for the showValue property.

Returns:

  • a void



219
220
221
 
# File 'lib/models/workbook_chart_data_labels.rb', line 219

def show_value=(value)
    @show_value = value
end