Class: AsposeCellsCloud::SparklineGroup

Inherits:
Object
  • Object
show all
Defined in:
lib/aspose_cells_cloud/models/sparkline_group.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SparklineGroup

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
231
232
233
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
 
# File 'lib/aspose_cells_cloud/models/sparkline_group.rb', line 151

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?(:'DisplayHidden')
    self.display_hidden = attributes[:'DisplayHidden']
  end

  if attributes.has_key?(:'FirstPointColor')
    self.first_point_color = attributes[:'FirstPointColor']
  end

  if attributes.has_key?(:'HighPointColor')
    self.high_point_color = attributes[:'HighPointColor']
  end

  if attributes.has_key?(:'HorizontalAxisColor')
    self.horizontal_axis_color = attributes[:'HorizontalAxisColor']
  end

  if attributes.has_key?(:'HorizontalAxisDateRange')
    self.horizontal_axis_date_range = attributes[:'HorizontalAxisDateRange']
  end

  if attributes.has_key?(:'LastPointColor')
    self.last_point_color = attributes[:'LastPointColor']
  end

  if attributes.has_key?(:'LineWeight')
    self.line_weight = attributes[:'LineWeight']
  end

  if attributes.has_key?(:'LowPointColor')
    self.low_point_color = attributes[:'LowPointColor']
  end

  if attributes.has_key?(:'MarkersColor')
    self.markers_color = attributes[:'MarkersColor']
  end

  if attributes.has_key?(:'NegativePointsColor')
    self.negative_points_color = attributes[:'NegativePointsColor']
  end

  if attributes.has_key?(:'PlotEmptyCellsType')
    self.plot_empty_cells_type = attributes[:'PlotEmptyCellsType']
  end

  if attributes.has_key?(:'PlotRightToLeft')
    self.plot_right_to_left = attributes[:'PlotRightToLeft']
  end

  if attributes.has_key?(:'PresetStyle')
    self.preset_style = attributes[:'PresetStyle']
  end

  if attributes.has_key?(:'SeriesColor')
    self.series_color = attributes[:'SeriesColor']
  end

  if attributes.has_key?(:'ShowFirstPoint')
    self.show_first_point = attributes[:'ShowFirstPoint']
  end

  if attributes.has_key?(:'ShowHighPoint')
    self.show_high_point = attributes[:'ShowHighPoint']
  end

  if attributes.has_key?(:'ShowHorizontalAxis')
    self.show_horizontal_axis = attributes[:'ShowHorizontalAxis']
  end

  if attributes.has_key?(:'ShowLastPoint')
    self.show_last_point = attributes[:'ShowLastPoint']
  end

  if attributes.has_key?(:'ShowLowPoint')
    self.show_low_point = attributes[:'ShowLowPoint']
  end

  if attributes.has_key?(:'ShowMarkers')
    self.show_markers = attributes[:'ShowMarkers']
  end

  if attributes.has_key?(:'ShowNegativePoints')
    self.show_negative_points = attributes[:'ShowNegativePoints']
  end

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

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

  if attributes.has_key?(:'VerticalAxisMaxValue')
    self.vertical_axis_max_value = attributes[:'VerticalAxisMaxValue']
  end

  if attributes.has_key?(:'VerticalAxisMaxValueType')
    self.vertical_axis_max_value_type = attributes[:'VerticalAxisMaxValueType']
  end

  if attributes.has_key?(:'VerticalAxisMinValue')
    self.vertical_axis_min_value = attributes[:'VerticalAxisMinValue']
  end

  if attributes.has_key?(:'VerticalAxisMinValueType')
    self.vertical_axis_min_value_type = attributes[:'VerticalAxisMinValueType']
  end

end

Instance Attribute Details

#display_hidden ⇒ Object

Returns the value of attribute display_hidden.



28
29
30
 
# File 'lib/aspose_cells_cloud/models/sparkline_group.rb', line 28

def display_hidden
  @display_hidden
end

#first_point_color ⇒ Object

Returns the value of attribute first_point_color.



30
31
32
 
# File 'lib/aspose_cells_cloud/models/sparkline_group.rb', line 30

def first_point_color
  @first_point_color
end

#high_point_color ⇒ Object

Returns the value of attribute high_point_color.



32
33
34
 
# File 'lib/aspose_cells_cloud/models/sparkline_group.rb', line 32

def high_point_color
  @high_point_color
end

#horizontal_axis_color ⇒ Object

Returns the value of attribute horizontal_axis_color.



34
35
36
 
# File 'lib/aspose_cells_cloud/models/sparkline_group.rb', line 34

def horizontal_axis_color
  @horizontal_axis_color
end

#horizontal_axis_date_range ⇒ Object

Returns the value of attribute horizontal_axis_date_range.



36
37
38
 
# File 'lib/aspose_cells_cloud/models/sparkline_group.rb', line 36

def horizontal_axis_date_range
  @horizontal_axis_date_range
end

#last_point_color ⇒ Object

Returns the value of attribute last_point_color.



38
39
40
 
# File 'lib/aspose_cells_cloud/models/sparkline_group.rb', line 38

def last_point_color
  @last_point_color
end

#line_weight ⇒ Object

Returns the value of attribute line_weight.



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

def line_weight
  @line_weight
end

#low_point_color ⇒ Object

Returns the value of attribute low_point_color.



42
43
44
 
# File 'lib/aspose_cells_cloud/models/sparkline_group.rb', line 42

def low_point_color
  @low_point_color
end

#markers_color ⇒ Object

Returns the value of attribute markers_color.



44
45
46
 
# File 'lib/aspose_cells_cloud/models/sparkline_group.rb', line 44

def markers_color
  @markers_color
end

#negative_points_color ⇒ Object

Returns the value of attribute negative_points_color.



46
47
48
 
# File 'lib/aspose_cells_cloud/models/sparkline_group.rb', line 46

def negative_points_color
  @negative_points_color
end

#plot_empty_cells_type ⇒ Object

Returns the value of attribute plot_empty_cells_type.



48
49
50
 
# File 'lib/aspose_cells_cloud/models/sparkline_group.rb', line 48

def plot_empty_cells_type
  @plot_empty_cells_type
end

#plot_right_to_left ⇒ Object

Returns the value of attribute plot_right_to_left.



50
51
52
 
# File 'lib/aspose_cells_cloud/models/sparkline_group.rb', line 50

def plot_right_to_left
  @plot_right_to_left
end

#preset_style ⇒ Object

Returns the value of attribute preset_style.



52
53
54
 
# File 'lib/aspose_cells_cloud/models/sparkline_group.rb', line 52

def preset_style
  @preset_style
end

#series_color ⇒ Object

Returns the value of attribute series_color.



54
55
56
 
# File 'lib/aspose_cells_cloud/models/sparkline_group.rb', line 54

def series_color
  @series_color
end

#show_first_point ⇒ Object

Returns the value of attribute show_first_point.



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

def show_first_point
  @show_first_point
end

#show_high_point ⇒ Object

Returns the value of attribute show_high_point.



58
59
60
 
# File 'lib/aspose_cells_cloud/models/sparkline_group.rb', line 58

def show_high_point
  @show_high_point
end

#show_horizontal_axis ⇒ Object

Returns the value of attribute show_horizontal_axis.



60
61
62
 
# File 'lib/aspose_cells_cloud/models/sparkline_group.rb', line 60

def show_horizontal_axis
  @show_horizontal_axis
end

#show_last_point ⇒ Object

Returns the value of attribute show_last_point.



62
63
64
 
# File 'lib/aspose_cells_cloud/models/sparkline_group.rb', line 62

def show_last_point
  @show_last_point
end

#show_low_point ⇒ Object

Returns the value of attribute show_low_point.



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

def show_low_point
  @show_low_point
end

#show_markers ⇒ Object

Returns the value of attribute show_markers.



66
67
68
 
# File 'lib/aspose_cells_cloud/models/sparkline_group.rb', line 66

def show_markers
  @show_markers
end

#show_negative_points ⇒ Object

Returns the value of attribute show_negative_points.



68
69
70
 
# File 'lib/aspose_cells_cloud/models/sparkline_group.rb', line 68

def show_negative_points
  @show_negative_points
end

#sparkline_collection ⇒ Object

Returns the value of attribute sparkline_collection.



70
71
72
 
# File 'lib/aspose_cells_cloud/models/sparkline_group.rb', line 70

def sparkline_collection
  @sparkline_collection
end

#type ⇒ Object

Returns the value of attribute type.



72
73
74
 
# File 'lib/aspose_cells_cloud/models/sparkline_group.rb', line 72

def type
  @type
end

#vertical_axis_max_value ⇒ Object

Returns the value of attribute vertical_axis_max_value.



74
75
76
 
# File 'lib/aspose_cells_cloud/models/sparkline_group.rb', line 74

def vertical_axis_max_value
  @vertical_axis_max_value
end

#vertical_axis_max_value_type ⇒ Object

Returns the value of attribute vertical_axis_max_value_type.



76
77
78
 
# File 'lib/aspose_cells_cloud/models/sparkline_group.rb', line 76

def vertical_axis_max_value_type
  @vertical_axis_max_value_type
end

#vertical_axis_min_value ⇒ Object

Returns the value of attribute vertical_axis_min_value.



78
79
80
 
# File 'lib/aspose_cells_cloud/models/sparkline_group.rb', line 78

def vertical_axis_min_value
  @vertical_axis_min_value
end

#vertical_axis_min_value_type ⇒ Object

Returns the value of attribute vertical_axis_min_value_type.



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

def vertical_axis_min_value_type
  @vertical_axis_min_value_type
end

Class Method Details

.attribute_map ⇒ Object

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



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/aspose_cells_cloud/models/sparkline_group.rb', line 84

def self.attribute_map
  {
    :'display_hidden' => :'DisplayHidden',
    :'first_point_color' => :'FirstPointColor',
    :'high_point_color' => :'HighPointColor',
    :'horizontal_axis_color' => :'HorizontalAxisColor',
    :'horizontal_axis_date_range' => :'HorizontalAxisDateRange',
    :'last_point_color' => :'LastPointColor',
    :'line_weight' => :'LineWeight',
    :'low_point_color' => :'LowPointColor',
    :'markers_color' => :'MarkersColor',
    :'negative_points_color' => :'NegativePointsColor',
    :'plot_empty_cells_type' => :'PlotEmptyCellsType',
    :'plot_right_to_left' => :'PlotRightToLeft',
    :'preset_style' => :'PresetStyle',
    :'series_color' => :'SeriesColor',
    :'show_first_point' => :'ShowFirstPoint',
    :'show_high_point' => :'ShowHighPoint',
    :'show_horizontal_axis' => :'ShowHorizontalAxis',
    :'show_last_point' => :'ShowLastPoint',
    :'show_low_point' => :'ShowLowPoint',
    :'show_markers' => :'ShowMarkers',
    :'show_negative_points' => :'ShowNegativePoints',
    :'sparkline_collection' => :'SparklineCollection',
    :'type' => :'Type',
    :'vertical_axis_max_value' => :'VerticalAxisMaxValue',
    :'vertical_axis_max_value_type' => :'VerticalAxisMaxValueType',
    :'vertical_axis_min_value' => :'VerticalAxisMinValue',
    :'vertical_axis_min_value_type' => :'VerticalAxisMinValueType'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/aspose_cells_cloud/models/sparkline_group.rb', line 117

def self.swagger_types
  {
    :'display_hidden' => :'BOOLEAN',
    :'first_point_color' => :'CellsColor',
    :'high_point_color' => :'CellsColor',
    :'horizontal_axis_color' => :'CellsColor',
    :'horizontal_axis_date_range' => :'String',
    :'last_point_color' => :'CellsColor',
    :'line_weight' => :'Float',
    :'low_point_color' => :'CellsColor',
    :'markers_color' => :'CellsColor',
    :'negative_points_color' => :'CellsColor',
    :'plot_empty_cells_type' => :'String',
    :'plot_right_to_left' => :'BOOLEAN',
    :'preset_style' => :'String',
    :'series_color' => :'CellsColor',
    :'show_first_point' => :'BOOLEAN',
    :'show_high_point' => :'BOOLEAN',
    :'show_horizontal_axis' => :'BOOLEAN',
    :'show_last_point' => :'BOOLEAN',
    :'show_low_point' => :'BOOLEAN',
    :'show_markers' => :'BOOLEAN',
    :'show_negative_points' => :'BOOLEAN',
    :'sparkline_collection' => :'Array<Sparkline>',
    :'type' => :'String',
    :'vertical_axis_max_value' => :'Float',
    :'vertical_axis_max_value_type' => :'String',
    :'vertical_axis_min_value' => :'Float',
    :'vertical_axis_min_value_type' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



284
285
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
314
 
# File 'lib/aspose_cells_cloud/models/sparkline_group.rb', line 284

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      display_hidden == o.display_hidden &&
      first_point_color == o.first_point_color &&
      high_point_color == o.high_point_color &&
      horizontal_axis_color == o.horizontal_axis_color &&
      horizontal_axis_date_range == o.horizontal_axis_date_range &&
      last_point_color == o.last_point_color &&
      line_weight == o.line_weight &&
      low_point_color == o.low_point_color &&
      markers_color == o.markers_color &&
      negative_points_color == o.negative_points_color &&
      plot_empty_cells_type == o.plot_empty_cells_type &&
      plot_right_to_left == o.plot_right_to_left &&
      preset_style == o.preset_style &&
      series_color == o.series_color &&
      show_first_point == o.show_first_point &&
      show_high_point == o.show_high_point &&
      show_horizontal_axis == o.show_horizontal_axis &&
      show_last_point == o.show_last_point &&
      show_low_point == o.show_low_point &&
      show_markers == o.show_markers &&
      show_negative_points == o.show_negative_points &&
      sparkline_collection == o.sparkline_collection &&
      type == o.type &&
      vertical_axis_max_value == o.vertical_axis_max_value &&
      vertical_axis_max_value_type == o.vertical_axis_max_value_type &&
      vertical_axis_min_value == o.vertical_axis_min_value &&
      vertical_axis_min_value_type == o.vertical_axis_min_value_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



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
379
380
381
382
383
384
385
386
387
388
 
# File 'lib/aspose_cells_cloud/models/sparkline_group.rb', line 352

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 = AsposeCellsCloud.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



418
419
420
421
422
423
424
425
426
427
428
429
430
 
# File 'lib/aspose_cells_cloud/models/sparkline_group.rb', line 418

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



331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
 
# File 'lib/aspose_cells_cloud/models/sparkline_group.rb', line 331

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    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 attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


318
319
320
 
# File 'lib/aspose_cells_cloud/models/sparkline_group.rb', line 318

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



324
325
326
 
# File 'lib/aspose_cells_cloud/models/sparkline_group.rb', line 324

def hash
  [display_hidden, first_point_color, high_point_color, horizontal_axis_color, horizontal_axis_date_range, last_point_color, line_weight, low_point_color, markers_color, negative_points_color, plot_empty_cells_type, plot_right_to_left, preset_style, series_color, show_first_point, show_high_point, show_horizontal_axis, show_last_point, show_low_point, show_markers, show_negative_points, sparkline_collection, type, vertical_axis_max_value, vertical_axis_max_value_type, vertical_axis_min_value, vertical_axis_min_value_type].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properies with the reasons



271
272
273
274
 
# File 'lib/aspose_cells_cloud/models/sparkline_group.rb', line 271

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



398
399
400
 
# File 'lib/aspose_cells_cloud/models/sparkline_group.rb', line 398

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



404
405
406
407
408
409
410
411
412
 
# File 'lib/aspose_cells_cloud/models/sparkline_group.rb', line 404

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



392
393
394
 
# File 'lib/aspose_cells_cloud/models/sparkline_group.rb', line 392

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



278
279
280
 
# File 'lib/aspose_cells_cloud/models/sparkline_group.rb', line 278

def valid?
  return true
end