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

Chart.Grid

WARNING! THIS IS AN ALPHA VERSION

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

type alias Config = Grid.Config

Use in the Chart.Config passed to Chart.viewCustom.

chartConfig : Chart.Config Data msg
chartConfig =
  { ...
  , grid = Grid.default
  , ...
  }
default : Config

Gets you some vague gray grid lines.

none : Config

No grid! (Ok, fine, it's there, but it's transparent!)

dots : Float -> Color.Color -> Config

Gets you a grid dots of a given radius and color.

lines : Float -> Color.Color -> Config

Gets you grid lines of a given width and color.

How do I change where the grid lines/dots are placed?

By default there is a grid by every tick. If you want to change the position of the grid or remove it all together, alter your tick configuration of your axis.

The path to the tick in the configuration does through the x or y property for vertical and horizontal grids respectivily and then in the axis property.

See Chart.Axis -> Chart.Axis.Ticks -> Chart.Axis.Tick.

module Chart.Grid exposing (Config, default, none, dots, lines)

{-|

# WARNING! THIS IS AN ALPHA VERSION

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

@docs Config, default, none, dots, lines

# How do I change where the grid lines/dots are placed?

By default there is a grid by every tick. If you want to change
the position of the grid or remove it all together, alter your tick
configuration of your axis.

The path to the tick in the configuration does through the `x` or `y`
property for vertical and horizontal grids respectivily and then in the
`axis` property.

See `Chart.Axis` -> `Chart.Axis.Ticks` -> `Chart.Axis.Tick`.

-}

import Internal.Grid as Grid
import Color


{-| Use in the `Chart.Config` passed to `Chart.viewCustom`.

    chartConfig : Chart.Config Data msg
    chartConfig =
      { ...
      , grid = Grid.default
      , ...
      }

-}
type alias Config =
  Grid.Config


{-| Gets you some vague gray grid lines.
-}
default : Config
default =
  Grid.default


{-| No grid! (Ok, fine, it's there, but it's transparent!) -}
none : Config
none =
  Grid.none


{-| Gets you a grid dots of a given radius and color.
-}
dots : Float -> Color.Color -> Config
dots =
  Grid.dots


{-| Gets you grid lines of a given width and color.
-}
lines : Float -> Color.Color -> Config
lines =
  Grid.lines