Class: AsposeCellsCloud::AddTextOptions

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AddTextOptions

Initializes the object

Parameters:

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

    Model attributes in the form of hash



81
82
83
84
85
86
87
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
 
# File 'lib/aspose_cells_cloud/models/add_text_options.rb', line 81

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?(:'Name')
      self.name = attributes[:'Name']
  end
  if attributes.has_key?(:'DataSource')
      self.data_source = attributes[:'DataSource']
  end
  if attributes.has_key?(:'FileInfo')
      self.file_info = attributes[:'FileInfo']
  end
  if attributes.has_key?(:'ScopeOptions')
      self.scope_options = attributes[:'ScopeOptions']
  end
  if attributes.has_key?(:'Text')
      self.text = attributes[:'Text']
  end
  if attributes.has_key?(:'SelectPoistion')
      self.select_poistion = attributes[:'SelectPoistion']
  end
  if attributes.has_key?(:'SelectText')
      self.select_text = attributes[:'SelectText']
  end
  if attributes.has_key?(:'SkipEmptyCells')
      self.skip_empty_cells = attributes[:'SkipEmptyCells']
  end

end

Instance Attribute Details

#data_source ⇒ Object

Represents data source. There are three types of data, they are CloudFileSystem, RequestFiles, HttpUri.



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

def data_source
  @data_source
end

#file_info ⇒ Object

Represents file information. Include of filename, filesize, and file content(base64String).



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

def file_info
  @file_info
end

#name ⇒ Object

The class has a public property named “Name” with a getter and setter method.



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

def name
  @name
end

#scope_options ⇒ Object

Specifies the range of cells within the worksheet where the spreadsheet operations will be performed. This parameter allows users to define the exact area to be processed, ensuring that operations are applied only to the designated cells.



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

def scope_options
  @scope_options
end

#select_poistion ⇒ Object

Represents where text should be inserted or selected in the spreadsheet.



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

def select_poistion
  @select_poistion
end

#select_text ⇒ Object

Selected text of cell where text should be inserted or selected in the spreadsheet.



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

def select_text
  @select_text
end

#skip_empty_cells ⇒ Object

Indicates whether empty cells should be skipped during processing.



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

def skip_empty_cells
  @skip_empty_cells
end

#text ⇒ Object

Add text content.



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

def text
  @text
end

Class Method Details

.attribute_map ⇒ Object

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



52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/aspose_cells_cloud/models/add_text_options.rb', line 52

def self.attribute_map
  {
    :'name' => :'Name',
    :'data_source' => :'DataSource',
    :'file_info' => :'FileInfo',
    :'scope_options' => :'ScopeOptions',
    :'text' => :'Text',
    :'select_poistion' => :'SelectPoistion',
    :'select_text' => :'SelectText',
    :'skip_empty_cells' => :'SkipEmptyCells'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/aspose_cells_cloud/models/add_text_options.rb', line 66

def self.swagger_types
  {
    :'name' => :'String',
    :'data_source' => :'DataSource',
    :'file_info' => :'FileInfo',
    :'scope_options' => :'ScopeOptions',
    :'text' => :'String',
    :'select_poistion' => :'String',
    :'select_text' => :'String',
    :'skip_empty_cells' => :'BOOLEAN'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/aspose_cells_cloud/models/add_text_options.rb', line 162

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      data_source == o.data_source &&
      file_info == o.file_info &&
      scope_options == o.scope_options &&
      text == o.text &&
      select_poistion == o.select_poistion &&
      select_text == o.select_text &&
      skip_empty_cells == o.skip_empty_cells 
      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



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
243
244
245
246
247
248
 
# File 'lib/aspose_cells_cloud/models/add_text_options.rb', line 212

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



278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/aspose_cells_cloud/models/add_text_options.rb', line 278

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



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/aspose_cells_cloud/models/add_text_options.rb', line 191

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


178
179
180
 
# File 'lib/aspose_cells_cloud/models/add_text_options.rb', line 178

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



184
185
186
 
# File 'lib/aspose_cells_cloud/models/add_text_options.rb', line 184

def hash
  [ name , data_source , file_info , scope_options , text , select_poistion , select_text , skip_empty_cells ].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



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/aspose_cells_cloud/models/add_text_options.rb', line 116

def list_invalid_properties
  invalid_properties = Array.new
  if @name.nil?
      invalid_properties.push("invalid value for 'name', name cannot be nil.")
  end
  if @data_source.nil?
      invalid_properties.push("invalid value for 'data_source', data_source cannot be nil.")
  end
  if @file_info.nil?
      invalid_properties.push("invalid value for 'file_info', file_info cannot be nil.")
  end
  if @scope_options.nil?
      invalid_properties.push("invalid value for 'scope_options', scope_options cannot be nil.")
  end
  if @text.nil?
      invalid_properties.push("invalid value for 'text', text cannot be nil.")
  end
  if @select_poistion.nil?
      invalid_properties.push("invalid value for 'select_poistion', select_poistion cannot be nil.")
  end
  if @select_text.nil?
      invalid_properties.push("invalid value for 'select_text', select_text cannot be nil.")
  end
  if @skip_empty_cells.nil?
      invalid_properties.push("invalid value for 'skip_empty_cells', skip_empty_cells 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



258
259
260
 
# File 'lib/aspose_cells_cloud/models/add_text_options.rb', line 258

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



264
265
266
267
268
269
270
271
272
 
# File 'lib/aspose_cells_cloud/models/add_text_options.rb', line 264

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



252
253
254
 
# File 'lib/aspose_cells_cloud/models/add_text_options.rb', line 252

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



148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/aspose_cells_cloud/models/add_text_options.rb', line 148

def valid?
  return false if @name.nil?
  return false if @data_source.nil?
  return false if @file_info.nil?
  return false if @scope_options.nil?
  return false if @text.nil?
  return false if @select_poistion.nil?
  return false if @select_text.nil?
  return false if @skip_empty_cells.nil?
  return true
end