Commit 6cd3c25f authored by Paul Asmuth's avatar Paul Asmuth
Browse files

consistent argument names

parent 1345adca
Loading
Loading
Loading
Loading
+0 −6
Original line number Diff line number Diff line
desc: Set the marker shape.
desc_code: |
  marker-shape (<marker-shape>)
examples: |
  ;; set marker size to 'hexagon'
  marker-shape (hexagon)
+6 −0
Original line number Diff line number Diff line
desc: Set the marker/point shape.
desc_code: |
  shape (<marker-shape>)
examples: |
  ;; set marker shape to 'hexagon'
  shape (hexagon)
+13 −13
Original line number Diff line number Diff line
@@ -28,10 +28,6 @@ arguments:
  - name: data-y-low
    type: dataset

  - name: color
    type: color
    desc: Set the bar color.

  - name: direction
    desc: |
      Set the bar 'direction'.
@@ -44,35 +40,39 @@ arguments:
      ;; draw a horizontal "column" chart
      direction horizontal

  - name: bar-width
  - name: color
    type: color
    desc: Set the bar color.

  - name: width
    desc: |
      Set the bar width. See the
      [measure](#FIXME) page for more details on valid values.
    desc_code: |
      bar-width <measure>
      width <measure>
    examples: |
      ;; set the bar width to 1em
      bar-width 1em
      width 1em

  - name: bar-offset
  - name: offset
    desc: |
      Set the bar offset. See the
      [measure](#FIXME) page for more details on valid values.
    desc_code: |
      bar-offset <measure>
      offset <measure>
    examples: |
      ;; set the bar offset to -.4em
      bar-offset -.4em
      offset -.4em

  - name: bar-stroke-color
  - name: stroke-color
    type: color
    desc: Set the bar's stroke color.

  - name: bar-stroke-width
  - name: stroke-width
    type: stroke_width
    desc: Set the bar stroke width.

  - name: bar-stroke-style
  - name: stroke-style
    type: stroke_style
    desc: Set the bar stroke style.

+16 −9
Original line number Diff line number Diff line
@@ -29,19 +29,26 @@ arguments:
  - name: data-y-low
    type: dataset

  - name: width
    type: line_width

  - name: color
    type: color
    desc: Set the bar color.
    desc: Set the error color.

  - name: colors
    type: dataset_colors
    desc: |
      Set an individual color for each errorbar. If no explicit `color-map`
      option is provided, the values in `colors` will be interpreted as
      hex color codes. Otherwise the mapping of input data to colors is controlled
      by the `color-map` option.

  - name: errorbar-width
  - name: color-map
    type: color_map
    desc: |
      Set the error bar width. See the
      [measure](#FIXME) page for more details on valid values.
    desc_code: |
      bar-width <measure>
    examples: |
      ;; set the bar width to 1em
      bar-width 1em
      Controls how input data is mapped to colors. If no map is specified, the
      values in `colors` will be interpreted as hex color values.

  - name: stroke-color
    type: color
+28 −56
Original line number Diff line number Diff line
@@ -15,85 +15,57 @@ arguments:
      Set the 'y' dataset for the plot. The 'y' dataset will be used to
      calculate the vertical position of points.

  - name: data-color
    desc: |
      Set the 'color' dataset for the plot. The 'color' dataset will be used to
      calculate the color of points. The mapping of input values to colors
      is controlled by the `color-map` option. If no explicit `color-map`
      option is provided, the values `data-color` will be interpreted as
      hex color codes.
    desc_code: |
      data-color (<values>...)
      data-color (csv <file> <column>)
    examples: |
      ;; list of static values
      data-color (#06c #c06 #06c)

      ;; load a csv file
      data-color (csv myfile.csv mycolors)
  - name: shape
    type: shape

  - name: data-size
  - name: shapes
    desc: |
      Set the 'size' dataset for the plot. The 'size' dataset will be used to
      calculate the size of points. The mapping of input values to typographic
      units is controlled by the `size-map` option.
      Set an individual 'shape' for each point.
    desc_code: |
      data-size (<values>...)
      data-size (csv <file> <column>)
      shapes (<values>...)
      shapes (csv <file> <column>)
    examples: |
      ;; list of static values
      data-size (2pt 8pt 5pt)
      shapes (hexagon circle square)

      ;; load a csv file
      data-size (csv myfile.csv mysizes)
      shapes (csv myfile.csv myshapes)

  - name: data-shape
  - name: size
    type: size
    desc: |
      Set the 'shape' dataset for the plot. The 'shape' dataset will be used to
      choose the marker shape of points.
    desc_code: |
      data-size (<values>...)
      data-size (csv <file> <column>)
    examples: |
      ;; list of static values
      data-size (hexagon circle square)
      Set the point size.

      ;; load a csv file
      data-size (csv myfile.csv myshapes)
  - name: sizes
    type: dataset_size
    desc: |
      Set an individual size for each point

  - name: size-map
    type: measure_map
    desc: |
      Set the point size map. If no map is specified, the values in `data-size`
      will be interpreted as unit values.
    desc_code: |
      size-map <measure-map>
      Controls how input data in `sizes` is mapped to typographic units.

  - name: color
    type: color
    desc: |
      Set the point color. Note that this value is only used if no data-colors
      Set the point color. Note that this value is only used if no `colors`
      option is specified.

  - name: color-map
  - name: colors
    type: dataset_colors
    desc: |
      Set the point color map. If no map is specified, the values in `data-color`
      will be interpreted as hex color values.
    desc_code: |
      color-map <color-map>
      Set an individual color for each point. If no explicit `color-map`
      option is provided, the values in `colors` will be interpreted as
      hex color codes. Otherwise the mapping of input data to colors is controlled
      by the `color-map` option.

  - name: marker-shape
    type: marker_shape

  - name: marker-size
    type: size
  - name: color-map
    type: color_map
    desc: |
      Set the marker size for the plot. If set to a value greater than zero, a
      'marker' will be drawn for each point in the dataset at the points (x, y)
      coordinate.
      Controls how input data in `colors` mapped to colors. If no map is specified, the
      values in `colors` will be interpreted as hex color values.

  - name: marker-color
    type: color
    desc: Set the marker color.

  - name: labels
    type: dataset_string
Loading