Class: AsposeWordsCloud::SaveAsTiffRequest

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

Overview

Request model for save_as_tiff operation.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, save_options, folder = nil, storage = nil, 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) ⇒ SaveAsTiffRequest

Initializes a new instance.

Parameters:

  • name —

    The document name.

  • save_options —

    Tiff save options.

  • folder (defaults to: nil) —

    Original document folder.

  • storage (defaults to: nil) —

    Original document storage.

  • 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) —

    Use antialiasing flag.

  • use_high_quality_rendering (defaults to: nil) —

    Use high quality flag.

  • image_brightness (defaults to: nil) —

    Brightness for the generated images.

  • image_color_mode (defaults to: nil) —

    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) —

    Number of pages to render.

  • page_index (defaults to: nil) —

    Page index to start rendering.

  • paper_color (defaults to: nil) —

    Background image color.

  • pixel_format (defaults to: nil) —

    The pixel format of generated images.

  • resolution (defaults to: nil) —

    The resolution of generated images.

  • scale (defaults to: nil) —

    Zoom factor for generated images.

  • tiff_compression (defaults to: nil) —

    The compression tipe.

  • dml_rendering_mode (defaults to: nil) —

    Optional, default is Fallback.

  • dml_effects_rendering_mode (defaults to: nil) —

    Optional, default is Simplified.

  • tiff_binarization_method (defaults to: nil) —

    Optional, Tiff binarization method, possible values are: FloydSteinbergDithering, Threshold.

  • zip_output (defaults to: nil) —

    Optional. A value determining zip output or not.

  • fonts_location (defaults to: nil) —

    Folder in filestorage with custom fonts.



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
 
# File 'lib/aspose_words_cloud/models/requests/SaveAsTiffRequest.rb', line 110

def initialize(name, save_options, folder = nil, storage = nil, 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.name = name
   self.save_options = save_options
   self.folder = folder
   self.storage = storage
   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

Optional, default is Simplified.



76
77
78
 
# File 'lib/aspose_words_cloud/models/requests/SaveAsTiffRequest.rb', line 76

def dml_effects_rendering_mode
  @dml_effects_rendering_mode
end

#dml_rendering_mode ⇒ Object

Optional, default is Fallback.



74
75
76
 
# File 'lib/aspose_words_cloud/models/requests/SaveAsTiffRequest.rb', line 74

def dml_rendering_mode
  @dml_rendering_mode
end

#folder ⇒ Object

Original document folder.



40
41
42
 
# File 'lib/aspose_words_cloud/models/requests/SaveAsTiffRequest.rb', line 40

def folder
  @folder
end

#fonts_location ⇒ Object

Folder in filestorage with custom fonts.



82
83
84
 
# File 'lib/aspose_words_cloud/models/requests/SaveAsTiffRequest.rb', line 82

def fonts_location
  @fonts_location
end

#image_brightness ⇒ Object

Brightness for the generated images.



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

def image_brightness
  @image_brightness
end

#image_color_mode ⇒ Object

Color mode for the generated images.



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

def image_color_mode
  @image_color_mode
end

#image_contrast ⇒ Object

The contrast for the generated images.



56
57
58
 
# File 'lib/aspose_words_cloud/models/requests/SaveAsTiffRequest.rb', line 56

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.



44
45
46
 
# File 'lib/aspose_words_cloud/models/requests/SaveAsTiffRequest.rb', line 44

def load_encoding
  @load_encoding
end

#name ⇒ Object

The document name.



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

def name
  @name
end

#numeral_format ⇒ Object

The images numeral format.



58
59
60
 
# File 'lib/aspose_words_cloud/models/requests/SaveAsTiffRequest.rb', line 58

def numeral_format
  @numeral_format
end

#page_count ⇒ Object

Number of pages to render.



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

def page_count
  @page_count
end

#page_index ⇒ Object

Page index to start rendering.



62
63
64
 
# File 'lib/aspose_words_cloud/models/requests/SaveAsTiffRequest.rb', line 62

def page_index
  @page_index
end

#paper_color ⇒ Object

Background image color.



64
65
66
 
# File 'lib/aspose_words_cloud/models/requests/SaveAsTiffRequest.rb', line 64

def paper_color
  @paper_color
end

#password ⇒ Object

Password for opening an encrypted document.



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

def password
  @password
end

#pixel_format ⇒ Object

The pixel format of generated images.



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

def pixel_format
  @pixel_format
end

#resolution ⇒ Object

The resolution of generated images.



68
69
70
 
# File 'lib/aspose_words_cloud/models/requests/SaveAsTiffRequest.rb', line 68

def resolution
  @resolution
end

#save_options ⇒ Object

Tiff save options.



38
39
40
 
# File 'lib/aspose_words_cloud/models/requests/SaveAsTiffRequest.rb', line 38

def save_options
  @save_options
end

#scale ⇒ Object

Zoom factor for generated images.



70
71
72
 
# File 'lib/aspose_words_cloud/models/requests/SaveAsTiffRequest.rb', line 70

def scale
  @scale
end

#storage ⇒ Object

Original document storage.



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

def storage
  @storage
end

#tiff_binarization_method ⇒ Object

Optional, Tiff binarization method, possible values are: FloydSteinbergDithering, Threshold.



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

def tiff_binarization_method
  @tiff_binarization_method
end

#tiff_compression ⇒ Object

The compression tipe.



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

def tiff_compression
  @tiff_compression
end

#use_anti_aliasing ⇒ Object

Use antialiasing flag.



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

def use_anti_aliasing
  @use_anti_aliasing
end

#use_high_quality_rendering ⇒ Object

Use high quality flag.



50
51
52
 
# File 'lib/aspose_words_cloud/models/requests/SaveAsTiffRequest.rb', line 50

def use_high_quality_rendering
  @use_high_quality_rendering
end

#zip_output ⇒ Object

Optional. A value determining zip output or not.



80
81
82
 
# File 'lib/aspose_words_cloud/models/requests/SaveAsTiffRequest.rb', line 80

def zip_output
  @zip_output
end