Sha256: 21911e89b7c41ad2251c2c2dce85573f2f129335d4fb94856e0a109f1a9fac94

Contents?: true

Size: 1.86 KB

Versions: 4

Compression:

Stored size: 1.86 KB

Contents

# frozen_string_literal: true

module Axlsx
  # The Scaling class defines axis scaling
  class Scaling
    include Axlsx::OptionsParser

    # creates a new Scaling object
    # @option options [Integer] logBase
    # @option options [Symbol] orientation
    # @option options [Float] max
    # @option options [Float] min
    def initialize(options = {})
      @orientation = :minMax
      @logBase, @min, @max = nil, nil, nil
      parse_options options
    end

    # logarithmic base for a logarithmic axis.
    # must be between 2 and 1000
    # @return [Integer]
    attr_reader :logBase

    # the orientation of the axis
    # must be one of [:minMax, :maxMin]
    # @return [Symbol]
    attr_reader :orientation

    # the maximum scaling
    # @return [Float]
    attr_reader :max

    # the minimu scaling
    # @return [Float]
    attr_reader :min

    # @see logBase
    def logBase=(v)
      DataTypeValidator.validate "Scaling.logBase", [Integer], v, ->(arg) { arg >= 2 && arg <= 1000 }
      @logBase = v
    end

    # @see orientation
    def orientation=(v)
      RestrictionValidator.validate "Scaling.orientation", [:minMax, :maxMin], v
      @orientation = v
    end

    # @see max
    def max=(v)
      DataTypeValidator.validate "Scaling.max", Float, v
      @max = v
    end

    # @see min
    def min=(v)
      DataTypeValidator.validate "Scaling.min", Float, v
      @min = v
    end

    # Serializes the object
    # @param [String] str
    # @return [String]
    def to_xml_string(str = +'')
      str << '<c:scaling>'
      str << '<c:logBase val="' << @logBase.to_s << '"/>' unless @logBase.nil?
      str << '<c:orientation val="' << @orientation.to_s << '"/>' unless @orientation.nil?
      str << '<c:min val="' << @min.to_s << '"/>' unless @min.nil?
      str << '<c:max val="' << @max.to_s << '"/>' unless @max.nil?
      str << '</c:scaling>'
    end
  end
end

Version data entries

4 entries across 4 versions & 2 rubygems

Version Path
cm-admin-1.5.22 vendor/bundle/ruby/3.3.0/gems/caxlsx-4.1.0/lib/axlsx/drawing/scaling.rb
cm-admin-1.5.21 vendor/bundle/ruby/3.3.0/gems/caxlsx-4.1.0/lib/axlsx/drawing/scaling.rb
cm-admin-1.5.20 vendor/bundle/ruby/3.3.0/gems/caxlsx-4.1.0/lib/axlsx/drawing/scaling.rb
caxlsx-4.1.0 lib/axlsx/drawing/scaling.rb