Class: MicrosoftGraph::Models::WorkbookChart

Inherits:
Entity
  • Object
show all
Includes:
MicrosoftKiotaAbstractions::Parsable
Defined in:
lib/models/workbook_chart.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 workbookChart and sets the default values.



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

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

Raises:

  • (StandardError) 


72
73
74
75
 
# File 'lib/models/workbook_chart.rb', line 72

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

Instance Method Details

#axes ⇒ Object

Gets the axes property value. Represents chart axes. Read-only.

Returns:

  • a workbook_chart_axes



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

def axes
    return @axes
end

#axes=(value) ⇒ Object

Sets the axes property value. Represents chart axes. Read-only.

Parameters:

  • value —

    Value to set for the axes property.

Returns:

  • a void



57
58
59
 
# File 'lib/models/workbook_chart.rb', line 57

def axes=(value)
    @axes = value
end

#data_labels ⇒ Object

Gets the dataLabels property value. Represents the datalabels on the chart. Read-only.

Returns:

  • a workbook_chart_data_labels



80
81
82
 
# File 'lib/models/workbook_chart.rb', line 80

def data_labels
    return @data_labels
end

#data_labels=(value) ⇒ Object

Sets the dataLabels property value. Represents the datalabels on the chart. Read-only.

Parameters:

  • value —

    Value to set for the dataLabels property.

Returns:

  • a void



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

def data_labels=(value)
    @data_labels = value
end

#format ⇒ Object

Gets the format property value. Encapsulates the format properties for the chart area. Read-only.

Returns:

  • a workbook_chart_area_format



95
96
97
 
# File 'lib/models/workbook_chart.rb', line 95

def format
    return @format
end

#format=(value) ⇒ Object

Sets the format property value. Encapsulates the format properties for the chart area. Read-only.

Parameters:

  • value —

    Value to set for the format property.

Returns:

  • a void



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

def format=(value)
    @format = value
end

#get_field_deserializers ⇒ Object

The deserialization information for the current model

Returns:

  • a i_dictionary



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/models/workbook_chart.rb', line 110

def get_field_deserializers()
    return super.merge({
        "axes" => lambda {|n| @axes = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::WorkbookChartAxes.create_from_discriminator_value(pn) }) },
        "dataLabels" => lambda {|n| @data_labels = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::WorkbookChartDataLabels.create_from_discriminator_value(pn) }) },
        "format" => lambda {|n| @format = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::WorkbookChartAreaFormat.create_from_discriminator_value(pn) }) },
        "height" => lambda {|n| @height = n.get_object_value(lambda {|pn| Double.create_from_discriminator_value(pn) }) },
        "left" => lambda {|n| @left = n.get_object_value(lambda {|pn| Double.create_from_discriminator_value(pn) }) },
        "legend" => lambda {|n| @legend = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::WorkbookChartLegend.create_from_discriminator_value(pn) }) },
        "name" => lambda {|n| @name = n.get_string_value() },
        "series" => lambda {|n| @series = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::WorkbookChartSeries.create_from_discriminator_value(pn) }) },
        "title" => lambda {|n| @title = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::WorkbookChartTitle.create_from_discriminator_value(pn) }) },
        "top" => lambda {|n| @top = n.get_object_value(lambda {|pn| Double.create_from_discriminator_value(pn) }) },
        "width" => lambda {|n| @width = n.get_object_value(lambda {|pn| Double.create_from_discriminator_value(pn) }) },
        "worksheet" => lambda {|n| @worksheet = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::WorkbookWorksheet.create_from_discriminator_value(pn) }) },
    })
end

#height ⇒ Object

Gets the height property value. Represents the height, in points, of the chart object.

Returns:

  • a double



130
131
132
 
# File 'lib/models/workbook_chart.rb', line 130

def height
    return @height
end

#height=(value) ⇒ Object

Sets the height property value. Represents the height, in points, of the chart object.

Parameters:

  • value —

    Value to set for the height property.

Returns:

  • a void



138
139
140
 
# File 'lib/models/workbook_chart.rb', line 138

def height=(value)
    @height = value
end

#left ⇒ Object

Gets the left property value. The distance, in points, from the left side of the chart to the worksheet origin.

Returns:

  • a double



145
146
147
 
# File 'lib/models/workbook_chart.rb', line 145

def left
    return @left
end

#left=(value) ⇒ Object

Sets the left property value. The distance, in points, from the left side of the chart to the worksheet origin.

Parameters:

  • value —

    Value to set for the left property.

Returns:

  • a void



153
154
155
 
# File 'lib/models/workbook_chart.rb', line 153

def left=(value)
    @left = value
end

#legend ⇒ Object

Gets the legend property value. Represents the legend for the chart. Read-only.

Returns:

  • a workbook_chart_legend



160
161
162
 
# File 'lib/models/workbook_chart.rb', line 160

def legend
    return @legend
end

#legend=(value) ⇒ Object

Sets the legend property value. Represents the legend for the chart. Read-only.

Parameters:

  • value —

    Value to set for the legend property.

Returns:

  • a void



168
169
170
 
# File 'lib/models/workbook_chart.rb', line 168

def legend=(value)
    @legend = value
end

#name ⇒ Object

Gets the name property value. Represents the name of a chart object.

Returns:

  • a string



175
176
177
 
# File 'lib/models/workbook_chart.rb', line 175

def name
    return @name
end

#name=(value) ⇒ Object

Sets the name property value. Represents the name of a chart object.

Parameters:

  • value —

    Value to set for the name property.

Returns:

  • a void



183
184
185
 
# File 'lib/models/workbook_chart.rb', line 183

def name=(value)
    @name = 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) 


191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/models/workbook_chart.rb', line 191

def serialize(writer)
    raise StandardError, 'writer cannot be null' if writer.nil?
    super
    writer.write_object_value("axes", @axes)
    writer.write_object_value("dataLabels", @data_labels)
    writer.write_object_value("format", @format)
    writer.write_object_value("height", @height)
    writer.write_object_value("left", @left)
    writer.write_object_value("legend", @legend)
    writer.write_string_value("name", @name)
    writer.write_collection_of_object_values("series", @series)
    writer.write_object_value("title", @title)
    writer.write_object_value("top", @top)
    writer.write_object_value("width", @width)
    writer.write_object_value("worksheet", @worksheet)
end

#series ⇒ Object

Gets the series property value. Represents either a single series or collection of series in the chart. Read-only.

Returns:

  • a workbook_chart_series



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

def series
    return @series
end

#series=(value) ⇒ Object

Sets the series property value. Represents either a single series or collection of series in the chart. Read-only.

Parameters:

  • value —

    Value to set for the series property.

Returns:

  • a void



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

def series=(value)
    @series = value
end

#title ⇒ Object

Gets the title property value. Represents the title of the specified chart, including the text, visibility, position and formating of the title. Read-only.

Returns:

  • a workbook_chart_title



226
227
228
 
# File 'lib/models/workbook_chart.rb', line 226

def title
    return @title
end

#title=(value) ⇒ Object

Sets the title property value. Represents the title of the specified chart, including the text, visibility, position and formating of the title. Read-only.

Parameters:

  • value —

    Value to set for the title property.

Returns:

  • a void



234
235
236
 
# File 'lib/models/workbook_chart.rb', line 234

def title=(value)
    @title = value
end

#top ⇒ Object

Gets the top property value. Represents the distance, in points, from the top edge of the object to the top of row 1 (on a worksheet) or the top of the chart area (on a chart).

Returns:

  • a double



241
242
243
 
# File 'lib/models/workbook_chart.rb', line 241

def top
    return @top
end

#top=(value) ⇒ Object

Sets the top property value. Represents the distance, in points, from the top edge of the object to the top of row 1 (on a worksheet) or the top of the chart area (on a chart).

Parameters:

  • value —

    Value to set for the top property.

Returns:

  • a void



249
250
251
 
# File 'lib/models/workbook_chart.rb', line 249

def top=(value)
    @top = value
end

#width ⇒ Object

Gets the width property value. Represents the width, in points, of the chart object.

Returns:

  • a double



256
257
258
 
# File 'lib/models/workbook_chart.rb', line 256

def width
    return @width
end

#width=(value) ⇒ Object

Sets the width property value. Represents the width, in points, of the chart object.

Parameters:

  • value —

    Value to set for the width property.

Returns:

  • a void



264
265
266
 
# File 'lib/models/workbook_chart.rb', line 264

def width=(value)
    @width = value
end

#worksheet ⇒ Object

Gets the worksheet property value. The worksheet containing the current chart. Read-only.

Returns:

  • a workbook_worksheet



271
272
273
 
# File 'lib/models/workbook_chart.rb', line 271

def worksheet
    return @worksheet
end

#worksheet=(value) ⇒ Object

Sets the worksheet property value. The worksheet containing the current chart. Read-only.

Parameters:

  • value —

    Value to set for the worksheet property.

Returns:

  • a void



279
280
281
 
# File 'lib/models/workbook_chart.rb', line 279

def worksheet=(value)
    @worksheet = value
end