Class: AsposeSlidesCloud::Chart

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

Overview

Represents chart resource

Defined Under Namespace

Classes: EnumAttributeValidator

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

Constructor Details

#initialize(attributes = {}) ⇒ Chart

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/aspose_slides_cloud/models/chart.rb', line 134

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

#axes ⇒ Object

Gets or sets the axes.



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

def axes
  @axes
end

#back_wall ⇒ Object

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

#categories ⇒ Object

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_type ⇒ Object

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_categories ⇒ Object

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

#floor ⇒ Object

Gets or sets the floor.



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

def floor
  @floor
end

#has_rounded_corners ⇒ Object

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

#legend ⇒ Object

Gets or sets the legend.



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

def legend
  @legend
end

#plot_area ⇒ Object

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

#series ⇒ Object

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_groups ⇒ Object

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_maximum ⇒ Object

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_wall ⇒ Object

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

#title ⇒ Object

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_map ⇒ Object

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



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

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_types ⇒ Object

Attribute type mapping.



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/aspose_slides_cloud/models/chart.rb', line 113

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



234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/aspose_slides_cloud/models/chart.rb', line 234

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

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'lib/aspose_slides_cloud/models/chart.rb', line 319

def _deserialize(type, value)
  if value.nil?
    nil
  else
    case type.to_sym
    when :DateTime
      DateTime.parse(value)
    when :Date
      Date.parse(value)
    when :String
      value.to_s
    when :Integer
      value.to_i
    when :Float
      value.to_f
    when :BOOLEAN
      if value.to_s =~ /\A(true|t|yes|y|1)\z/i
        true
      else
        false
      end
    when :Object
      # generic object (usually a Hash), return directly
      value
    when /\AArray<(?<inner_type>.+)>\z/
      inner_type = Regexp.last_match[:inner_type]
      value.map { |v| _deserialize(inner_type, v) }
    when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
      k_type = Regexp.last_match[:k_type]
      v_type = Regexp.last_match[:v_type]
      {}.tap do |hash|
        value.each do |k, v|
          hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
        end
      end
    else # model
      registry_type = AsposeSlidesCloud::TypeRegistry.get_type(type.to_s, value)
      if registry_type
        type = registry_type
      end
      temp_model = AsposeSlidesCloud.const_get(type).new
      temp_model.build_from_hash(value)
    end
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



393
394
395
396
397
398
399
400
401
402
403
404
405
 
# File 'lib/aspose_slides_cloud/models/chart.rb', line 393

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/aspose_slides_cloud/models/chart.rb', line 286

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    mapKey = self.class.attribute_map[key]
    if !mapKey.nil?
      val = attributes[mapKey]
      if val.nil?
        mapKeyString = mapKey.to_s
        mapKeyString[0] = mapKeyString[0].downcase
        mapKey = mapKeyString.to_sym
        val = attributes[mapKey]
      end
      if !val.nil?
        if type =~ /\AArray<(.*)>/i
          # check to ensure the input is an array given that the the attribute
          # is documented as an array but the input is not
          if val.is_a?(Array)
            self.send("#{key}=", val.map { |v| _deserialize($1, v) })
          end
        else
          self.send("#{key}=", _deserialize(type, val))
        end
      end
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


273
274
275
 
# File 'lib/aspose_slides_cloud/models/chart.rb', line 273

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



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

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_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



203
204
205
206
207
208
209
210
 
# File 'lib/aspose_slides_cloud/models/chart.rb', line 203

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

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



373
374
375
 
# File 'lib/aspose_slides_cloud/models/chart.rb', line 373

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



379
380
381
382
383
384
385
386
387
 
# File 'lib/aspose_slides_cloud/models/chart.rb', line 379

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



367
368
369
 
# File 'lib/aspose_slides_cloud/models/chart.rb', line 367

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



214
215
216
217
218
219
220
 
# File 'lib/aspose_slides_cloud/models/chart.rb', line 214

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