Class: AsposeWordsCloud::MetafileRenderingOptionsData

Inherits:
Object
  • Object
show all
Defined in:
lib/aspose_words_cloud/models/metafile_rendering_options_data.rb

Overview

Container class for options of metafile rendering.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ MetafileRenderingOptionsData

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/aspose_words_cloud/models/metafile_rendering_options_data.rb', line 102

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

  if attributes.key?(:'EmulateRasterOperations')
    self.emulate_raster_operations = attributes[:'EmulateRasterOperations']
  end

  if attributes.key?(:'EmulateRenderingToSizeOnPage')
    self.emulate_rendering_to_size_on_page = attributes[:'EmulateRenderingToSizeOnPage']
  end

  if attributes.key?(:'EmulateRenderingToSizeOnPageResolution')
    self.emulate_rendering_to_size_on_page_resolution = attributes[:'EmulateRenderingToSizeOnPageResolution']
  end

  if attributes.key?(:'RenderingMode')
    self.rendering_mode = attributes[:'RenderingMode']
  end

  if attributes.key?(:'UseEmfEmbeddedToWmf')
    self.use_emf_embedded_to_wmf = attributes[:'UseEmfEmbeddedToWmf']
  end
end

Instance Attribute Details

#emf_plus_dual_rendering_mode ⇒ Object

Gets or sets the option that controls how EMF+ Dual metafiles should be rendered.



33
34
35
 
# File 'lib/aspose_words_cloud/models/metafile_rendering_options_data.rb', line 33

def emf_plus_dual_rendering_mode
  @emf_plus_dual_rendering_mode
end

#emulate_raster_operations ⇒ Object

Gets or sets a value indicating whether the raster operations should be emulated. Specific raster operations could be used in metafiles. They can not be rendered directly to vector graphics. Emulating raster operations requires partial rasterization of the resulting vector graphics which may affect the metafile rendering performance. When this value is set to true, Aspose.Words emulates the raster operations. The resulting output maybe partially rasterized and performance might be slower. When this value is set to false, Aspose.Words does not emulate the raster operations. When Aspose.Words encounters a raster operation in a metafile it fallbacks to rendering the metafile into a bitmap by using the operating system. This option is used only when metafile is rendered as vector graphics. The default value is true.



37
38
39
 
# File 'lib/aspose_words_cloud/models/metafile_rendering_options_data.rb', line 37

def emulate_raster_operations
  @emulate_raster_operations
end

#emulate_rendering_to_size_on_page ⇒ Object

Gets or sets a value determining whether metafile rendering emulates the display of the metafile according to the size on page or the display of the metafile in its default size.



41
42
43
 
# File 'lib/aspose_words_cloud/models/metafile_rendering_options_data.rb', line 41

def emulate_rendering_to_size_on_page
  @emulate_rendering_to_size_on_page
end

#emulate_rendering_to_size_on_page_resolution ⇒ Object

Gets or sets the resolution in pixels per inch for the emulation of metafile rendering to the size on page. This option is used only when EmulateRenderingToSizeOnPage is set to true.The default value is 96. This is a default display resolution. I.e. metafile rendering will emulate the display of the metafile in MS Word with a 100% zoom factor.



46
47
48
 
# File 'lib/aspose_words_cloud/models/metafile_rendering_options_data.rb', line 46

def emulate_rendering_to_size_on_page_resolution
  @emulate_rendering_to_size_on_page_resolution
end

#rendering_mode ⇒ Object

Gets or sets the option that controls how metafile images should be rendered.



49
50
51
 
# File 'lib/aspose_words_cloud/models/metafile_rendering_options_data.rb', line 49

def rendering_mode
  @rendering_mode
end

#use_emf_embedded_to_wmf ⇒ Object

Gets or sets the flag, that controls how WMF metafiles with embedded EMF metafiles should be rendered.



52
53
54
 
# File 'lib/aspose_words_cloud/models/metafile_rendering_options_data.rb', line 52

def use_emf_embedded_to_wmf
  @use_emf_embedded_to_wmf
end

Class Method Details

.attribute_map ⇒ Object

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



77
78
79
80
81
82
83
84
85
86
 
# File 'lib/aspose_words_cloud/models/metafile_rendering_options_data.rb', line 77

def self.attribute_map
  {
    :'emf_plus_dual_rendering_mode' => :'EmfPlusDualRenderingMode',
    :'emulate_raster_operations' => :'EmulateRasterOperations',
    :'emulate_rendering_to_size_on_page' => :'EmulateRenderingToSizeOnPage',
    :'emulate_rendering_to_size_on_page_resolution' => :'EmulateRenderingToSizeOnPageResolution',
    :'rendering_mode' => :'RenderingMode',
    :'use_emf_embedded_to_wmf' => :'UseEmfEmbeddedToWmf'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



89
90
91
92
93
94
95
96
97
98
 
# File 'lib/aspose_words_cloud/models/metafile_rendering_options_data.rb', line 89

def self.swagger_types
  {
    :'emf_plus_dual_rendering_mode' => :'String',
    :'emulate_raster_operations' => :'BOOLEAN',
    :'emulate_rendering_to_size_on_page' => :'BOOLEAN',
    :'emulate_rendering_to_size_on_page_resolution' => :'Integer',
    :'rendering_mode' => :'String',
    :'use_emf_embedded_to_wmf' => :'BOOLEAN'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



175
176
177
178
179
180
181
182
183
184
 
# File 'lib/aspose_words_cloud/models/metafile_rendering_options_data.rb', line 175

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
      emf_plus_dual_rendering_mode == other.emf_plus_dual_rendering_mode &&
      emulate_raster_operations == other.emulate_raster_operations &&
      emulate_rendering_to_size_on_page == other.emulate_rendering_to_size_on_page &&
      emulate_rendering_to_size_on_page_resolution == other.emulate_rendering_to_size_on_page_resolution &&
      rendering_mode == other.rendering_mode &&
      use_emf_embedded_to_wmf == other.use_emf_embedded_to_wmf
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



223
224
225
226
227
228
229
230
231
232
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
 
# File 'lib/aspose_words_cloud/models/metafile_rendering_options_data.rb', line 223

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    Time.at(/\d/.match(value)[0].to_f).to_datetime
  when :Date
    Time.at(/\d/.match(value)[0].to_f).to_date
  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
    if value[:'$type']
        type = value[:'$type'][0..-4]
    end

    temp_model = AsposeWordsCloud.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



294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/aspose_words_cloud/models/metafile_rendering_options_data.rb', line 294

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



201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/aspose_words_cloud/models/metafile_rendering_options_data.rb', line 201

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

  self
end

#collectFilesContent(resultFilesContent) ⇒ Object 



308
309
 
# File 'lib/aspose_words_cloud/models/metafile_rendering_options_data.rb', line 308

def collectFilesContent(resultFilesContent)
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


188
189
190
 
# File 'lib/aspose_words_cloud/models/metafile_rendering_options_data.rb', line 188

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



194
195
196
 
# File 'lib/aspose_words_cloud/models/metafile_rendering_options_data.rb', line 194

def hash
  [emf_plus_dual_rendering_mode, emulate_raster_operations, emulate_rendering_to_size_on_page, emulate_rendering_to_size_on_page_resolution, rendering_mode, use_emf_embedded_to_wmf].hash
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



274
275
276
 
# File 'lib/aspose_words_cloud/models/metafile_rendering_options_data.rb', line 274

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



280
281
282
283
284
285
286
287
288
 
# File 'lib/aspose_words_cloud/models/metafile_rendering_options_data.rb', line 280

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



268
269
270
 
# File 'lib/aspose_words_cloud/models/metafile_rendering_options_data.rb', line 268

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



135
136
137
138
139
140
141
142
 
# File 'lib/aspose_words_cloud/models/metafile_rendering_options_data.rb', line 135

def valid?
  emf_plus_dual_rendering_mode_validator = EnumAttributeValidator.new('String', ["EmfPlusWithFallback", "EmfPlus", "Emf"])
  return false unless emf_plus_dual_rendering_mode_validator.valid?(@emf_plus_dual_rendering_mode)
  rendering_mode_validator = EnumAttributeValidator.new('String', ["VectorWithFallback", "Vector", "Bitmap"])
  return false unless rendering_mode_validator.valid?(@rendering_mode)

  return true
end

#validate ⇒ Object 



311
312
 
# File 'lib/aspose_words_cloud/models/metafile_rendering_options_data.rb', line 311

def validate()
end