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

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

**Data-space and SVG-space**

Data-space is the regular cartesian coordinate system, the coordinate system you probably learned about in school. The x axis goes horizontally and the numbers grow larger as we progress to the right. The y axis goes vertically and the numbers grow larger as we progress upwards.

SVG-space is different because here, the y axis numbers grow larger as we
progress *downwards*, and there coordinates are relative to the pixel height and
width of the chart, not your data.

Since SVG only understand SVG-space coordinates, when we have data-space coordinates
we need to translate them in order the use them for drawing. For this we need some
info which I calculate for you and is stored in the `System`

type. With the `System`

we
can use the translating functions contained in this module.

Furthermore, the `System`

holds your axis range minimum and maximum, as well as
that off your data range. This can be useful info when moving stuff in `Junk`

!

**Note:** Most of the functions in `Junk`

takes data-space coordinates, so it's
only when you do you're own crazy junk in pure SVG that you have to worry about
this module!

type alias System =
{ frame : Frame
, x : Range -- TODO { full : Range, data : Range } ?
, y : Range
, xData : Range
, yData : Range
, id : String
}

The system holds informations about the dimensions of your chart.

**frame**is information about the size and margins of your chart.**x**is the minimum and maximum of your axis range.**y**is the minimum and maximum of your axis domain.**xData**is the minimum and maximum of your data range.**yData**is the minimum and maximum of your data domain.**id**is the id of your chart.

This is all the information we need for translating your data coordinates into SVG coordinates.

*If you're confused as to what "axis range" and "data range" means,
check out Axis.Range for an explanation!*

type alias Frame =
{ margin : Container.Margin
, size : Size
}

Specifies the size and margins of your chart.

type alias Size =
{ width : Float
, height : Float
}

The size (px) of your chart.

type alias Range =
{ min : Float
, max : Float
}

These are minimum and maximum values that make up a range.

type alias Point =
{ x : Float
, y : Float
}

toSvg : System -> Point -> Point

Translates a data-space point to a SVG-space point.

toData : System -> Point -> Point

Translates a SVG-space point to a data-space point.

toSvgX : System -> Float -> Float

Translate a x-coordinate from data-space to SVG-space.

toSvgY : System -> Float -> Float

Translate a y-coordinate from data-space to SVG-space.

toDataX : System -> Float -> Float

Translate a x-coordinate from SVG-space to data-space.

toDataY : System -> Float -> Float

Translate a y-coordinate from SVG-space to data-space.

Scaling is different from translating in that it does not take a position as
it's input, but a *distance*. Translating a position takes the frame into
account, scaling doesn't.

```
system : System
system =
{ frame = Frame (Margin 10 10 10 10) (Size 100 100)
, x = Range 0 10
, y = Range 0 10
}
data : Point
data =
Point 2 3
dataXinSvg : Float
dataXinSvg =
toSvgX system data.x -- 30 (margin.left + 2 * 100 / 10)
dataXinSvg : Float
dataXinSvg =
scaleSvgX system data.x -- 20 (2 * 100 / 10)
```

scaleSvgX : System -> Float -> Float

Scale a x-value from data-space to SVG-space.

scaleSvgY : System -> Float -> Float

Scale a y-value from data-space to SVG-space.

scaleDataX : System -> Float -> Float

Scale a x-value from SVG-space to data-space.

scaleDataY : System -> Float -> Float

Scale a y-value from SVG-space to data-space.

```
module Chart.Coordinate exposing
( Frame, Size
, System, Range
, Point, toSvg, toData
, toSvgX, toSvgY
, toDataX, toDataY
, scaleSvgX, scaleSvgY
, scaleDataX, scaleDataY
)
{-|
# WARNING! THIS IS AN ALPHA VERSION
*IT HAS MISSING, MISLEADING AND PLAIN WRONG DOCUMENTATION.*
*IT HAS BUGS AND AWKWARDNESS.*
*USE AT OWN RISK.*
**Data-space and SVG-space**
Data-space is the regular cartesian coordinate system, the coordinate system you
probably learned about in school. The x axis goes horizontally and the numbers
grow larger as we progress to the right. The y axis goes vertically and the numbers
grow larger as we progress upwards.
SVG-space is different because here, the y axis numbers grow larger as we
progress _downwards_, and there coordinates are relative to the pixel height and
width of the chart, not your data.
<img alt="Space" width="610" src="https://github.com/terezka/line-charts/blob/master/images/space.png?raw=true"></src>
Since SVG only understand SVG-space coordinates, when we have data-space coordinates
we need to translate them in order the use them for drawing. For this we need some
info which I calculate for you and is stored in the `System` type. With the `System` we
can use the translating functions contained in this module.
Furthermore, the `System` holds your axis range minimum and maximum, as well as
that off your data range. This can be useful info when moving stuff in `Junk`!
**Note:** Most of the functions in `Junk` takes data-space coordinates, so it's
only when you do you're own crazy junk in pure SVG that you have to worry about
this module!
# System
@docs System, Frame, Size, Range
# Translation
## Point
@docs Point, toSvg, toData
## Single value
@docs toSvgX, toSvgY, toDataX, toDataY
# Scaling
Scaling is different from translating in that it does not take a position as
it's input, but a _distance_. Translating a position takes the frame into
account, scaling doesn't.
system : System
system =
{ frame = Frame (Margin 10 10 10 10) (Size 100 100)
, x = Range 0 10
, y = Range 0 10
}
data : Point
data =
Point 2 3
dataXinSvg : Float
dataXinSvg =
toSvgX system data.x -- 30 (margin.left + 2 * 100 / 10)
dataXinSvg : Float
dataXinSvg =
scaleSvgX system data.x -- 20 (2 * 100 / 10)
@docs scaleSvgX, scaleSvgY, scaleDataX, scaleDataY
-}
import Internal.Coordinate as Coordinate
import Chart.Container as Container
{-| Specifies the size and margins of your chart.
-}
type alias Frame =
{ margin : Container.Margin
, size : Size
}
{-| The size (px) of your chart.
-}
type alias Size =
{ width : Float
, height : Float
}
-- SYSTEM
{-| The system holds informations about the dimensions of your chart.
- **frame** is information about the size and margins of your chart.
- **x** is the minimum and maximum of your axis range.
- **y** is the minimum and maximum of your axis domain.
- **xData** is the minimum and maximum of your data range.
- **yData** is the minimum and maximum of your data domain.
- **id** is the id of your chart.
This is all the information we need for translating your data coordinates into
SVG coordinates.
_If you're confused as to what "axis range" and "data range" means,
check out `Axis.Range` for an explanation!_
-}
type alias System =
{ frame : Frame
, x : Range -- TODO { full : Range, data : Range } ?
, y : Range
, xData : Range
, yData : Range
, id : String
}
{-| These are minimum and maximum values that make up a range.
-}
type alias Range =
{ min : Float
, max : Float
}
-- TRANSLATION
{-| Translate a x-coordinate from data-space to SVG-space.
-}
toSvgX : System -> Float -> Float
toSvgX =
Coordinate.toSvgX
{-| Translate a y-coordinate from data-space to SVG-space.
-}
toSvgY : System -> Float -> Float
toSvgY =
Coordinate.toSvgY
{-| Translate a x-coordinate from SVG-space to data-space.
-}
toDataX : System -> Float -> Float
toDataX =
Coordinate.toDataX
{-| Translate a y-coordinate from SVG-space to data-space.
-}
toDataY : System -> Float -> Float
toDataY =
Coordinate.toDataY
-- Scaling
{-| Scale a x-value from data-space to SVG-space.
-}
scaleSvgX : System -> Float -> Float
scaleSvgX =
Coordinate.scaleSvgX
{-| Scale a y-value from data-space to SVG-space.
-}
scaleSvgY : System -> Float -> Float
scaleSvgY =
Coordinate.scaleSvgY
{-| Scale a x-value from SVG-space to data-space.
-}
scaleDataX : System -> Float -> Float
scaleDataX =
Coordinate.scaleDataX
{-| Scale a y-value from SVG-space to data-space.
-}
scaleDataY : System -> Float -> Float
scaleDataY =
Coordinate.scaleDataY
-- Points
{-| -}
type alias Point =
{ x : Float
, y : Float
}
{-| Translates a data-space point to a SVG-space point.
-}
toSvg : System -> Point -> Point
toSvg =
Coordinate.toSvg
{-| Translates a SVG-space point to a data-space point.
-}
toData : System -> Point -> Point
toData =
Coordinate.toData
```