Class: AsposeCellsCloud::FormatCondition

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FormatCondition

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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/format_condition.rb', line 109

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?(:'Priority')
      self.priority = attributes[:'Priority']
  end
  if attributes.has_key?(:'Type')
      self.type = attributes[:'Type']
  end
  if attributes.has_key?(:'StopIfTrue')
      self.stop_if_true = attributes[:'StopIfTrue']
  end
  if attributes.has_key?(:'AboveAverage')
      self.above_average = attributes[:'AboveAverage']
  end
  if attributes.has_key?(:'ColorScale')
      self.color_scale = attributes[:'ColorScale']
  end
  if attributes.has_key?(:'DataBar')
      self.data_bar = attributes[:'DataBar']
  end
  if attributes.has_key?(:'Formula1')
      self.formula1 = attributes[:'Formula1']
  end
  if attributes.has_key?(:'Formula2')
      self.formula2 = attributes[:'Formula2']
  end
  if attributes.has_key?(:'IconSet')
      self.icon_set = attributes[:'IconSet']
  end
  if attributes.has_key?(:'Operator')
      self.operator = attributes[:'Operator']
  end
  if attributes.has_key?(:'Style')
      self.style = attributes[:'Style']
  end
  if attributes.has_key?(:'Text')
      self.text = attributes[:'Text']
  end
  if attributes.has_key?(:'TimePeriod')
      self.time_period = attributes[:'TimePeriod']
  end
  if attributes.has_key?(:'Top10')
      self.top10 = attributes[:'Top10']
  end
  if attributes.has_key?(:'link')
      self.link = attributes[:'link']
  end

end

Instance Attribute Details

#above_average ⇒ Object

Get the conditional formatting’s “AboveAverage” instance. The default instance’s rule highlights cells that are above the average for all values in the range. Valid only for type = AboveAverage.



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

def above_average
  @above_average
end

#color_scale ⇒ Object

Get the conditional formatting’s “ColorScale” instance. The default instance is a “green-yellow-red” 3ColorScale . Valid only for type = ColorScale.



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

def color_scale
  @color_scale
end

#data_bar ⇒ Object

Get the conditional formatting’s “DataBar” instance. The default instance’s color is blue. Valid only for type is DataBar.



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

def data_bar
  @data_bar
end

#formula1 ⇒ Object

Gets and sets the value or expression associated with conditional formatting.



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

def formula1
  @formula1
end

#formula2 ⇒ Object

Gets and sets the value or expression associated with conditional formatting.



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

def formula2
  @formula2
end

#icon_set ⇒ Object

Get the conditional formatting’s “IconSet” instance. The default instance’s IconSetType is TrafficLights31. Valid only for type = IconSet.



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

def icon_set
  @icon_set
end

#link ⇒ Object

Returns the value of attribute link.



63
64
65
 
# File 'lib/aspose_cells_cloud/models/format_condition.rb', line 63

def link
  @link
end

#operator ⇒ Object

Gets and sets the conditional format operator type.



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

def operator
  @operator
end

#priority ⇒ Object

The priority of this conditional formatting rule. This value is used to determine which format should be evaluated and rendered. Lower numeric values are higher priority than higher numeric values, where ‘1’ is the highest priority.



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

def priority
  @priority
end

#stop_if_true ⇒ Object

True, no rules with lower priority may be applied over this rule, when this rule evaluates to true. Only applies for Excel 2007;



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

def stop_if_true
  @stop_if_true
end

#style ⇒ Object

Gets or setts style of conditional formatted cell ranges.



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

def style
  @style
end

#text ⇒ Object

The text value in a “text contains” conditional formatting rule. Valid only for type = containsText, notContainsText, beginsWith and endsWith. The default value is null.



57
58
59
 
# File 'lib/aspose_cells_cloud/models/format_condition.rb', line 57

def text
  @text
end

#time_period ⇒ Object

The applicable time period in a “date occurring…” conditional formatting rule. Valid only for type = timePeriod. The default value is TimePeriodType.Today.



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

def time_period
  @time_period
end

#top10 ⇒ Object

Get the conditional formatting’s “Top10” instance. The default instance’s rule highlights cells whose values fall in the top 10 bracket. Valid only for type is Top10.



61
62
63
 
# File 'lib/aspose_cells_cloud/models/format_condition.rb', line 61

def top10
  @top10
end

#type ⇒ Object

Gets and sets whether the conditional format Type.



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

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/aspose_cells_cloud/models/format_condition.rb', line 66

def self.attribute_map
  {
    :'priority' => :'Priority',
    :'type' => :'Type',
    :'stop_if_true' => :'StopIfTrue',
    :'above_average' => :'AboveAverage',
    :'color_scale' => :'ColorScale',
    :'data_bar' => :'DataBar',
    :'formula1' => :'Formula1',
    :'formula2' => :'Formula2',
    :'icon_set' => :'IconSet',
    :'operator' => :'Operator',
    :'style' => :'Style',
    :'text' => :'Text',
    :'time_period' => :'TimePeriod',
    :'top10' => :'Top10',
    :'link' => :'link'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/aspose_cells_cloud/models/format_condition.rb', line 87

def self.swagger_types
  {
    :'priority' => :'Integer',
    :'type' => :'String',
    :'stop_if_true' => :'BOOLEAN',
    :'above_average' => :'AboveAverage',
    :'color_scale' => :'ColorScale',
    :'data_bar' => :'DataBar',
    :'formula1' => :'String',
    :'formula2' => :'String',
    :'icon_set' => :'IconSet',
    :'operator' => :'String',
    :'style' => :'Style',
    :'text' => :'String',
    :'time_period' => :'String',
    :'top10' => :'Top10',
    :'link' => :'Link'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/aspose_cells_cloud/models/format_condition.rb', line 239

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      priority == o.priority &&
      type == o.type &&
      stop_if_true == o.stop_if_true &&
      above_average == o.above_average &&
      color_scale == o.color_scale &&
      data_bar == o.data_bar &&
      formula1 == o.formula1 &&
      formula2 == o.formula2 &&
      icon_set == o.icon_set &&
      operator == o.operator &&
      style == o.style &&
      text == o.text &&
      time_period == o.time_period &&
      top10 == o.top10 &&
      link == o.link 
      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



296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
 
# File 'lib/aspose_cells_cloud/models/format_condition.rb', line 296

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



362
363
364
365
366
367
368
369
370
371
372
373
374
 
# File 'lib/aspose_cells_cloud/models/format_condition.rb', line 362

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



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

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


262
263
264
 
# File 'lib/aspose_cells_cloud/models/format_condition.rb', line 262

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



268
269
270
 
# File 'lib/aspose_cells_cloud/models/format_condition.rb', line 268

def hash
  [ priority , type , stop_if_true , above_average , color_scale , data_bar , formula1 , formula2 , icon_set , operator , style , text , time_period , top10 , link ].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



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
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/aspose_cells_cloud/models/format_condition.rb', line 165

def list_invalid_properties
  invalid_properties = Array.new
  if @priority.nil?
      invalid_properties.push("invalid value for 'priority', priority cannot be nil.")
  end
  if @type.nil?
      invalid_properties.push("invalid value for 'type', type cannot be nil.")
  end
  if @stop_if_true.nil?
      invalid_properties.push("invalid value for 'stop_if_true', stop_if_true cannot be nil.")
  end
  if @above_average.nil?
      invalid_properties.push("invalid value for 'above_average', above_average cannot be nil.")
  end
  if @color_scale.nil?
      invalid_properties.push("invalid value for 'color_scale', color_scale cannot be nil.")
  end
  if @data_bar.nil?
      invalid_properties.push("invalid value for 'data_bar', data_bar cannot be nil.")
  end
  if @formula1.nil?
      invalid_properties.push("invalid value for 'formula1', formula1 cannot be nil.")
  end
  if @formula2.nil?
      invalid_properties.push("invalid value for 'formula2', formula2 cannot be nil.")
  end
  if @icon_set.nil?
      invalid_properties.push("invalid value for 'icon_set', icon_set cannot be nil.")
  end
  if @operator.nil?
      invalid_properties.push("invalid value for 'operator', operator cannot be nil.")
  end
  if @style.nil?
      invalid_properties.push("invalid value for 'style', style cannot be nil.")
  end
  if @text.nil?
      invalid_properties.push("invalid value for 'text', text cannot be nil.")
  end
  if @time_period.nil?
      invalid_properties.push("invalid value for 'time_period', time_period cannot be nil.")
  end
  if @top10.nil?
      invalid_properties.push("invalid value for 'top10', top10 cannot be nil.")
  end
  if @link.nil?
      invalid_properties.push("invalid value for 'link', link 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



342
343
344
 
# File 'lib/aspose_cells_cloud/models/format_condition.rb', line 342

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



348
349
350
351
352
353
354
355
356
 
# File 'lib/aspose_cells_cloud/models/format_condition.rb', line 348

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



336
337
338
 
# File 'lib/aspose_cells_cloud/models/format_condition.rb', line 336

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



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/aspose_cells_cloud/models/format_condition.rb', line 218

def valid?
  return false if @priority.nil?
  return false if @type.nil?
  return false if @stop_if_true.nil?
  return false if @above_average.nil?
  return false if @color_scale.nil?
  return false if @data_bar.nil?
  return false if @formula1.nil?
  return false if @formula2.nil?
  return false if @icon_set.nil?
  return false if @operator.nil?
  return false if @style.nil?
  return false if @text.nil?
  return false if @time_period.nil?
  return false if @top10.nil?
  return false if @link.nil?
  return true
end