Class: GroupDocsViewerCloud::WebDocumentOptions

Inherits:
Object
  • Object
show all
Defined in:
lib/groupdocs_viewer_cloud/models/web_document_options.rb

Overview

This rendering options enables you to customize the appearance of the output HTML/PDF/PNG/JPEG when rendering Web documents.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ WebDocumentOptions

Initializes the object

Parameters:

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

    Model attributes in the form of hash



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/groupdocs_viewer_cloud/models/web_document_options.rb', line 94

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

  if attributes.key?(:'LeftMargin')
    self.left_margin = attributes[:'LeftMargin']
  end

  if attributes.key?(:'RightMargin')
    self.right_margin = attributes[:'RightMargin']
  end

  if attributes.key?(:'TopMargin')
    self.top_margin = attributes[:'TopMargin']
  end

  if attributes.key?(:'BottomMargin')
    self.bottom_margin = attributes[:'BottomMargin']
  end

end

Instance Attribute Details

#bottom_margin ⇒ Object

The distance (in points) between the bottom edge of the page and the bottom boundary of the body text. The default value is 72 points.



47
48
49
 
# File 'lib/groupdocs_viewer_cloud/models/web_document_options.rb', line 47

def bottom_margin
  @bottom_margin
end

#left_margin ⇒ Object

The distance (in points) between the left edge of the page and the left boundary of the body text. The default value is 5 points.



38
39
40
 
# File 'lib/groupdocs_viewer_cloud/models/web_document_options.rb', line 38

def left_margin
  @left_margin
end

#page_size ⇒ Object

The size of the output page. The default value is GroupDocs.Viewer.Options.PageSize.Letter 792 x 612 points. When contents does not fit set a larger page size e.g. GroupDocs.Viewer.Options.PageSize.A3.



35
36
37
 
# File 'lib/groupdocs_viewer_cloud/models/web_document_options.rb', line 35

def page_size
  @page_size
end

#right_margin ⇒ Object

The distance (in points) between the right edge of the page and the right boundary of the body text. The default value is 5 points.



41
42
43
 
# File 'lib/groupdocs_viewer_cloud/models/web_document_options.rb', line 41

def right_margin
  @right_margin
end

#top_margin ⇒ Object

The distance (in points) between the top edge of the page and the top boundary of the body text. The default value is 72 points.



44
45
46
 
# File 'lib/groupdocs_viewer_cloud/models/web_document_options.rb', line 44

def top_margin
  @top_margin
end

Class Method Details

.attribute_map ⇒ Object

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



71
72
73
74
75
76
77
78
79
 
# File 'lib/groupdocs_viewer_cloud/models/web_document_options.rb', line 71

def self.attribute_map
  {
    :'page_size' => :'PageSize',
    :'left_margin' => :'LeftMargin',
    :'right_margin' => :'RightMargin',
    :'top_margin' => :'TopMargin',
    :'bottom_margin' => :'BottomMargin'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



82
83
84
85
86
87
88
89
90
 
# File 'lib/groupdocs_viewer_cloud/models/web_document_options.rb', line 82

def self.swagger_types
  {
    :'page_size' => :'String',
    :'left_margin' => :'Float',
    :'right_margin' => :'Float',
    :'top_margin' => :'Float',
    :'bottom_margin' => :'Float'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



178
179
180
181
182
183
184
185
186
 
# File 'lib/groupdocs_viewer_cloud/models/web_document_options.rb', line 178

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
      page_size == other.page_size &&
      left_margin == other.left_margin &&
      right_margin == other.right_margin &&
      top_margin == other.top_margin &&
      bottom_margin == other.bottom_margin
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



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
 
# File 'lib/groupdocs_viewer_cloud/models/web_document_options.rb', line 233

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 = GroupDocsViewerCloud.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



300
301
302
303
304
305
306
307
308
309
310
311
312
 
# File 'lib/groupdocs_viewer_cloud/models/web_document_options.rb', line 300

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



209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/groupdocs_viewer_cloud/models/web_document_options.rb', line 209

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


190
191
192
 
# File 'lib/groupdocs_viewer_cloud/models/web_document_options.rb', line 190

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



196
197
198
 
# File 'lib/groupdocs_viewer_cloud/models/web_document_options.rb', line 196

def hash
  [page_size, left_margin, right_margin, top_margin, bottom_margin].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



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/groupdocs_viewer_cloud/models/web_document_options.rb', line 124

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

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

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

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

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



280
281
282
 
# File 'lib/groupdocs_viewer_cloud/models/web_document_options.rb', line 280

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



286
287
288
289
290
291
292
293
294
 
# File 'lib/groupdocs_viewer_cloud/models/web_document_options.rb', line 286

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



274
275
276
 
# File 'lib/groupdocs_viewer_cloud/models/web_document_options.rb', line 274

def to_s
  to_hash.to_s
end

#uncap(str) ⇒ Object

Downcases first letter.

Returns:

  • downcased string



202
203
204
 
# File 'lib/groupdocs_viewer_cloud/models/web_document_options.rb', line 202

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



151
152
153
154
155
156
157
158
159
160
 
# File 'lib/groupdocs_viewer_cloud/models/web_document_options.rb', line 151

def valid?
  return false if @page_size.nil?
  page_size_validator = EnumAttributeValidator.new('String', ["Unspecified", "Letter", "Ledger", "A0", "A1", "A2", "A3", "A4"])
  return false unless page_size_validator.valid?(@page_size)
  return false if @left_margin.nil?
  return false if @right_margin.nil?
  return false if @top_margin.nil?
  return false if @bottom_margin.nil?
  return true
end