Plots.Axis.Scale

Determine how to scale an axis.

Axis scale

data AxisScaling

Data type used that concerns everything to do with the size or scale of the axis.

Instances

Default AxisScaling

Defined in Plots.Axis.Scale

Methods

def :: AxisScaling

HasAxisScaling f AxisScaling

Defined in Plots.Axis.Scale

Methods

axisScaling :: LensLike' f AxisScaling AxisScaling

scaleAspectRatio :: LensLike' f AxisScaling (Maybe Double)

scaleMode :: LensLike' f AxisScaling ScaleMode

logScale :: LensLike' f AxisScaling LogScale

axisExtend :: LensLike' f AxisScaling Extending

boundMin :: LensLike' f AxisScaling (Maybe Double)

boundMax :: LensLike' f AxisScaling (Maybe Double)

renderSize :: LensLike' f AxisScaling (Maybe Double)

type N AxisScaling

Defined in Plots.Axis.Scale

type N AxisScaling = Double

data ScaleMode

How the axis should be scaled when not all dimensions are set.

Constructors

AutoScale

NoScale

Stretch

UniformScale UniformScaleStrategy

Instances

Read ScaleMode

Defined in Plots.Axis.Scale

Methods

readsPrec :: Int -> ReadS ScaleMode

readList :: ReadS [ScaleMode]

readPrec :: ReadPrec ScaleMode

readListPrec :: ReadPrec [ScaleMode]

Show ScaleMode

Defined in Plots.Axis.Scale

Methods

showsPrec :: Int -> ScaleMode -> ShowS

show :: ScaleMode -> String

showList :: [ScaleMode] -> ShowS

data UniformScaleStrategy

?

Constructors

AutoUniformScale

UnitOnly

ChangeVerticalLimits

ChangeHorizontalLimits

Instances

Read UniformScaleStrategy

Defined in Plots.Axis.Scale

Methods

readsPrec :: Int -> ReadS UniformScaleStrategy

readList :: ReadS [UniformScaleStrategy]

readPrec :: ReadPrec UniformScaleStrategy

readListPrec :: ReadPrec [UniformScaleStrategy]

Show UniformScaleStrategy

Defined in Plots.Axis.Scale

Methods

showsPrec :: Int -> UniformScaleStrategy -> ShowS

show :: UniformScaleStrategy -> String

showList :: [UniformScaleStrategy] -> ShowS

data Extending

How much to extend the bounds beyond any inferred bounds.

Constructors

AbsoluteExtend !Double

RelativeExtend !Double

Instances

Eq Extending

Defined in Plots.Axis.Scale

Methods

(==) :: Extending -> Extending -> Bool

(/=) :: Extending -> Extending -> Bool

Ord Extending

Defined in Plots.Axis.Scale

Methods

compare :: Extending -> Extending -> Ordering

(<) :: Extending -> Extending -> Bool

(<=) :: Extending -> Extending -> Bool

(>) :: Extending -> Extending -> Bool

(>=) :: Extending -> Extending -> Bool

max :: Extending -> Extending -> Extending

min :: Extending -> Extending -> Extending

Show Extending

Defined in Plots.Axis.Scale

Methods

showsPrec :: Int -> Extending -> ShowS

show :: Extending -> String

showList :: [Extending] -> ShowS

noExtend :: Extending

Do not extend the axis beyond the inferred bounds.

class HasAxisScaling f a where

Class of things that have an AxisScaling.

Minimal complete definition

axisScaling

Methods

axisScaling :: LensLike' f a AxisScaling

The way to scale in one direction.

scaleAspectRatio :: Functor f => LensLike' f a (Maybe Double)

The ratio relative to other axis. If no ratios are set, the ratio is not enforced. If at least one is set, Nothing ratios are 1.

scaleMode :: Functor f => LensLike' f a ScaleMode

The mode to determine how to scale the bounds in a direction. Choose between AutoScale, NoScale, Stretch or UniformScale.

Default is AutoScale.

logScale :: Functor f => LensLike' f a LogScale

Whether the axis uses LogAxis or LinearAxis.

Default is LinearAxis.

axisExtend :: Functor f => LensLike' f a Extending

How much to extend the bounds over infered bounds. This is ignored if a boundMax or boundMin is set.

boundMin :: Functor f => LensLike' f a (Maybe Double)

The maximum bound the axis. There are helper functions for setting a minimum bound for a specific axis.

xMin :: Lens' (Axis b V2 Double) (Maybe Double)
yMin :: Lens' (Axis b V2 Double) (Maybe Double)

Default is Nothing.

boundMax :: Functor f => LensLike' f a (Maybe Double)

The maximum bound the axis. There are helper functions for setting a maximum bound specific axis.

xMax :: Lens' (Axis b V2 Double) (Maybe Double)
yMax :: Lens' (Axis b V2 Double) (Maybe Double)
rMax :: Lens' (Axis b 'Polar Double) (Maybe Double)

Default is Nothing.

renderSize :: Functor f => LensLike' f a (Maybe Double)

The size of the rendered axis. Default is Just 400.

Instances

HasAxisScaling f AxisScaling

Defined in Plots.Axis.Scale

Methods

axisScaling :: LensLike' f AxisScaling AxisScaling

scaleAspectRatio :: LensLike' f AxisScaling (Maybe Double)

scaleMode :: LensLike' f AxisScaling ScaleMode

logScale :: LensLike' f AxisScaling LogScale

axisExtend :: LensLike' f AxisScaling Extending

boundMin :: LensLike' f AxisScaling (Maybe Double)

boundMax :: LensLike' f AxisScaling (Maybe Double)

renderSize :: LensLike' f AxisScaling (Maybe Double)

(Applicative f, Traversable c) => HasAxisScaling f (Axis c)

Defined in Plots.Axis

Methods

axisScaling :: LensLike' f (Axis c) AxisScaling

scaleAspectRatio :: LensLike' f (Axis c) (Maybe Double)

scaleMode :: LensLike' f (Axis c) ScaleMode

logScale :: LensLike' f (Axis c) LogScale

axisExtend :: LensLike' f (Axis c) Extending

boundMin :: LensLike' f (Axis c) (Maybe Double)

boundMax :: LensLike' f (Axis c) (Maybe Double)

renderSize :: LensLike' f (Axis c) (Maybe Double)

Functor f => HasAxisScaling f (SingleAxis v)

Defined in Plots.Axis

Methods

axisScaling :: LensLike' f (SingleAxis v) AxisScaling

scaleAspectRatio :: LensLike' f (SingleAxis v) (Maybe Double)

scaleMode :: LensLike' f (SingleAxis v) ScaleMode

logScale :: LensLike' f (SingleAxis v) LogScale

axisExtend :: LensLike' f (SingleAxis v) Extending

boundMin :: LensLike' f (SingleAxis v) (Maybe Double)

boundMax :: LensLike' f (SingleAxis v) (Maybe Double)

renderSize :: LensLike' f (SingleAxis v) (Maybe Double)

Log scales

data LogScale

Should the axis be on a logarithmic scale. The Default is LinearAxis.

Constructors

LinearAxis

LogAxis

Instances

Eq LogScale

Defined in Plots.Axis.Scale

Methods

(==) :: LogScale -> LogScale -> Bool

(/=) :: LogScale -> LogScale -> Bool

Show LogScale

Defined in Plots.Axis.Scale

Methods

showsPrec :: Int -> LogScale -> ShowS

show :: LogScale -> String

showList :: [LogScale] -> ShowS

Default LogScale

Defined in Plots.Axis.Scale

Methods

def :: LogScale

logNumber :: Floating a => LogScale -> a -> a

Log the number for LogAxis, do nothing for LinearAxis.

logPoint :: (Additive v, Floating n) => v LogScale -> Point v n -> Point v n

Transform a point according to the axis scale. Does nothing for linear scales.

Low level calculations

These functions are used by Plots.Axis.Render.

calculateBounds

Arguments

:: AxisScaling

Scaling to use for this axis

-> Maybe (Double, Double)

Inferred bounds (from any plots)

-> (Double, Double)

Lower and upper bounds to use for this axis

Calculating the bounds for an axis.

calculateScaling

Arguments

:: (HasLinearMap v, Applicative v)

=> v AxisScaling

axis scaling options

-> BoundingBox v Double

bounding box from the axis plots

-> (v (Double, Double), Transformation v Double, Transformation v Double)

Calculate the scaling for the axis.

The result returns:

• The final bounds for the axis
• scale to match desired scaleAspectRatio
• scale to match desired asSizeSpec