Class: AsposeCellsCloud::DataBar

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

Overview

Describe the DataBar conditional formatting rule. This conditional formatting rule displays a gradated data bar in the range of cells.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DataBar

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

  if attributes.has_key?(:'MaxCfvo')
    self.max_cfvo = attributes[:'MaxCfvo']
  end

  if attributes.has_key?(:'Color')
    self.color = attributes[:'Color']
  end

  if attributes.has_key?(:'MinLength')
    self.min_length = attributes[:'MinLength']
  end

  if attributes.has_key?(:'BarFillType')
    self.bar_fill_type = attributes[:'BarFillType']
  end

  if attributes.has_key?(:'MinCfvo')
    self.min_cfvo = attributes[:'MinCfvo']
  end

  if attributes.has_key?(:'AxisPosition')
    self.axis_position = attributes[:'AxisPosition']
  end

  if attributes.has_key?(:'NegativeBarFormat')
    self.negative_bar_format = attributes[:'NegativeBarFormat']
  end

  if attributes.has_key?(:'BarBorder')
    self.bar_border = attributes[:'BarBorder']
  end

  if attributes.has_key?(:'AxisColor')
    self.axis_color = attributes[:'AxisColor']
  end

  if attributes.has_key?(:'MaxLength')
    self.max_length = attributes[:'MaxLength']
  end

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

end

Instance Attribute Details

#axis_color ⇒ Object

Gets the color of the axis for cells with conditional formatting as data bars.



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

def axis_color
  @axis_color
end

#axis_position ⇒ Object

Gets or sets the position of the axis of the data bars specified by a conditional formatting rule.



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

def axis_position
  @axis_position
end

#bar_border ⇒ Object

Gets an object that specifies the border of a data bar.



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

def bar_border
  @bar_border
end

#bar_fill_type ⇒ Object

Gets or sets how a data bar is filled with color.



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

def bar_fill_type
  @bar_fill_type
end

#color ⇒ Object

Get or set this DataBar’s Color.



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

def color
  @color
end

#direction ⇒ Object

Gets or sets the direction the databar is displayed.



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

def direction
  @direction
end

#max_cfvo ⇒ Object

Get or set this DataBar’s max value object. Cannot set null or CFValueObject with type FormatConditionValueType.Min to it.



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

def max_cfvo
  @max_cfvo
end

#max_length ⇒ Object

Represents the max length of data bar .



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

def max_length
  @max_length
end

#min_cfvo ⇒ Object

Get or set this DataBar’s min value object. Cannot set null or CFValueObject with type FormatConditionValueType.Max to it.



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

def min_cfvo
  @min_cfvo
end

#min_length ⇒ Object

Represents the min length of data bar .



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

def min_length
  @min_length
end

#negative_bar_format ⇒ Object

Gets the NegativeBarFormat object associated with a data bar conditional formatting rule.



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

def negative_bar_format
  @negative_bar_format
end

#show_value ⇒ Object

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



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

def show_value
  @show_value
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
 
# File 'lib/aspose_cells_cloud/models/data_bar.rb', line 66

def self.attribute_map
  {
    :'direction' => :'Direction',
    :'max_cfvo' => :'MaxCfvo',
    :'color' => :'Color',
    :'min_length' => :'MinLength',
    :'bar_fill_type' => :'BarFillType',
    :'min_cfvo' => :'MinCfvo',
    :'axis_position' => :'AxisPosition',
    :'negative_bar_format' => :'NegativeBarFormat',
    :'bar_border' => :'BarBorder',
    :'axis_color' => :'AxisColor',
    :'max_length' => :'MaxLength',
    :'show_value' => :'ShowValue'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/aspose_cells_cloud/models/data_bar.rb', line 84

def self.swagger_types
  {
    :'direction' => :'String',
    :'max_cfvo' => :'ConditionalFormattingValue',
    :'color' => :'Color',
    :'min_length' => :'Integer',
    :'bar_fill_type' => :'String',
    :'min_cfvo' => :'ConditionalFormattingValue',
    :'axis_position' => :'String',
    :'negative_bar_format' => :'NegativeBarFormat',
    :'bar_border' => :'DataBarBorder',
    :'axis_color' => :'Color',
    :'max_length' => :'Integer',
    :'show_value' => :'BOOLEAN'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      direction == o.direction &&
      max_cfvo == o.max_cfvo &&
      color == o.color &&
      min_length == o.min_length &&
      bar_fill_type == o.bar_fill_type &&
      min_cfvo == o.min_cfvo &&
      axis_position == o.axis_position &&
      negative_bar_format == o.negative_bar_format &&
      bar_border == o.bar_border &&
      axis_color == o.axis_color &&
      max_length == o.max_length &&
      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



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/data_bar.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/data_bar.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/data_bar.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/data_bar.rb', line 193

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



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

def hash
  [direction, max_cfvo, color, min_length, bar_fill_type, min_cfvo, axis_position, negative_bar_format, bar_border, axis_color, max_length, 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



161
162
163
164
 
# File 'lib/aspose_cells_cloud/models/data_bar.rb', line 161

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



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

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



279
280
281
282
283
284
285
286
287
 
# File 'lib/aspose_cells_cloud/models/data_bar.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_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



267
268
269
 
# File 'lib/aspose_cells_cloud/models/data_bar.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



168
169
170
 
# File 'lib/aspose_cells_cloud/models/data_bar.rb', line 168

def valid?
  return true
end