Class: AsposeCellsCloud::Cell

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

Overview

Encapsulates the object that represents a single Workbook cell.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Cell

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/aspose_cells_cloud/models/cell.rb', line 125

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

  if attributes.has_key?(:'Style')
    self.style = attributes[:'Style']
  end

  if attributes.has_key?(:'HtmlString')
    self.html_string = attributes[:'HtmlString']
  end

  if attributes.has_key?(:'Name')
    self.name = attributes[:'Name']
  end

  if attributes.has_key?(:'Column')
    self.column = attributes[:'Column']
  end

  if attributes.has_key?(:'Worksheet')
    self.worksheet = attributes[:'Worksheet']
  end

  if attributes.has_key?(:'IsInTable')
    self.is_in_table = attributes[:'IsInTable']
  end

  if attributes.has_key?(:'IsArrayHeader')
    self.is_array_header = attributes[:'IsArrayHeader']
  end

  if attributes.has_key?(:'Value')
    self.value = attributes[:'Value']
  end

  if attributes.has_key?(:'IsFormula')
    self.is_formula = attributes[:'IsFormula']
  end

  if attributes.has_key?(:'IsStyleSet')
    self.is_style_set = attributes[:'IsStyleSet']
  end

  if attributes.has_key?(:'IsInArray')
    self.is_in_array = attributes[:'IsInArray']
  end

  if attributes.has_key?(:'IsErrorValue')
    self.is_error_value = attributes[:'IsErrorValue']
  end

  if attributes.has_key?(:'IsMerged')
    self.is_merged = attributes[:'IsMerged']
  end

  if attributes.has_key?(:'Formula')
    self.formula = attributes[:'Formula']
  end

  if attributes.has_key?(:'Type')
    self.type = attributes[:'Type']
  end

  if attributes.has_key?(:'Row')
    self.row = attributes[:'Row']
  end

end

Instance Attribute Details

#column ⇒ Object

Gets column number (zero based) of the cell.



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

def column
  @column
end

#formula ⇒ Object

Gets or sets a formula of the Aspose.Cells.Cell.



68
69
70
 
# File 'lib/aspose_cells_cloud/models/cell.rb', line 68

def formula
  @formula
end

#html_string ⇒ Object

Gets and sets the html string which contains data and some formattings in this cell.



33
34
35
 
# File 'lib/aspose_cells_cloud/models/cell.rb', line 33

def html_string
  @html_string
end

#is_array_header ⇒ Object

Inidicates the cell’s formula is and array formula and it is the first cell of the array.



48
49
50
 
# File 'lib/aspose_cells_cloud/models/cell.rb', line 48

def is_array_header
  @is_array_header
end

#is_error_value ⇒ Object

Checks if a formula can properly evaluate a result.



62
63
64
 
# File 'lib/aspose_cells_cloud/models/cell.rb', line 62

def is_error_value
  @is_error_value
end

#is_formula ⇒ Object

Represents if the specified cell contains formula.



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

def is_formula
  @is_formula
end

#is_in_array ⇒ Object

Indicates whether the cell formula is an array formula.



59
60
61
 
# File 'lib/aspose_cells_cloud/models/cell.rb', line 59

def is_in_array
  @is_in_array
end

#is_in_table ⇒ Object

Indicates whethe this cell is part of table formula.



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

def is_in_table
  @is_in_table
end

#is_merged ⇒ Object

Checks if a cell is part of a merged range or not.



65
66
67
 
# File 'lib/aspose_cells_cloud/models/cell.rb', line 65

def is_merged
  @is_merged
end

#is_style_set ⇒ Object

Indicates if the cell’s style is set. If return false, it means this cell has a default cell format.



56
57
58
 
# File 'lib/aspose_cells_cloud/models/cell.rb', line 56

def is_style_set
  @is_style_set
end

#link ⇒ Object

Returns the value of attribute link.



28
29
30
 
# File 'lib/aspose_cells_cloud/models/cell.rb', line 28

def link
  @link
end

#name ⇒ Object

Gets the name of the cell.



36
37
38
 
# File 'lib/aspose_cells_cloud/models/cell.rb', line 36

def name
  @name
end

#row ⇒ Object

Gets row number (zero based) of the cell.



74
75
76
 
# File 'lib/aspose_cells_cloud/models/cell.rb', line 74

def row
  @row
end

#style ⇒ Object

Returns the value of attribute style.



30
31
32
 
# File 'lib/aspose_cells_cloud/models/cell.rb', line 30

def style
  @style
end

#type ⇒ Object

Specifies a cell value type.



71
72
73
 
# File 'lib/aspose_cells_cloud/models/cell.rb', line 71

def type
  @type
end

#value ⇒ Object

Returns the value of attribute value.



50
51
52
 
# File 'lib/aspose_cells_cloud/models/cell.rb', line 50

def value
  @value
end

#worksheet ⇒ Object

Gets the parent worksheet.



42
43
44
 
# File 'lib/aspose_cells_cloud/models/cell.rb', line 42

def worksheet
  @worksheet
end

Class Method Details

.attribute_map ⇒ Object

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



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/aspose_cells_cloud/models/cell.rb', line 78

def self.attribute_map
  {
    :'link' => :'link',
    :'style' => :'Style',
    :'html_string' => :'HtmlString',
    :'name' => :'Name',
    :'column' => :'Column',
    :'worksheet' => :'Worksheet',
    :'is_in_table' => :'IsInTable',
    :'is_array_header' => :'IsArrayHeader',
    :'value' => :'Value',
    :'is_formula' => :'IsFormula',
    :'is_style_set' => :'IsStyleSet',
    :'is_in_array' => :'IsInArray',
    :'is_error_value' => :'IsErrorValue',
    :'is_merged' => :'IsMerged',
    :'formula' => :'Formula',
    :'type' => :'Type',
    :'row' => :'Row'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/aspose_cells_cloud/models/cell.rb', line 101

def self.swagger_types
  {
    :'link' => :'Link',
    :'style' => :'LinkElement',
    :'html_string' => :'String',
    :'name' => :'String',
    :'column' => :'Integer',
    :'worksheet' => :'String',
    :'is_in_table' => :'BOOLEAN',
    :'is_array_header' => :'BOOLEAN',
    :'value' => :'String',
    :'is_formula' => :'BOOLEAN',
    :'is_style_set' => :'BOOLEAN',
    :'is_in_array' => :'BOOLEAN',
    :'is_error_value' => :'BOOLEAN',
    :'is_merged' => :'BOOLEAN',
    :'formula' => :'String',
    :'type' => :'String',
    :'row' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/aspose_cells_cloud/models/cell.rb', line 261

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      link == o.link &&
      style == o.style &&
      html_string == o.html_string &&
      name == o.name &&
      column == o.column &&
      worksheet == o.worksheet &&
      is_in_table == o.is_in_table &&
      is_array_header == o.is_array_header &&
      value == o.value &&
      is_formula == o.is_formula &&
      is_style_set == o.is_style_set &&
      is_in_array == o.is_in_array &&
      is_error_value == o.is_error_value &&
      is_merged == o.is_merged &&
      formula == o.formula &&
      type == o.type &&
      row == o.row
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



319
320
321
322
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
 
# File 'lib/aspose_cells_cloud/models/cell.rb', line 319

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



385
386
387
388
389
390
391
392
393
394
395
396
397
 
# File 'lib/aspose_cells_cloud/models/cell.rb', line 385

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



298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/aspose_cells_cloud/models/cell.rb', line 298

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


285
286
287
 
# File 'lib/aspose_cells_cloud/models/cell.rb', line 285

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



291
292
293
 
# File 'lib/aspose_cells_cloud/models/cell.rb', line 291

def hash
  [link, style, html_string, name, column, worksheet, is_in_table, is_array_header, value, is_formula, is_style_set, is_in_array, is_error_value, is_merged, formula, type, row].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



203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/aspose_cells_cloud/models/cell.rb', line 203

def list_invalid_properties
  invalid_properties = Array.new
  if @column.nil?
    invalid_properties.push("invalid value for 'column', column cannot be nil.")
  end

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

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

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

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

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

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

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

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



365
366
367
 
# File 'lib/aspose_cells_cloud/models/cell.rb', line 365

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



371
372
373
374
375
376
377
378
379
 
# File 'lib/aspose_cells_cloud/models/cell.rb', line 371

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



359
360
361
 
# File 'lib/aspose_cells_cloud/models/cell.rb', line 359

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



246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/aspose_cells_cloud/models/cell.rb', line 246

def valid?
  return false if @column.nil?
  return false if @is_in_table.nil?
  return false if @is_array_header.nil?
  return false if @is_formula.nil?
  return false if @is_style_set.nil?
  return false if @is_in_array.nil?
  return false if @is_error_value.nil?
  return false if @is_merged.nil?
  return false if @row.nil?
  return true
end