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

add documentation for the 'chart/linechart' and 'chart/scatterplot' elements

parent 32e4b438
Loading
Loading
Loading
Loading
+2 −0
Original line number Diff line number Diff line
@@ -44,6 +44,8 @@ ReturnCode build(
    {"marker-sizes", bind(&expr_rewritev, _1, "marker-sizes", &geom_opts)},
    {"labels", bind(&expr_rewritev, _1, "labels", &geom_opts)},
    {"label-font-size", bind(&expr_rewritev, _1, "label-font-size", &geom_opts)},
    {"label-color", bind(&expr_rewritev, _1, "label-color", &geom_opts)},
    {"label-padding", bind(&expr_rewritev, _1, "label-padding", &geom_opts)},

    /* scale options */
    {"limit-x", bind(&expr_rewritev, _1, "limit-x", &layout_opts)},
+39 −0
Original line number Diff line number Diff line
name: chart/linechart
example: charts-basic/linechart_timeseries
desc: |
  The `chart/linechart` element is a helper element for creating linecharts.

reference: |
  (chart/linechart <options>)

option_summary: true

properties:

  - title: "Line Options"
    anchor: line-options
    inherit: ["elements/chart/lines", "line-options"]

  - title: "Label Options"
    anchor: label-options
    inherit: ["elements/chart/lines", "label-options"]

  - title: "Scale Options"
    anchor: scale-options
    inherit: ["elements/chart/layout", "scale-options"]

  - title: "Axis Options"
    anchor: axis-options
    inherit: ["elements/chart/layout", "axis-options"]

  - title: "Layout Options"
    anchor: layout-options
    inherit: ["elements/layout/box", "layout-options"]

  - title: "Background Options"
    anchor: background-options
    inherit: ["elements/layout/box", "background-options"]

  - title: "Border Options"
    anchor: border-options
    inherit: ["elements/layout/box", "border-options"]
+39 −0
Original line number Diff line number Diff line
name: chart/scatterplot
example: charts-basic/scatterplot
desc: |
  The `chart/scatterplot` element is a helper element for creating scatterplots.

reference: |
  (chart/scatterplot <options>)

option_summary: true

properties:

  - title: "Point Options"
    anchor: point-options
    inherit: ["elements/chart/points", "point-options"]

  - title: "Label Options"
    anchor: label-options
    inherit: ["elements/chart/points", "label-options"]

  - title: "Scale Options"
    anchor: scale-options
    inherit: ["elements/chart/layout", "scale-options"]

  - title: "Axis Options"
    anchor: axis-options
    inherit: ["elements/chart/layout", "axis-options"]

  - title: "Layout Options"
    anchor: layout-options
    inherit: ["elements/layout/box", "layout-options"]

  - title: "Background Options"
    anchor: background-options
    inherit: ["elements/layout/box", "background-options"]

  - title: "Border Options"
    anchor: border-options
    inherit: ["elements/layout/box", "border-options"]
+6 −0
Original line number Diff line number Diff line
@@ -93,6 +93,12 @@ documentation:
    url: "/documentation/elements"
    file: "elements"
    pages:
      -
        title: "chart/linechart"
        url: "/documentation/elements/chart/linechart"
      -
        title: "chart/scatterplot"
        url: "/documentation/elements/chart/scatterplot"
      -
        title: "chart/layout"
        url: "/documentation/elements/chart/layout"