class AsposeCellsCloud::Axis
Attributes
Gets the .
Represents if the value axis crosses the category axis between categories.
Gets the appearance of an Axis
.
Represents the base unit scale for the category axis.
Represents the category axis type.
Represents the point on the value axis where the category axis crosses it.
Represents the on the specified axis where the other axis crosses.
Represents the unit label for the specified axis.
Represents a unit label on an axis in the specified chart. Unit labels are useful for charting large values— for example, in the millions or billions.
Indicates whether the labels shall be shown as multi level.
Indicates whether the major unit of the axis is automatically assigned.
Indicates whether the max value is automatically assigned.
Indicates whether the min value is automatically assigned.
Indicates whether the minor unit of the axis is automatically assigned.
Represents if the display unit label is shown on the specified axis.
Represents if the value axis scale type is logarithmic or not.
Represents if Microsoft Excel plots data points from last to first.
Represents if the axis is visible.
Represents the logarithmic base. Default value is 10.Only applies for Excel2007.
Represents major gridlines on a chart axis.
Represents the type of major tick mark for the specified axis.
Represents the major units for the axis.
Represents the major unit scale for the category axis.
Represents the maximum value on the value axis.
Represents the minimum value on the value axis.
Represents minor gridlines on a chart axis.
Represents the type of minor tick mark for the specified axis.
Represents the minor units for the axis.
Represents the major unit scale for the category axis.
Represents the position of tick-mark labels on the specified axis.
Represents the number of categories or series between tick-mark labels. Applies only to category and series axes.
Returns a object that represents the tick-mark labels for the specified axis.
Returns or sets the number of categories or series between tick marks. Applies only to category and series axes.
Gets the axis’ title.
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/aspose_cells_cloud/models/axis.rb, line 106 def self.attribute_map { :'area' => :'Area', :'axis_between_categories' => :'AxisBetweenCategories', :'axis_line' => :'AxisLine', :'base_unit_scale' => :'BaseUnitScale', :'category_type' => :'CategoryType', :'cross_at' => :'CrossAt', :'cross_type' => :'CrossType', :'display_unit' => :'DisplayUnit', :'display_unit_label' => :'DisplayUnitLabel', :'has_multi_level_labels' => :'HasMultiLevelLabels', :'is_automatic_major_unit' => :'IsAutomaticMajorUnit', :'is_automatic_max_value' => :'IsAutomaticMaxValue', :'is_automatic_minor_unit' => :'IsAutomaticMinorUnit', :'is_automatic_min_value' => :'IsAutomaticMinValue', :'is_display_unit_label_shown' => :'IsDisplayUnitLabelShown', :'is_logarithmic' => :'IsLogarithmic', :'is_plot_order_reversed' => :'IsPlotOrderReversed', :'is_visible' => :'IsVisible', :'log_base' => :'LogBase', :'major_grid_lines' => :'MajorGridLines', :'major_tick_mark' => :'MajorTickMark', :'major_unit' => :'MajorUnit', :'major_unit_scale' => :'MajorUnitScale', :'max_value' => :'MaxValue', :'minor_grid_lines' => :'MinorGridLines', :'minor_tick_mark' => :'MinorTickMark', :'minor_unit' => :'MinorUnit', :'minor_unit_scale' => :'MinorUnitScale', :'min_value' => :'MinValue', :'tick_label_position' => :'TickLabelPosition', :'tick_labels' => :'TickLabels', :'tick_label_spacing' => :'TickLabelSpacing', :'tick_mark_spacing' => :'TickMarkSpacing', :'title' => :'Title', :'link' => :'link' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/aspose_cells_cloud/models/axis.rb, line 189 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?(:'Area') self.area = attributes[:'Area'] end if attributes.has_key?(:'AxisBetweenCategories') self.axis_between_categories = attributes[:'AxisBetweenCategories'] end if attributes.has_key?(:'AxisLine') self.axis_line = attributes[:'AxisLine'] end if attributes.has_key?(:'BaseUnitScale') self.base_unit_scale = attributes[:'BaseUnitScale'] end if attributes.has_key?(:'CategoryType') self.category_type = attributes[:'CategoryType'] end if attributes.has_key?(:'CrossAt') self.cross_at = attributes[:'CrossAt'] end if attributes.has_key?(:'CrossType') self.cross_type = attributes[:'CrossType'] end if attributes.has_key?(:'DisplayUnit') self.display_unit = attributes[:'DisplayUnit'] end if attributes.has_key?(:'DisplayUnitLabel') self.display_unit_label = attributes[:'DisplayUnitLabel'] end if attributes.has_key?(:'HasMultiLevelLabels') self.has_multi_level_labels = attributes[:'HasMultiLevelLabels'] end if attributes.has_key?(:'IsAutomaticMajorUnit') self.is_automatic_major_unit = attributes[:'IsAutomaticMajorUnit'] end if attributes.has_key?(:'IsAutomaticMaxValue') self.is_automatic_max_value = attributes[:'IsAutomaticMaxValue'] end if attributes.has_key?(:'IsAutomaticMinorUnit') self.is_automatic_minor_unit = attributes[:'IsAutomaticMinorUnit'] end if attributes.has_key?(:'IsAutomaticMinValue') self.is_automatic_min_value = attributes[:'IsAutomaticMinValue'] end if attributes.has_key?(:'IsDisplayUnitLabelShown') self.is_display_unit_label_shown = attributes[:'IsDisplayUnitLabelShown'] end if attributes.has_key?(:'IsLogarithmic') self.is_logarithmic = attributes[:'IsLogarithmic'] end if attributes.has_key?(:'IsPlotOrderReversed') self.is_plot_order_reversed = attributes[:'IsPlotOrderReversed'] end if attributes.has_key?(:'IsVisible') self.is_visible = attributes[:'IsVisible'] end if attributes.has_key?(:'LogBase') self.log_base = attributes[:'LogBase'] end if attributes.has_key?(:'MajorGridLines') self.major_grid_lines = attributes[:'MajorGridLines'] end if attributes.has_key?(:'MajorTickMark') self.major_tick_mark = attributes[:'MajorTickMark'] end if attributes.has_key?(:'MajorUnit') self.major_unit = attributes[:'MajorUnit'] end if attributes.has_key?(:'MajorUnitScale') self.major_unit_scale = attributes[:'MajorUnitScale'] end if attributes.has_key?(:'MaxValue') self.max_value = attributes[:'MaxValue'] end if attributes.has_key?(:'MinorGridLines') self.minor_grid_lines = attributes[:'MinorGridLines'] end if attributes.has_key?(:'MinorTickMark') self.minor_tick_mark = attributes[:'MinorTickMark'] end if attributes.has_key?(:'MinorUnit') self.minor_unit = attributes[:'MinorUnit'] end if attributes.has_key?(:'MinorUnitScale') self.minor_unit_scale = attributes[:'MinorUnitScale'] end if attributes.has_key?(:'MinValue') self.min_value = attributes[:'MinValue'] end if attributes.has_key?(:'TickLabelPosition') self.tick_label_position = attributes[:'TickLabelPosition'] end if attributes.has_key?(:'TickLabels') self.tick_labels = attributes[:'TickLabels'] end if attributes.has_key?(:'TickLabelSpacing') self.tick_label_spacing = attributes[:'TickLabelSpacing'] end if attributes.has_key?(:'TickMarkSpacing') self.tick_mark_spacing = attributes[:'TickMarkSpacing'] end if attributes.has_key?(:'Title') self.title = attributes[:'Title'] end if attributes.has_key?(:'link') self.link = attributes[:'link'] end end
Attribute type mapping.
# File lib/aspose_cells_cloud/models/axis.rb, line 147 def self.swagger_types { :'area' => :'Area', :'axis_between_categories' => :'BOOLEAN', :'axis_line' => :'Line', :'base_unit_scale' => :'String', :'category_type' => :'String', :'cross_at' => :'Float', :'cross_type' => :'String', :'display_unit' => :'String', :'display_unit_label' => :'DisplayUnitLabel', :'has_multi_level_labels' => :'BOOLEAN', :'is_automatic_major_unit' => :'BOOLEAN', :'is_automatic_max_value' => :'BOOLEAN', :'is_automatic_minor_unit' => :'BOOLEAN', :'is_automatic_min_value' => :'BOOLEAN', :'is_display_unit_label_shown' => :'BOOLEAN', :'is_logarithmic' => :'BOOLEAN', :'is_plot_order_reversed' => :'BOOLEAN', :'is_visible' => :'BOOLEAN', :'log_base' => :'Float', :'major_grid_lines' => :'Line', :'major_tick_mark' => :'String', :'major_unit' => :'Float', :'major_unit_scale' => :'String', :'max_value' => :'Float', :'minor_grid_lines' => :'Line', :'minor_tick_mark' => :'String', :'minor_unit' => :'Float', :'minor_unit_scale' => :'String', :'min_value' => :'Float', :'tick_label_position' => :'String', :'tick_labels' => :'TickLabels', :'tick_label_spacing' => :'Integer', :'tick_mark_spacing' => :'Integer', :'title' => :'Title', :'link' => :'Link' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/aspose_cells_cloud/models/axis.rb, line 459 def ==(o) return true if self.equal?(o) self.class == o.class && area == o.area && axis_between_categories == o.axis_between_categories && axis_line == o.axis_line && base_unit_scale == o.base_unit_scale && category_type == o.category_type && cross_at == o.cross_at && cross_type == o.cross_type && display_unit == o.display_unit && display_unit_label == o.display_unit_label && has_multi_level_labels == o.has_multi_level_labels && is_automatic_major_unit == o.is_automatic_major_unit && is_automatic_max_value == o.is_automatic_max_value && is_automatic_minor_unit == o.is_automatic_minor_unit && is_automatic_min_value == o.is_automatic_min_value && is_display_unit_label_shown == o.is_display_unit_label_shown && is_logarithmic == o.is_logarithmic && is_plot_order_reversed == o.is_plot_order_reversed && is_visible == o.is_visible && log_base == o.log_base && major_grid_lines == o.major_grid_lines && major_tick_mark == o.major_tick_mark && major_unit == o.major_unit && major_unit_scale == o.major_unit_scale && max_value == o.max_value && minor_grid_lines == o.minor_grid_lines && minor_tick_mark == o.minor_tick_mark && minor_unit == o.minor_unit && minor_unit_scale == o.minor_unit_scale && min_value == o.min_value && tick_label_position == o.tick_label_position && tick_labels == o.tick_labels && tick_label_spacing == o.tick_label_spacing && tick_mark_spacing == o.tick_mark_spacing && title == o.title && link == o.link std_dev == o.std_dev end
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# File lib/aspose_cells_cloud/models/axis.rb, line 536 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
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
# File lib/aspose_cells_cloud/models/axis.rb, line 602 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/aspose_cells_cloud/models/axis.rb, line 515 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
@see the ‘==` method @param [Object] Object to be compared
# File lib/aspose_cells_cloud/models/axis.rb, line 502 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/aspose_cells_cloud/models/axis.rb, line 508 def hash [ area , axis_between_categories , axis_line , base_unit_scale , category_type , cross_at , cross_type , display_unit , display_unit_label , has_multi_level_labels , is_automatic_major_unit , is_automatic_max_value , is_automatic_minor_unit , is_automatic_min_value , is_display_unit_label_shown , is_logarithmic , is_plot_order_reversed , is_visible , log_base , major_grid_lines , major_tick_mark , major_unit , major_unit_scale , max_value , minor_grid_lines , minor_tick_mark , minor_unit , minor_unit_scale , min_value , tick_label_position , tick_labels , tick_label_spacing , tick_mark_spacing , title , link ].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properies with the reasons
# File lib/aspose_cells_cloud/models/axis.rb, line 305 def list_invalid_properties invalid_properties = Array.new if @area.nil? invalid_properties.push("invalid value for 'area', area cannot be nil.") end if @axis_between_categories.nil? invalid_properties.push("invalid value for 'axis_between_categories', axis_between_categories cannot be nil.") end if @axis_line.nil? invalid_properties.push("invalid value for 'axis_line', axis_line cannot be nil.") end if @base_unit_scale.nil? invalid_properties.push("invalid value for 'base_unit_scale', base_unit_scale cannot be nil.") end if @category_type.nil? invalid_properties.push("invalid value for 'category_type', category_type cannot be nil.") end if @cross_at.nil? invalid_properties.push("invalid value for 'cross_at', cross_at cannot be nil.") end if @cross_type.nil? invalid_properties.push("invalid value for 'cross_type', cross_type cannot be nil.") end if @display_unit.nil? invalid_properties.push("invalid value for 'display_unit', display_unit cannot be nil.") end if @display_unit_label.nil? invalid_properties.push("invalid value for 'display_unit_label', display_unit_label cannot be nil.") end if @has_multi_level_labels.nil? invalid_properties.push("invalid value for 'has_multi_level_labels', has_multi_level_labels cannot be nil.") end if @is_automatic_major_unit.nil? invalid_properties.push("invalid value for 'is_automatic_major_unit', is_automatic_major_unit cannot be nil.") end if @is_automatic_max_value.nil? invalid_properties.push("invalid value for 'is_automatic_max_value', is_automatic_max_value cannot be nil.") end if @is_automatic_minor_unit.nil? invalid_properties.push("invalid value for 'is_automatic_minor_unit', is_automatic_minor_unit cannot be nil.") end if @is_automatic_min_value.nil? invalid_properties.push("invalid value for 'is_automatic_min_value', is_automatic_min_value cannot be nil.") end if @is_display_unit_label_shown.nil? invalid_properties.push("invalid value for 'is_display_unit_label_shown', is_display_unit_label_shown cannot be nil.") end if @is_logarithmic.nil? invalid_properties.push("invalid value for 'is_logarithmic', is_logarithmic cannot be nil.") end if @is_plot_order_reversed.nil? invalid_properties.push("invalid value for 'is_plot_order_reversed', is_plot_order_reversed cannot be nil.") end if @is_visible.nil? invalid_properties.push("invalid value for 'is_visible', is_visible cannot be nil.") end if @log_base.nil? invalid_properties.push("invalid value for 'log_base', log_base cannot be nil.") end if @major_grid_lines.nil? invalid_properties.push("invalid value for 'major_grid_lines', major_grid_lines cannot be nil.") end if @major_tick_mark.nil? invalid_properties.push("invalid value for 'major_tick_mark', major_tick_mark cannot be nil.") end if @major_unit.nil? invalid_properties.push("invalid value for 'major_unit', major_unit cannot be nil.") end if @major_unit_scale.nil? invalid_properties.push("invalid value for 'major_unit_scale', major_unit_scale cannot be nil.") end if @max_value.nil? invalid_properties.push("invalid value for 'max_value', max_value cannot be nil.") end if @minor_grid_lines.nil? invalid_properties.push("invalid value for 'minor_grid_lines', minor_grid_lines cannot be nil.") end if @minor_tick_mark.nil? invalid_properties.push("invalid value for 'minor_tick_mark', minor_tick_mark cannot be nil.") end if @minor_unit.nil? invalid_properties.push("invalid value for 'minor_unit', minor_unit cannot be nil.") end if @minor_unit_scale.nil? invalid_properties.push("invalid value for 'minor_unit_scale', minor_unit_scale cannot be nil.") end if @min_value.nil? invalid_properties.push("invalid value for 'min_value', min_value cannot be nil.") end if @tick_label_position.nil? invalid_properties.push("invalid value for 'tick_label_position', tick_label_position cannot be nil.") end if @tick_labels.nil? invalid_properties.push("invalid value for 'tick_labels', tick_labels cannot be nil.") end if @tick_label_spacing.nil? invalid_properties.push("invalid value for 'tick_label_spacing', tick_label_spacing cannot be nil.") end if @tick_mark_spacing.nil? invalid_properties.push("invalid value for 'tick_mark_spacing', tick_mark_spacing cannot be nil.") end if @title.nil? invalid_properties.push("invalid value for 'title', title cannot be nil.") end if @link.nil? invalid_properties.push("invalid value for 'link', link cannot be nil.") end return invalid_properties end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/aspose_cells_cloud/models/axis.rb, line 588 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/aspose_cells_cloud/models/axis.rb, line 576 def to_s to_hash.to_s end
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/aspose_cells_cloud/models/axis.rb, line 418 def valid? return false if @area.nil? return false if @axis_between_categories.nil? return false if @axis_line.nil? return false if @base_unit_scale.nil? return false if @category_type.nil? return false if @cross_at.nil? return false if @cross_type.nil? return false if @display_unit.nil? return false if @display_unit_label.nil? return false if @has_multi_level_labels.nil? return false if @is_automatic_major_unit.nil? return false if @is_automatic_max_value.nil? return false if @is_automatic_minor_unit.nil? return false if @is_automatic_min_value.nil? return false if @is_display_unit_label_shown.nil? return false if @is_logarithmic.nil? return false if @is_plot_order_reversed.nil? return false if @is_visible.nil? return false if @log_base.nil? return false if @major_grid_lines.nil? return false if @major_tick_mark.nil? return false if @major_unit.nil? return false if @major_unit_scale.nil? return false if @max_value.nil? return false if @minor_grid_lines.nil? return false if @minor_tick_mark.nil? return false if @minor_unit.nil? return false if @minor_unit_scale.nil? return false if @min_value.nil? return false if @tick_label_position.nil? return false if @tick_labels.nil? return false if @tick_label_spacing.nil? return false if @tick_mark_spacing.nil? return false if @title.nil? return false if @link.nil? return true end