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

consistent naming of plot/add-axes arguments

parent c4fb017c

README.md

+3 −3
Original line number Diff line number Diff line
@@ -37,9 +37,9 @@ Input File (`example_chart.clp`): 


    (plot

      axes (bottom left)

      axis-y-label-format (scientific)

      axis-x-label-format (datetime "%H:%M:%S")

      axis-x-label-placement (linear-align 1800)

      label-format-y (scientific)

      label-format-x (datetime "%H:%M:%S")

      label-placement-x (linear-align 1800)

      lines (

        data-x (csv "tests/testdata/measurement.csv" time)

        data-y (csv "tests/testdata/measurement.csv" value1)

doc/commands/arg/label_attach.yaml

0 → 100644
+8 −0
Original line number Diff line number Diff line 
desc_append: |

  The label 'attachment' controls how labels are oriented when placing them on the

  axis. Useful in conjunction with the `label-rotate` option.

desc_code: |

  label-attach [top|right|bottom|left]

examples: |

  ;; set label attach to left

  label-attach left

doc/commands/arg/label_format.yaml

0 → 100644
+5 −0
Original line number Diff line number Diff line 
desc_code: |

  labels <labels>

examples: |

  ;; use scientific labels for the top/bottom axes

  label-format (scientific)

doc/commands/arg/label_offset.yaml

0 → 100644
+8 −0
Original line number Diff line number Diff line 
desc: |

  Controls to which side of the axis the labels are placed. Value is

  clamped to [-1, 1].

desc_code: |

  label-offset <value>

examples: |

  ;; center the labels

  label-offset 0

doc/commands/arg/label_padding.yaml

0 → 100644
+7 −0
Original line number Diff line number Diff line 
desc: |

  Set the label padding/spacing. See the [measure](#FIXME) page for more details on valid values.

desc_code: |

  label-padding <measure>

examples: |

  ;; set the label padding to 2em

  label-padding 2em

CRA Git | Maintained and supported by SUSTech CRA and CCSE