Class: AsposeSlidesCloud::Chart

Inherits:
ShapeBase show all
Defined in:
lib/aspose_slides_cloud/models/chart.rb

Overview

Represents chart resource

Instance Attribute Summary collapse

Attributes inherited from ShapeBase

#alternative_text, #alternative_text_title, #effect_format, #fill_format, #height, #hidden, #hyperlink_click, #hyperlink_mouse_over, #line_format, #name, #three_d_format, #type, #width, #x, #y, #z_order_position

Attributes inherited from ResourceBase

#alternate_links, #self_uri

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseObject

#_deserialize, #_to_hash, #build_from_hash, #to_body, #to_hash, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ Chart

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {})

    Model attributes in the form of hash



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
# File 'lib/aspose_slides_cloud/models/chart.rb', line 112

def initialize(attributes = {})
  super

  if attributes.has_key?(:'ChartType')
    self.chart_type = attributes[:'ChartType']
  end

  if attributes.has_key?(:'ShowDataLabelsOverMaximum')
    self.show_data_labels_over_maximum = attributes[:'ShowDataLabelsOverMaximum']
  end

  if attributes.has_key?(:'Series')
    if (value = attributes[:'Series']).is_a?(Array)
      self.series = value
    end
  end

  if attributes.has_key?(:'Categories')
    if (value = attributes[:'Categories']).is_a?(Array)
      self.categories = value
    end
  end

  if attributes.has_key?(:'DataSourceForCategories')
    self.data_source_for_categories = attributes[:'DataSourceForCategories']
  end

  if attributes.has_key?(:'Title')
    self.title = attributes[:'Title']
  end

  if attributes.has_key?(:'BackWall')
    self.back_wall = attributes[:'BackWall']
  end

  if attributes.has_key?(:'SideWall')
    self.side_wall = attributes[:'SideWall']
  end

  if attributes.has_key?(:'Floor')
    self.floor = attributes[:'Floor']
  end

  if attributes.has_key?(:'Legend')
    self.legend = attributes[:'Legend']
  end

  if attributes.has_key?(:'Axes')
    self.axes = attributes[:'Axes']
  end

  if attributes.has_key?(:'PlotArea')
    self.plot_area = attributes[:'PlotArea']
  end

  if attributes.has_key?(:'HasRoundedCorners')
    self.has_rounded_corners = attributes[:'HasRoundedCorners']
  end

  if attributes.has_key?(:'SeriesGroups')
    if (value = attributes[:'SeriesGroups']).is_a?(Array)
      self.series_groups = value
    end
  end
  self.type = 'Chart'
end

Instance Attribute Details

#axesObject

Gets or sets the axes.



59
60
61
# File 'lib/aspose_slides_cloud/models/chart.rb', line 59

def axes
  @axes
end

#back_wallObject

Gets or sets the back wall.



47
48
49
# File 'lib/aspose_slides_cloud/models/chart.rb', line 47

def back_wall
  @back_wall
end

#categoriesObject

Gets or sets the categories for chart data



38
39
40
# File 'lib/aspose_slides_cloud/models/chart.rb', line 38

def categories
  @categories
end

#chart_typeObject

Gets or sets the type of the chart.



29
30
31
# File 'lib/aspose_slides_cloud/models/chart.rb', line 29

def chart_type
  @chart_type
end

#data_source_for_categoriesObject

Data source type for categories.



41
42
43
# File 'lib/aspose_slides_cloud/models/chart.rb', line 41

def data_source_for_categories
  @data_source_for_categories
end

#floorObject

Gets or sets the floor.



53
54
55
# File 'lib/aspose_slides_cloud/models/chart.rb', line 53

def floor
  @floor
end

#has_rounded_cornersObject

Specifies the chart area shall have rounded corners.



65
66
67
# File 'lib/aspose_slides_cloud/models/chart.rb', line 65

def has_rounded_corners
  @has_rounded_corners
end

#legendObject

Gets or sets the legend.



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

def legend
  @legend
end

#plot_areaObject

Gets or sets the plot area.



62
63
64
# File 'lib/aspose_slides_cloud/models/chart.rb', line 62

def plot_area
  @plot_area
end

#seriesObject

Gets or sets the series of chart data values.



35
36
37
# File 'lib/aspose_slides_cloud/models/chart.rb', line 35

def series
  @series
end

#series_groupsObject

Gets groups of series.



68
69
70
# File 'lib/aspose_slides_cloud/models/chart.rb', line 68

def series_groups
  @series_groups
end

#show_data_labels_over_maximumObject

True if data labels over the maximum of the chart shall be shown.



32
33
34
# File 'lib/aspose_slides_cloud/models/chart.rb', line 32

def show_data_labels_over_maximum
  @show_data_labels_over_maximum
end

#side_wallObject

Gets or sets the side wall.



50
51
52
# File 'lib/aspose_slides_cloud/models/chart.rb', line 50

def side_wall
  @side_wall
end

#titleObject

Gets or sets the title.



44
45
46
# File 'lib/aspose_slides_cloud/models/chart.rb', line 44

def title
  @title
end

Class Method Details

.attribute_mapObject

Attribute mapping from ruby-style variable name to JSON key.



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
# File 'lib/aspose_slides_cloud/models/chart.rb', line 71

def self.attribute_map
  super.merge({
    :'chart_type' => :'ChartType',
    :'show_data_labels_over_maximum' => :'ShowDataLabelsOverMaximum',
    :'series' => :'Series',
    :'categories' => :'Categories',
    :'data_source_for_categories' => :'DataSourceForCategories',
    :'title' => :'Title',
    :'back_wall' => :'BackWall',
    :'side_wall' => :'SideWall',
    :'floor' => :'Floor',
    :'legend' => :'Legend',
    :'axes' => :'Axes',
    :'plot_area' => :'PlotArea',
    :'has_rounded_corners' => :'HasRoundedCorners',
    :'series_groups' => :'SeriesGroups',
  })
end

.swagger_typesObject

Attribute type mapping.



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
# File 'lib/aspose_slides_cloud/models/chart.rb', line 91

def self.swagger_types
  super.merge({
    :'chart_type' => :'String',
    :'show_data_labels_over_maximum' => :'BOOLEAN',
    :'series' => :'Array<Series>',
    :'categories' => :'Array<ChartCategory>',
    :'data_source_for_categories' => :'DataSource',
    :'title' => :'ChartTitle',
    :'back_wall' => :'ChartWall',
    :'side_wall' => :'ChartWall',
    :'floor' => :'ChartWall',
    :'legend' => :'Legend',
    :'axes' => :'Axes',
    :'plot_area' => :'PlotArea',
    :'has_rounded_corners' => :'BOOLEAN',
    :'series_groups' => :'Array<ChartSeriesGroup>',
  })
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



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
# File 'lib/aspose_slides_cloud/models/chart.rb', line 212

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      self_uri == o.self_uri &&
      alternate_links == o.alternate_links &&
      name == o.name &&
      width == o.width &&
      height == o.height &&
      alternative_text == o.alternative_text &&
      alternative_text_title == o.alternative_text_title &&
      hidden == o.hidden &&
      x == o.x &&
      y == o.y &&
      z_order_position == o.z_order_position &&
      fill_format == o.fill_format &&
      effect_format == o.effect_format &&
      three_d_format == o.three_d_format &&
      line_format == o.line_format &&
      hyperlink_click == o.hyperlink_click &&
      hyperlink_mouse_over == o.hyperlink_mouse_over &&
      type == o.type &&
      chart_type == o.chart_type &&
      show_data_labels_over_maximum == o.show_data_labels_over_maximum &&
      series == o.series &&
      categories == o.categories &&
      data_source_for_categories == o.data_source_for_categories &&
      title == o.title &&
      back_wall == o.back_wall &&
      side_wall == o.side_wall &&
      floor == o.floor &&
      legend == o.legend &&
      axes == o.axes &&
      plot_area == o.plot_area &&
      has_rounded_corners == o.has_rounded_corners &&
      series_groups == o.series_groups
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


251
252
253
# File 'lib/aspose_slides_cloud/models/chart.rb', line 251

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



257
258
259
# File 'lib/aspose_slides_cloud/models/chart.rb', line 257

def hash
  [self_uri, alternate_links, name, width, height, alternative_text, alternative_text_title, hidden, x, y, z_order_position, fill_format, effect_format, three_d_format, line_format, hyperlink_click, hyperlink_mouse_over, type, chart_type, show_data_labels_over_maximum, series, categories, data_source_for_categories, title, back_wall, side_wall, floor, legend, axes, plot_area, has_rounded_corners, series_groups].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



181
182
183
184
185
186
187
188
# File 'lib/aspose_slides_cloud/models/chart.rb', line 181

def list_invalid_properties
  invalid_properties = super
  if @chart_type.nil?
    invalid_properties.push('invalid value for "chart_type", chart_type cannot be nil.')
  end

  invalid_properties
end

#valid?Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean)

    true if the model is valid



192
193
194
195
196
197
198
# File 'lib/aspose_slides_cloud/models/chart.rb', line 192

def valid?
  return false if !super
  return false if @chart_type.nil?
  chart_type_validator = EnumAttributeValidator.new('String', ['ClusteredColumn', 'StackedColumn', 'PercentsStackedColumn', 'ClusteredColumn3D', 'StackedColumn3D', 'PercentsStackedColumn3D', 'Column3D', 'ClusteredCylinder', 'StackedCylinder', 'PercentsStackedCylinder', 'Cylinder3D', 'ClusteredCone', 'StackedCone', 'PercentsStackedCone', 'Cone3D', 'ClusteredPyramid', 'StackedPyramid', 'PercentsStackedPyramid', 'Pyramid3D', 'Line', 'StackedLine', 'PercentsStackedLine', 'LineWithMarkers', 'StackedLineWithMarkers', 'PercentsStackedLineWithMarkers', 'Line3D', 'Pie', 'Pie3D', 'PieOfPie', 'ExplodedPie', 'ExplodedPie3D', 'BarOfPie', 'PercentsStackedBar', 'ClusteredBar3D', 'ClusteredBar', 'StackedBar', 'StackedBar3D', 'PercentsStackedBar3D', 'ClusteredHorizontalCylinder', 'StackedHorizontalCylinder', 'PercentsStackedHorizontalCylinder', 'ClusteredHorizontalCone', 'StackedHorizontalCone', 'PercentsStackedHorizontalCone', 'ClusteredHorizontalPyramid', 'StackedHorizontalPyramid', 'PercentsStackedHorizontalPyramid', 'Area', 'StackedArea', 'PercentsStackedArea', 'Area3D', 'StackedArea3D', 'PercentsStackedArea3D', 'ScatterWithMarkers', 'ScatterWithSmoothLinesAndMarkers', 'ScatterWithSmoothLines', 'ScatterWithStraightLinesAndMarkers', 'ScatterWithStraightLines', 'HighLowClose', 'OpenHighLowClose', 'VolumeHighLowClose', 'VolumeOpenHighLowClose', 'Surface3D', 'WireframeSurface3D', 'Contour', 'WireframeContour', 'Doughnut', 'ExplodedDoughnut', 'Bubble', 'BubbleWith3D', 'Radar', 'RadarWithMarkers', 'FilledRadar', 'SeriesOfMixedTypes', 'Treemap', 'Sunburst', 'Histogram', 'ParetoLine', 'BoxAndWhisker', 'Waterfall', 'Funnel', 'Map'])
  return false unless chart_type_validator.valid?(@chart_type)
  true
end