Class: AsposeCellsCloud::Legend

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Legend

Initializes the object

Parameters:

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

    Model attributes in the form of hash



109
110
111
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
 
# File 'lib/aspose_cells_cloud/models/legend.rb', line 109

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?(:'Position')
      self.position = attributes[:'Position']
  end
  if attributes.has_key?(:'LegendEntries')
      self.legend_entries = attributes[:'LegendEntries']
  end
  if attributes.has_key?(:'Area')
      self.area = attributes[:'Area']
  end
  if attributes.has_key?(:'AutoScaleFont')
      self.auto_scale_font = attributes[:'AutoScaleFont']
  end
  if attributes.has_key?(:'BackgroundMode')
      self.background_mode = attributes[:'BackgroundMode']
  end
  if attributes.has_key?(:'Border')
      self.border = attributes[:'Border']
  end
  if attributes.has_key?(:'Font')
      self.font = attributes[:'Font']
  end
  if attributes.has_key?(:'IsAutomaticSize')
      self.is_automatic_size = attributes[:'IsAutomaticSize']
  end
  if attributes.has_key?(:'IsInnerMode')
      self.is_inner_mode = attributes[:'IsInnerMode']
  end
  if attributes.has_key?(:'Shadow')
      self.shadow = attributes[:'Shadow']
  end
  if attributes.has_key?(:'ShapeProperties')
      self.shape_properties = attributes[:'ShapeProperties']
  end
  if attributes.has_key?(:'Width')
      self.width = attributes[:'Width']
  end
  if attributes.has_key?(:'Height')
      self.height = attributes[:'Height']
  end
  if attributes.has_key?(:'X')
      self.x = attributes[:'X']
  end
  if attributes.has_key?(:'Y')
      self.y = attributes[:'Y']
  end

end

Instance Attribute Details

#area ⇒ Object

Returns the value of attribute area.



39
40
41
 
# File 'lib/aspose_cells_cloud/models/legend.rb', line 39

def area
  @area
end

#auto_scale_font ⇒ Object

Returns the value of attribute auto_scale_font.



41
42
43
 
# File 'lib/aspose_cells_cloud/models/legend.rb', line 41

def auto_scale_font
  @auto_scale_font
end

#background_mode ⇒ Object

Returns the value of attribute background_mode.



43
44
45
 
# File 'lib/aspose_cells_cloud/models/legend.rb', line 43

def background_mode
  @background_mode
end

#border ⇒ Object

Returns the value of attribute border.



45
46
47
 
# File 'lib/aspose_cells_cloud/models/legend.rb', line 45

def border
  @border
end

#font ⇒ Object

Returns the value of attribute font.



47
48
49
 
# File 'lib/aspose_cells_cloud/models/legend.rb', line 47

def font
  @font
end

#height ⇒ Object

Returns the value of attribute height.



59
60
61
 
# File 'lib/aspose_cells_cloud/models/legend.rb', line 59

def height
  @height
end

#is_automatic_size ⇒ Object

Returns the value of attribute is_automatic_size.



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

def is_automatic_size
  @is_automatic_size
end

#is_inner_mode ⇒ Object

Returns the value of attribute is_inner_mode.



51
52
53
 
# File 'lib/aspose_cells_cloud/models/legend.rb', line 51

def is_inner_mode
  @is_inner_mode
end

#legend_entries ⇒ Object

Gets a collection of all the LegendEntry objects in the specified chart legend. Setting the legend entries of the surface chart is not supported. So it will return null if the chart type is surface chart type.



37
38
39
 
# File 'lib/aspose_cells_cloud/models/legend.rb', line 37

def legend_entries
  @legend_entries
end

#position ⇒ Object

Gets or sets the legend position type.



35
36
37
 
# File 'lib/aspose_cells_cloud/models/legend.rb', line 35

def position
  @position
end

#shadow ⇒ Object

Returns the value of attribute shadow.



53
54
55
 
# File 'lib/aspose_cells_cloud/models/legend.rb', line 53

def shadow
  @shadow
end

#shape_properties ⇒ Object

Returns the value of attribute shape_properties.



55
56
57
 
# File 'lib/aspose_cells_cloud/models/legend.rb', line 55

def shape_properties
  @shape_properties
end

#width ⇒ Object

Returns the value of attribute width.



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

def width
  @width
end

#x ⇒ Object

Returns the value of attribute x.



61
62
63
 
# File 'lib/aspose_cells_cloud/models/legend.rb', line 61

def x
  @x
end

#y ⇒ Object

Returns the value of attribute y.



63
64
65
 
# File 'lib/aspose_cells_cloud/models/legend.rb', line 63

def y
  @y
end

Class Method Details

.attribute_map ⇒ Object

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



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/aspose_cells_cloud/models/legend.rb', line 66

def self.attribute_map
  {
    :'position' => :'Position',
    :'legend_entries' => :'LegendEntries',
    :'area' => :'Area',
    :'auto_scale_font' => :'AutoScaleFont',
    :'background_mode' => :'BackgroundMode',
    :'border' => :'Border',
    :'font' => :'Font',
    :'is_automatic_size' => :'IsAutomaticSize',
    :'is_inner_mode' => :'IsInnerMode',
    :'shadow' => :'Shadow',
    :'shape_properties' => :'ShapeProperties',
    :'width' => :'Width',
    :'height' => :'Height',
    :'x' => :'X',
    :'y' => :'Y'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/aspose_cells_cloud/models/legend.rb', line 87

def self.swagger_types
  {
    :'position' => :'String',
    :'legend_entries' => :'LinkElement',
    :'area' => :'Area',
    :'auto_scale_font' => :'BOOLEAN',
    :'background_mode' => :'String',
    :'border' => :'Line',
    :'font' => :'Font',
    :'is_automatic_size' => :'BOOLEAN',
    :'is_inner_mode' => :'BOOLEAN',
    :'shadow' => :'BOOLEAN',
    :'shape_properties' => :'Array<LinkElement>',
    :'width' => :'Integer',
    :'height' => :'Integer',
    :'x' => :'Integer',
    :'y' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/aspose_cells_cloud/models/legend.rb', line 239

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      position == o.position &&
      legend_entries == o.legend_entries &&
      area == o.area &&
      auto_scale_font == o.auto_scale_font &&
      background_mode == o.background_mode &&
      border == o.border &&
      font == o.font &&
      is_automatic_size == o.is_automatic_size &&
      is_inner_mode == o.is_inner_mode &&
      shadow == o.shadow &&
      shape_properties == o.shape_properties &&
      width == o.width &&
      height == o.height &&
      x == o.x &&
      y == o.y 
      std_dev == o.std_dev
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



296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
 
# File 'lib/aspose_cells_cloud/models/legend.rb', line 296

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



362
363
364
365
366
367
368
369
370
371
372
373
374
 
# File 'lib/aspose_cells_cloud/models/legend.rb', line 362

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



275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/aspose_cells_cloud/models/legend.rb', line 275

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


262
263
264
 
# File 'lib/aspose_cells_cloud/models/legend.rb', line 262

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



268
269
270
 
# File 'lib/aspose_cells_cloud/models/legend.rb', line 268

def hash
  [ position , legend_entries , area , auto_scale_font , background_mode , border , font , is_automatic_size , is_inner_mode , shadow , shape_properties , width , height , x , y ].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



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

def list_invalid_properties
  invalid_properties = Array.new
  if @position.nil?
      invalid_properties.push("invalid value for 'position', position cannot be nil.")
  end
  if @legend_entries.nil?
      invalid_properties.push("invalid value for 'legend_entries', legend_entries cannot be nil.")
  end
  if @area.nil?
      invalid_properties.push("invalid value for 'area', area cannot be nil.")
  end
  if @auto_scale_font.nil?
      invalid_properties.push("invalid value for 'auto_scale_font', auto_scale_font cannot be nil.")
  end
  if @background_mode.nil?
      invalid_properties.push("invalid value for 'background_mode', background_mode cannot be nil.")
  end
  if @border.nil?
      invalid_properties.push("invalid value for 'border', border cannot be nil.")
  end
  if @font.nil?
      invalid_properties.push("invalid value for 'font', font cannot be nil.")
  end
  if @is_automatic_size.nil?
      invalid_properties.push("invalid value for 'is_automatic_size', is_automatic_size cannot be nil.")
  end
  if @is_inner_mode.nil?
      invalid_properties.push("invalid value for 'is_inner_mode', is_inner_mode cannot be nil.")
  end
  if @shadow.nil?
      invalid_properties.push("invalid value for 'shadow', shadow cannot be nil.")
  end
  if @shape_properties.nil?
      invalid_properties.push("invalid value for 'shape_properties', shape_properties cannot be nil.")
  end
  if @width.nil?
      invalid_properties.push("invalid value for 'width', width cannot be nil.")
  end
  if @height.nil?
      invalid_properties.push("invalid value for 'height', height cannot be nil.")
  end
  if @x.nil?
      invalid_properties.push("invalid value for 'x', x cannot be nil.")
  end
  if @y.nil?
      invalid_properties.push("invalid value for 'y', y cannot be nil.")
  end

  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



342
343
344
 
# File 'lib/aspose_cells_cloud/models/legend.rb', line 342

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



348
349
350
351
352
353
354
355
356
 
# File 'lib/aspose_cells_cloud/models/legend.rb', line 348

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



336
337
338
 
# File 'lib/aspose_cells_cloud/models/legend.rb', line 336

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



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/aspose_cells_cloud/models/legend.rb', line 218

def valid?
  return false if @position.nil?
  return false if @legend_entries.nil?
  return false if @area.nil?
  return false if @auto_scale_font.nil?
  return false if @background_mode.nil?
  return false if @border.nil?
  return false if @font.nil?
  return false if @is_automatic_size.nil?
  return false if @is_inner_mode.nil?
  return false if @shadow.nil?
  return false if @shape_properties.nil?
  return false if @width.nil?
  return false if @height.nil?
  return false if @x.nil?
  return false if @y.nil?
  return true
end