Class: GroupDocsViewerCloud::PdfDocumentOptions

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

Overview

Provides options for rendering PDF documents

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PdfDocumentOptions

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

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

  if attributes.key?(:'EnableLayeredRendering')
    self.enable_layered_rendering = attributes[:'EnableLayeredRendering']
  end

  if attributes.key?(:'EnableFontHinting')
    self.enable_font_hinting = attributes[:'EnableFontHinting']
  end

  if attributes.key?(:'RenderOriginalPageSize')
    self.render_original_page_size = attributes[:'RenderOriginalPageSize']
  end

  if attributes.key?(:'ImageQuality')
    self.image_quality = attributes[:'ImageQuality']
  end

  if attributes.key?(:'RenderTextAsImage')
    self.render_text_as_image = attributes[:'RenderTextAsImage']
  end

  if attributes.key?(:'FixedLayout')
    self.fixed_layout = attributes[:'FixedLayout']
  end

  if attributes.key?(:'WrapImagesInSvg')
    self.wrap_images_in_svg = attributes[:'WrapImagesInSvg']
  end

  if attributes.key?(:'DisableFontLicenseVerifications')
    self.disable_font_license_verifications = attributes[:'DisableFontLicenseVerifications']
  end

end

Instance Attribute Details

#disable_chars_grouping ⇒ Object

Disables chars grouping to keep maximum precision during chars positioning when rendering the page



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

def disable_chars_grouping
  @disable_chars_grouping
end

#disable_font_license_verifications ⇒ Object

Disables any license restrictions for all fonts in the current XPS/OXPS document.



59
60
61
 
# File 'lib/groupdocs_viewer_cloud/models/pdf_document_options.rb', line 59

def disable_font_license_verifications
  @disable_font_license_verifications
end

#enable_font_hinting ⇒ Object

Enables font hinting. The font hinting adjusts the display of an outline font. Supported only for TTF fonts when these fonts are used in source document.



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

def enable_font_hinting
  @enable_font_hinting
end

#enable_layered_rendering ⇒ Object

Enables rendering of text and graphics according to z-order in original PDF document when rendering into HTML



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

def enable_layered_rendering
  @enable_layered_rendering
end

#fixed_layout ⇒ Object

Enables rendering the PDF and EPUB documents to HTML with a fixed layout.



53
54
55
 
# File 'lib/groupdocs_viewer_cloud/models/pdf_document_options.rb', line 53

def fixed_layout
  @fixed_layout
end

#image_quality ⇒ Object

Specifies output image quality for image resources when rendering into HTML. The default value is Low



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

def image_quality
  @image_quality
end

#render_original_page_size ⇒ Object

When this option enabled the output pages will have the same size in pixels as page size in a source PDF document. By default GroupDocs.Viewer calculates output image page size for better rendering quality. This option is supported when rendering into PNG or JPG formats.



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

def render_original_page_size
  @render_original_page_size
end

#render_text_as_image ⇒ Object

When this option is set to true, the text is rendered as an image in the output HTML. Enable this option to make text unselectable or to fix characters rendering and make HTML look like PDF. The default value is false. This option is supported when rendering into HTML.



50
51
52
 
# File 'lib/groupdocs_viewer_cloud/models/pdf_document_options.rb', line 50

def render_text_as_image
  @render_text_as_image
end

#wrap_images_in_svg ⇒ Object

Enables wrapping each image in the output HTML document in SVG tag to improve the output quality.



56
57
58
 
# File 'lib/groupdocs_viewer_cloud/models/pdf_document_options.rb', line 56

def wrap_images_in_svg
  @wrap_images_in_svg
end

Class Method Details

.attribute_map ⇒ Object

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



83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/groupdocs_viewer_cloud/models/pdf_document_options.rb', line 83

def self.attribute_map
  {
    :'disable_chars_grouping' => :'DisableCharsGrouping',
    :'enable_layered_rendering' => :'EnableLayeredRendering',
    :'enable_font_hinting' => :'EnableFontHinting',
    :'render_original_page_size' => :'RenderOriginalPageSize',
    :'image_quality' => :'ImageQuality',
    :'render_text_as_image' => :'RenderTextAsImage',
    :'fixed_layout' => :'FixedLayout',
    :'wrap_images_in_svg' => :'WrapImagesInSvg',
    :'disable_font_license_verifications' => :'DisableFontLicenseVerifications'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'disable_chars_grouping' => :'BOOLEAN',
    :'enable_layered_rendering' => :'BOOLEAN',
    :'enable_font_hinting' => :'BOOLEAN',
    :'render_original_page_size' => :'BOOLEAN',
    :'image_quality' => :'String',
    :'render_text_as_image' => :'BOOLEAN',
    :'fixed_layout' => :'BOOLEAN',
    :'wrap_images_in_svg' => :'BOOLEAN',
    :'disable_font_license_verifications' => :'BOOLEAN'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/groupdocs_viewer_cloud/models/pdf_document_options.rb', line 234

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
      disable_chars_grouping == other.disable_chars_grouping &&
      enable_layered_rendering == other.enable_layered_rendering &&
      enable_font_hinting == other.enable_font_hinting &&
      render_original_page_size == other.render_original_page_size &&
      image_quality == other.image_quality &&
      render_text_as_image == other.render_text_as_image &&
      fixed_layout == other.fixed_layout &&
      wrap_images_in_svg == other.wrap_images_in_svg &&
      disable_font_license_verifications == other.disable_font_license_verifications
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



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
328
329
330
 
# File 'lib/groupdocs_viewer_cloud/models/pdf_document_options.rb', line 293

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



360
361
362
363
364
365
366
367
368
369
370
371
372
 
# File 'lib/groupdocs_viewer_cloud/models/pdf_document_options.rb', line 360

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



269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/groupdocs_viewer_cloud/models/pdf_document_options.rb', line 269

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


250
251
252
 
# File 'lib/groupdocs_viewer_cloud/models/pdf_document_options.rb', line 250

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



256
257
258
 
# File 'lib/groupdocs_viewer_cloud/models/pdf_document_options.rb', line 256

def hash
  [disable_chars_grouping, enable_layered_rendering, enable_font_hinting, render_original_page_size, image_quality, render_text_as_image, fixed_layout, wrap_images_in_svg, disable_font_license_verifications].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



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
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/groupdocs_viewer_cloud/models/pdf_document_options.rb', line 160

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

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

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

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

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

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

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

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

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



340
341
342
 
# File 'lib/groupdocs_viewer_cloud/models/pdf_document_options.rb', line 340

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



346
347
348
349
350
351
352
353
354
 
# File 'lib/groupdocs_viewer_cloud/models/pdf_document_options.rb', line 346

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



334
335
336
 
# File 'lib/groupdocs_viewer_cloud/models/pdf_document_options.rb', line 334

def to_s
  to_hash.to_s
end

#uncap(str) ⇒ Object

Downcases first letter.

Returns:

  • downcased string



262
263
264
 
# File 'lib/groupdocs_viewer_cloud/models/pdf_document_options.rb', line 262

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



203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/groupdocs_viewer_cloud/models/pdf_document_options.rb', line 203

def valid?
  return false if @disable_chars_grouping.nil?
  return false if @enable_layered_rendering.nil?
  return false if @enable_font_hinting.nil?
  return false if @render_original_page_size.nil?
  return false if @image_quality.nil?
  image_quality_validator = EnumAttributeValidator.new('String', ["Low", "Medium", "High"])
  return false unless image_quality_validator.valid?(@image_quality)
  return false if @render_text_as_image.nil?
  return false if @fixed_layout.nil?
  return false if @wrap_images_in_svg.nil?
  return false if @disable_font_license_verifications.nil?
  return true
end