Class: AsposeCellsCloud::Range

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Range

Initializes the object

Parameters:

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

    Model attributes in the form of hash



88
89
90
91
92
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
# File 'lib/aspose_cells_cloud/models/range.rb', line 88

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

  if attributes.has_key?(:'RowHeight')
    self.row_height = attributes[:'RowHeight']
  end

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

  if attributes.has_key?(:'FirstColumn')
    self.first_column = attributes[:'FirstColumn']
  end

  if attributes.has_key?(:'ColumnWidth')
    self.column_width = attributes[:'ColumnWidth']
  end

  if attributes.has_key?(:'RefersTo')
    self.refers_to = attributes[:'RefersTo']
  end

  if attributes.has_key?(:'RowCount')
    self.row_count = attributes[:'RowCount']
  end

  if attributes.has_key?(:'FirstRow')
    self.first_row = attributes[:'FirstRow']
  end

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

end

Instance Attribute Details

#column_countObject

Gets the count of columns in the range.



29
30
31
# File 'lib/aspose_cells_cloud/models/range.rb', line 29

def column_count
  @column_count
end

#column_widthObject

Sets or gets the column width of this range



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

def column_width
  @column_width
end

#first_columnObject

Gets the index of the first column of the range.



38
39
40
# File 'lib/aspose_cells_cloud/models/range.rb', line 38

def first_column
  @first_column
end

#first_rowObject

Gets the index of the first row of the range.



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

def first_row
  @first_row
end

#nameObject

Gets or sets the name of the range.



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

def name
  @name
end

#refers_toObject

Gets the range’s refers to.



44
45
46
# File 'lib/aspose_cells_cloud/models/range.rb', line 44

def refers_to
  @refers_to
end

#row_countObject

Gets the count of rows in the range.



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

def row_count
  @row_count
end

#row_heightObject

Sets or gets the height of rows in this range



32
33
34
# File 'lib/aspose_cells_cloud/models/range.rb', line 32

def row_height
  @row_height
end

#worksheetObject

Gets the Aspose.Cells.Range.Worksheetobject which contains this range.



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

def worksheet
  @worksheet
end

Class Method Details

.attribute_mapObject

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



57
58
59
60
61
62
63
64
65
66
67
68
69
# File 'lib/aspose_cells_cloud/models/range.rb', line 57

def self.attribute_map
  {
    :'column_count' => :'ColumnCount',
    :'row_height' => :'RowHeight',
    :'name' => :'Name',
    :'first_column' => :'FirstColumn',
    :'column_width' => :'ColumnWidth',
    :'refers_to' => :'RefersTo',
    :'row_count' => :'RowCount',
    :'first_row' => :'FirstRow',
    :'worksheet' => :'Worksheet'
  }
end

.swagger_typesObject

Attribute type mapping.



72
73
74
75
76
77
78
79
80
81
82
83
84
# File 'lib/aspose_cells_cloud/models/range.rb', line 72

def self.swagger_types
  {
    :'column_count' => :'Integer',
    :'row_height' => :'Float',
    :'name' => :'String',
    :'first_column' => :'Integer',
    :'column_width' => :'Float',
    :'refers_to' => :'String',
    :'row_count' => :'Integer',
    :'first_row' => :'Integer',
    :'worksheet' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      column_count == o.column_count &&
      row_height == o.row_height &&
      name == o.name &&
      first_column == o.first_column &&
      column_width == o.column_width &&
      refers_to == o.refers_to &&
      row_count == o.row_count &&
      first_row == o.first_row &&
      worksheet == o.worksheet
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



227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
# File 'lib/aspose_cells_cloud/models/range.rb', line 227

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



293
294
295
296
297
298
299
300
301
302
303
304
305
# File 'lib/aspose_cells_cloud/models/range.rb', line 293

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



206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
# File 'lib/aspose_cells_cloud/models/range.rb', line 206

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


193
194
195
# File 'lib/aspose_cells_cloud/models/range.rb', line 193

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



199
200
201
# File 'lib/aspose_cells_cloud/models/range.rb', line 199

def hash
  [column_count, row_height, name, first_column, column_width, refers_to, row_count, first_row, worksheet].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properies with the reasons



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
# File 'lib/aspose_cells_cloud/models/range.rb', line 134

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

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

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

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

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

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

  return invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



273
274
275
# File 'lib/aspose_cells_cloud/models/range.rb', line 273

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



279
280
281
282
283
284
285
286
287
# File 'lib/aspose_cells_cloud/models/range.rb', line 279

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



267
268
269
# File 'lib/aspose_cells_cloud/models/range.rb', line 267

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



165
166
167
168
169
170
171
172
173
# File 'lib/aspose_cells_cloud/models/range.rb', line 165

def valid?
  return false if @column_count.nil?
  return false if @row_height.nil?
  return false if @first_column.nil?
  return false if @column_width.nil?
  return false if @row_count.nil?
  return false if @first_row.nil?
  return true
end