Class: AsposeSlidesCloud::OneValueSeries

Inherits:
Series
  • Object
show all
Defined in:
lib/aspose_slides_cloud/models/one_value_series.rb

Overview

One value series.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Attributes inherited from Series

#data_point_type, #data_source_for_series_name, #effect_format, #explosion, #fill_format, #invert_if_negative, #inverted_solid_fill_color, #is_color_varied, #line_format, #marker, #name, #order, #plot_on_second_axis, #smooth, #type

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OneValueSeries

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
 
# File 'lib/aspose_slides_cloud/models/one_value_series.rb', line 109

def initialize(attributes = {})
  super

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

  if attributes.has_key?(:'NumberFormatOfValues')
    self.number_format_of_values = attributes[:'NumberFormatOfValues']
  end

  if attributes.has_key?(:'DataSourceForValues')
    self.data_source_for_values = attributes[:'DataSourceForValues']
  end

  if attributes.has_key?(:'ShowConnectorLines')
    self.show_connector_lines = attributes[:'ShowConnectorLines']
  end

  if attributes.has_key?(:'QuartileMethod')
    self.quartile_method = attributes[:'QuartileMethod']
  end

  if attributes.has_key?(:'ShowInnerPoints')
    self.show_inner_points = attributes[:'ShowInnerPoints']
  end

  if attributes.has_key?(:'ShowMeanLine')
    self.show_mean_line = attributes[:'ShowMeanLine']
  end

  if attributes.has_key?(:'ShowMeanMarkers')
    self.show_mean_markers = attributes[:'ShowMeanMarkers']
  end

  if attributes.has_key?(:'ShowOutlierPoints')
    self.show_outlier_points = attributes[:'ShowOutlierPoints']
  end
  self.data_point_type = 'OneValue'
end

Instance Attribute Details

#data_points ⇒ Object

Gets or sets the values.



29
30
31
 
# File 'lib/aspose_slides_cloud/models/one_value_series.rb', line 29

def data_points
  @data_points
end

#data_source_for_values ⇒ Object

Data source type for values.



35
36
37
 
# File 'lib/aspose_slides_cloud/models/one_value_series.rb', line 35

def data_source_for_values
  @data_source_for_values
end

#number_format_of_values ⇒ Object

The number format for the series values.



32
33
34
 
# File 'lib/aspose_slides_cloud/models/one_value_series.rb', line 32

def number_format_of_values
  @number_format_of_values
end

#quartile_method ⇒ Object

Quartile method. Applied to BoxAndWhisker series only.



41
42
43
 
# File 'lib/aspose_slides_cloud/models/one_value_series.rb', line 41

def quartile_method
  @quartile_method
end

#show_connector_lines ⇒ Object

True if inner points are shown. Applied to Waterfall series only.



38
39
40
 
# File 'lib/aspose_slides_cloud/models/one_value_series.rb', line 38

def show_connector_lines
  @show_connector_lines
end

#show_inner_points ⇒ Object

True if inner points are shown. Applied to BoxAndWhisker series only.



44
45
46
 
# File 'lib/aspose_slides_cloud/models/one_value_series.rb', line 44

def show_inner_points
  @show_inner_points
end

#show_mean_line ⇒ Object

True if mean line is shown. Applied to BoxAndWhisker series only.



47
48
49
 
# File 'lib/aspose_slides_cloud/models/one_value_series.rb', line 47

def show_mean_line
  @show_mean_line
end

#show_mean_markers ⇒ Object

True if mean markers are shown. Applied to BoxAndWhisker series only.



50
51
52
 
# File 'lib/aspose_slides_cloud/models/one_value_series.rb', line 50

def show_mean_markers
  @show_mean_markers
end

#show_outlier_points ⇒ Object

True if outlier points are shown. Applied to BoxAndWhisker series only.



53
54
55
 
# File 'lib/aspose_slides_cloud/models/one_value_series.rb', line 53

def show_outlier_points
  @show_outlier_points
end

Class Method Details

.attribute_map ⇒ Object

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



78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/aspose_slides_cloud/models/one_value_series.rb', line 78

def self.attribute_map
  super.merge({
    :'data_points' => :'DataPoints',
    :'number_format_of_values' => :'NumberFormatOfValues',
    :'data_source_for_values' => :'DataSourceForValues',
    :'show_connector_lines' => :'ShowConnectorLines',
    :'quartile_method' => :'QuartileMethod',
    :'show_inner_points' => :'ShowInnerPoints',
    :'show_mean_line' => :'ShowMeanLine',
    :'show_mean_markers' => :'ShowMeanMarkers',
    :'show_outlier_points' => :'ShowOutlierPoints',
  })
end

.swagger_types ⇒ Object

Attribute type mapping.



93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/aspose_slides_cloud/models/one_value_series.rb', line 93

def self.swagger_types
  super.merge({
    :'data_points' => :'Array<OneValueChartDataPoint>',
    :'number_format_of_values' => :'String',
    :'data_source_for_values' => :'DataSource',
    :'show_connector_lines' => :'BOOLEAN',
    :'quartile_method' => :'String',
    :'show_inner_points' => :'BOOLEAN',
    :'show_mean_line' => :'BOOLEAN',
    :'show_mean_markers' => :'BOOLEAN',
    :'show_outlier_points' => :'BOOLEAN',
  })
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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_slides_cloud/models/one_value_series.rb', line 180

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      type == o.type &&
      name == o.name &&
      data_source_for_series_name == o.data_source_for_series_name &&
      is_color_varied == o.is_color_varied &&
      inverted_solid_fill_color == o.inverted_solid_fill_color &&
      smooth == o.smooth &&
      plot_on_second_axis == o.plot_on_second_axis &&
      order == o.order &&
      invert_if_negative == o.invert_if_negative &&
      explosion == o.explosion &&
      marker == o.marker &&
      fill_format == o.fill_format &&
      effect_format == o.effect_format &&
      line_format == o.line_format &&
      data_point_type == o.data_point_type &&
      data_points == o.data_points &&
      number_format_of_values == o.number_format_of_values &&
      data_source_for_values == o.data_source_for_values &&
      show_connector_lines == o.show_connector_lines &&
      quartile_method == o.quartile_method &&
      show_inner_points == o.show_inner_points &&
      show_mean_line == o.show_mean_line &&
      show_mean_markers == o.show_mean_markers &&
      show_outlier_points == o.show_outlier_points
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



257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/aspose_slides_cloud/models/one_value_series.rb', line 257

def _deserialize(type, value)
  if value.nil?
    nil
  else
    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
      registry_type = AsposeSlidesCloud::TypeRegistry.get_type(type.to_s, value)
      if registry_type
        type = registry_type
      end
      temp_model = AsposeSlidesCloud.const_get(type).new
      temp_model.build_from_hash(value)
    end
  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



331
332
333
334
335
336
337
338
339
340
341
342
343
 
# File 'lib/aspose_slides_cloud/models/one_value_series.rb', line 331

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



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
249
250
251
 
# File 'lib/aspose_slides_cloud/models/one_value_series.rb', line 224

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    mapKey = self.class.attribute_map[key]
    if !mapKey.nil?
      val = attributes[mapKey]
      if val.nil?
        mapKeyString = mapKey.to_s
        mapKeyString[0] = mapKeyString[0].downcase
        mapKey = mapKeyString.to_sym
        val = attributes[mapKey]
      end
      if !val.nil?
        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 val.is_a?(Array)
            self.send("#{key}=", val.map { |v| _deserialize($1, v) })
          end
        else
          self.send("#{key}=", _deserialize(type, val))
        end
      end
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


211
212
213
 
# File 'lib/aspose_slides_cloud/models/one_value_series.rb', line 211

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



217
218
219
 
# File 'lib/aspose_slides_cloud/models/one_value_series.rb', line 217

def hash
  [type, name, data_source_for_series_name, is_color_varied, inverted_solid_fill_color, smooth, plot_on_second_axis, order, invert_if_negative, explosion, marker, fill_format, effect_format, line_format, data_point_type, data_points, number_format_of_values, data_source_for_values, show_connector_lines, quartile_method, show_inner_points, show_mean_line, show_mean_markers, show_outlier_points].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



154
155
156
157
 
# File 'lib/aspose_slides_cloud/models/one_value_series.rb', line 154

def list_invalid_properties
  invalid_properties = super
  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



311
312
313
 
# File 'lib/aspose_slides_cloud/models/one_value_series.rb', line 311

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



317
318
319
320
321
322
323
324
325
 
# File 'lib/aspose_slides_cloud/models/one_value_series.rb', line 317

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



305
306
307
 
# File 'lib/aspose_slides_cloud/models/one_value_series.rb', line 305

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



161
162
163
164
165
166
 
# File 'lib/aspose_slides_cloud/models/one_value_series.rb', line 161

def valid?
  return false if !super
  quartile_method_validator = EnumAttributeValidator.new('String', ['Exclusive', 'Inclusive'])
  return false unless quartile_method_validator.valid?(@quartile_method)
  true
end