Class: GroupDocsViewerCloud::SpreadsheetOptions

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

Overview

Rendering options for Spreadsheet file formats. Spreadsheet file formats include files with extensions: .xls, .xlsx, .xlsm, .xlsb, .csv, .ods, .ots, .xltx, .xltm, .tsv

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SpreadsheetOptions

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/groupdocs_viewer_cloud/models/spreadsheet_options.rb', line 124

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

  if attributes.key?(:'CountRowsPerPage')
    self.count_rows_per_page = attributes[:'CountRowsPerPage']
  end

  if attributes.key?(:'CountColumnsPerPage')
    self.count_columns_per_page = attributes[:'CountColumnsPerPage']
  end

  if attributes.key?(:'RenderGridLines')
    self.render_grid_lines = attributes[:'RenderGridLines']
  end

  if attributes.key?(:'RenderEmptyRows')
    self.render_empty_rows = attributes[:'RenderEmptyRows']
  end

  if attributes.key?(:'RenderEmptyColumns')
    self.render_empty_columns = attributes[:'RenderEmptyColumns']
  end

  if attributes.key?(:'RenderHiddenRows')
    self.render_hidden_rows = attributes[:'RenderHiddenRows']
  end

  if attributes.key?(:'RenderHiddenColumns')
    self.render_hidden_columns = attributes[:'RenderHiddenColumns']
  end

  if attributes.key?(:'RenderHeadings')
    self.render_headings = attributes[:'RenderHeadings']
  end

  if attributes.key?(:'RenderPrintAreaOnly')
    self.render_print_area_only = attributes[:'RenderPrintAreaOnly']
  end

  if attributes.key?(:'TextOverflowMode')
    self.text_overflow_mode = attributes[:'TextOverflowMode']
  end

end

Instance Attribute Details

#count_columns_per_page ⇒ Object

The columns count to include into each page when splitting worksheet into pages.



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

def count_columns_per_page
  @count_columns_per_page
end

#count_rows_per_page ⇒ Object

The number of rows rendered into one page when PaginateSheets is enabled. Default value is 50.



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

def count_rows_per_page
  @count_rows_per_page
end

#paginate_sheets ⇒ Object

Allows to enable worksheets pagination. By default one worksheet is rendered into one page.



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

def paginate_sheets
  @paginate_sheets
end

#render_empty_columns ⇒ Object

By default empty columns are skipped. Enable this option in case you want to render empty columns.



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

def render_empty_columns
  @render_empty_columns
end

#render_empty_rows ⇒ Object

By default empty rows are skipped. Enable this option in case you want to render empty rows.



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

def render_empty_rows
  @render_empty_rows
end

#render_grid_lines ⇒ Object

Indicates whether to render grid lines



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

def render_grid_lines
  @render_grid_lines
end

#render_headings ⇒ Object

Enables headings rendering.



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

def render_headings
  @render_headings
end

#render_hidden_columns ⇒ Object

Enables rendering of hidden columns.



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

def render_hidden_columns
  @render_hidden_columns
end

#render_hidden_rows ⇒ Object

Enables rendering of hidden rows.



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

def render_hidden_rows
  @render_hidden_rows
end

#render_print_area_only ⇒ Object

Enables rendering worksheet(s) sections which is defined as print area. Renders each print area in a worksheet as a separate page.



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

def render_print_area_only
  @render_print_area_only
end

#text_overflow_mode ⇒ Object

The text overflow mode for rendering spreadsheet documents into HTML



65
66
67
 
# File 'lib/groupdocs_viewer_cloud/models/spreadsheet_options.rb', line 65

def text_overflow_mode
  @text_overflow_mode
end

Class Method Details

.attribute_map ⇒ Object

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



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/groupdocs_viewer_cloud/models/spreadsheet_options.rb', line 89

def self.attribute_map
  {
    :'paginate_sheets' => :'PaginateSheets',
    :'count_rows_per_page' => :'CountRowsPerPage',
    :'count_columns_per_page' => :'CountColumnsPerPage',
    :'render_grid_lines' => :'RenderGridLines',
    :'render_empty_rows' => :'RenderEmptyRows',
    :'render_empty_columns' => :'RenderEmptyColumns',
    :'render_hidden_rows' => :'RenderHiddenRows',
    :'render_hidden_columns' => :'RenderHiddenColumns',
    :'render_headings' => :'RenderHeadings',
    :'render_print_area_only' => :'RenderPrintAreaOnly',
    :'text_overflow_mode' => :'TextOverflowMode'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/groupdocs_viewer_cloud/models/spreadsheet_options.rb', line 106

def self.swagger_types
  {
    :'paginate_sheets' => :'BOOLEAN',
    :'count_rows_per_page' => :'Integer',
    :'count_columns_per_page' => :'Integer',
    :'render_grid_lines' => :'BOOLEAN',
    :'render_empty_rows' => :'BOOLEAN',
    :'render_empty_columns' => :'BOOLEAN',
    :'render_hidden_rows' => :'BOOLEAN',
    :'render_hidden_columns' => :'BOOLEAN',
    :'render_headings' => :'BOOLEAN',
    :'render_print_area_only' => :'BOOLEAN',
    :'text_overflow_mode' => :'String'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/groupdocs_viewer_cloud/models/spreadsheet_options.rb', line 262

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
      paginate_sheets == other.paginate_sheets &&
      count_rows_per_page == other.count_rows_per_page &&
      count_columns_per_page == other.count_columns_per_page &&
      render_grid_lines == other.render_grid_lines &&
      render_empty_rows == other.render_empty_rows &&
      render_empty_columns == other.render_empty_columns &&
      render_hidden_rows == other.render_hidden_rows &&
      render_hidden_columns == other.render_hidden_columns &&
      render_headings == other.render_headings &&
      render_print_area_only == other.render_print_area_only &&
      text_overflow_mode == other.text_overflow_mode
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



323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
 
# File 'lib/groupdocs_viewer_cloud/models/spreadsheet_options.rb', line 323

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



390
391
392
393
394
395
396
397
398
399
400
401
402
 
# File 'lib/groupdocs_viewer_cloud/models/spreadsheet_options.rb', line 390

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



299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'lib/groupdocs_viewer_cloud/models/spreadsheet_options.rb', line 299

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


280
281
282
 
# File 'lib/groupdocs_viewer_cloud/models/spreadsheet_options.rb', line 280

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



286
287
288
 
# File 'lib/groupdocs_viewer_cloud/models/spreadsheet_options.rb', line 286

def hash
  [paginate_sheets, count_rows_per_page, count_columns_per_page, render_grid_lines, render_empty_rows, render_empty_columns, render_hidden_rows, render_hidden_columns, render_headings, render_print_area_only, text_overflow_mode].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



178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/groupdocs_viewer_cloud/models/spreadsheet_options.rb', line 178

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

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

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

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

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

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

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

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

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

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

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



370
371
372
 
# File 'lib/groupdocs_viewer_cloud/models/spreadsheet_options.rb', line 370

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



376
377
378
379
380
381
382
383
384
 
# File 'lib/groupdocs_viewer_cloud/models/spreadsheet_options.rb', line 376

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



364
365
366
 
# File 'lib/groupdocs_viewer_cloud/models/spreadsheet_options.rb', line 364

def to_s
  to_hash.to_s
end

#uncap(str) ⇒ Object

Downcases first letter.

Returns:

  • downcased string



292
293
294
 
# File 'lib/groupdocs_viewer_cloud/models/spreadsheet_options.rb', line 292

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



229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/groupdocs_viewer_cloud/models/spreadsheet_options.rb', line 229

def valid?
  return false if @paginate_sheets.nil?
  return false if @count_rows_per_page.nil?
  return false if @count_columns_per_page.nil?
  return false if @render_grid_lines.nil?
  return false if @render_empty_rows.nil?
  return false if @render_empty_columns.nil?
  return false if @render_hidden_rows.nil?
  return false if @render_hidden_columns.nil?
  return false if @render_headings.nil?
  return false if @render_print_area_only.nil?
  return false if @text_overflow_mode.nil?
  text_overflow_mode_validator = EnumAttributeValidator.new('String', ["Overlay", "OverlayIfNextIsEmpty", "AutoFitColumn", "HideText"])
  return false unless text_overflow_mode_validator.valid?(@text_overflow_mode)
  return true
end