Class: AsposeCellsCloud::FormulaSettings

Inherits:
Object
  • Object
show all
Defined in:
lib/aspose_cells_cloud/models/formula_settings.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FormulaSettings

Initializes the object

Parameters:

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

    Model attributes in the form of hash



93
94
95
96
97
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
 
# File 'lib/aspose_cells_cloud/models/formula_settings.rb', line 93

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.has_key?(:'CalculateOnOpen')
      self.calculate_on_open = attributes[:'CalculateOnOpen']
  end
  if attributes.has_key?(:'CalculateOnSave')
      self.calculate_on_save = attributes[:'CalculateOnSave']
  end
  if attributes.has_key?(:'ForceFullCalculation')
      self.force_full_calculation = attributes[:'ForceFullCalculation']
  end
  if attributes.has_key?(:'CalculationMode')
      self.calculation_mode = attributes[:'CalculationMode']
  end
  if attributes.has_key?(:'CalculationId')
      self.calculation_id = attributes[:'CalculationId']
  end
  if attributes.has_key?(:'EnableIterativeCalculation')
      self.enable_iterative_calculation = attributes[:'EnableIterativeCalculation']
  end
  if attributes.has_key?(:'MaxIteration')
      self.max_iteration = attributes[:'MaxIteration']
  end
  if attributes.has_key?(:'MaxChange')
      self.max_change = attributes[:'MaxChange']
  end
  if attributes.has_key?(:'PrecisionAsDisplayed')
      self.precision_as_displayed = attributes[:'PrecisionAsDisplayed']
  end
  if attributes.has_key?(:'EnableCalculationChain')
      self.enable_calculation_chain = attributes[:'EnableCalculationChain']
  end
  if attributes.has_key?(:'PreservePaddingSpaces')
      self.preserve_padding_spaces = attributes[:'PreservePaddingSpaces']
  end

end

Instance Attribute Details

#calculate_on_open ⇒ Object

Indicates whether the application is required to perform a full calculation when the workbook is opened.



35
36
37
 
# File 'lib/aspose_cells_cloud/models/formula_settings.rb', line 35

def calculate_on_open
  @calculate_on_open
end

#calculate_on_save ⇒ Object

Indicates whether recalculate the workbook before saving the document, when in manual calculation mode.



37
38
39
 
# File 'lib/aspose_cells_cloud/models/formula_settings.rb', line 37

def calculate_on_save
  @calculate_on_save
end

#calculation_id ⇒ Object

Specifies the version of the calculation engine used to calculate values in the workbook.



43
44
45
 
# File 'lib/aspose_cells_cloud/models/formula_settings.rb', line 43

def calculation_id
  @calculation_id
end

#calculation_mode ⇒ Object

Gets or sets the mode for workbook calculation in ms excel.



41
42
43
 
# File 'lib/aspose_cells_cloud/models/formula_settings.rb', line 41

def calculation_mode
  @calculation_mode
end

#enable_calculation_chain ⇒ Object

Whether enable calculation chain for formulas. Default is false.



53
54
55
 
# File 'lib/aspose_cells_cloud/models/formula_settings.rb', line 53

def enable_calculation_chain
  @enable_calculation_chain
end

#enable_iterative_calculation ⇒ Object

Indicates whether enable iterative calculation to resolve circular references.



45
46
47
 
# File 'lib/aspose_cells_cloud/models/formula_settings.rb', line 45

def enable_iterative_calculation
  @enable_iterative_calculation
end

#force_full_calculation ⇒ Object

Indicates whether calculates all formulas every time when a calculation is triggered.



39
40
41
 
# File 'lib/aspose_cells_cloud/models/formula_settings.rb', line 39

def force_full_calculation
  @force_full_calculation
end

#max_change ⇒ Object

The maximum change to resolve a circular reference.



49
50
51
 
# File 'lib/aspose_cells_cloud/models/formula_settings.rb', line 49

def max_change
  @max_change
end

#max_iteration ⇒ Object

The maximum iterations to resolve a circular reference.



47
48
49
 
# File 'lib/aspose_cells_cloud/models/formula_settings.rb', line 47

def max_iteration
  @max_iteration
end

#precision_as_displayed ⇒ Object

Whether the precision of calculated result be set as they are displayed while calculating formulas



51
52
53
 
# File 'lib/aspose_cells_cloud/models/formula_settings.rb', line 51

def precision_as_displayed
  @precision_as_displayed
end

#preserve_padding_spaces ⇒ Object

Indicates whether preserve those spaces and line breaks that are padded between formula tokens while getting and setting formulas. Default value is false.



55
56
57
 
# File 'lib/aspose_cells_cloud/models/formula_settings.rb', line 55

def preserve_padding_spaces
  @preserve_padding_spaces
end

Class Method Details

.attribute_map ⇒ Object

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



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/aspose_cells_cloud/models/formula_settings.rb', line 58

def self.attribute_map
  {
    :'calculate_on_open' => :'CalculateOnOpen',
    :'calculate_on_save' => :'CalculateOnSave',
    :'force_full_calculation' => :'ForceFullCalculation',
    :'calculation_mode' => :'CalculationMode',
    :'calculation_id' => :'CalculationId',
    :'enable_iterative_calculation' => :'EnableIterativeCalculation',
    :'max_iteration' => :'MaxIteration',
    :'max_change' => :'MaxChange',
    :'precision_as_displayed' => :'PrecisionAsDisplayed',
    :'enable_calculation_chain' => :'EnableCalculationChain',
    :'preserve_padding_spaces' => :'PreservePaddingSpaces'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/aspose_cells_cloud/models/formula_settings.rb', line 75

def self.swagger_types
  {
    :'calculate_on_open' => :'BOOLEAN',
    :'calculate_on_save' => :'BOOLEAN',
    :'force_full_calculation' => :'BOOLEAN',
    :'calculation_mode' => :'String',
    :'calculation_id' => :'String',
    :'enable_iterative_calculation' => :'BOOLEAN',
    :'max_iteration' => :'Integer',
    :'max_change' => :'Float',
    :'precision_as_displayed' => :'BOOLEAN',
    :'enable_calculation_chain' => :'BOOLEAN',
    :'preserve_padding_spaces' => :'BOOLEAN'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/aspose_cells_cloud/models/formula_settings.rb', line 195

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      calculate_on_open == o.calculate_on_open &&
      calculate_on_save == o.calculate_on_save &&
      force_full_calculation == o.force_full_calculation &&
      calculation_mode == o.calculation_mode &&
      calculation_id == o.calculation_id &&
      enable_iterative_calculation == o.enable_iterative_calculation &&
      max_iteration == o.max_iteration &&
      max_change == o.max_change &&
      precision_as_displayed == o.precision_as_displayed &&
      enable_calculation_chain == o.enable_calculation_chain &&
      preserve_padding_spaces == o.preserve_padding_spaces 
      std_dev == o.std_dev
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



248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/aspose_cells_cloud/models/formula_settings.rb', line 248

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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 = AsposeCellsCloud.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



314
315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/aspose_cells_cloud/models/formula_settings.rb', line 314

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



227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/aspose_cells_cloud/models/formula_settings.rb', line 227

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


214
215
216
 
# File 'lib/aspose_cells_cloud/models/formula_settings.rb', line 214

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



220
221
222
 
# File 'lib/aspose_cells_cloud/models/formula_settings.rb', line 220

def hash
  [ calculate_on_open , calculate_on_save , force_full_calculation , calculation_mode , calculation_id , enable_iterative_calculation , max_iteration , max_change , precision_as_displayed , enable_calculation_chain , preserve_padding_spaces ].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



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/aspose_cells_cloud/models/formula_settings.rb', line 137

def list_invalid_properties
  invalid_properties = Array.new
  if @calculate_on_open.nil?
      invalid_properties.push("invalid value for 'calculate_on_open', calculate_on_open cannot be nil.")
  end
  if @calculate_on_save.nil?
      invalid_properties.push("invalid value for 'calculate_on_save', calculate_on_save cannot be nil.")
  end
  if @force_full_calculation.nil?
      invalid_properties.push("invalid value for 'force_full_calculation', force_full_calculation cannot be nil.")
  end
  if @calculation_mode.nil?
      invalid_properties.push("invalid value for 'calculation_mode', calculation_mode cannot be nil.")
  end
  if @calculation_id.nil?
      invalid_properties.push("invalid value for 'calculation_id', calculation_id cannot be nil.")
  end
  if @enable_iterative_calculation.nil?
      invalid_properties.push("invalid value for 'enable_iterative_calculation', enable_iterative_calculation cannot be nil.")
  end
  if @max_iteration.nil?
      invalid_properties.push("invalid value for 'max_iteration', max_iteration cannot be nil.")
  end
  if @max_change.nil?
      invalid_properties.push("invalid value for 'max_change', max_change cannot be nil.")
  end
  if @precision_as_displayed.nil?
      invalid_properties.push("invalid value for 'precision_as_displayed', precision_as_displayed cannot be nil.")
  end
  if @enable_calculation_chain.nil?
      invalid_properties.push("invalid value for 'enable_calculation_chain', enable_calculation_chain cannot be nil.")
  end
  if @preserve_padding_spaces.nil?
      invalid_properties.push("invalid value for 'preserve_padding_spaces', preserve_padding_spaces 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



294
295
296
 
# File 'lib/aspose_cells_cloud/models/formula_settings.rb', line 294

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



300
301
302
303
304
305
306
307
308
 
# File 'lib/aspose_cells_cloud/models/formula_settings.rb', line 300

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



288
289
290
 
# File 'lib/aspose_cells_cloud/models/formula_settings.rb', line 288

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



178
179
180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/aspose_cells_cloud/models/formula_settings.rb', line 178

def valid?
  return false if @calculate_on_open.nil?
  return false if @calculate_on_save.nil?
  return false if @force_full_calculation.nil?
  return false if @calculation_mode.nil?
  return false if @calculation_id.nil?
  return false if @enable_iterative_calculation.nil?
  return false if @max_iteration.nil?
  return false if @max_change.nil?
  return false if @precision_as_displayed.nil?
  return false if @enable_calculation_chain.nil?
  return false if @preserve_padding_spaces.nil?
  return true
end