Class: AsposeSlidesCloud::Series

Inherits:
Object
  • Object
show all
Defined in:
lib/aspose_slides_cloud/models/series.rb

Overview

A chart series.

Direct Known Subclasses

BubbleSeries, OneValueSeries, ScatterSeries

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Series

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/aspose_slides_cloud/models/series.rb', line 153

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'Type')
    self.type = attributes[:'Type']
  end

  if attributes.has_key?(:'Name')
    self.name = attributes[:'Name']
  end

  if attributes.has_key?(:'IsColorVaried')
    self.is_color_varied = attributes[:'IsColorVaried']
  end

  if attributes.has_key?(:'InvertedSolidFillColor')
    self.inverted_solid_fill_color = attributes[:'InvertedSolidFillColor']
  end

  if attributes.has_key?(:'Smooth')
    self.smooth = attributes[:'Smooth']
  end

  if attributes.has_key?(:'PlotOnSecondAxis')
    self.plot_on_second_axis = attributes[:'PlotOnSecondAxis']
  end

  if attributes.has_key?(:'Order')
    self.order = attributes[:'Order']
  end

  if attributes.has_key?(:'NumberFormatOfYValues')
    self.number_format_of_y_values = attributes[:'NumberFormatOfYValues']
  end

  if attributes.has_key?(:'NumberFormatOfXValues')
    self.number_format_of_x_values = attributes[:'NumberFormatOfXValues']
  end

  if attributes.has_key?(:'NumberFormatOfValues')
    self.number_format_of_values = attributes[:'NumberFormatOfValues']
  end

  if attributes.has_key?(:'NumberFormatOfBubbleSizes')
    self.number_format_of_bubble_sizes = attributes[:'NumberFormatOfBubbleSizes']
  end

  if attributes.has_key?(:'InvertIfNegative')
    self.invert_if_negative = attributes[:'InvertIfNegative']
  end

  if attributes.has_key?(:'Explosion')
    self.explosion = attributes[:'Explosion']
  end

  if attributes.has_key?(:'Marker')
    self.marker = attributes[:'Marker']
  end

  if attributes.has_key?(:'FillFormat')
    self.fill_format = attributes[:'FillFormat']
  end

  if attributes.has_key?(:'EffectFormat')
    self.effect_format = attributes[:'EffectFormat']
  end

  if attributes.has_key?(:'LineFormat')
    self.line_format = attributes[:'LineFormat']
  end

  if attributes.has_key?(:'DataPointType')
    self.data_point_type = attributes[:'DataPointType']
  end
end

Instance Attribute Details

#data_point_type ⇒ Object

Returns the value of attribute data_point_type.



79
80
81
 
# File 'lib/aspose_slides_cloud/models/series.rb', line 79

def data_point_type
  @data_point_type
end

#effect_format ⇒ Object

Effect properties set for the series.



74
75
76
 
# File 'lib/aspose_slides_cloud/models/series.rb', line 74

def effect_format
  @effect_format
end

#explosion ⇒ Object

The distance of an open pie slice from the center of the pie chart is expressed as a percentage of the pie diameter.



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

def explosion
  @explosion
end

#fill_format ⇒ Object

Fill properties set for the series.



71
72
73
 
# File 'lib/aspose_slides_cloud/models/series.rb', line 71

def fill_format
  @fill_format
end

#invert_if_negative ⇒ Object

True if the series shall invert its colors if the value is negative. Applies to bar, column and bubble series.



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

def invert_if_negative
  @invert_if_negative
end

#inverted_solid_fill_color ⇒ Object

Invert solid color for the series.



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

def inverted_solid_fill_color
  @inverted_solid_fill_color
end

#is_color_varied ⇒ Object

True if each data marker in the series has a different color.



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

def is_color_varied
  @is_color_varied
end

#line_format ⇒ Object

Line properties set for the series.



77
78
79
 
# File 'lib/aspose_slides_cloud/models/series.rb', line 77

def line_format
  @line_format
end

#marker ⇒ Object

Series marker.



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

def marker
  @marker
end

#name ⇒ Object

Series name.



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

def name
  @name
end

#number_format_of_bubble_sizes ⇒ Object

The number format for the series bubble sizes.



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

def number_format_of_bubble_sizes
  @number_format_of_bubble_sizes
end

#number_format_of_values ⇒ Object

The number format for the series values.



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

def number_format_of_values
  @number_format_of_values
end

#number_format_of_x_values ⇒ Object

The number format for the series x values.



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

def number_format_of_x_values
  @number_format_of_x_values
end

#number_format_of_y_values ⇒ Object

The number format for the series y values.



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

def number_format_of_y_values
  @number_format_of_y_values
end

#order ⇒ Object

Series order.



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

def order
  @order
end

#plot_on_second_axis ⇒ Object

True if the series is plotted on second value axis.



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

def plot_on_second_axis
  @plot_on_second_axis
end

#smooth ⇒ Object

True if curve smoothing is turned on. Applies only to line and scatter connected by lines charts.



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

def smooth
  @smooth
end

#type ⇒ Object

Series type.



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

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/aspose_slides_cloud/models/series.rb', line 104

def self.attribute_map
  {
    :'type' => :'Type',
    :'name' => :'Name',
    :'is_color_varied' => :'IsColorVaried',
    :'inverted_solid_fill_color' => :'InvertedSolidFillColor',
    :'smooth' => :'Smooth',
    :'plot_on_second_axis' => :'PlotOnSecondAxis',
    :'order' => :'Order',
    :'number_format_of_y_values' => :'NumberFormatOfYValues',
    :'number_format_of_x_values' => :'NumberFormatOfXValues',
    :'number_format_of_values' => :'NumberFormatOfValues',
    :'number_format_of_bubble_sizes' => :'NumberFormatOfBubbleSizes',
    :'invert_if_negative' => :'InvertIfNegative',
    :'explosion' => :'Explosion',
    :'marker' => :'Marker',
    :'fill_format' => :'FillFormat',
    :'effect_format' => :'EffectFormat',
    :'line_format' => :'LineFormat',
    :'data_point_type' => :'DataPointType',
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/aspose_slides_cloud/models/series.rb', line 128

def self.swagger_types
  {
    :'type' => :'String',
    :'name' => :'String',
    :'is_color_varied' => :'BOOLEAN',
    :'inverted_solid_fill_color' => :'String',
    :'smooth' => :'BOOLEAN',
    :'plot_on_second_axis' => :'BOOLEAN',
    :'order' => :'Integer',
    :'number_format_of_y_values' => :'String',
    :'number_format_of_x_values' => :'String',
    :'number_format_of_values' => :'String',
    :'number_format_of_bubble_sizes' => :'String',
    :'invert_if_negative' => :'BOOLEAN',
    :'explosion' => :'Integer',
    :'marker' => :'SeriesMarker',
    :'fill_format' => :'FillFormat',
    :'effect_format' => :'EffectFormat',
    :'line_format' => :'LineFormat',
    :'data_point_type' => :'String',
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/aspose_slides_cloud/models/series.rb', line 271

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      type == o.type &&
      name == o.name &&
      is_color_varied == o.is_color_varied &&
      inverted_solid_fill_color == o.inverted_solid_fill_color &&
      smooth == o.smooth &&
      plot_on_second_axis == o.plot_on_second_axis &&
      order == o.order &&
      number_format_of_y_values == o.number_format_of_y_values &&
      number_format_of_x_values == o.number_format_of_x_values &&
      number_format_of_values == o.number_format_of_values &&
      number_format_of_bubble_sizes == o.number_format_of_bubble_sizes &&
      invert_if_negative == o.invert_if_negative &&
      explosion == o.explosion &&
      marker == o.marker &&
      fill_format == o.fill_format &&
      effect_format == o.effect_format &&
      line_format == o.line_format &&
      data_point_type == o.data_point_type
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



342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
 
# File 'lib/aspose_slides_cloud/models/series.rb', line 342

def _deserialize(type, value)
  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
    temp_model = AsposeSlidesCloud.const_get(type).new
    temp_model.build_from_hash(value)
  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



408
409
410
411
412
413
414
415
416
417
418
419
420
 
# File 'lib/aspose_slides_cloud/models/series.rb', line 408

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



309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
 
# File 'lib/aspose_slides_cloud/models/series.rb', line 309

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


296
297
298
 
# File 'lib/aspose_slides_cloud/models/series.rb', line 296

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



302
303
304
 
# File 'lib/aspose_slides_cloud/models/series.rb', line 302

def hash
  [type, name, is_color_varied, inverted_solid_fill_color, smooth, plot_on_second_axis, order, number_format_of_y_values, number_format_of_x_values, number_format_of_values, number_format_of_bubble_sizes, invert_if_negative, explosion, marker, fill_format, effect_format, line_format, data_point_type].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



234
235
236
237
 
# File 'lib/aspose_slides_cloud/models/series.rb', line 234

def list_invalid_properties
  invalid_properties = Array.new
  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



388
389
390
 
# File 'lib/aspose_slides_cloud/models/series.rb', line 388

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



394
395
396
397
398
399
400
401
402
 
# File 'lib/aspose_slides_cloud/models/series.rb', line 394

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



382
383
384
 
# File 'lib/aspose_slides_cloud/models/series.rb', line 382

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



241
242
243
244
245
246
247
 
# File 'lib/aspose_slides_cloud/models/series.rb', line 241

def valid?
  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'])
  return false unless type_validator.valid?(@type)
  data_point_type_validator = EnumAttributeValidator.new('String', ['OneValue', 'Scatter', 'Bubble'])
  return false unless data_point_type_validator.valid?(@data_point_type)
  true
end