Commit c75fa968 authored by Paul Asmuth's avatar Paul Asmuth
Browse files

update documentation

parent 52ec0ccb
Loading
Loading
Loading
Loading
+2 −2
Original line number Diff line number Diff line
Unit Formats
============
Units & Formats
===============

The `<label-format>` setting controls how values are formatted for display. Here
is the list of valid values:
+33 −0
Original line number Diff line number Diff line
Scales
======

Scale settings control how input data is mapped to plot coordinates.

## Scale Types

You can change the scale type using the `scale-x` and `scale-y` properties on
the `plot` element:

    plot {
      scale-x: <scale-options>;
      scale-y: <scale-options>;
    }

The following scale options are currently supported:

  - `linear` - A simple linear scale from min to max
  - `logarithmic` - A logarithmic scale
  - `discrete` - A discrete (categorical) scale
  - `inverted` - A modifier that will invert any of the scales listed above

## Limits

The scale limits are the smallest (min) and largest (max) values that will be
displayed on the plot. Configure using the `axis-x-min`, `axis-x-max`, `axis-y-min` 
and `axis-y-max` properties.

    plot {
      scale-x-min: <value>;
      scale-x-max: <value>;
      scale-y-min: <value>;
      scale-y-max: <value>;
    }


## Categorical Values

## Logarithmic, Inverted

## Multiple Scales
+50 −33
Original line number Diff line number Diff line
@@ -33,70 +33,87 @@ documentation:
        title: "API Reference"
        url: "/reference"
        file: "reference"
  -
    title: "Examples"
    pages:
      -
        title: "Example Gallery"
        url: "/examples"
        file: "examples"

  -
    title: "Chart Options"
    pages:
  #    -
  #      title: "Document Setup"
  #      url: "/documentation/document-settings"
  #      file: "doc_settings"
  #    -
  #      title: "Units & Formatters"
  #      url: "/documentation/formatter"
  #      file: "formatters"
      -
        title: "Scales"
        url: "/documentation/plot-scales"
        file: "scales"
      #-
      #  title: "Colours"
      #  url: "/documentation/color-palette"
      #  file: "color_palette"
      -
        title: "Axes"
        url: "/documentation/plot-axes"
        file: "axes"
      -
        title: "Unit Formats"
        title: "Units & Formats"
        url: "/documentation/formatter"
        file: "formatter"
      -
        title: "Axis Styles"
        url: "/documentation/plot-axes"
        file: "axes"
      #-
  #      title: "Plot: Gridlines"
      #  title: "Gridlines"
      #  url: "/documentation/plot-gridlines"
  #      file: ""
      #  file: "gridlines"
      #-
  #      title: "Plot: Lines"
      #  title: "Line Styles"
      #  url: "/documentation/line-styles"
      #  file: "line_styles"
      #-
      #  title: "Point Styles"
      #  url: "/documentation/point-styles"
      #  file: "point_styles"
      #-
      #  title: "Caption"
      #  url: "/documentation/caption"
      #  file: "caption"
      #-
      #  title: "Legend"
      #  url: "/documentation/legend"
      #  file: "legend"
      #-
      #  title: "Layout"
      #  url: "/documentation/layout"
      #  file: "layout"

  #-
  #  title: "Chart Types"
  #  pages:
  #    -
  #      title: "Linechart"
  #      url: "/documentation/plot-lines"
  #      file: "plot_lines"
  #    -
  #      title: "Plot: Scatter"
  #      title: "Scatter / Point"
  #      url: "/documentation/plot-scatter"
  #      file: ""
  #    -
  #      title: "Plot: Areas"
  #      title: "Areachart"
  #      url: "/documentation/plot-areas"
  #      file: ""
  #    -
  #      title: "Plot: Bars"
  #      title: "Barchart"
  #      url: "/documentation/plot-bars"
  #      file: ""
  #    -
  #      title: "Plot: Styling"
  #      url: "/documentation/plot-style"
  #      file: "plot_style"

  #-
  #  title: "Data Sources"
  #  pages:
  #    -
  #      title: "Data Source: CSV"
  #      title: "CSV"
  #      url: "/documentation/data-csvx"
  #      file: "data_csv"

  -
    title: "Examples"
    pages:
      -
        title: "Example Gallery"
        url: "/examples"
        file: "examples"

  -
    title: "Community"
    pages: