Skip to content

Commit

Permalink
Updates documentation
Browse files Browse the repository at this point in the history
Closes #69.
  • Loading branch information
gampleman committed Jan 13, 2020
1 parent aa9dd74 commit 6e55ef5
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 2 deletions.
13 changes: 13 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,10 +36,23 @@ as well as arcs (as in pie charts).

Use a simulation of physical forces to do layout. Suitable for i.e. network graphs.

### [Interpolation](http://package.elm-lang.org/packages/gampleman/elm-visualization/latest/Interpolation)

Smoothly transition between pairs of values. Useful for animation, or generating gradients of values.

### [Transition](http://package.elm-lang.org/packages/gampleman/elm-visualization/latest/Transition)

Build complex animations using Interpolation.


### [Histogram](http://package.elm-lang.org/packages/gampleman/elm-visualization/latest/Histogram)

Compute histograms of data.

### [Zoom](http://package.elm-lang.org/packages/gampleman/elm-visualization/latest/Zoom)

Build pan and zoom user interactions.

### [Statistics](http://package.elm-lang.org/packages/gampleman/elm-visualization/latest/Statistics)

Process data to extract useful insights for visualizations.
Expand Down
6 changes: 4 additions & 2 deletions src/Scale.elm
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,8 @@ import Time
This is still done in a convenient and type-safe manner, however the cost is
a certain ugliness and complexity of the type signatures. For this reason after the type alias of each scale, the supported functions are listed along with a more specialized type signature appropriate for that scale type.
**Note:** As a convention, the scales typically take arguments in a `range -> domain` order. This may seem somewhat counterinutive, as scales map a domain onto a range, but it is quite common to need to compute the domain, but know the range statically, so this argument order works much better for composition.
If you're new to this, I recommend ignoring the types of the type aliases and of the operations and just look at these listings.
-}
Expand All @@ -123,8 +125,8 @@ type Scale scaleSpec
-- Continuous Scales


{-| Maps a `(Float, Float)` **domain** to a
`(out, out)` **range** (this will be either `(Float, Float)` or `(Time.Posix, Time.Posix)`.)
{-| Maps a `(inp, inp)` **domain** to a
`(Float, Float)` **range** (this will be either `(Float, Float)` or `(Time.Posix, Time.Posix)`.)
Continuous scales support the following operations:
Expand Down

0 comments on commit 6e55ef5

Please sign in to comment.