Plots.Axis.Scale

Determine how to scale an axis.

Axis scale

data AxisScaling n

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

Instances

HasAxisScaling f (AxisScaling n)

Defined in Plots.Axis.Scale

Methods

axisScaling :: LensLike' f (AxisScaling n) (AxisScaling (N (AxisScaling n)))

scaleAspectRatio :: LensLike' f (AxisScaling n) (Maybe (N (AxisScaling n)))

scaleMode :: LensLike' f (AxisScaling n) ScaleMode

logScale :: LensLike' f (AxisScaling n) LogScale

axisExtend :: LensLike' f (AxisScaling n) (Extending (N (AxisScaling n)))

boundMin :: LensLike' f (AxisScaling n) (Maybe (N (AxisScaling n)))

boundMax :: LensLike' f (AxisScaling n) (Maybe (N (AxisScaling n)))

renderSize :: LensLike' f (AxisScaling n) (Maybe (N (AxisScaling n)))

Fractional n => Default (AxisScaling n)

Defined in Plots.Axis.Scale

Methods

def :: AxisScaling n

type N (AxisScaling n)

Defined in Plots.Axis.Scale

type N (AxisScaling n) = n

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 n

How much to extend the bounds beyond any inferred bounds.

Constructors

AbsoluteExtend n

RelativeExtend n

Instances

Functor Extending

Defined in Plots.Axis.Scale

Methods

fmap :: (a -> b) -> Extending a -> Extending b

(<$) :: a -> Extending b -> Extending a

Show n => Show (Extending n)

Defined in Plots.Axis.Scale

Methods

showsPrec :: Int -> Extending n -> ShowS

show :: Extending n -> String

showList :: [Extending n] -> ShowS

Eq n => Eq (Extending n)

Defined in Plots.Axis.Scale

Methods

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

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

Ord n => Ord (Extending n)

Defined in Plots.Axis.Scale

Methods

compare :: Extending n -> Extending n -> Ordering

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

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

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

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

max :: Extending n -> Extending n -> Extending n

min :: Extending n -> Extending n -> Extending n

noExtend :: Num n => Extending n

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 (N a))

The way to scale in one direction.

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

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 (N a))

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 (N a))

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 (N a))

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 (N a))

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

Instances

HasAxisScaling f (AxisScaling n)

Defined in Plots.Axis.Scale

Methods

axisScaling :: LensLike' f (AxisScaling n) (AxisScaling (N (AxisScaling n)))

scaleAspectRatio :: LensLike' f (AxisScaling n) (Maybe (N (AxisScaling n)))

scaleMode :: LensLike' f (AxisScaling n) ScaleMode

logScale :: LensLike' f (AxisScaling n) LogScale

axisExtend :: LensLike' f (AxisScaling n) (Extending (N (AxisScaling n)))

boundMin :: LensLike' f (AxisScaling n) (Maybe (N (AxisScaling n)))

boundMax :: LensLike' f (AxisScaling n) (Maybe (N (AxisScaling n)))

renderSize :: LensLike' f (AxisScaling n) (Maybe (N (AxisScaling n)))

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

Defined in Plots.Axis

Methods

axisScaling :: LensLike' f (Axis b c n) (AxisScaling (N (Axis b c n)))

scaleAspectRatio :: LensLike' f (Axis b c n) (Maybe (N (Axis b c n)))

scaleMode :: LensLike' f (Axis b c n) ScaleMode

logScale :: LensLike' f (Axis b c n) LogScale

axisExtend :: LensLike' f (Axis b c n) (Extending (N (Axis b c n)))

boundMin :: LensLike' f (Axis b c n) (Maybe (N (Axis b c n)))

boundMax :: LensLike' f (Axis b c n) (Maybe (N (Axis b c n)))

renderSize :: LensLike' f (Axis b c n) (Maybe (N (Axis b c n)))

Functor f => HasAxisScaling f (SingleAxis b v n)

Defined in Plots.Axis

Methods

axisScaling :: LensLike' f (SingleAxis b v n) (AxisScaling (N (SingleAxis b v n)))

scaleAspectRatio :: LensLike' f (SingleAxis b v n) (Maybe (N (SingleAxis b v n)))

scaleMode :: LensLike' f (SingleAxis b v n) ScaleMode

logScale :: LensLike' f (SingleAxis b v n) LogScale

axisExtend :: LensLike' f (SingleAxis b v n) (Extending (N (SingleAxis b v n)))

boundMin :: LensLike' f (SingleAxis b v n) (Maybe (N (SingleAxis b v n)))

boundMax :: LensLike' f (SingleAxis b v n) (Maybe (N (SingleAxis b v n)))

renderSize :: LensLike' f (SingleAxis b v n) (Maybe (N (SingleAxis b v n)))

Log scales

data LogScale

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

Constructors

LinearAxis

LogAxis

Instances

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

Eq LogScale

Defined in Plots.Axis.Scale

Methods

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

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

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.

logDeform :: (InSpace v n a, Foldable v, Floating n, Deformable a a) => v LogScale -> a -> a

Deform an object according to the axis scale. Does nothing for linear scales.

Low level calculations

These functions are used by Plots.Axis.Render.

calculateBounds

Arguments

:: OrderedField n

=> AxisScaling n

Scaling to use for this axis

-> Maybe (n, n)

Inferred bounds (from any plots)

-> (n, n)

Lower and upper bounds to use for this axis

Calculating the bounds for an axis.

calculateScaling

Arguments

:: (HasLinearMap v, OrderedField n, Applicative v)

=> v (AxisScaling n)

axis scaling options

-> BoundingBox v n

bounding box from the axis plots

-> (v (n, n), Transformation v n, Transformation v n)

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