Class: AsposeSlidesCloud::Series

Inherits:
BaseObject show all
Defined in:
lib/aspose_slides_cloud/models/series.rb

Overview

A chart series.

Direct Known Subclasses

OneValueSeries, XYSeries

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseObject

#_deserialize, #_to_hash, #build_from_hash, #to_body, #to_hash, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ Series

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/aspose_slides_cloud/models/series.rb', line 116

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

  if attributes.has_key?(:'Name')
    self.name = attributes[:'Name']
  end

  if attributes.has_key?(:'DataSourceForSeriesName')
    self.data_source_for_series_name = attributes[:'DataSourceForSeriesName']
  end

  if attributes.has_key?(:'IsColorVaried')
    self.is_color_varied = attributes[:'IsColorVaried']
  end

  if attributes.has_key?(:'InvertedSolidFillColor')
    self.inverted_solid_fill_color = attributes[:'InvertedSolidFillColor']
  end

  if attributes.has_key?(:'Smooth')
    self.smooth = attributes[:'Smooth']
  end

  if attributes.has_key?(:'PlotOnSecondAxis')
    self.plot_on_second_axis = attributes[:'PlotOnSecondAxis']
  end

  if attributes.has_key?(:'Order')
    self.order = attributes[:'Order']
  end

  if attributes.has_key?(:'InvertIfNegative')
    self.invert_if_negative = attributes[:'InvertIfNegative']
  end

  if attributes.has_key?(:'Explosion')
    self.explosion = attributes[:'Explosion']
  end

  if attributes.has_key?(:'Marker')
    self.marker = attributes[:'Marker']
  end

  if attributes.has_key?(:'FillFormat')
    self.fill_format = attributes[:'FillFormat']
  end

  if attributes.has_key?(:'EffectFormat')
    self.effect_format = attributes[:'EffectFormat']
  end

  if attributes.has_key?(:'LineFormat')
    self.line_format = attributes[:'LineFormat']
  end

  if attributes.has_key?(:'DataPointType')
    self.data_point_type = attributes[:'DataPointType']
  end
end

Instance Attribute Details

#data_point_type ⇒ Object

Returns the value of attribute data_point_type.



70
71
72
 
# File 'lib/aspose_slides_cloud/models/series.rb', line 70

def data_point_type
  @data_point_type
end

#data_source_for_series_name ⇒ Object

Series name data source.



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

def data_source_for_series_name
  @data_source_for_series_name
end

#effect_format ⇒ Object

Effect properties set for the series.



65
66
67
 
# File 'lib/aspose_slides_cloud/models/series.rb', line 65

def effect_format
  @effect_format
end

#explosion ⇒ Object

The distance of an open pie slice from the center of the pie chart is expressed as a percentage of the pie diameter.



56
57
58
 
# File 'lib/aspose_slides_cloud/models/series.rb', line 56

def explosion
  @explosion
end

#fill_format ⇒ Object

Fill properties set for the series.



62
63
64
 
# File 'lib/aspose_slides_cloud/models/series.rb', line 62

def fill_format
  @fill_format
end

#invert_if_negative ⇒ Object

True if the series shall invert its colors if the value is negative. Applies to bar, column and bubble series.



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

def invert_if_negative
  @invert_if_negative
end

#inverted_solid_fill_color ⇒ Object

Invert solid color for the series.



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

def inverted_solid_fill_color
  @inverted_solid_fill_color
end

#is_color_varied ⇒ Object

True if each data marker in the series has a different color.



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

def is_color_varied
  @is_color_varied
end

#line_format ⇒ Object

Line properties set for the series.



68
69
70
 
# File 'lib/aspose_slides_cloud/models/series.rb', line 68

def line_format
  @line_format
end

#marker ⇒ Object

Series marker.



59
60
61
 
# File 'lib/aspose_slides_cloud/models/series.rb', line 59

def marker
  @marker
end

#name ⇒ Object

Series name.



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

def name
  @name
end

#order ⇒ Object

Series order.



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

def order
  @order
end

#plot_on_second_axis ⇒ Object

True if the series is plotted on second value axis.



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

def plot_on_second_axis
  @plot_on_second_axis
end

#smooth ⇒ Object

True if curve smoothing is turned on. Applies only to line and scatter connected by lines charts.



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

def smooth
  @smooth
end

#type ⇒ Object

Series type.



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

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/aspose_slides_cloud/models/series.rb', line 73

def self.attribute_map
  {
    :'type' => :'Type',
    :'name' => :'Name',
    :'data_source_for_series_name' => :'DataSourceForSeriesName',
    :'is_color_varied' => :'IsColorVaried',
    :'inverted_solid_fill_color' => :'InvertedSolidFillColor',
    :'smooth' => :'Smooth',
    :'plot_on_second_axis' => :'PlotOnSecondAxis',
    :'order' => :'Order',
    :'invert_if_negative' => :'InvertIfNegative',
    :'explosion' => :'Explosion',
    :'marker' => :'Marker',
    :'fill_format' => :'FillFormat',
    :'effect_format' => :'EffectFormat',
    :'line_format' => :'LineFormat',
    :'data_point_type' => :'DataPointType',
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/aspose_slides_cloud/models/series.rb', line 94

def self.swagger_types
  {
    :'type' => :'String',
    :'name' => :'String',
    :'data_source_for_series_name' => :'DataSource',
    :'is_color_varied' => :'BOOLEAN',
    :'inverted_solid_fill_color' => :'String',
    :'smooth' => :'BOOLEAN',
    :'plot_on_second_axis' => :'BOOLEAN',
    :'order' => :'Integer',
    :'invert_if_negative' => :'BOOLEAN',
    :'explosion' => :'Integer',
    :'marker' => :'SeriesMarker',
    :'fill_format' => :'FillFormat',
    :'effect_format' => :'EffectFormat',
    :'line_format' => :'LineFormat',
    :'data_point_type' => :'String',
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/aspose_slides_cloud/models/series.rb', line 222

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
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


244
245
246
 
# File 'lib/aspose_slides_cloud/models/series.rb', line 244

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



250
251
252
 
# File 'lib/aspose_slides_cloud/models/series.rb', line 250

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].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



185
186
187
188
 
# File 'lib/aspose_slides_cloud/models/series.rb', line 185

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



192
193
194
195
196
197
198
 
# File 'lib/aspose_slides_cloud/models/series.rb', line 192

def valid?
  type_validator = EnumAttributeValidator.new('String', ['ClusteredColumn', 'StackedColumn', 'PercentsStackedColumn', 'ClusteredColumn3D', 'StackedColumn3D', 'PercentsStackedColumn3D', 'Column3D', 'ClusteredCylinder', 'StackedCylinder', 'PercentsStackedCylinder', 'Cylinder3D', 'ClusteredCone', 'StackedCone', 'PercentsStackedCone', 'Cone3D', 'ClusteredPyramid', 'StackedPyramid', 'PercentsStackedPyramid', 'Pyramid3D', 'Line', 'StackedLine', 'PercentsStackedLine', 'LineWithMarkers', 'StackedLineWithMarkers', 'PercentsStackedLineWithMarkers', 'Line3D', 'Pie', 'Pie3D', 'PieOfPie', 'ExplodedPie', 'ExplodedPie3D', 'BarOfPie', 'PercentsStackedBar', 'ClusteredBar3D', 'ClusteredBar', 'StackedBar', 'StackedBar3D', 'PercentsStackedBar3D', 'ClusteredHorizontalCylinder', 'StackedHorizontalCylinder', 'PercentsStackedHorizontalCylinder', 'ClusteredHorizontalCone', 'StackedHorizontalCone', 'PercentsStackedHorizontalCone', 'ClusteredHorizontalPyramid', 'StackedHorizontalPyramid', 'PercentsStackedHorizontalPyramid', 'Area', 'StackedArea', 'PercentsStackedArea', 'Area3D', 'StackedArea3D', 'PercentsStackedArea3D', 'ScatterWithMarkers', 'ScatterWithSmoothLinesAndMarkers', 'ScatterWithSmoothLines', 'ScatterWithStraightLinesAndMarkers', 'ScatterWithStraightLines', 'HighLowClose', 'OpenHighLowClose', 'VolumeHighLowClose', 'VolumeOpenHighLowClose', 'Surface3D', 'WireframeSurface3D', 'Contour', 'WireframeContour', 'Doughnut', 'ExplodedDoughnut', 'Bubble', 'BubbleWith3D', 'Radar', 'RadarWithMarkers', 'FilledRadar', 'SeriesOfMixedTypes', 'Treemap', 'Sunburst', 'Histogram', 'ParetoLine', 'BoxAndWhisker', 'Waterfall', 'Funnel', 'Map'])
  return false unless type_validator.valid?(@type)
  data_point_type_validator = EnumAttributeValidator.new('String', ['OneValue', 'Scatter', 'Bubble'])
  return false unless data_point_type_validator.valid?(@data_point_type)
  true
end