Class: GroupDocsConversionCloud::WatermarkOptions

Inherits:
Object
  • Object
show all
Defined in:
lib/groupdocs_conversion_cloud/models/watermark_options.rb

Overview

Options for settings watermark to the converted document

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ WatermarkOptions

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/groupdocs_conversion_cloud/models/watermark_options.rb', line 123

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

  if attributes.key?(:'FontName')
    self.font_name = attributes[:'FontName']
  end

  if attributes.key?(:'FontSize')
    self.font_size = attributes[:'FontSize']
  end

  if attributes.key?(:'Bold')
    self.bold = attributes[:'Bold']
  end

  if attributes.key?(:'Italic')
    self.italic = attributes[:'Italic']
  end

  if attributes.key?(:'Color')
    self.color = attributes[:'Color']
  end

  if attributes.key?(:'Width')
    self.width = attributes[:'Width']
  end

  if attributes.key?(:'Height')
    self.height = attributes[:'Height']
  end

  if attributes.key?(:'Top')
    self.top = attributes[:'Top']
  end

  if attributes.key?(:'Left')
    self.left = attributes[:'Left']
  end

  if attributes.key?(:'RotationAngle')
    self.rotation_angle = attributes[:'RotationAngle']
  end

  if attributes.key?(:'Transparency')
    self.transparency = attributes[:'Transparency']
  end

  if attributes.key?(:'Background')
    self.background = attributes[:'Background']
  end

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

  if attributes.key?(:'AutoAlign')
    self.auto_align = attributes[:'AutoAlign']
  end

end

Instance Attribute Details

#auto_align ⇒ Object

Auto scale the watermark. If the value is true the font size and the position is automatically calculated to fit the page size.



77
78
79
 
# File 'lib/groupdocs_conversion_cloud/models/watermark_options.rb', line 77

def auto_align
  @auto_align
end

#background ⇒ Object

Indicates that the watermark is stamped as background. If the value is true, the watermark is layed at the bottom. By default is false and the watermark is layed on top.



71
72
73
 
# File 'lib/groupdocs_conversion_cloud/models/watermark_options.rb', line 71

def background
  @background
end

#bold ⇒ Object

Watermark font bold style if text watermark is applied



44
45
46
 
# File 'lib/groupdocs_conversion_cloud/models/watermark_options.rb', line 44

def bold
  @bold
end

#color ⇒ Object

Watermark font color if text watermark is applied



50
51
52
 
# File 'lib/groupdocs_conversion_cloud/models/watermark_options.rb', line 50

def color
  @color
end

#font_name ⇒ Object

Watermark font name if text watermark is applied



38
39
40
 
# File 'lib/groupdocs_conversion_cloud/models/watermark_options.rb', line 38

def font_name
  @font_name
end

#font_size ⇒ Object

Watermark font name if text watermark is applied



41
42
43
 
# File 'lib/groupdocs_conversion_cloud/models/watermark_options.rb', line 41

def font_size
  @font_size
end

#height ⇒ Object

Watermark height



56
57
58
 
# File 'lib/groupdocs_conversion_cloud/models/watermark_options.rb', line 56

def height
  @height
end

#image ⇒ Object

Image watermark



74
75
76
 
# File 'lib/groupdocs_conversion_cloud/models/watermark_options.rb', line 74

def image
  @image
end

#italic ⇒ Object

Watermark font italic style if text watermark is applied



47
48
49
 
# File 'lib/groupdocs_conversion_cloud/models/watermark_options.rb', line 47

def italic
  @italic
end

#left ⇒ Object

Watermark left position



62
63
64
 
# File 'lib/groupdocs_conversion_cloud/models/watermark_options.rb', line 62

def left
  @left
end

#rotation_angle ⇒ Object

Watermark rotation angle



65
66
67
 
# File 'lib/groupdocs_conversion_cloud/models/watermark_options.rb', line 65

def rotation_angle
  @rotation_angle
end

#text ⇒ Object

Watermark text



35
36
37
 
# File 'lib/groupdocs_conversion_cloud/models/watermark_options.rb', line 35

def text
  @text
end

#top ⇒ Object

Watermark top position



59
60
61
 
# File 'lib/groupdocs_conversion_cloud/models/watermark_options.rb', line 59

def top
  @top
end

#transparency ⇒ Object

Watermark transparency. Value between 0 and 1. Value 0 is fully visible, value 1 is invisible.



68
69
70
 
# File 'lib/groupdocs_conversion_cloud/models/watermark_options.rb', line 68

def transparency
  @transparency
end

#width ⇒ Object

Watermark width



53
54
55
 
# File 'lib/groupdocs_conversion_cloud/models/watermark_options.rb', line 53

def width
  @width
end

Class Method Details

.attribute_map ⇒ Object

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



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/groupdocs_conversion_cloud/models/watermark_options.rb', line 80

def self.attribute_map
  {
    :'text' => :'Text',
    :'font_name' => :'FontName',
    :'font_size' => :'FontSize',
    :'bold' => :'Bold',
    :'italic' => :'Italic',
    :'color' => :'Color',
    :'width' => :'Width',
    :'height' => :'Height',
    :'top' => :'Top',
    :'left' => :'Left',
    :'rotation_angle' => :'RotationAngle',
    :'transparency' => :'Transparency',
    :'background' => :'Background',
    :'image' => :'Image',
    :'auto_align' => :'AutoAlign'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/groupdocs_conversion_cloud/models/watermark_options.rb', line 101

def self.swagger_types
  {
    :'text' => :'String',
    :'font_name' => :'String',
    :'font_size' => :'Integer',
    :'bold' => :'BOOLEAN',
    :'italic' => :'BOOLEAN',
    :'color' => :'String',
    :'width' => :'Integer',
    :'height' => :'Integer',
    :'top' => :'Integer',
    :'left' => :'Integer',
    :'rotation_angle' => :'Integer',
    :'transparency' => :'Float',
    :'background' => :'BOOLEAN',
    :'image' => :'String',
    :'auto_align' => :'BOOLEAN'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/groupdocs_conversion_cloud/models/watermark_options.rb', line 261

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
      text == other.text &&
      font_name == other.font_name &&
      font_size == other.font_size &&
      bold == other.bold &&
      italic == other.italic &&
      color == other.color &&
      width == other.width &&
      height == other.height &&
      top == other.top &&
      left == other.left &&
      rotation_angle == other.rotation_angle &&
      transparency == other.transparency &&
      background == other.background &&
      image == other.image &&
      auto_align == other.auto_align
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



326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'lib/groupdocs_conversion_cloud/models/watermark_options.rb', line 326

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    Date.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 = GroupDocsConversionCloud.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



393
394
395
396
397
398
399
400
401
402
403
404
405
 
# File 'lib/groupdocs_conversion_cloud/models/watermark_options.rb', line 393

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



302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
 
# File 'lib/groupdocs_conversion_cloud/models/watermark_options.rb', line 302

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

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


283
284
285
 
# File 'lib/groupdocs_conversion_cloud/models/watermark_options.rb', line 283

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



289
290
291
 
# File 'lib/groupdocs_conversion_cloud/models/watermark_options.rb', line 289

def hash
  [text, font_name, font_size, bold, italic, color, width, height, top, left, rotation_angle, transparency, background, image, auto_align].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



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
 
# File 'lib/groupdocs_conversion_cloud/models/watermark_options.rb', line 193

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

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

  if @italic.nil?
    invalid_properties.push("invalid value for 'italic', italic 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 @top.nil?
    invalid_properties.push("invalid value for 'top', top cannot be nil.")
  end

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

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

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

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

  if @auto_align.nil?
    invalid_properties.push("invalid value for 'auto_align', auto_align 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



373
374
375
 
# File 'lib/groupdocs_conversion_cloud/models/watermark_options.rb', line 373

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



379
380
381
382
383
384
385
386
387
 
# File 'lib/groupdocs_conversion_cloud/models/watermark_options.rb', line 379

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



367
368
369
 
# File 'lib/groupdocs_conversion_cloud/models/watermark_options.rb', line 367

def to_s
  to_hash.to_s
end

#uncap(str) ⇒ Object

Downcases first letter.

Returns:

  • downcased string



295
296
297
 
# File 'lib/groupdocs_conversion_cloud/models/watermark_options.rb', line 295

def uncap(str)
  str[0, 1].downcase + str[1..-1]
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



244
245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/groupdocs_conversion_cloud/models/watermark_options.rb', line 244

def valid?
  return false if @font_size.nil?
  return false if @bold.nil?
  return false if @italic.nil?
  return false if @width.nil?
  return false if @height.nil?
  return false if @top.nil?
  return false if @left.nil?
  return false if @rotation_angle.nil?
  return false if @transparency.nil?
  return false if @background.nil?
  return false if @auto_align.nil?
  return true
end