Data.FormatN

Formatting of numeric values.

Documentation

data FormatN

Number formatting options.

>>> defaultFormatN
FormatComma (Just 2)

Constructors

FormatFixed (Maybe Int)

FormatDecimal (Maybe Int)

FormatComma (Maybe Int)

FormatExpt (Maybe Int)

FormatPrec (Maybe Int)

FormatDollar (Maybe Int)

FormatPercent (Maybe Int)

FormatNone

Instances

Eq FormatN

Defined in Data.FormatN

Methods

(==) :: FormatN -> FormatN -> Bool

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

Show FormatN

Defined in Data.FormatN

Methods

showsPrec :: Int -> FormatN -> ShowS

show :: FormatN -> String

showList :: [FormatN] -> ShowS

Generic FormatN

Defined in Data.FormatN

Associated Types

type Rep FormatN :: Type -> Type

Methods

from :: FormatN -> Rep FormatN x

to :: Rep FormatN x -> FormatN

type Rep FormatN

Defined in Data.FormatN

type Rep FormatN = D1 ('MetaData "FormatN" "Data.FormatN" "chart-svg-0.2.0-92kmzNutfhz4Yaw4NJVLJs" 'False) (((C1 ('MetaCons "FormatFixed" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int))) :+: C1 ('MetaCons "FormatDecimal" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int)))) :+: (C1 ('MetaCons "FormatComma" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int))) :+: C1 ('MetaCons "FormatExpt" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int))))) :+: ((C1 ('MetaCons "FormatPrec" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int))) :+: C1 ('MetaCons "FormatDollar" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int)))) :+: (C1 ('MetaCons "FormatPercent" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int))) :+: C1 ('MetaCons "FormatNone" 'PrefixI 'False) (U1 :: Type -> Type))))

defaultFormatN :: FormatN

The official format

fromFormatN :: IsString s => FormatN -> s

textifier

toFormatN :: (Eq s, IsString s) => s -> Maybe Int -> FormatN

readifier

fixed :: Maybe Int -> Double -> Text

to x decimal places

>>> fixed (Just 2) 1
"1.00"

>>> fixed (Just 2) 0.001
"0.00"

decimal :: Maybe Int -> Double -> Text

round to n significant figures and always use decimal notation >>> decimal (Just 2) 0.000001234 "0.00000123"

>>> decimal (Just 2) 1234567
"1230000"

prec :: Maybe Int -> Double -> Text

format numbers between 0.001 and 1,000,000 using digit and comma notation and exponential outside this range, with x significant figures. > prec (Just 1) 0.00234 "0.0023"

prec (Just 1) 0.000023

"2.3e-5"

prec (Just 1) 123

"120"

prec (Just 1) 123456

"120,000"

>>> prec (Just 1) 1234567
"1.2e6"

comma :: Maybe Int -> Double -> Text

add commas format for numbers above 1,000 but below 1 million, otherwise use prec.

>>> comma Nothing 1234.567
"1,234.567"

>>> comma (Just 2) 1234
"1,230"

expt :: Maybe Int -> Double -> Text

scientific exponential

>>> expt (Just 2) 1234
"1.23e3"

dollar :: Maybe Int -> Double -> Text

dollars and cents, always decimal notation

>>> dollar (Just 2) 1234
"$1,230"

>>> dollar (Just 2) 0.01234
"$0.0123"

formatN :: FormatN -> Double -> Text

make text

precision :: (Maybe Int -> Double -> Text) -> Maybe Int -> [Double] -> [Text]

Provide formatted text for a list of numbers so that they are just distinguished. 'precision commas 2 ticks' means use as much precision as is needed for them to be distinguished, but with at least 2 significant figures.

formatNs :: FormatN -> [Double] -> [Text]

Consistently format a list of doubles.

showOr :: FormatN -> Double -> Text

Format with the shorter of show and formatN.