class AsposeSlidesCloud::ChartSeriesGroup

Chart series group. Defines common properties for a group of series.

Attributes

bubble_size_representation[RW]

Specifies how the bubble size values are represented on the bubble chart. Read/write BubbleSizeRepresentationType.

bubble_size_scale[RW]

Specifies the scale factor for the bubble chart (can be between 0 and 300 percents of the default size). Read/write Int32.

doughnut_hole_size[RW]

Specifies the size of the hole in a doughnut chart (can be between 10 and 90 percents of the size of the plot area.).

first_slice_angle[RW]

Gets or sets the angle of the first pie or doughnut chart slice, in degrees (clockwise from up, from 0 to 360 degrees).

gap_depth[RW]

Returns or sets the distance, as a percentage of the marker width, between the data series in a 3D chart.

gap_width[RW]

Specifies the space between bar or column clusters, as a percentage of the bar or column width.

has_series_lines[RW]

True if chart has series lines. Applied to stacked bar and OfPie charts.

hi_low_lines_format[RW]

Specifies HiLowLines format. HiLowLines applied with HiLowClose, OpenHiLowClose, VolumeHiLowClose and VolumeOpenHiLowClose chart types.

is_color_varied[RW]

Specifies that each data marker in the series has a different color.

overlap[RW]

Specifies how much bars and columns shall overlap on 2-D charts (from -100 to 100).

pie_split_by[RW]

Specifies how to determine which data points are in the second pie or bar on a pie-of-pie or bar-of-pie chart.

pie_split_position[RW]

Specifies a value that shall be used to determine which data points are in the second pie or bar on a pie-of-pie or bar-of-pie chart. Is used together with PieSplitBy property.

second_pie_size[RW]

Specifies the size of the second pie or bar of a pie-of-pie chart or a bar-of-pie chart, as a percentage of the size of the first pie (can be between 5 and 200 percents).

type[RW]

Returns a type of this series group.

Public Class Methods

attribute_map() click to toggle source

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

# File lib/aspose_slides_cloud/models/chart_series_group.rb, line 71
def self.attribute_map
  {
    :'type' => :'Type',
    :'gap_width' => :'GapWidth',
    :'gap_depth' => :'GapDepth',
    :'first_slice_angle' => :'FirstSliceAngle',
    :'is_color_varied' => :'IsColorVaried',
    :'has_series_lines' => :'HasSeriesLines',
    :'overlap' => :'Overlap',
    :'second_pie_size' => :'SecondPieSize',
    :'pie_split_position' => :'PieSplitPosition',
    :'pie_split_by' => :'PieSplitBy',
    :'doughnut_hole_size' => :'DoughnutHoleSize',
    :'bubble_size_scale' => :'BubbleSizeScale',
    :'hi_low_lines_format' => :'HiLowLinesFormat',
    :'bubble_size_representation' => :'BubbleSizeRepresentation',
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/aspose_slides_cloud/models/chart_series_group.rb, line 112
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?(:'GapWidth')
    self.gap_width = attributes[:'GapWidth']
  end

  if attributes.has_key?(:'GapDepth')
    self.gap_depth = attributes[:'GapDepth']
  end

  if attributes.has_key?(:'FirstSliceAngle')
    self.first_slice_angle = attributes[:'FirstSliceAngle']
  end

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

  if attributes.has_key?(:'HasSeriesLines')
    self.has_series_lines = attributes[:'HasSeriesLines']
  end

  if attributes.has_key?(:'Overlap')
    self.overlap = attributes[:'Overlap']
  end

  if attributes.has_key?(:'SecondPieSize')
    self.second_pie_size = attributes[:'SecondPieSize']
  end

  if attributes.has_key?(:'PieSplitPosition')
    self.pie_split_position = attributes[:'PieSplitPosition']
  end

  if attributes.has_key?(:'PieSplitBy')
    self.pie_split_by = attributes[:'PieSplitBy']
  end

  if attributes.has_key?(:'DoughnutHoleSize')
    self.doughnut_hole_size = attributes[:'DoughnutHoleSize']
  end

  if attributes.has_key?(:'BubbleSizeScale')
    self.bubble_size_scale = attributes[:'BubbleSizeScale']
  end

  if attributes.has_key?(:'HiLowLinesFormat')
    self.hi_low_lines_format = attributes[:'HiLowLinesFormat']
  end

  if attributes.has_key?(:'BubbleSizeRepresentation')
    self.bubble_size_representation = attributes[:'BubbleSizeRepresentation']
  end
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/aspose_slides_cloud/models/chart_series_group.rb, line 91
def self.swagger_types
  {
    :'type' => :'String',
    :'gap_width' => :'Integer',
    :'gap_depth' => :'Integer',
    :'first_slice_angle' => :'Integer',
    :'is_color_varied' => :'BOOLEAN',
    :'has_series_lines' => :'BOOLEAN',
    :'overlap' => :'Integer',
    :'second_pie_size' => :'Integer',
    :'pie_split_position' => :'Float',
    :'pie_split_by' => :'String',
    :'doughnut_hole_size' => :'Integer',
    :'bubble_size_scale' => :'Integer',
    :'hi_low_lines_format' => :'ChartLinesFormat',
    :'bubble_size_representation' => :'String',
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/aspose_slides_cloud/models/chart_series_group.rb, line 226
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      type == o.type &&
      gap_width == o.gap_width &&
      gap_depth == o.gap_depth &&
      first_slice_angle == o.first_slice_angle &&
      is_color_varied == o.is_color_varied &&
      has_series_lines == o.has_series_lines &&
      overlap == o.overlap &&
      second_pie_size == o.second_pie_size &&
      pie_split_position == o.pie_split_position &&
      pie_split_by == o.pie_split_by &&
      doughnut_hole_size == o.doughnut_hole_size &&
      bubble_size_scale == o.bubble_size_scale &&
      hi_low_lines_format == o.hi_low_lines_format &&
      bubble_size_representation == o.bubble_size_representation
end
bubble_size_representation=(bubble_size_representation) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] bubble_size_representation Object to be assigned

# File lib/aspose_slides_cloud/models/chart_series_group.rb, line 216
def bubble_size_representation=(bubble_size_representation)
  validator = EnumAttributeValidator.new('String', ['Area', 'Width'])
  unless validator.valid?(bubble_size_representation)
    fail ArgumentError, 'invalid value for "bubble_size_representation", must be one of #{validator.allowable_values}.'
  end
  @bubble_size_representation = bubble_size_representation
end
eql?(o) click to toggle source

@see the ‘==` method @param [Object] Object to be compared

# File lib/aspose_slides_cloud/models/chart_series_group.rb, line 247
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/aspose_slides_cloud/models/chart_series_group.rb, line 253
def hash
  [type, gap_width, gap_depth, first_slice_angle, is_color_varied, has_series_lines, overlap, second_pie_size, pie_split_position, pie_split_by, doughnut_hole_size, bubble_size_scale, hi_low_lines_format, bubble_size_representation].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/aspose_slides_cloud/models/chart_series_group.rb, line 177
def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end
pie_split_by=(pie_split_by) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] pie_split_by Object to be assigned

# File lib/aspose_slides_cloud/models/chart_series_group.rb, line 206
def pie_split_by=(pie_split_by)
  validator = EnumAttributeValidator.new('String', ['Default', 'Custom', 'ByPercentage', 'ByPos', 'ByValue'])
  unless validator.valid?(pie_split_by)
    fail ArgumentError, 'invalid value for "pie_split_by", must be one of #{validator.allowable_values}.'
  end
  @pie_split_by = pie_split_by
end
type=(type) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] type Object to be assigned

# File lib/aspose_slides_cloud/models/chart_series_group.rb, line 196
def type=(type)
  validator = EnumAttributeValidator.new('String', ['BarOfPieChart', 'PieOfPieChart', 'DoughnutChart', 'PieChart', 'AreaChartArea', 'AreaChartPercentsStackedArea', 'AreaChartStackedArea', 'BarChartHorizClustered', 'BarChartHorizStacked', 'BarChartHorizPercentsStacked', 'BarChartVertClustered', 'BarChartVertStacked', 'BarChartVertPercentsStacked', 'LineChartLine', 'LineChartStackedLine', 'LineChartPercentsStackedLine', 'RadarChart', 'FilledRadarChart', 'StockHighLowClose', 'StockOpenHighLowClose', 'StockVolumeHighLowClose', 'StockVolumeOpenHighLowClose', 'ScatterStraightMarker', 'ScatterSmoothMarker', 'AreaChartArea3D', 'AreaChartStackedArea3D', 'AreaChartPercentsStackedArea3D', 'Line3DChart', 'Pie3DChart', 'Bar3DChartVert', 'Bar3DChartVertClustered', 'Bar3DChartVertPercentsStackedColumn3D', 'Bar3DChartVertPercentsStackedCone', 'Bar3DChartVertPercentsStackedCylinder', 'Bar3DChartVertPercentsStackedPyramid', 'Bar3DChartVertStackedColumn3D', 'Bar3DChartVertStackedCone', 'Bar3DChartVertStackedCylinder', 'Bar3DChartVertStackedPyramid', 'Bar3DChartHorizClustered', 'Bar3DChartHorizStackedBar3D', 'Bar3DChartHorizStackedCone', 'Bar3DChartHorizStackedCylinder', 'Bar3DChartHorizStackedPyramid', 'Bar3DChartHorizPercentsStackedBar3D', 'Bar3DChartHorizPercentsStackedCone', 'Bar3DChartHorizPercentsStackedCylinder', 'Bar3DChartHorizPercentsStackedPyramid', 'SurfaceChartContour', 'SurfaceChartWireframeContour', 'SurfaceChartSurface3D', 'SurfaceChartWireframeSurface3D', 'BubbleChart', 'HistogramChart', 'ParetoLineChart', 'BoxAndWhiskerChart', 'WaterfallChart', 'FunnelChart', 'TreemapChart', 'MapChart', 'SunburstChart'])
  unless validator.valid?(type)
    fail ArgumentError, 'invalid value for "type", must be one of #{validator.allowable_values}.'
  end
  @type = type
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/aspose_slides_cloud/models/chart_series_group.rb, line 184
def valid?
  type_validator = EnumAttributeValidator.new('String', ['BarOfPieChart', 'PieOfPieChart', 'DoughnutChart', 'PieChart', 'AreaChartArea', 'AreaChartPercentsStackedArea', 'AreaChartStackedArea', 'BarChartHorizClustered', 'BarChartHorizStacked', 'BarChartHorizPercentsStacked', 'BarChartVertClustered', 'BarChartVertStacked', 'BarChartVertPercentsStacked', 'LineChartLine', 'LineChartStackedLine', 'LineChartPercentsStackedLine', 'RadarChart', 'FilledRadarChart', 'StockHighLowClose', 'StockOpenHighLowClose', 'StockVolumeHighLowClose', 'StockVolumeOpenHighLowClose', 'ScatterStraightMarker', 'ScatterSmoothMarker', 'AreaChartArea3D', 'AreaChartStackedArea3D', 'AreaChartPercentsStackedArea3D', 'Line3DChart', 'Pie3DChart', 'Bar3DChartVert', 'Bar3DChartVertClustered', 'Bar3DChartVertPercentsStackedColumn3D', 'Bar3DChartVertPercentsStackedCone', 'Bar3DChartVertPercentsStackedCylinder', 'Bar3DChartVertPercentsStackedPyramid', 'Bar3DChartVertStackedColumn3D', 'Bar3DChartVertStackedCone', 'Bar3DChartVertStackedCylinder', 'Bar3DChartVertStackedPyramid', 'Bar3DChartHorizClustered', 'Bar3DChartHorizStackedBar3D', 'Bar3DChartHorizStackedCone', 'Bar3DChartHorizStackedCylinder', 'Bar3DChartHorizStackedPyramid', 'Bar3DChartHorizPercentsStackedBar3D', 'Bar3DChartHorizPercentsStackedCone', 'Bar3DChartHorizPercentsStackedCylinder', 'Bar3DChartHorizPercentsStackedPyramid', 'SurfaceChartContour', 'SurfaceChartWireframeContour', 'SurfaceChartSurface3D', 'SurfaceChartWireframeSurface3D', 'BubbleChart', 'HistogramChart', 'ParetoLineChart', 'BoxAndWhiskerChart', 'WaterfallChart', 'FunnelChart', 'TreemapChart', 'MapChart', 'SunburstChart'])
  return false unless type_validator.valid?(@type)
  pie_split_by_validator = EnumAttributeValidator.new('String', ['Default', 'Custom', 'ByPercentage', 'ByPos', 'ByValue'])
  return false unless pie_split_by_validator.valid?(@pie_split_by)
  bubble_size_representation_validator = EnumAttributeValidator.new('String', ['Area', 'Width'])
  return false unless bubble_size_representation_validator.valid?(@bubble_size_representation)
  true
end