Class: AsposeSlidesCloud::Legend

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

Overview

Represents a chart legend

Defined Under Namespace

Classes: EnumAttributeValidator

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
 
# File 'lib/aspose_slides_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?(:'X')
    self.x = attributes[:'X']
  end

  if attributes.has_key?(:'Y')
    self.y = attributes[:'Y']
  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?(:'Overlay')
    self.overlay = attributes[:'Overlay']
  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
end

Instance Attribute Details

#effect_format ⇒ Object

Get or sets the effect format.



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

def effect_format
  @effect_format
end

#fill_format ⇒ Object

Get or sets the fill format.



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

def fill_format
  @fill_format
end

#height ⇒ Object

Height



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

def height
  @height
end

#line_format ⇒ Object

Get or sets the line format.



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

def line_format
  @line_format
end

#overlay ⇒ Object

true if other elements are allowed to overlay the legend



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

def overlay
  @overlay
end

#position ⇒ Object

position



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

def position
  @position
end

#width ⇒ Object

Width



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

def width
  @width
end

#x ⇒ Object

the X location



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

def x
  @x
end

#y ⇒ Object

the Y location



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

def y
  @y
end

Class Method Details

.attribute_map ⇒ Object

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



78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/aspose_slides_cloud/models/legend.rb', line 78

def self.attribute_map
  {
    :'position' => :'Position',
    :'x' => :'X',
    :'y' => :'Y',
    :'width' => :'Width',
    :'height' => :'Height',
    :'overlay' => :'Overlay',
    :'fill_format' => :'FillFormat',
    :'effect_format' => :'EffectFormat',
    :'line_format' => :'LineFormat',
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/aspose_slides_cloud/models/legend.rb', line 93

def self.swagger_types
  {
    :'position' => :'String',
    :'x' => :'Float',
    :'y' => :'Float',
    :'width' => :'Float',
    :'height' => :'Float',
    :'overlay' => :'BOOLEAN',
    :'fill_format' => :'FillFormat',
    :'effect_format' => :'EffectFormat',
    :'line_format' => :'LineFormat',
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



179
180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/aspose_slides_cloud/models/legend.rb', line 179

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      position == o.position &&
      x == o.x &&
      y == o.y &&
      width == o.width &&
      height == o.height &&
      overlay == o.overlay &&
      fill_format == o.fill_format &&
      effect_format == o.effect_format &&
      line_format == o.line_format
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



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
270
271
272
273
274
275
276
277
 
# File 'lib/aspose_slides_cloud/models/legend.rb', line 241

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



307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'lib/aspose_slides_cloud/models/legend.rb', line 307

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



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

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


195
196
197
 
# File 'lib/aspose_slides_cloud/models/legend.rb', line 195

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



201
202
203
 
# File 'lib/aspose_slides_cloud/models/legend.rb', line 201

def hash
  [position, x, y, width, height, overlay, fill_format, effect_format, line_format].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



154
155
156
157
 
# File 'lib/aspose_slides_cloud/models/legend.rb', line 154

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



287
288
289
 
# File 'lib/aspose_slides_cloud/models/legend.rb', line 287

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



293
294
295
296
297
298
299
300
301
 
# File 'lib/aspose_slides_cloud/models/legend.rb', line 293

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



281
282
283
 
# File 'lib/aspose_slides_cloud/models/legend.rb', line 281

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



161
162
163
164
165
 
# File 'lib/aspose_slides_cloud/models/legend.rb', line 161

def valid?
  position_validator = EnumAttributeValidator.new('String', ['Bottom', 'Left', 'Right', 'Top', 'TopRight'])
  return false unless position_validator.valid?(@position)
  true
end