Skip to content
Snippets Groups Projects
Commit d8fc9c50 authored by Mayr, Hannes's avatar Mayr, Hannes
Browse files

Add figure_ids parameter to README.

parent 17311260
Branches
Tags
4 merge requests!65Release v0.3.0,!64New year developments,!63Improve handling of long IDs,!61Custom IDs
Pipeline #883462 passed
......@@ -56,6 +56,8 @@ The argument "plot_engine" defines which plot engine was used to create the figu
tagplot returns a PlotIDTransfer object that contains the tagged figures and the corresponding IDs as strings.
Optional parameters can be used to customize the tag process.
- *figure_ids*: list of str, optional
IDs that will be printed on the plot. If empty, IDs will be generated for each plot. If this option is used, an ID for each plot has to be specified. Default: [].
- *prefix* : str, optional
Will be added as prefix to the ID.
- *id_method* : str, optional
......
......@@ -41,7 +41,8 @@ def tagplot(
----------------
figure_ids: list of str, optional
IDs that will be printed on the plot. If empty, IDs will be generated for each
plot. Default: [].
plot. If this option is used, an ID for each plot has to be specified.
Default: [].
location : str, optional
Location for ID to be displayed on the plot. Default is "east".
rotation: float or int, optional
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment