Class: AsposeSlidesCloud::PictureFill

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

Overview

Picture fill.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Attributes inherited from FillFormat

#type

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PictureFill

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

def initialize(attributes = {})
  super

  if attributes.has_key?(:'CropBottom')
    self.crop_bottom = attributes[:'CropBottom']
  end

  if attributes.has_key?(:'CropLeft')
    self.crop_left = attributes[:'CropLeft']
  end

  if attributes.has_key?(:'CropRight')
    self.crop_right = attributes[:'CropRight']
  end

  if attributes.has_key?(:'CropTop')
    self.crop_top = attributes[:'CropTop']
  end

  if attributes.has_key?(:'Dpi')
    self.dpi = attributes[:'Dpi']
  end

  if attributes.has_key?(:'Image')
    self.image = attributes[:'Image']
  end

  if attributes.has_key?(:'Base64Data')
    self.base64_data = attributes[:'Base64Data']
  end

  if attributes.has_key?(:'SvgData')
    self.svg_data = attributes[:'SvgData']
  end

  if attributes.has_key?(:'PictureFillMode')
    self.picture_fill_mode = attributes[:'PictureFillMode']
  end

  if attributes.has_key?(:'ImageTransformList')
    if (value = attributes[:'ImageTransformList']).is_a?(Array)
      self.image_transform_list = value
    end
  end
  self.type = 'Picture'
end

Instance Attribute Details

#base64_data ⇒ Object

Base 64 image data.



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

def base64_data
  @base64_data
end

#crop_bottom ⇒ Object

Percentage of image height that is cropped from the bottom.



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

def crop_bottom
  @crop_bottom
end

#crop_left ⇒ Object

Percentage of image height that is cropped from the left.



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

def crop_left
  @crop_left
end

#crop_right ⇒ Object

Percentage of image height that is cropped from the right.



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

def crop_right
  @crop_right
end

#crop_top ⇒ Object

Percentage of image height that is cropped from the top.



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

def crop_top
  @crop_top
end

#dpi ⇒ Object

Picture resolution.



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

def dpi
  @dpi
end

#image ⇒ Object

Internal image link.



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

def image
  @image
end

#image_transform_list ⇒ Object

Image transform effects.



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

def image_transform_list
  @image_transform_list
end

#picture_fill_mode ⇒ Object

Fill mode.



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

def picture_fill_mode
  @picture_fill_mode
end

#svg_data ⇒ Object

SVG image data.



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

def svg_data
  @svg_data
end

Class Method Details

.attribute_map ⇒ Object

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



81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/aspose_slides_cloud/models/picture_fill.rb', line 81

def self.attribute_map
  super.merge({
    :'crop_bottom' => :'CropBottom',
    :'crop_left' => :'CropLeft',
    :'crop_right' => :'CropRight',
    :'crop_top' => :'CropTop',
    :'dpi' => :'Dpi',
    :'image' => :'Image',
    :'base64_data' => :'Base64Data',
    :'svg_data' => :'SvgData',
    :'picture_fill_mode' => :'PictureFillMode',
    :'image_transform_list' => :'ImageTransformList',
  })
end

.swagger_types ⇒ Object

Attribute type mapping.



97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/aspose_slides_cloud/models/picture_fill.rb', line 97

def self.swagger_types
  super.merge({
    :'crop_bottom' => :'Float',
    :'crop_left' => :'Float',
    :'crop_right' => :'Float',
    :'crop_top' => :'Float',
    :'dpi' => :'Integer',
    :'image' => :'ResourceUri',
    :'base64_data' => :'String',
    :'svg_data' => :'String',
    :'picture_fill_mode' => :'String',
    :'image_transform_list' => :'Array<ImageTransformEffect>',
  })
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/aspose_slides_cloud/models/picture_fill.rb', line 219

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      type == o.type &&
      crop_bottom == o.crop_bottom &&
      crop_left == o.crop_left &&
      crop_right == o.crop_right &&
      crop_top == o.crop_top &&
      dpi == o.dpi &&
      image == o.image &&
      base64_data == o.base64_data &&
      svg_data == o.svg_data &&
      picture_fill_mode == o.picture_fill_mode &&
      image_transform_list == o.image_transform_list
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



283
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
315
316
317
318
319
320
321
322
323
324
325
326
327
 
# File 'lib/aspose_slides_cloud/models/picture_fill.rb', line 283

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



357
358
359
360
361
362
363
364
365
366
367
368
369
 
# File 'lib/aspose_slides_cloud/models/picture_fill.rb', line 357

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



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/picture_fill.rb', line 250

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


237
238
239
 
# File 'lib/aspose_slides_cloud/models/picture_fill.rb', line 237

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



243
244
245
 
# File 'lib/aspose_slides_cloud/models/picture_fill.rb', line 243

def hash
  [type, crop_bottom, crop_left, crop_right, crop_top, dpi, image, base64_data, svg_data, picture_fill_mode, image_transform_list].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



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

def list_invalid_properties
  invalid_properties = super
  if @crop_bottom.nil?
    invalid_properties.push('invalid value for "crop_bottom", crop_bottom cannot be nil.')
  end

  if @crop_left.nil?
    invalid_properties.push('invalid value for "crop_left", crop_left cannot be nil.')
  end

  if @crop_right.nil?
    invalid_properties.push('invalid value for "crop_right", crop_right cannot be nil.')
  end

  if @crop_top.nil?
    invalid_properties.push('invalid value for "crop_top", crop_top cannot be nil.')
  end

  if @dpi.nil?
    invalid_properties.push('invalid value for "dpi", dpi cannot be nil.')
  end

  if @picture_fill_mode.nil?
    invalid_properties.push('invalid value for "picture_fill_mode", picture_fill_mode cannot be nil.')
  end

  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



337
338
339
 
# File 'lib/aspose_slides_cloud/models/picture_fill.rb', line 337

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



343
344
345
346
347
348
349
350
351
 
# File 'lib/aspose_slides_cloud/models/picture_fill.rb', line 343

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



331
332
333
 
# File 'lib/aspose_slides_cloud/models/picture_fill.rb', line 331

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



194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/aspose_slides_cloud/models/picture_fill.rb', line 194

def valid?
  return false if !super
  return false if @crop_bottom.nil?
  return false if @crop_left.nil?
  return false if @crop_right.nil?
  return false if @crop_top.nil?
  return false if @dpi.nil?
  return false if @picture_fill_mode.nil?
  picture_fill_mode_validator = EnumAttributeValidator.new('String', ['Tile', 'Stretch'])
  return false unless picture_fill_mode_validator.valid?(@picture_fill_mode)
  true
end