Class: GroupDocsViewerCloud::PdfOptimizationOptions

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

Overview

Contains the PDF optimization options to apply to the output PDF file.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PdfOptimizationOptions

Initializes the object

Parameters:

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

    Model attributes in the form of hash



98
99
100
101
102
103
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
142
143
144
 
# File 'lib/groupdocs_viewer_cloud/models/pdf_optimization_options.rb', line 98

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

  if attributes.key?(:'RemoveAnnotations')
    self.remove_annotations = attributes[:'RemoveAnnotations']
  end

  if attributes.key?(:'RemoveFormFields')
    self.remove_form_fields = attributes[:'RemoveFormFields']
  end

  if attributes.key?(:'ConvertToGrayScale')
    self.convert_to_gray_scale = attributes[:'ConvertToGrayScale']
  end

  if attributes.key?(:'SubsetFonts')
    self.subset_fonts = attributes[:'SubsetFonts']
  end

  if attributes.key?(:'CompressImages')
    self.compress_images = attributes[:'CompressImages']
  end

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

  if attributes.key?(:'ResizeImages')
    self.resize_images = attributes[:'ResizeImages']
  end

  if attributes.key?(:'MaxResolution')
    self.max_resolution = attributes[:'MaxResolution']
  end

  if attributes.key?(:'OptimizeSpreadsheets')
    self.optimize_spreadsheets = attributes[:'OptimizeSpreadsheets']
  end

end

Instance Attribute Details

#compress_images ⇒ Object

Enables compressing images in the output PDF file. Use this option to allow other compressing options: PdfOptimizationOptions.ImageQuality and PdfOptimizationOptions.MaxResolution.



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

def compress_images
  @compress_images
end

#convert_to_gray_scale ⇒ Object

Enables converting the output PDF file to a grayscale.



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

def convert_to_gray_scale
  @convert_to_gray_scale
end

#image_quality ⇒ Object

Sets the image quality in the output PDF file (in percent). To change the image quality, first set the PdfOptimizationOptions.CompressImages property to true.



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

def image_quality
  @image_quality
end

#lineriaze ⇒ Object

Enables optimization the output PDF file for viewing online with a web browser. This optimization allows a browser to display the first pages of a PDF file when you open the document, instead of waiting for the entire file to download.



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

def lineriaze
  @lineriaze
end

#max_resolution ⇒ Object

Sets the maximum resolution in the output PDF file. To allow this option, set the GroupDocs.Viewer.Options.PdfOptimizationOptions.CompressImages and GroupDocs.Viewer.Options.PdfOptimizationOptions.MaxResolution properties to true. The default value is 300.



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

def max_resolution
  @max_resolution
end

#optimize_spreadsheets ⇒ Object

Enables optimization of spreadsheets in the PDF files. This optimization allows to reduce the output file size by setting up border lines. Besides that, it removes the Arial and Times New Roman characters of 32-127 codes.



62
63
64
 
# File 'lib/groupdocs_viewer_cloud/models/pdf_optimization_options.rb', line 62

def optimize_spreadsheets
  @optimize_spreadsheets
end

#remove_annotations ⇒ Object

Enables removing annotation from the output PDF file.



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

def remove_annotations
  @remove_annotations
end

#remove_form_fields ⇒ Object

Enables removing form fields from a PDF file.



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

def remove_form_fields
  @remove_form_fields
end

#resize_images ⇒ Object

Enables setting the maximum resolution in the output PDF file. To allow this option, set the GroupDocs.Viewer.Options.PdfOptimizationOptions.CompressImages property to true. This option allows setting the GroupDocs.Viewer.Options.PdfOptimizationOptions.MaxResolution property.



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

def resize_images
  @resize_images
end

#subset_fonts ⇒ Object

Subsets fonts in the output PDF file. If the file uses embedded fonts, it contains all font data. GroupDocs.Viewer can subset embedded fonts to reduce the file size.



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

def subset_fonts
  @subset_fonts
end

Class Method Details

.attribute_map ⇒ Object

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



65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/groupdocs_viewer_cloud/models/pdf_optimization_options.rb', line 65

def self.attribute_map
  {
    :'lineriaze' => :'Lineriaze',
    :'remove_annotations' => :'RemoveAnnotations',
    :'remove_form_fields' => :'RemoveFormFields',
    :'convert_to_gray_scale' => :'ConvertToGrayScale',
    :'subset_fonts' => :'SubsetFonts',
    :'compress_images' => :'CompressImages',
    :'image_quality' => :'ImageQuality',
    :'resize_images' => :'ResizeImages',
    :'max_resolution' => :'MaxResolution',
    :'optimize_spreadsheets' => :'OptimizeSpreadsheets'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'lineriaze' => :'BOOLEAN',
    :'remove_annotations' => :'BOOLEAN',
    :'remove_form_fields' => :'BOOLEAN',
    :'convert_to_gray_scale' => :'BOOLEAN',
    :'subset_fonts' => :'BOOLEAN',
    :'compress_images' => :'BOOLEAN',
    :'image_quality' => :'Integer',
    :'resize_images' => :'BOOLEAN',
    :'max_resolution' => :'Integer',
    :'optimize_spreadsheets' => :'BOOLEAN'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



211
212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/groupdocs_viewer_cloud/models/pdf_optimization_options.rb', line 211

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
      lineriaze == other.lineriaze &&
      remove_annotations == other.remove_annotations &&
      remove_form_fields == other.remove_form_fields &&
      convert_to_gray_scale == other.convert_to_gray_scale &&
      subset_fonts == other.subset_fonts &&
      compress_images == other.compress_images &&
      image_quality == other.image_quality &&
      resize_images == other.resize_images &&
      max_resolution == other.max_resolution &&
      optimize_spreadsheets == other.optimize_spreadsheets
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



271
272
273
274
275
276
277
278
279
280
281
282
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
 
# File 'lib/groupdocs_viewer_cloud/models/pdf_optimization_options.rb', line 271

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



338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'lib/groupdocs_viewer_cloud/models/pdf_optimization_options.rb', line 338

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



247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/groupdocs_viewer_cloud/models/pdf_optimization_options.rb', line 247

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


228
229
230
 
# File 'lib/groupdocs_viewer_cloud/models/pdf_optimization_options.rb', line 228

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



234
235
236
 
# File 'lib/groupdocs_viewer_cloud/models/pdf_optimization_options.rb', line 234

def hash
  [lineriaze, remove_annotations, remove_form_fields, convert_to_gray_scale, subset_fonts, compress_images, image_quality, resize_images, max_resolution, optimize_spreadsheets].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



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
190
191
 
# File 'lib/groupdocs_viewer_cloud/models/pdf_optimization_options.rb', line 148

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

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

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

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

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

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

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

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

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

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



318
319
320
 
# File 'lib/groupdocs_viewer_cloud/models/pdf_optimization_options.rb', line 318

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



324
325
326
327
328
329
330
331
332
 
# File 'lib/groupdocs_viewer_cloud/models/pdf_optimization_options.rb', line 324

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



312
313
314
 
# File 'lib/groupdocs_viewer_cloud/models/pdf_optimization_options.rb', line 312

def to_s
  to_hash.to_s
end

#uncap(str) ⇒ Object

Downcases first letter.

Returns:

  • downcased string



240
241
242
 
# File 'lib/groupdocs_viewer_cloud/models/pdf_optimization_options.rb', line 240

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



195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/groupdocs_viewer_cloud/models/pdf_optimization_options.rb', line 195

def valid?
  return false if @lineriaze.nil?
  return false if @remove_annotations.nil?
  return false if @remove_form_fields.nil?
  return false if @convert_to_gray_scale.nil?
  return false if @subset_fonts.nil?
  return false if @compress_images.nil?
  return false if @image_quality.nil?
  return false if @resize_images.nil?
  return false if @max_resolution.nil?
  return false if @optimize_spreadsheets.nil?
  return true
end