Class: AsposeWordsCloud::SaveAsTiffOnlineRequest

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

Overview

Request model for save_as_tiff_online operation.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(document, save_options, load_encoding = nil, password = nil, use_anti_aliasing = nil, use_high_quality_rendering = nil, image_brightness = nil, image_color_mode = nil, image_contrast = nil, numeral_format = nil, page_count = nil, page_index = nil, paper_color = nil, pixel_format = nil, resolution = nil, scale = nil, tiff_compression = nil, dml_rendering_mode = nil, dml_effects_rendering_mode = nil, tiff_binarization_method = nil, zip_output = nil, fonts_location = nil) ⇒ SaveAsTiffOnlineRequest

Initializes a new instance.

Parameters:

  • document —

    The document.

  • save_options —

    Tiff save options.

  • load_encoding (defaults to: nil) —

    Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.

  • password (defaults to: nil) —

    Password for opening an encrypted document.

  • use_anti_aliasing (defaults to: nil) —

    The flag indicating whether to use antialiasing.

  • use_high_quality_rendering (defaults to: nil) —

    The flag indicating whether to use high quality.

  • image_brightness (defaults to: nil) —

    The level of brightness for the generated images.

  • image_color_mode (defaults to: nil) —

    The color mode for the generated images.

  • image_contrast (defaults to: nil) —

    The contrast for the generated images.

  • numeral_format (defaults to: nil) —

    The images numeral format.

  • page_count (defaults to: nil) —

    The number of pages to render.

  • page_index (defaults to: nil) —

    The index of the page to start rendering.

  • paper_color (defaults to: nil) —

    The background image color.

  • pixel_format (defaults to: nil) —

    The pixel format of the generated images.

  • resolution (defaults to: nil) —

    The resolution of the generated images.

  • scale (defaults to: nil) —

    The zoom factor for the generated images.

  • tiff_compression (defaults to: nil) —

    The compression tipe.

  • dml_rendering_mode (defaults to: nil) —

    The optional dml rendering mode. The default value is Fallback.

  • dml_effects_rendering_mode (defaults to: nil) —

    The optional dml effects rendering mode. The default value is Simplified.

  • tiff_binarization_method (defaults to: nil) —

    The optional TIFF binarization method. Possible values are: FloydSteinbergDithering, Threshold.

  • zip_output (defaults to: nil) —

    The flag indicating whether to ZIP the output.

  • fonts_location (defaults to: nil) —

    Folder in filestorage with custom fonts.



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

def initialize(document, save_options, load_encoding = nil, password = nil, use_anti_aliasing = nil, use_high_quality_rendering = nil, image_brightness = nil, image_color_mode = nil, image_contrast = nil, numeral_format = nil, page_count = nil, page_index = nil, paper_color = nil, pixel_format = nil, resolution = nil, scale = nil, tiff_compression = nil, dml_rendering_mode = nil, dml_effects_rendering_mode = nil, tiff_binarization_method = nil, zip_output = nil, fonts_location = nil)
  self.document = document
  self.save_options = save_options
  self.load_encoding = load_encoding
  self.password = password
  self.use_anti_aliasing = use_anti_aliasing
  self.use_high_quality_rendering = use_high_quality_rendering
  self.image_brightness = image_brightness
  self.image_color_mode = image_color_mode
  self.image_contrast = image_contrast
  self.numeral_format = numeral_format
  self.page_count = page_count
  self.page_index = page_index
  self.paper_color = paper_color
  self.pixel_format = pixel_format
  self.resolution = resolution
  self.scale = scale
  self.tiff_compression = tiff_compression
  self.dml_rendering_mode = dml_rendering_mode
  self.dml_effects_rendering_mode = dml_effects_rendering_mode
  self.tiff_binarization_method = tiff_binarization_method
  self.zip_output = zip_output
  self.fonts_location = fonts_location
end

Instance Attribute Details

#dml_effects_rendering_mode ⇒ Object

The optional dml effects rendering mode. The default value is Simplified.



87
88
89
 
# File 'lib/aspose_words_cloud/models/requests/save_as_tiff_online_request.rb', line 87

def dml_effects_rendering_mode
  @dml_effects_rendering_mode
end

#dml_rendering_mode ⇒ Object

The optional dml rendering mode. The default value is Fallback.



84
85
86
 
# File 'lib/aspose_words_cloud/models/requests/save_as_tiff_online_request.rb', line 84

def dml_rendering_mode
  @dml_rendering_mode
end

#document ⇒ Object

The document.



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

def document
  @document
end

#fonts_location ⇒ Object

Folder in filestorage with custom fonts.



96
97
98
 
# File 'lib/aspose_words_cloud/models/requests/save_as_tiff_online_request.rb', line 96

def fonts_location
  @fonts_location
end

#image_brightness ⇒ Object

The level of brightness for the generated images.



51
52
53
 
# File 'lib/aspose_words_cloud/models/requests/save_as_tiff_online_request.rb', line 51

def image_brightness
  @image_brightness
end

#image_color_mode ⇒ Object

The color mode for the generated images.



54
55
56
 
# File 'lib/aspose_words_cloud/models/requests/save_as_tiff_online_request.rb', line 54

def image_color_mode
  @image_color_mode
end

#image_contrast ⇒ Object

The contrast for the generated images.



57
58
59
 
# File 'lib/aspose_words_cloud/models/requests/save_as_tiff_online_request.rb', line 57

def image_contrast
  @image_contrast
end

#load_encoding ⇒ Object

Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.



39
40
41
 
# File 'lib/aspose_words_cloud/models/requests/save_as_tiff_online_request.rb', line 39

def load_encoding
  @load_encoding
end

#numeral_format ⇒ Object

The images numeral format.



60
61
62
 
# File 'lib/aspose_words_cloud/models/requests/save_as_tiff_online_request.rb', line 60

def numeral_format
  @numeral_format
end

#page_count ⇒ Object

The number of pages to render.



63
64
65
 
# File 'lib/aspose_words_cloud/models/requests/save_as_tiff_online_request.rb', line 63

def page_count
  @page_count
end

#page_index ⇒ Object

The index of the page to start rendering.



66
67
68
 
# File 'lib/aspose_words_cloud/models/requests/save_as_tiff_online_request.rb', line 66

def page_index
  @page_index
end

#paper_color ⇒ Object

The background image color.



69
70
71
 
# File 'lib/aspose_words_cloud/models/requests/save_as_tiff_online_request.rb', line 69

def paper_color
  @paper_color
end

#password ⇒ Object

Password for opening an encrypted document.



42
43
44
 
# File 'lib/aspose_words_cloud/models/requests/save_as_tiff_online_request.rb', line 42

def password
  @password
end

#pixel_format ⇒ Object

The pixel format of the generated images.



72
73
74
 
# File 'lib/aspose_words_cloud/models/requests/save_as_tiff_online_request.rb', line 72

def pixel_format
  @pixel_format
end

#resolution ⇒ Object

The resolution of the generated images.



75
76
77
 
# File 'lib/aspose_words_cloud/models/requests/save_as_tiff_online_request.rb', line 75

def resolution
  @resolution
end

#save_options ⇒ Object

Tiff save options.



36
37
38
 
# File 'lib/aspose_words_cloud/models/requests/save_as_tiff_online_request.rb', line 36

def save_options
  @save_options
end

#scale ⇒ Object

The zoom factor for the generated images.



78
79
80
 
# File 'lib/aspose_words_cloud/models/requests/save_as_tiff_online_request.rb', line 78

def scale
  @scale
end

#tiff_binarization_method ⇒ Object

The optional TIFF binarization method. Possible values are: FloydSteinbergDithering, Threshold.



90
91
92
 
# File 'lib/aspose_words_cloud/models/requests/save_as_tiff_online_request.rb', line 90

def tiff_binarization_method
  @tiff_binarization_method
end

#tiff_compression ⇒ Object

The compression tipe.



81
82
83
 
# File 'lib/aspose_words_cloud/models/requests/save_as_tiff_online_request.rb', line 81

def tiff_compression
  @tiff_compression
end

#use_anti_aliasing ⇒ Object

The flag indicating whether to use antialiasing.



45
46
47
 
# File 'lib/aspose_words_cloud/models/requests/save_as_tiff_online_request.rb', line 45

def use_anti_aliasing
  @use_anti_aliasing
end

#use_high_quality_rendering ⇒ Object

The flag indicating whether to use high quality.



48
49
50
 
# File 'lib/aspose_words_cloud/models/requests/save_as_tiff_online_request.rb', line 48

def use_high_quality_rendering
  @use_high_quality_rendering
end

#zip_output ⇒ Object

The flag indicating whether to ZIP the output.



93
94
95
 
# File 'lib/aspose_words_cloud/models/requests/save_as_tiff_online_request.rb', line 93

def zip_output
  @zip_output
end