Class: AsposeCellsCloud::IconSet

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

Overview

Describe the IconSet conditional formatting rule. This conditional formatting rule applies icons to cells according to their values.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ IconSet

Initializes the object

Parameters:

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

    Model attributes in the form of hash



73
74
75
76
77
78
79
80
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
 
# File 'lib/aspose_cells_cloud/models/icon_set.rb', line 73

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

  if attributes.has_key?(:'CfIcons')
    if (value = attributes[:'CfIcons']).is_a?(Array)
      self.cf_icons = value
    end
  end

  if attributes.has_key?(:'Cfvos')
    if (value = attributes[:'Cfvos']).is_a?(Array)
      self.cfvos = value
    end
  end

  if attributes.has_key?(:'IconSetType')
    self.icon_set_type = attributes[:'IconSetType']
  end

  if attributes.has_key?(:'IsCustom')
    self.is_custom = attributes[:'IsCustom']
  end

  if attributes.has_key?(:'ShowValue')
    self.show_value = attributes[:'ShowValue']
  end

end

Instance Attribute Details

#cf_icons ⇒ Object

Get theAspose.Cells.ConditionalFormattingIcon from the collection



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

def cf_icons
  @cf_icons
end

#cfvos ⇒ Object

Get the CFValueObjects instance.



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

def cfvos
  @cfvos
end

#icon_set_type ⇒ Object

Get or Set the icon set type to display. Setting the type will auto check if the current Cfvos’s count is accord with the new type. If not accord, old Cfvos will be cleaned and default Cfvos will be added.



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

def icon_set_type
  @icon_set_type
end

#is_custom ⇒ Object

Indicates whether the icon set is custom. Default value is false.



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

def is_custom
  @is_custom
end

#reverse ⇒ Object

Get or set the flag indicating whether to reverses the default order of the icons in this icon set. Default value is false.



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

def reverse
  @reverse
end

#show_value ⇒ Object

Get or set the flag indicating whether to show the values of the cells on which this icon set is applied. Default value is true.



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

def show_value
  @show_value
end

Class Method Details

.attribute_map ⇒ Object

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



48
49
50
51
52
53
54
55
56
57
 
# File 'lib/aspose_cells_cloud/models/icon_set.rb', line 48

def self.attribute_map
  {
    :'reverse' => :'Reverse',
    :'cf_icons' => :'CfIcons',
    :'cfvos' => :'Cfvos',
    :'icon_set_type' => :'IconSetType',
    :'is_custom' => :'IsCustom',
    :'show_value' => :'ShowValue'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'reverse' => :'BOOLEAN',
    :'cf_icons' => :'Array<ConditionalFormattingIcon>',
    :'cfvos' => :'Array<ConditionalFormattingValue>',
    :'icon_set_type' => :'String',
    :'is_custom' => :'BOOLEAN',
    :'show_value' => :'BOOLEAN'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



124
125
126
127
128
129
130
131
132
133
 
# File 'lib/aspose_cells_cloud/models/icon_set.rb', line 124

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      reverse == o.reverse &&
      cf_icons == o.cf_icons &&
      cfvos == o.cfvos &&
      icon_set_type == o.icon_set_type &&
      is_custom == o.is_custom &&
      show_value == o.show_value
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



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
200
201
202
203
204
205
206
207
 
# File 'lib/aspose_cells_cloud/models/icon_set.rb', line 171

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



237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/aspose_cells_cloud/models/icon_set.rb', line 237

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



150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/aspose_cells_cloud/models/icon_set.rb', line 150

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


137
138
139
 
# File 'lib/aspose_cells_cloud/models/icon_set.rb', line 137

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



143
144
145
 
# File 'lib/aspose_cells_cloud/models/icon_set.rb', line 143

def hash
  [reverse, cf_icons, cfvos, icon_set_type, is_custom, show_value].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



111
112
113
114
 
# File 'lib/aspose_cells_cloud/models/icon_set.rb', line 111

def list_invalid_properties
  invalid_properties = Array.new
  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



217
218
219
 
# File 'lib/aspose_cells_cloud/models/icon_set.rb', line 217

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



223
224
225
226
227
228
229
230
231
 
# File 'lib/aspose_cells_cloud/models/icon_set.rb', line 223

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



211
212
213
 
# File 'lib/aspose_cells_cloud/models/icon_set.rb', line 211

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



118
119
120
 
# File 'lib/aspose_cells_cloud/models/icon_set.rb', line 118

def valid?
  return true
end