This is an alternative site for discovering Elm packages. You may be looking for the official Elm package site instead.
0.0.1

Chart.Axis.Dependent

WARNING! THIS IS AN ALPHA VERSION

IT HAS MISSING, MISLEADING AND PLAIN WRONG DOCUMENTATION. IT HAS BUGS AND AWKWARDNESS. USE AT OWN RISK.

This is the configuration for the dependent axis of a blocks chart. It is not used for the dots or line charts.

type alias Config msg = Dependent.Config msg
default : String -> Unit.Config -> Config msg

The default configuration. Pass the title and the unit of the axis.

Chart.Blocks.viewCustom
  { ...
  , dependentAxis = Chart.Axis.Dependent.default "Income" Chart.Axis.Unit.dollars
  , ...
  }
custom : Properties msg -> Config msg

Customize your dependent axis. The properties are:

  • title: The title of your axis. See the Chart.Axis.Title module.
  • unit: The unit of your axis. See the Chart.Axis.Unit module.
  • range: The range of your axis. See the Chart.Axis.Range module.
  • line: The line of your axis. See the Chart.Axis.Line module.
  • ticks: The ticks on your axis. See the Chart.Axis.Ticks module.
module Chart.Axis.Dependent exposing (Config, default, custom)

{-| 

# WARNING! THIS IS AN ALPHA VERSION

*IT HAS MISSING, MISLEADING AND PLAIN WRONG DOCUMENTATION.*
*IT HAS BUGS AND AWKWARDNESS.*
*USE AT OWN RISK.*

This is the configuration for the dependent axis of a blocks chart.
It is _not_ used for the dots or line charts.

@docs Config, default, custom


-}


import Internal.Axis.Dependent as Dependent
import Internal.Axis.Ticks as Ticks
import Internal.Axis.Line as AxisLine
import Internal.Axis.Title as Title
import Internal.Axis.Range as Range
import Internal.Unit as Unit


{-| -}
type alias Config msg =
  Dependent.Config msg


{-| The default configuration. Pass the title and
the unit of the axis.

    Chart.Blocks.viewCustom
      { ...
      , dependentAxis = Chart.Axis.Dependent.default "Income" Chart.Axis.Unit.dollars
      , ...
      }

-}
default : String -> Unit.Config -> Config msg
default =
  Dependent.default


{-| Customize your dependent axis. The properties are:

  - title: The title of your axis. See the `Chart.Axis.Title` module.
  - unit: The unit of your axis. See the `Chart.Axis.Unit` module.
  - range: The range of your axis. See the `Chart.Axis.Range` module.
  - line: The line of your axis. See the `Chart.Axis.Line` module.
  - ticks: The ticks on your axis. See the `Chart.Axis.Ticks` module.

-}
custom : Properties msg -> Config msg
custom =
  Dependent.custom


{-| -}
type alias Properties msg =
  { title : Title.Config msg
  , unit : Unit.Config
  , range : Range.Config
  , line : AxisLine.Config msg
  , ticks : Ticks.Config msg
  }