Class: AsposeSlidesCloud::PlotArea

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

Overview

Represents the plot area

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PlotArea

Initializes the object

Parameters:

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

    Model attributes in the form of hash



104
105
106
107
108
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
 
# File 'lib/aspose_slides_cloud/models/plot_area.rb', line 104

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?(:'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?(:'LayoutTargetType')
    self.layout_target_type = attributes[:'LayoutTargetType']
  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.



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

def effect_format
  @effect_format
end

#fill_format ⇒ Object

Get or sets the fill format.



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

def fill_format
  @fill_format
end

#height ⇒ Object

Height



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

def height
  @height
end

#layout_target_type ⇒ Object

If layout of the plot area is defined manually specifies whether to layout the plot area by its inside (not including axis and axis labels) or outside.



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

def layout_target_type
  @layout_target_type
end

#line_format ⇒ Object

Get or sets the line format.



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

def line_format
  @line_format
end

#width ⇒ Object

Width



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

def width
  @width
end

#x ⇒ Object

the X location



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

def x
  @x
end

#y ⇒ Object

the Y location



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

def y
  @y
end

Class Method Details

.attribute_map ⇒ Object

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



75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/aspose_slides_cloud/models/plot_area.rb', line 75

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

.swagger_types ⇒ Object

Attribute type mapping.



89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/aspose_slides_cloud/models/plot_area.rb', line 89

def self.swagger_types
  {
    :'x' => :'Float',
    :'y' => :'Float',
    :'width' => :'Float',
    :'height' => :'Float',
    :'layout_target_type' => :'String',
    :'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



170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/aspose_slides_cloud/models/plot_area.rb', line 170

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



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
268
269
270
271
272
273
274
275
 
# File 'lib/aspose_slides_cloud/models/plot_area.rb', line 231

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



305
306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'lib/aspose_slides_cloud/models/plot_area.rb', line 305

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



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

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


185
186
187
 
# File 'lib/aspose_slides_cloud/models/plot_area.rb', line 185

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



191
192
193
 
# File 'lib/aspose_slides_cloud/models/plot_area.rb', line 191

def hash
  [x, y, width, height, layout_target_type, 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



145
146
147
148
 
# File 'lib/aspose_slides_cloud/models/plot_area.rb', line 145

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



285
286
287
 
# File 'lib/aspose_slides_cloud/models/plot_area.rb', line 285

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



291
292
293
294
295
296
297
298
299
 
# File 'lib/aspose_slides_cloud/models/plot_area.rb', line 291

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



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

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



152
153
154
155
156
 
# File 'lib/aspose_slides_cloud/models/plot_area.rb', line 152

def valid?
  layout_target_type_validator = EnumAttributeValidator.new('String', ['Inner', 'Outer'])
  return false unless layout_target_type_validator.valid?(@layout_target_type)
  true
end