From 373bf71d6b108a638c6ba2ec6937d055c1d0f7dd Mon Sep 17 00:00:00 2001 From: TEC Date: Sun, 25 Oct 2020 02:14:37 +0800 Subject: [PATCH 15/15] org-manual.org: document org-plot changes * doc/org-manual.org: Document changes to org-plot.el. --- doc/org-manual.org | 39 ++++++++++++++++++++++++++++++++++++++- 1 file changed, 38 insertions(+), 1 deletion(-) diff --git a/doc/org-manual.org b/doc/org-manual.org index 066092238..7eff42aee 100644 --- a/doc/org-manual.org +++ b/doc/org-manual.org @@ -2809,6 +2809,19 @@ following table. | Morelia | 257.56 | 17.67 | #+end_example +Org Plot supports a range of plot types, and provides the ability to add more. +For example, a radar plot can be generated like so: +#+begin_example +,#+PLOT: title:"An evaluation of plaintext document formats" transpose:yes type:radar min:0 max:4 +| Format | Fine-grained-control | Initial Effort | Syntax simplicity | Editor Support | Integrations | Ease-of-referencing | Versatility | +|-------------------+----------------------+----------------+-------------------+----------------+--------------+---------------------+-------------| +| Word | 2 | 4 | 4 | 2 | 3 | 2 | 2 | +| LaTeX | 4 | 1 | 1 | 3 | 2 | 4 | 3 | +| Org Mode | 4 | 2 | 3.5 | 1 | 4 | 4 | 4 | +| Markdown | 1 | 3 | 3 | 4 | 3 | 3 | 1 | +| Markdown + Pandoc | 2.5 | 2.5 | 2.5 | 3 | 3 | 3 | 2 | +#+end_example + Notice that Org Plot is smart enough to apply the table's headers as labels. Further control over the labels, type, content, and appearance of plots can be exercised through the =PLOT= keyword @@ -2839,9 +2852,15 @@ For more information and examples see the [[https://orgmode.org/worg/org-tutoria the third and fourth columns. Defaults to graphing all other columns aside from the =ind= column. +- transpose :: + + When =y=, =yes=, or =t= attempt to transpose the table data before plotting. Also + recognises the shorthand option =trans=. + - =type= :: - Specify whether the plot is =2d=, =3d=, or =grid=. + Specify the type of the plot, by default one of =2d=, =3d=, =radar=, or =grid=. + Available types can be customised with ~org-plot/preset-plot-types~. - =with= :: @@ -2868,6 +2887,24 @@ For more information and examples see the [[https://orgmode.org/worg/org-tutoria When plotting =3d= or =grid= types, set this to =t= to graph a flat mapping rather than a =3d= slope. +- min :: + + Provides a minimum axis value that may be used by a plot type. Implicitly + assumes the =y= axis is being referred to. Can explicitly provide a value for a + either the =x= or =y= axis with =xmin= and =ymin=. + +- max :: + + Provides a maximum axis value that may be used by a plot type. Implicitly + assumes the =y= axis is being referred to. Can explicitly provide a value for a + either the =x= or =y= axis with =xmax= and =ymax=. + +- ticks :: + + Provides a desired number of axis ticks to display, that may be used by a plot + type. If none is given a plot type that requires ticks will use + ~org--plot/sensible-tick-num~ to try to determine a good value. + - =timefmt= :: Specify format of Org mode timestamps as they will be parsed by -- 2.28.0