Plots
Plots
--plotDATASET
Use the current backend to load the given datasets onto the data stack and plot them. It is a
combination of the load and the plot-last commands; you might want to see their documentation.
Optionalarguments:asbypass-transformsclassclippedcolorcolor-mapcontour-conreccontour-minor-numbercontour-minor-scalecontour-minor-stylecontour-numberdeptherror-bar-colorerror-bar-line-widthfillfill-colorfill-patternfill-transparencyidignore_hookslegendline-capline-styleline-widthmarkermarker-anglemarker-colormarker-color-mapmarker-fill-colormarker-fill-color-mapmarker-line-colormarker-line-color-mapmarker-line-widthmarker-min-scalemarker-scalenamepath-styleregion-sidesplit-on-nanwherexaxisyaxiszaxisCorrespondingcommand:plot(dataset,option=...)-p,--plot-last
Plots the last dataset pushed onto the data stack (or the one specified with the which option),
with the current style. All aspects of the curve style (colors, markers, line styles...) can be
overridden through the use of options.
Optionalarguments:classclippedcolorcolor-mapcontour-conreccontour-minor-numbercontour-minor-scalecontour-minor-stylecontour-numberdeptherror-bar-colorerror-bar-line-widthfillfill-colorfill-patternfill-transparencyidlegendline-capline-styleline-widthmarkermarker-anglemarker-colormarker-color-mapmarker-fill-colormarker-fill-color-mapmarker-line-colormarker-line-color-mapmarker-line-widthmarker-min-scalemarker-scalepath-styleregion-sidesplit-on-nanwhichxaxisyaxiszaxisCorrespondingcommand:plot-last(,option=...)Curvesstyles
Set stylistic details of curves or other object drawn from data
--[no-]clipped
Sets the clipped for subsequent curves, until cancelled with auto as argument.
Correspondingcommand:clipped(boolean-or-auto)-c,--colorCOLOR-OR-FALSE-OR-AUTO
Sets the line color for subsequent curves, until cancelled with auto as argument.
Correspondingcommand:color(color-or-false-or-auto)--color-mapCOLORMAP-OR-AUTO
Sets the color map for the subsequent curves, until cancelled by an auto argument.
Color maps are used for 3D plots, ie under the effet of contour, xyz-map and xy-parametric.
Correspondingcommand:color-map(colormap-or-auto)--color-setCOLOR-OR-FALSE-SET
Chooses a set for the line color of subsequent curves. Also sets color to auto, so that the set
takes effect immediately
Correspondingcommand:color-set(color-or-false-set)--[no-]contour-conrec
If on, the subsequent curves will use the CONREC algorithm for contouring. In the opposite case,
the contouring algorithm of Gri is used.
Only useful when contour is in effect.
Correspondingcommand:contour-conrec(boolean-or-auto)--contour-minor-numberINTEGER-OR-AUTO
Sets the number of minor level lines between major ones (approx) for subsequent curves, until
cancelled with auto as argument.
Correspondingcommand:contour-minor-number(integer-or-auto)--contour-minor-scaleFLOAT-OR-AUTO
Sets the relative scale of minor level lines for subsequent curves, until cancelled with auto as
argument.
Correspondingcommand:contour-minor-scale(float-or-auto)--contour-minor-styleLINE-STYLE-OR-AUTO
Sets the minor ticks line style for subsequent curves, until cancelled with auto as argument.
Correspondingcommand:contour-minor-style(line-style-or-auto)--contour-numberINTEGER-OR-AUTO
Sets the overall number of level lines for subsequent curves, until cancelled with auto as
argument.
Correspondingcommand:contour-number(integer-or-auto)--depthINTEGER-OR-AUTO
Sets the depth for subsequent curves, until cancelled with auto as argument.
Correspondingcommand:depth(integer-or-auto)--error-bar-colorCOLOR-OR-FALSE-OR-AUTO
Sets the error bar color for subsequent curves, until cancelled with auto as argument.
Correspondingcommand:error-bar-color(color-or-false-or-auto)--error-bar-color-setCOLOR-OR-FALSE-SET
Chooses a set for the error bar color of subsequent curves. Also sets error-bar-color to auto, so
that the set takes effect immediately
Correspondingcommand:error-bar-color-set(color-or-false-set)--error-bar-line-widthFLOAT-OR-AUTO
Sets the error bar line width for subsequent curves, until cancelled with auto as argument.
Correspondingcommand:error-bar-line-width(float-or-auto)--error-bar-line-width-setFLOAT-SET
Chooses a set for the error bar line width of subsequent curves. Also sets error-bar-line-width
to auto, so that the set takes effect immediately
Correspondingcommand:error-bar-line-width-set(float-set)--fillFILL-UNTIL-OR-AUTO
Sets the Fill until for subsequent curves, until cancelled with auto as argument.
Correspondingcommand:fill(fill-until-or-auto)--fill-colorCOLOR-OR-AUTO
Sets the fill color for subsequent curves, until cancelled with auto as argument.
Correspondingcommand:fill-color(color-or-auto)--fill-color-setCOLOR-SET
Chooses a set for the fill color of subsequent curves. Also sets fill-color to auto, so that the
set takes effect immediately
Correspondingcommand:fill-color-set(color-set)--fill-patternFILL-PATTERN-OR-AUTO
Sets the fill pattern for subsequent curves, until cancelled with auto as argument.
Correspondingcommand:fill-pattern(fill-pattern-or-auto)--fill-setFILL-UNTIL-SET
Chooses a set for the Fill until of subsequent curves. Also sets fill to auto, so that the set
takes effect immediately
Correspondingcommand:fill-set(fill-until-set)--fill-transparencyFLOAT-OR-AUTO
Sets the fill transparency for subsequent curves, until cancelled with auto as argument.
Correspondingcommand:fill-transparency(float-or-auto)--fill-transparency-setFLOAT-SET
Chooses a set for the fill transparency of subsequent curves. Also sets fill-transparency to
auto, so that the set takes effect immediately
Correspondingcommand:fill-transparency-set(float-set)--line-capLINE-CAP-OR-AUTO
Sets the line cap for subsequent curves, until cancelled with auto as argument.
Correspondingcommand:line-cap(line-cap-or-auto)--line-styleLINE-STYLE-OR-AUTO
Sets the line style for subsequent curves, until cancelled with auto as argument.
Correspondingcommand:line-style(line-style-or-auto)--line-style-setLINE-STYLE-SET
Chooses a set for the line style of subsequent curves. Also sets line-style to auto, so that the
set takes effect immediately
Correspondingcommand:line-style-set(line-style-set)--line-widthFLOAT-OR-AUTO
Sets the line width for subsequent curves, until cancelled with auto as argument.
Correspondingcommand:line-width(float-or-auto)--line-width-setFLOAT-SET
Chooses a set for the line width of subsequent curves. Also sets line-width to auto, so that the
set takes effect immediately
Correspondingcommand:line-width-set(float-set)-m,--markerMARKER-OR-AUTO
Sets the marker for subsequent curves, until cancelled with auto as argument.
Correspondingcommand:marker(marker-or-auto)--marker-angleFLOAT-OR-AUTO
Sets the marker angle for subsequent curves, until cancelled with auto as argument.
Correspondingcommand:marker-angle(float-or-auto)--marker-colorCOLOR-OR-FALSE-OR-AUTO
Sets the marker color for subsequent curves, until cancelled with auto as argument.
Correspondingcommand:marker-color(color-or-false-or-auto)--marker-color-mapCOLORMAP-OR-AUTO
Sets the color map for markers for subsequent curves, until cancelled with auto as argument.
Correspondingcommand:marker-color-map(colormap-or-auto)--marker-color-setCOLOR-OR-FALSE-SET
Chooses a set for the marker color of subsequent curves. Also sets marker-color to auto, so that
the set takes effect immediately
Correspondingcommand:marker-color-set(color-or-false-set)--marker-fill-colorCOLOR-OR-FALSE-OR-AUTO
Sets the marker fill color for subsequent curves, until cancelled with auto as argument.
Correspondingcommand:marker-fill-color(color-or-false-or-auto)--marker-fill-color-mapCOLORMAP-OR-AUTO
Sets the color map for the lines of markers for subsequent curves, until cancelled with auto as
argument.
Correspondingcommand:marker-fill-color-map(colormap-or-auto)--marker-fill-color-setCOLOR-OR-FALSE-SET
Chooses a set for the marker fill color of subsequent curves. Also sets marker-fill-color to
auto, so that the set takes effect immediately
Correspondingcommand:marker-fill-color-set(color-or-false-set)--marker-line-colorCOLOR-OR-FALSE-OR-AUTO
Sets the marker stroke color for subsequent curves, until cancelled with auto as argument.
Correspondingcommand:marker-line-color(color-or-false-or-auto)--marker-line-color-mapCOLORMAP-OR-AUTO
Sets the color map for the lines of markers for subsequent curves, until cancelled with auto as
argument.
Correspondingcommand:marker-line-color-map(colormap-or-auto)--marker-line-color-setCOLOR-OR-FALSE-SET
Chooses a set for the marker stroke color of subsequent curves. Also sets marker-line-color to
auto, so that the set takes effect immediately
Correspondingcommand:marker-line-color-set(color-or-false-set)--marker-line-widthFLOAT-OR-AUTO
Sets the marker line width for subsequent curves, until cancelled with auto as argument.
Correspondingcommand:marker-line-width(float-or-auto)--marker-min-scaleFLOAT-OR-FALSE-OR-AUTO
Sets the marker scale for subsequent curves, until cancelled with auto as argument.
Correspondingcommand:marker-min-scale(float-or-false-or-auto)--marker-scaleFLOAT-OR-AUTO
Sets the marker scale for subsequent curves, until cancelled with auto as argument.
Correspondingcommand:marker-scale(float-or-auto)--marker-scale-setFLOAT-SET
Chooses a set for the marker scale of subsequent curves. Also sets marker-scale to auto, so that
the set takes effect immediately
Correspondingcommand:marker-scale-set(float-set)--marker-setMARKER-SET
Chooses a set for the marker of subsequent curves. Also sets marker to auto, so that the set
takes effect immediately
Correspondingcommand:marker-set(marker-set)--path-styleTEXT-OR-AUTO
Sets the path style for subsequent curves, until cancelled with auto as argument.
Correspondingcommand:path-style(text-or-auto)--path-style-setTEXT-SET
Chooses a set for the path style of subsequent curves. Also sets path-style to auto, so that the
set takes effect immediately
Correspondingcommand:path-style-set(text-set)--region-sideREGION-SIDE-OR-AUTO
Sets the region side for subsequent curves, until cancelled with auto as argument.
Correspondingcommand:region-side(region-side-or-auto)--region-side-setREGION-SIDE-SET
Chooses a set for the region side of subsequent curves. Also sets region-side to auto, so that
the set takes effect immediately
Correspondingcommand:region-side-set(region-side-set)--reuse-styleOBJECT
After using this command, the next curve will have the same style as the curve whose name was
given as the first argument (it is the name given to the `/id=` option to plot.
Correspondingcommand:reuse-style(object)--skip This command acts as if one (or number) dataset had been drawn with respect to the style of the
next dataset to be drawn.
Optionalarguments:numberCorrespondingcommand:skip(,option=...)--[no-]split-on-nan
In general, the NaN (not a number, ie invalid data points in the dataset) in a dataset are
silently ignored. When this option is on, the lines of xy-plot-style plots are split upon
encountering a NaN.
Correspondingcommand:split-on-nan(boolean-or-auto)--zaxisTEXT-OR-AUTO
Sets the name of the zaxis for the subsequent curves. This must be an axis that has been
previously created using new-zaxis.
This axis will be used to display the colormaps of the following curve.
Correspondingcommand:zaxis(text-or-auto)Legends
Commands to specify legends and tweak their look.
--[no-]auto-legend
When this option is in effect (off by default), all datasets get a legend, their 'dataset name',
unless another legend is manually specified.
Correspondingcommand:auto-legend(boolean)-l,--legendTEXT
Sets the legend for the next dataset. Overridden by the legend option to the plot command.
Correspondingcommand:legend(text)--legend-insideALIGNED-POINT
Using this command sets the position of the legends for the current (sub)plot inside it, at the
precise location given.
As a shortcut, legend-inside also takes all the options that legend-style takes, with the same
effect.
Optionalarguments:classdyframe_capframe_colorframe_fill_colorframe_fill_patternframe_fill_transparencyframe_paddingframe_radiusframe_shapeframe_styleframe_widthidpicto_heightpicto_to_textpicto_widthscalesymbol_scaletext_scalevpaddingCorrespondingcommand:legend-inside(aligned-point,option=...)--legend-lineTEXT
Adds a line of text unrelated to any curve to the legend.
The options controlling the aspect of the legend are documented in the define-text-style command.
Optionalarguments:alignalignmentanglecolorhalignjustificationpositionscaleshifttext_aligntext_widthvalignCorrespondingcommand:legend-line(text,option=...)--legend-multicol
Following legends will be layed out in multiple columns, until a call to legend-multicol-end.
Optionalarguments:columnsdxCorrespondingcommand:legend-multicol(,option=...)--legend-multicol-end
Stop layout out legends in several columns
Correspondingcommand:legend-multicol-end()--legend-style
Sets the various aspects of the style of the legends throught its options:
* dy: the spacing between the baseline of consecutive lines; it is deprecated now in favor
of vpadding;
* vpadding: the space left between the bottom of a line and the top of the next one;
* scale: the overall scale of the legends
* text-scale: the scale of the text (and the markers) inside the legends
The frame- options control the drawing of a frame around the legend; they have the same meaning
as corresponding ones of define-box-style with the frame- bit dropped.
Optionalarguments:classdyframe_capframe_colorframe_fill_colorframe_fill_patternframe_fill_transparencyframe_paddingframe_radiusframe_shapeframe_styleframe_widthidpicto_heightpicto_to_textpicto_widthscalesymbol_scaletext_scalevpaddingCorrespondingcommand:legend-style(,option=...)Switchbetweendifferentkindsofplots
How to switch between different kinds of plot types
--contour
Switch to contour plots for later curves. Contour plots need three columns (X,Y,Z). They have
major and minor lines.
Correspondingcommand:contour()--histogram
Switch to drawing histograms.
Optionalarguments:compute_dxcumulativegapintra_sepCorrespondingcommand:histogram(,option=...)--xy-parametric
Switch to XY parametric plots, that is standard XY plots whose appearance (such as color, marker
color, and, potentially, marker kinds and more) are governed by one (or more ?) Z values.
Optionalarguments:z1z2z3z4Correspondingcommand:xy-parametric(,option=...)--xy-plot
Switch (back) to standard XY plots (ctioga's default)
Correspondingcommand:xy-plot()--xyz-map
Switch to XYZ maps, ie plots where the color at a XY location is given by its Z value.
Correspondingcommand:xyz-map()Plotcoordinates
Plot coordinates
--marginFLOAT
Leaves a margin around the data points. Expressed in relative size of the whole plot.
Correspondingcommand:margin(float)--xfactFLOAT
Alias for xscale.
Correspondingcommand:xfact(float)--[no-]xlog
Uses a logarithmic scale for the X axis.
Correspondingcommand:xlog(boolean)--xoffsetFLOAT
Adds the given offset to all X coordinates.
Correspondingcommand:xoffset(float)--xrangePARTIAL-FLOAT-RANGE
Sets the range of the X coordinates.
*Important note:* when the axis is in log range (using xlog), the numbers you give are not the or
ylog values, but their log10, so that to display X values from 1e-2 to 1e3, use:
xyrange -2:3
Correspondingcommand:xrange(partial-float-range)--xscaleFLOAT
Multiplies the X coordinates by this factor.
Correspondingcommand:xscale(float)--yfactFLOAT
Alias for yscale.
Correspondingcommand:yfact(float)--[no-]ylog
Uses a logarithmic scale for the Y axis.
Correspondingcommand:ylog(boolean)--yoffsetFLOAT
Adds the given offset to all Y coordinates.
Correspondingcommand:yoffset(float)--yrangePARTIAL-FLOAT-RANGE
Sets the range of the Y coordinates.
*Important note:* when the axis is in log range (using ylog), the numbers you give are not the or
ylog values, but their log10, so that to display Y values from 1e-2 to 1e3, use:
yyrange -2:3
Correspondingcommand:yrange(partial-float-range)--yscaleFLOAT
Multiplies the Y coordinates by this factor.
Correspondingcommand:yscale(float)Graphicsprimitives
Tioga graphics primitives
--drawDRAWING-SPEC
Tries to emulate the old --draw behavior of ctioga. Don't use it for new things.
Correspondingcommand:draw(drawing-spec)--draw-arrowPOINTPOINT
Draws arrow on the current plot, using the given style. For more information on the available
options, see the define-arrow-style command.
Optionalarguments:capclassclippedcolordepthhead_anglehead_colorhead_markerhead_scaleidline_styleline_widthstyletail_angletail_colortail_markertail_scalewidthCorrespondingcommand:draw-arrow(point,point,option=...)--draw-boxPOINTPOINT
Draws box on the current plot, using the given style. For more information on the available
options, see the define-box-style command.
Optionalarguments:capclassclippedcolordepthfill-colorfill-transparencyfill_colorfill_patternfill_transparencyidradiusshapestylewidthCorrespondingcommand:draw-box(point,point,option=...)--draw-color-listPOINTDIMENSION
Directly draws the list of all named colors on the current plot
Optionalarguments:classclippedcolumnsdepthidpaddingscaleCorrespondingcommand:draw-color-list(point,dimension,option=...)--draw-color-set-listPOINTDIMENSION
Directly draws the list of all color sets on the current plot
Optionalarguments:classclippeddepthexcludeidincludescaleCorrespondingcommand:draw-color-set-list(point,dimension,option=...)--draw-contourLEVEL
Directly draws contour on the current plot
Optionalarguments:classclippedclosedcolordepthidstylewidthCorrespondingcommand:draw-contour(level,option=...)--draw-imageFILETOP-LEFTBOTTOM-RIGHT
Draws image on the current plot, using the given style. For more information on the available
options, see the define-image-style command.
Optionalarguments:aspect_ratioauto_rotateclassclippeddepthidtransparencyCorrespondingcommand:draw-image(file,top-left,bottom-right,option=...)--draw-legend-pictogramPOINTOBJECT
Draws the legend pictogram for the given curve
Optionalarguments:classclippeddepthidwidthCorrespondingcommand:draw-legend-pictogram(point,object,option=...)--draw-linePOINTPOINT
Draws line on the current plot, using the given style. For more information on the available
options, see the define-line-style command.
Optionalarguments:capclassclippedcolordepthhead_anglehead_colorhead_markerhead_scaleidline_styleline_widthstyletail_angletail_colortail_markertail_scalewidthCorrespondingcommand:draw-line(point,point,option=...)--draw-line-style-listPOINTDIMENSION
Directly draws the list of all named line styles on the current plot
Optionalarguments:classclippedcolumnsdepthidpaddingscaleCorrespondingcommand:draw-line-style-list(point,dimension,option=...)--draw-markerPOINTMARKER
Draws marker on the current plot, using the given style. For more information on the available
options, see the define-marker-style command.
Optionalarguments:alignmentangleclassclippedcolordepthfill_colorhorizontal_scaleidjustificationscalestroke_colorstroke_widthvertical_scaleCorrespondingcommand:draw-marker(point,marker,option=...)--draw-marker-listPOINTDIMENSION
Directly draws the list of all named markers on the current plot
Optionalarguments:classclippedcolumnsdepthidpaddingscaleCorrespondingcommand:draw-marker-list(point,dimension,option=...)--draw-marker-set-listPOINTDIMENSION
Directly draws the list of all marker sets on the current plot
Optionalarguments:classclippeddepthexcludeidincludescaleCorrespondingcommand:draw-marker-set-list(point,dimension,option=...)--draw-oriented-linePOINTDIMENSION
Draws oriented-line on the current plot, using the given style. For more information on the
available options, see the define-oriented-line-style command.
Optionalarguments:anglecapclassclippedcolordepthhead_anglehead_colorhead_markerhead_scaleidoriginstyletail_angletail_colortail_markertail_scalewidthCorrespondingcommand:draw-oriented-line(point,dimension,option=...)--draw-string-markerPOINTTEXT
Draws marker on the current plot, using the given style. For more information on the available
options, see the define-marker-style command.
Optionalarguments:alignmentangleclassclippedcolordepthfill_colorfonthorizontal_scaleidjustificationscalestroke_colorstroke_widthvertical_scaleCorrespondingcommand:draw-string-marker(point,text,option=...)--draw-tangentDATA-POINT
Draws tangent on the current plot, using the given style. For more information on the available
options, see the define-arrow-style command.
Optionalarguments:capclassclippedcolordepthhead_anglehead_colorhead_markerhead_scaleidline_styleline_widthnbavgstyletail_angletail_colortail_markertail_scalewidthxextentxfromxtoyextentyfromytoCorrespondingcommand:draw-tangent(data-point,option=...)--draw-textPOINTTEXT
Draws text on the current plot, using the given style. For more information on the available
options, see the define-text-style command.
Optionalarguments:alignmentangleclassclippedcolordepthfonthalignidjustificationpositionscaleshifttext_aligntext_widthvalignCorrespondingcommand:draw-text(point,text,option=...)The'direct'backend:Directformat
The commands in this group drive the behaviour of the direct backend; see its documentation for more
information
--direct
Selects the 'direct' backend
Correspondingcommand:direct()The'gnuplot'backend:Gnuplotfiles
The commands in this group drive the behaviour of the gnuplot backend; see its documentation for more
information
--gnuplot
Selects the 'gnuplot' backend
Optionalarguments:rangesamplesvarsCorrespondingcommand:gnuplot(,option=...)--gnuplot-rangeRANGE
The plotting X range, such as 0:2
Correspondingcommand:gnuplot-range(range)--gnuplot-samplesSAMPLES
The number of samples
Correspondingcommand:gnuplot-samples(samples)--gnuplot-varsVARS
A colon-separated override of local variables, such as a=1;b=3;c=5
Correspondingcommand:gnuplot-vars(vars)The'math'backend:Mathematicalfunctions
The commands in this group drive the behaviour of the math backend; see its documentation for more
information
--math Selects the 'math' backend
Optionalarguments:logsamplestrangexrangeCorrespondingcommand:math(,option=...)--[no-]math-log
Space samples logarithmically
Correspondingcommand:math-log(log)--math-samplesSAMPLES
The number of points
Correspondingcommand:math-samples(samples)--math-trangeTRANGE
T range (a:b) (parametric plot)
Correspondingcommand:math-trange(trange)--math-xrangeXRANGE
X range (a:b)
Correspondingcommand:math-xrange(xrange)The'smath'backend:Mathematicalfunctions(multi-D)
The commands in this group drive the behaviour of the smath backend; see its documentation for more
information
--smath Selects the 'smath' backend
Optionalarguments:samplesurangeusamplesvrangevsamplesCorrespondingcommand:smath(,option=...)--smath-samplesSAMPLES
Number of samples (default, overriden by variable-specific specs)
Correspondingcommand:smath-samples(samples)--smath-urangeURANGE
U range (a:b)
Correspondingcommand:smath-urange(urange)--smath-usamplesUSAMPLES
Number of U samples
Correspondingcommand:smath-usamples(usamples)--smath-vrangeVRANGE
V range (a:b)
Correspondingcommand:smath-vrange(vrange)--smath-vsamplesVSAMPLES
Number of V samples
Correspondingcommand:smath-vsamples(vsamples)The'text'backend:Textformat
The commands in this group drive the behaviour of the text backend; see its documentation for more
information
--csv Now parse the following data files as CSV. Equivalent to
text /separator=/[,;]/
Correspondingcommand:csv()--text Selects the 'text' backend
Optionalarguments:colheader-lineparametersseparatorskipsplitCorrespondingcommand:text(,option=...)--text-colCOL
Which columns to use when the @1:2 syntax is not used
Correspondingcommand:text-col(col)--text-header-lineHEADER-LINE
Regular expression indicating the header line (containing column names) (default /^##/
Correspondingcommand:text-header-line(header-line)--text-parametersPARAMETERS
Regular expression for extracting parameters from a file. Defaults to nil (ie nothing)
Correspondingcommand:text-parameters(parameters)--text-separatorSEPARATOR
The columns separator. Defaults to / +/
Correspondingcommand:text-separator(separator)--text-skipSKIP
Number of lines to be skipped at the beginning of the file
Correspondingcommand:text-skip(skip)--[no-]text-split
If true, splits files into subsets on blank/non number lines
Correspondingcommand:text-split(split)LaTeX
Commands providing control over the LaTeX output (preamble, packages...)
--preambleTEXT
Adds the given string to the LaTeX preamble of the output.
Correspondingcommand:preamble(text)--set-global-font
Set global font. Sets the size of everything, including that of text that has already been used.
Optionalarguments:sizeCorrespondingcommand:set-global-font(,option=...)--useTEXT
Adds a command to include the LaTeX package into the preamble. The arguments, if given, are given
within [square backets].
Optionalarguments:argumentsCorrespondingcommand:use(text,option=...)--utf8 Makes ctioga2 use UTF-8 for all text. It is exactly equivalent to the command preamble with the
argument:
sepackage[utf8]{inputenc}sepackage[T1]{fontenc}
Correspondingcommand:utf8()Subplotsandassimilated
Subplots and assimilated
--end Leaves the current subobject.
Correspondingcommand:end()--frame-marginsFRAME-MARGINS
Sets the margins for the current plot. Margins are the same things as the position (such as
specified for and inset). Using this within an inset or more complex plots might produce
unexpected results. The main use of this function is to control the padding around simple plots.
The options override the contents of the margin, which makes it easy to set all the dimensions to
a given value and just override the ones you need to:
frame-margins 2mm /left=1cm This sets all the margins around the side to 2mm excepted the left
one, which means in particular the bottom axis tick labels will be cut.
Optionalarguments:bottomleftrighttopCorrespondingcommand:frame-margins(frame-margins,option=...)--gradientCOLORCOLOR
All the curves between this command and the corresponding end will have their color set to a
weighted average of the colors given as argument. This gives a neat gradient effect.
Optionalarguments:classidCorrespondingcommand:gradient(color,color,option=...)--hideOBJECTS
Hides all the named objects in the list. Useful for creating animations.
Optionalarguments:showCorrespondingcommand:hide(objects,option=...)--insetBOX
Starts a new inset within the given box.
If no graph has been started yet, it just creates a new graph using the given box. In short, it
does what it seems it should.
Optionalarguments:classidCorrespondingcommand:inset(box,option=...)--next-insetBOX
Has the same effet as end followed by inset.
Particularly useful for chaining subgraphs. In that case, you might be interested in the grid box
specification and setup-grid.
Optionalarguments:classidCorrespondingcommand:next-inset(box,option=...)--paddingDIMENSION
When the frame-margins is set to automatic, ctioga2 leaves that much space around the plot on the
sides where there are no labels.
Correspondingcommand:padding(dimension)--plot-scaleFLOAT
Applies a scaling factor to the whole current subplot. Depending on the 'what' option (default
text), the scale applies to:
* text ('text' or 'both')
* marker size ('text' or 'both')
* line widths ('lines' or 'both') Scaling also applies to all elements of the plot that were
added before the call to plot-scale.
Optionalarguments:whatCorrespondingcommand:plot-scale(float,option=...)--region
The curves up to the corresponding end will be considered for delimiting a colored region between
them. The actual position of the curves with respect to the region can be fine-tuned using the
region-side command (or the corresponding option to plot).
Optionalarguments:classcoloridpatternreversed_colorreversed_patternreversed_transparencytransparencyCorrespondingcommand:region(,option=...)--reopenOBJECT
Reopens a previously finished container, such as a subplot, a region or a gradient. Provide the
unique name you gave as the /id= option to the first command
Correspondingcommand:reopen(object)--root-plot
Begins the root plot. This command is only necessary if you want to give styling information to
the root plot.
Optionalarguments:classidCorrespondingcommand:root-plot(,option=...)--setup-gridTEXT
Sets up a grid of the given layout (such as 2x1). After this command, arguments such as grid:0,1
can be used as the box argument of inset and next-inset commands.
Alternatively, the layout can be specified as 1,2,1x1,4, in which case there are three columns
and two rows; the second column is 2 times larger than the other ones, while the second row is
four times larger than the first.
Optionalarguments:bottomdxdyleftrighttopCorrespondingcommand:setup-grid(text,option=...)--text-adjust-modeTEXT-ADJUST-MODE
When this is on (the default), ctioga2 tries to be smart about the size of the text bits around
the plot. However, this can be bothersome at times, so you can disable that with this command.
Correspondingcommand:text-adjust-mode(text-adjust-mode)Axesandlabels
Axes and labels
--axis-styleAXIS
This command can be used to set various aspects of the style of the given axis, through its
various options, which are documented in more details in the define-axis-style command --
excepted for the ticks bit which are documented in the ticks command.
If the option also-axes is specified, the style is also applied to the comma-separated list of
axes it contains.
Optionalarguments:also-axesaxis_label_alignmentaxis_label_angleaxis_label_coloraxis_label_halignaxis_label_justificationaxis_label_locaxis_label_positionaxis_label_scaleaxis_label_shiftaxis_label_textaxis_label_text_alignaxis_label_text_widthaxis_label_valignbackground_lines_capbackground_lines_colorbackground_lines_stylebackground_lines_widthdecorationline_widthlocationlogmajor_tick_lengthmajor_tick_widthminor_tick_lengthminor_tick_widthoffsetstroke_colortick_label_alignmenttick_label_angletick_label_colortick_label_haligntick_label_justificationtick_label_positiontick_label_scaletick_label_shifttick_label_text_aligntick_label_text_widthtick_label_valignticks_formatticks_format_lastticks_labelsticks_majorticks_major_deltaticks_major_numberticks_major_septicks_minorticks_minor_deltaticks_minor_numberticks_minor_sep_minticks_sidetransformCorrespondingcommand:axis-style(axis,option=...)--background-gridCOLOR-OR-FALSE
Shortcut to set the color for the left and bottom axes
Optionalarguments:capstylewidthCorrespondingcommand:background-grid(color-or-false,option=...)--background-linesAXISCOLOR-OR-FALSE
Sets the color of the background lines for the given axis.
Optionalarguments:capstylewidthCorrespondingcommand:background-lines(axis,color-or-false,option=...)--bottomAXIS-DECORATION
Sets the type of the bottom axis.
The options have the same meaning as for define-axis-style, see that command for more
information.
Optionalarguments:axis_label_alignmentaxis_label_angleaxis_label_coloraxis_label_halignaxis_label_justificationaxis_label_locaxis_label_positionaxis_label_scaleaxis_label_shiftaxis_label_textaxis_label_text_alignaxis_label_text_widthaxis_label_valignbackground_lines_capbackground_lines_colorbackground_lines_stylebackground_lines_widthline_widthlocationlogmajor_tick_lengthmajor_tick_widthminor_tick_lengthminor_tick_widthoffsetstroke_colortick_label_alignmenttick_label_angletick_label_colortick_label_haligntick_label_justificationtick_label_positiontick_label_scaletick_label_shifttick_label_text_aligntick_label_text_widthtick_label_valignticks_formatticks_format_lastticks_labelsticks_majorticks_major_deltaticks_major_numberticks_major_septicks_minorticks_minor_deltaticks_minor_numberticks_minor_sep_minticks_sidetransformCorrespondingcommand:bottom(axis-decoration,option=...)--clear-axes
Removes all the axes and their associated labels
Correspondingcommand:clear-axes()--drawing-frame
Setup a drawing frame, ie a frame in which the top-left point is at 0,0, with X and Y values
positive over the whole frame, and counted in centimeters (or with the unit given using the
/units option, ie /units=mm expressed in millimeters or /units=12pt expressed in multiple of 12
TeX points).
Optionalarguments:unitsCorrespondingcommand:drawing-frame(,option=...)--label-styleLABEL
Sets the style of the given label (see the type label for more information). See define-text-style for detailed information about the meaning of the options.
The option text permits to also set the text of the label (does not work for ticks).
For tick labels, setting the color option also sets the color for the lines of the corresponding
axis. If you don't want that, you can override the color using the stroke-color option of axis-style. This will only work with Tioga version 1.11 or greater.
Optionalarguments:alignalignmentanglecolorhalignjustificationlocpositionscaleshifttexttext_aligntext_widthvalignCorrespondingcommand:label-style(label,option=...)--leftAXIS-DECORATION
Sets the type of the left axis.
The options have the same meaning as for define-axis-style, see that command for more
information.
Optionalarguments:axis_label_alignmentaxis_label_angleaxis_label_coloraxis_label_halignaxis_label_justificationaxis_label_locaxis_label_positionaxis_label_scaleaxis_label_shiftaxis_label_textaxis_label_text_alignaxis_label_text_widthaxis_label_valignbackground_lines_capbackground_lines_colorbackground_lines_stylebackground_lines_widthline_widthlocationlogmajor_tick_lengthmajor_tick_widthminor_tick_lengthminor_tick_widthoffsetstroke_colortick_label_alignmenttick_label_angletick_label_colortick_label_haligntick_label_justificationtick_label_positiontick_label_scaletick_label_shifttick_label_text_aligntick_label_text_widthtick_label_valignticks_formatticks_format_lastticks_labelsticks_majorticks_major_deltaticks_major_numberticks_major_septicks_minorticks_minor_deltaticks_minor_numberticks_minor_sep_minticks_sidetransformCorrespondingcommand:left(axis-decoration,option=...)--new-zaxisTEXT
Creates a named Z axis that can display information from Z color maps
Optionalarguments:axis_label_alignmentaxis_label_angleaxis_label_coloraxis_label_halignaxis_label_justificationaxis_label_locaxis_label_positionaxis_label_scaleaxis_label_shiftaxis_label_textaxis_label_text_alignaxis_label_text_widthaxis_label_valignbackground_lines_capbackground_lines_colorbackground_lines_stylebackground_lines_widthbar_shiftbar_sizeboundsclassdecorationidline_widthlocationlogmajor_tick_lengthmajor_tick_widthminor_tick_lengthminor_tick_widthoffsetpaddingstroke_colortick_label_alignmenttick_label_angletick_label_colortick_label_haligntick_label_justificationtick_label_positiontick_label_scaletick_label_shifttick_label_text_aligntick_label_text_widthtick_label_valignticks_formatticks_format_lastticks_labelsticks_majorticks_major_deltaticks_major_numberticks_major_septicks_minorticks_minor_deltaticks_minor_numberticks_minor_sep_minticks_sidetransformCorrespondingcommand:new-zaxis(text,option=...)--no-title
Removes the title of the current plot.
Correspondingcommand:no-title()--no-xlabel
Removes the X label for the current plot.
Correspondingcommand:no-xlabel()--no-ylabel
Removes the Y label for the current plot.
Correspondingcommand:no-ylabel()--rightAXIS-DECORATION
Sets the type of the right axis.
The options have the same meaning as for define-axis-style, see that command for more
information.
Optionalarguments:axis_label_alignmentaxis_label_angleaxis_label_coloraxis_label_halignaxis_label_justificationaxis_label_locaxis_label_positionaxis_label_scaleaxis_label_shiftaxis_label_textaxis_label_text_alignaxis_label_text_widthaxis_label_valignbackground_lines_capbackground_lines_colorbackground_lines_stylebackground_lines_widthline_widthlocationlogmajor_tick_lengthmajor_tick_widthminor_tick_lengthminor_tick_widthoffsetstroke_colortick_label_alignmenttick_label_angletick_label_colortick_label_haligntick_label_justificationtick_label_positiontick_label_scaletick_label_shifttick_label_text_aligntick_label_text_widthtick_label_valignticks_formatticks_format_lastticks_labelsticks_majorticks_major_deltaticks_major_numberticks_major_septicks_minorticks_minor_deltaticks_minor_numberticks_minor_sep_minticks_sidetransformCorrespondingcommand:right(axis-decoration,option=...)--ticksAXIS
This command can be used to control the location of major and minor ticks and the text of their
labels for the given axis. Options available:
* format the format of the tick labels, using a sprintf-like syntax (see below)
* format-last the format of the last of the tick labels (useful to include an overall
"power-of-ten" factor
* major a space or comma-separated list of the positions of the major (labeled) ticks
* minor same for the minor ticks
* label a comma-separated list of the tick labels (must be the same number of elements as
that of the major list). If you must include a comma inside, then use || as a separator.
Format is a normal sprintf format, with the following additional special codes:
* %p the "common power of 10": if you divide the tick values by 10 to the power %p, the
smallest absolute value will be between 1 and 10 (excluding 0 of course)
* %b... is the tick value divided by this common power of 10. You *must* follow this spec by
a usual sprintf format: %b.3g would get you a number with 3 significant digits
Optionalarguments:formatformat_lastlabelsmajormajor_deltamajor_numbermajor_sepminorminor_deltaminor_numberminor_sep_minCorrespondingcommand:ticks(axis,option=...)-t,--titleTEXT
Sets the title of the current plot.
Optionalarguments:alignalignmentanglecolorhalignjustificationlocpositionscaleshifttext_aligntext_widthvalignCorrespondingcommand:title(text,option=...)--topAXIS-DECORATION
Sets the type of the top axis.
The options have the same meaning as for define-axis-style, see that command for more
information.
Optionalarguments:axis_label_alignmentaxis_label_angleaxis_label_coloraxis_label_halignaxis_label_justificationaxis_label_locaxis_label_positionaxis_label_scaleaxis_label_shiftaxis_label_textaxis_label_text_alignaxis_label_text_widthaxis_label_valignbackground_lines_capbackground_lines_colorbackground_lines_stylebackground_lines_widthline_widthlocationlogmajor_tick_lengthmajor_tick_widthminor_tick_lengthminor_tick_widthoffsetstroke_colortick_label_alignmenttick_label_angletick_label_colortick_label_haligntick_label_justificationtick_label_positiontick_label_scaletick_label_shifttick_label_text_aligntick_label_text_widthtick_label_valignticks_formatticks_format_lastticks_labelsticks_majorticks_major_deltaticks_major_numberticks_major_septicks_minorticks_minor_deltaticks_minor_numberticks_minor_sep_minticks_sidetransformCorrespondingcommand:top(axis-decoration,option=...)--x2 Switches to using the top axis for X axis for the subsequent curves, and turns on full decoration
for the right axis. Shortcut for:
xaxis top
axis-style top /decoration=full
Correspondingcommand:x2()--xaxisAXIS
Sets the default axis for the X axis for all subsequent commands take rely on default axes (such
as plot, xrange, yrange...).
Correspondingcommand:xaxis(axis)-x,--xlabelTEXT
Sets the X label of the current plot.
Optionalarguments:alignalignmentanglecolorhalignjustificationlocpositionscaleshifttext_aligntext_widthvalignCorrespondingcommand:xlabel(text,option=...)--y2 Switches to using the right axis for Y axis for the subsequent curves, and turns on full
decoration for the right axis. Shortcut for:
yaxis right
axis-style right /decoration=full
Correspondingcommand:y2()--yaxisAXIS
Sets the default axis for the Y axis for all subsequent commands take rely on default axes (such
as plot, xrange, yrange...).
Correspondingcommand:yaxis(axis)-y,--ylabelTEXT
Sets the Y label of the current plot.
Optionalarguments:alignalignmentanglecolorhalignjustificationlocpositionscaleshifttext_aligntext_widthvalignCorrespondingcommand:ylabel(text,option=...)Background
Commands dealing with the aspect of the background of a plot (excluding background lines, which are
linked to axes).
--backgroundCOLOR-OR-FALSE
Sets the background color for the current (and subsequent?) plot.
Correspondingcommand:background(color-or-false)--watermarkTEXT
Sets a watermark for the background of the current plot.
Optionalarguments:alignmentanglecolorfill_colorfonthorizontal_scalejustificationscalestroke_colorstroke_widthvertical_scaleCorrespondingcommand:watermark(text,option=...)Defaultstyles
Commands for defining default styles.
All commands take the selector of the style to be defined. It is a CSS-like selector, relying on #id and
.class, and using #parentality. Therefore, defining a style for .insets #stuff will define it for an
object named stuff, but only if it is contained within another one that has a .insets class.
ctioga2 does not support changing a style after its use. It may affect only the following objects or all
the ones that were created from the beginning, depending on the context. For safety, only define style
before issueing any graphics command.
--define-arrow-styleTEXT
Sets the default style for arrows. All arrow styles descend from the base style. Use a style
different than base by passing its name as the /base-style option to the draw-arrow command.
Meaning of the style parameters:
* color, style and width: same as in define-line-style* head-marker, tail-marker: a marker to be used for the head or for the tail
* head-scale, tail-scale: scale of the head or tail markers
* head-angle, tail-angle: rotate the head or the tail by that many degrees
* head-color, tail-color: the color of the head or tail
Optionalarguments:capcolorhead_anglehead_colorhead_markerhead_scalestyletail_angletail_colortail_markertail_scalewidthCorrespondingcommand:define-arrow-style(text,option=...)--define-axis-styleTEXT
Sets the style for a whole axis. All axis styles descend from the base style. Horizontal and
vertical axis styles descend from the x and y styles, and plot sides are styled with the left,
right, top and bottom styles.
Axis styles have lots of parameters:
* axis-label- and tick-label- parameters are title style parameters whose meaning is given
in define-title-style, that affect ticks and axis labels
* decoration: a axis-decoration that specify which ticks and tick labels to draw
* background-lines- parameters define the style of background lines, as in define-line-styleOptionalarguments:axis_label_alignmentaxis_label_angleaxis_label_coloraxis_label_halignaxis_label_justificationaxis_label_locaxis_label_positionaxis_label_scaleaxis_label_shiftaxis_label_textaxis_label_text_alignaxis_label_text_widthaxis_label_valignbackground_lines_capbackground_lines_colorbackground_lines_stylebackground_lines_widthdecorationline_widthlocationlogmajor_tick_lengthmajor_tick_widthminor_tick_lengthminor_tick_widthoffsetstroke_colortick_label_alignmenttick_label_angletick_label_colortick_label_haligntick_label_justificationtick_label_positiontick_label_scaletick_label_shifttick_label_text_aligntick_label_text_widthtick_label_valignticks_formatticks_format_lastticks_labelsticks_majorticks_major_deltaticks_major_numberticks_major_septicks_minorticks_minor_deltaticks_minor_numberticks_minor_sep_minticks_sidetransformCorrespondingcommand:define-axis-style(text,option=...)--define-background-styleTEXT
Sets the style for plot background. All background styles descend from the base style. In
addition, the background of a plot is change by the style name background.
Meaning of the style parameters:
* watermark: the text of the watermark
* all watermark_ styles have the same meaning as in define-text-style, as the watermark is a
string marker
* background_color: the color of the background
Optionalarguments:background_colorwatermarkwatermark_alignmentwatermark_anglewatermark_colorwatermark_fill_colorwatermark_fontwatermark_horizontal_scalewatermark_justificationwatermark_scalewatermark_stroke_colorwatermark_stroke_widthwatermark_vertical_scaleCorrespondingcommand:define-background-style(text,option=...)--define-box-styleTEXT
Sets the default style for boxes. All box styles descend from the base style. Use a style
different than base by passing its name as the /base-style option to the draw-box command.
Meaning of the style parameters:
* color, style and width: same as in define-line-style* fill-color: fill color for the box
* fill-transparency: the transparency for the fill, from 0 to 1
Optionalarguments:capcolorfill_colorfill_patternfill_transparencyradiusshapestylewidthCorrespondingcommand:define-box-style(text,option=...)--define-curve-styleTEXT
Sets the default style for the named plot background.
Optionalarguments:clippedcolorcolor_mapcontour_conreccontour_minor_numbercontour_minor_scalecontour_minor_stylecontour_minor_widthcontour_numbercontour_use_naturalsdeptherror_bar_colorerror_bar_line_caperror_bar_line_colorerror_bar_line_styleerror_bar_line_widthfillfill_close_typefill_colorfill_patternfill_transparencylegendline_capline_colorline_styleline_widthlocation_xaxislocation_yaxismarkermarker_anglemarker_colormarker_color_mapmarker_fill_colormarker_fill_color_mapmarker_line_colormarker_line_color_mapmarker_line_widthmarker_markermarker_min_scalemarker_scalepath_styleregion_positionsplit_on_nanzaxisCorrespondingcommand:define-curve-style(text,option=...)--define-image-styleTEXT
Sets the default style for the named image.
Optionalarguments:aspect_ratioauto_rotatetransparencyCorrespondingcommand:define-image-style(text,option=...)--define-legend-styleTEXT
Sets the style for legends.
Optionalarguments:dyframe_capframe_colorframe_fill_colorframe_fill_patternframe_fill_transparencyframe_paddingframe_radiusframe_shapeframe_styleframe_widthpicto_heightpicto_to_textpicto_widthscalesymbol_scaletext_scalevpaddingCorrespondingcommand:define-legend-style(text,option=...)--define-line-styleTEXT
Sets the default style for lines. All line styles descend from the base style. Use a style
different than base by passing its name as the /base-style option to the draw-line command.
Meaning of the style parameters:
* color: the color of the line, see color* style: the line style, see line-style* width: the line width (in points)
--define-line-style * /color=Pink makes all lines pink (unless overriden by the /color option
to draw-line), while
--define-line-style .pink /color=Pink only affect those to which the /class=pink style option
was given.
Optionalarguments:capcolorstylewidthCorrespondingcommand:define-line-style(text,option=...)--define-marker-styleTEXT
Sets the style for marker and marker strings. All marker and marker string styles descend from
the base style. Use a style different than base by passing its name as the /base-style option to
the draw-marker or draw-string-marker commands.
Meaning of the style parameters:
* alignment, justification, angle, color and scale: as in define-text-style* fill-color and stroke_color: markers are both stroked and filled, you can control all
colors in one go using color or specifying each with fill-color and stroke_color
* font: is a PDF font number (from 1 to 14), only used for marker strings
* horizontal-scale, vertical-scale: scales the marker only horizontally or vertically
Optionalarguments:alignmentanglecolorfill_colorfonthorizontal_scalejustificationscalestroke_colorstroke_widthvertical_scaleCorrespondingcommand:define-marker-style(text,option=...)--define-oriented-line-styleTEXT
Sets the default style for the named oriented lines.
Optionalarguments:anglecapcolorhead_anglehead_colorhead_markerhead_scaleoriginstyletail_angletail_colortail_markertail_scalewidthCorrespondingcommand:define-oriented-line-style(text,option=...)--define-styleTEXTOptionalarguments:alignmentangleaspect_ratioauto_rotateaxis_label_alignmentaxis_label_angleaxis_label_coloraxis_label_halignaxis_label_justificationaxis_label_locaxis_label_positionaxis_label_scaleaxis_label_shiftaxis_label_textaxis_label_text_alignaxis_label_text_widthaxis_label_valignbackground_colorbackground_lines_capbackground_lines_colorbackground_lines_stylebackground_lines_widthcapclippedcolorcolor_mapcontour_conreccontour_minor_numbercontour_minor_scalecontour_minor_stylecontour_minor_widthcontour_numbercontour_use_naturalsdecorationdepthdyerror_bar_colorerror_bar_line_caperror_bar_line_colorerror_bar_line_styleerror_bar_line_widthfillfill_close_typefill_colorfill_patternfill_transparencyfontframe_capframe_colorframe_fill_colorframe_fill_patternframe_fill_transparencyframe_paddingframe_radiusframe_shapeframe_styleframe_widthhalignhead_anglehead_colorhead_markerhead_scalehorizontal_scalejustificationlegendline_capline_colorline_styleline_widthloclocationlocation_xaxislocation_yaxislogmajor_tick_lengthmajor_tick_widthmarkermarker_anglemarker_colormarker_color_mapmarker_fill_colormarker_fill_color_mapmarker_line_colormarker_line_color_mapmarker_line_widthmarker_markermarker_min_scalemarker_scaleminor_tick_lengthminor_tick_widthoffsetoriginpath_stylepicto_heightpicto_to_textpicto_widthpositionradiusregion_positionscaleshapeshiftsplit_on_nanstroke_colorstroke_widthstylesymbol_scaletail_angletail_colortail_markertail_scaletexttext_aligntext_scaletext_widthtick_label_alignmenttick_label_angletick_label_colortick_label_haligntick_label_justificationtick_label_positiontick_label_scaletick_label_shifttick_label_text_aligntick_label_text_widthtick_label_valignticks_formatticks_format_lastticks_labelsticks_majorticks_major_deltaticks_major_numberticks_major_septicks_minorticks_minor_deltaticks_minor_numberticks_minor_sep_minticks_sidetransformtransparencyvalignvertical_scalevpaddingwatermarkwatermark_alignmentwatermark_anglewatermark_colorwatermark_fill_colorwatermark_fontwatermark_horizontal_scalewatermark_justificationwatermark_scalewatermark_stroke_colorwatermark_stroke_widthwatermark_vertical_scalewidthzaxisCorrespondingcommand:define-style(text,option=...)--define-text-styleTEXT
Sets the default style for texts. All text styles descend from the base style. Use a style
different than base by passing its name as the /base-style option to the draw-text command.
Meaning of the style parameters:
* alignment: vertical alignment
* justification: horizontal alignment
* angle: angle in degrees to the horizontal (or default orientation in some cases)
* color: text color
* scale: text scale
Optionalarguments:alignmentanglecolorhalignjustificationpositionscaleshifttext_aligntext_widthvalignCorrespondingcommand:define-text-style(text,option=...)--define-title-styleTEXT
Sets the style for title. All title styles descend from the base style. In addition, the title of
a plot is addressed by the style name title.
Meaning of the style parameters:
* alignment, justification, angle, color and scale: as in define-text-style* text: sets the title text
* loc: the side on which to display the title, a location* shift: the distance away from the plot in text size units (maybe a dimension should be
better later)
* position: shift from the center (parallel to the plot side)
Optionalarguments:alignmentanglecolorhalignjustificationlocpositionscaleshifttexttext_aligntext_widthvalignCorrespondingcommand:define-title-style(text,option=...)--load-styleFILECorrespondingcommand:load-style(file)Outputsetup
Commands in this group deal with various aspects of the production of output files:
* output file location
* post-processing (including automatic display)
* cleanup...
--[no-]clean
When this is on (the default), ctioga2 automatically cleans up intermediate files produced by
Tioga. When LaTeX fails, it can be useful to have a closer look at them, so disable it to be able
to look into them.
Correspondingcommand:clean(boolean)--[no-]cleanup-pdf
If this is on, then ctioga2 uses ghostscript to cleanup the PDF file produced. It is on by
default is ctioga2 is able to find the gs executable.
Correspondingcommand:cleanup-pdf(boolean)--dependenciesFILE
Saves the dependencies as a Makefike into the given file name.
Correspondingcommand:dependencies(file)--[no-]eps
When this feature is on, all produced PDF files are converted to EPS using the pdftops program
(from the xpdf tools suite).
Correspondingcommand:eps(boolean)--[no-]mark
When this feature is on (which is the default, as it comes in very useful), the 'title' field of
the PDF informations is set to the command-line that resulted in the PDF file. Disable it if you
don't want any information to leak.
Please note that this will not log the values of the CTIOGA2_PRE and CTIOGA2_POST variables, so
you might still get a different output if you make heavy use of those.
Correspondingcommand:mark(boolean)-n,--nameFIGURE_NAME
Sets the name of the figure, which is also the base name for the output file. This has nothing to
do with the title of the plot, which can be set using the command title.
If the name contains a %, it is interpreted by ctioga2 as a printf-like format. It will attempt
to find the first file that does not exist, feeding it with increasing numbers.
The default value is now Plot-%03d, which means you'll get increasing numbers automatically.
Correspondingcommand:name(figurename)--open Uses open (available on MacOS) to view the PDF files produced by ctioga2.
Correspondingcommand:open()-o,--outputFIGURE_NAME
Writes a figure with the given name (see name) and keeps the current state. This can be used to
create an animation.
Correspondingcommand:output-now(figurename)--output-and-reset
Writes the current figure and starts a fresh one. All non-graphical information are kept (curves
loaded, figure names, preamble, and so on).
Correspondingcommand:output-and-reset()-O,--output-directoryTEXT
Sets the directory to which files will be plot. It defaults to the current directory.
Correspondingcommand:output-directory(text)-r,--page-sizeTEXT
Sets the size of the output PDF file, in real units. Takes arguments in the form of 12cm x 3in
(spaces can be omitted).
Optionalarguments:count-legendCorrespondingcommand:page-size(text,option=...)--pngRESOLUTION
Turns all produced PDF files into PNG images of the given resolution using convert. This also has
for effect to set the page-size to the resolution divided by the 'scale' option in Postscript
points. By default, 2 pixels are rendered for 1 final to produce a nicely antialiased image. Use
the 'oversampling' option to change that, in case the output looks too pixelized. This option
only affects conversion time.
Optionalarguments:oversamplingpdftoppmscaleCorrespondingcommand:png(resolution,option=...)--resolutionFLOAT
By default, ctioga2 has a resolution of 1/100th of a postscript point. This is clearly enough for
most tasks, but you can increase it should you need, or decrease it to generate possibly a little
more jaggy but less large PDF files.
The number given is the number of output points per postscript point.
Better change that at the beginning of the plot.
Correspondingcommand:resolution(float)--[no-]svg
When this feature is on, all produced PDF files are converted to SVG using the neat pdf2svg
program.
Correspondingcommand:svg(boolean)--viewerTEXT
Sets the command for viewing the PDF file after ctioga2 has been run.
Correspondingcommand:viewer(text)-X,--xpdf
Uses xpdf to view the PDF files produced by ctioga2.
If xpdf is not found, then it tries to guess which viewers are available:
* on windows, it uses the system file associations to open the PDF file
* on mac, it uses the open command
* on linux, it tries, mime-open, and if that is missing, falls back to commonly available
PDF viewers.
Correspondingcommand:xpdf()Datastackmanipulation
Commands for manipulation of the data stack
--appendDATASET
Use the current backend to load the given dataset(s) and append to the last dataset on the stack
(without creating a new dataset). Roughly the equivalent of first running load and then join-datasets.
Optionalarguments:asignore_hookswhereCorrespondingcommand:append(dataset,option=...)--apply-formulaTEXT
Applies a formula to the last dataset (or the named one)
Optionalarguments:namewhichCorrespondingcommand:apply-formula(text,option=...)--bin This command bins the contents of the Y column of the last dataset on the stack, and pushes the
results as a new dataset.
Optionalarguments:columndeltamaxminnamenormalizenumberwhichCorrespondingcommand:bin(,option=...)--compute-contourFLOAT
Computes the contour at the given level for the given dataset (or the last on the stack if none
is specified) and pushes it onto the data stack.
You can further manipulate it as usual.
Optionalarguments:whichCorrespondingcommand:compute-contour(float,option=...)--dataset-hookCOMMANDS
The dataset hook is a series of commands such as those in the command files that are run every
time after a dataset is added onto the data stack. Its main use is to provide automatic filtering
of data, but any arbitrary command can be used, so enjoy !
Correspondingcommand:dataset-hook(commands)--dataset-hook-addCOMMANDS
Adds the given commands to the dataset hook. See dataset-hook for more information about the
dataset hook.
Correspondingcommand:dataset-hook-add(commands)--dataset-hook-clear
Clears the dataset hook. See dataset-hook for more information.
Correspondingcommand:dataset-hook-clear()--dropSTORED-DATASET
Removes the given dataset from the stack.
Can become useful when dealing with large datasets, some of which are only used as intermediates
for apply-formula or compute-contour, for instance.
Correspondingcommand:drop(stored-dataset)-j,--join-datasets
Pops the last two (or number, if it is specified) datasets from the stack, concatenates them
(older last) and push them back onto the stack. The name option can be used to give a name to the
new dataset.
Optionalarguments:namenumberwhichCorrespondingcommand:join-datasets(,option=...)-L,--loadDATASET
Use the current backend to load the given dataset(s) onto the data stack.
If the name option is given, the last dataset loaded this way (if dataset expansion occurs) gets
named, or, if it contains a %d (or similar construct), each dataset gets named with %d replace
with the number of the dataset within the expansion (starting at 0). This name can be used to
further use the dataset without remembering its number. See the type stored-dataset for more
information.
Optionalarguments:asignore_hooksnamewhereCorrespondingcommand:load(dataset,option=...)--make-contourFLOATOptionalarguments:asignore_hooksnamewherewhichCorrespondingcommand:make-contour(float,option=...)--merge-datasets
This commands merges data with matching X values from a dataset (by default the one before the
last) into the last one. Data points that have no corresponding X value in the current dataset
are simply ignored. If the columns option is provided, the numbered columns are use instead of
the X columns (X is 1). More than one column can be provided this way, in which case *all* values
must match.
This can be used to build 3D datasets for xyz-map or xy-parametric.
Optionalarguments:columnsnumberprecisionwhichCorrespondingcommand:merge-datasets(,option=...)-P,--print-dataset
Prints to standard output data contained in the last dataset pushed onto the stack, or the given
stored dataset if the which option is given.
Optionalarguments:savewhichCorrespondingcommand:print-dataset(,option=...)--show-stack
Displays the current contents of the dataset stack.
Mostly used for debugging when operations like merge-datasets or join-datasets don't work as
expected.
Correspondingcommand:show-stack()--xy-reglin
This command will get documented some day.
Optionalarguments:linearwhichCorrespondingcommand:xy-reglin(,option=...)Introspection
Commands displaying information about the internals of ctioga2, such as known types/commands/backends...
--edit-commandTEXT
Edit the given command in an editor. It will only work from the top directory of a ctioga2 source
tree.
Optionalarguments:docCorrespondingcommand:edit-command(text,option=...)--edit-groupTEXT
Edit the given group in an editor. It will only work from the top directory of a ctioga2 source
tree.
Correspondingcommand:edit-group(text)--edit-typeTEXT
Edit the given type in an editor. It will only work from the top directory of a ctioga2 source
tree.
Correspondingcommand:edit-type(text)--list-commands
List all commands known to ctioga2
Optionalarguments:formatrawCorrespondingcommand:list-commands(,option=...)--list-groups
List all command groups known to ctioga2
Optionalarguments:rawCorrespondingcommand:list-groups(,option=...)--list-styles
Lists all available color sets, marker sets and the like.
Optionalarguments:rawCorrespondingcommand:list-styles(,option=...)--list-types
List all types known to ctioga2
Optionalarguments:rawCorrespondingcommand:list-types(,option=...)--version-raw
Prints the raw version number, without any other decoration and newline.
Correspondingcommand:version-raw()Filters
The commands in this group act upon the last dataset pushed unto the data stack: they can be viewed as
filters.
--avg-dup
Install the avg-dup-last command as a dataset hook (see dataset-hook): all datasets acquired
after this is on will be averaged if they have identical successive values of X.
Correspondingcommand:avg-dup()--avg-dup-last
Averages successive points with identical X values. This algorithm is naive with respect to the
min/max values and averages them just as well, whereas one might expect something more clever.
To average over all X values when they are not successive in the dataset, you should use sort-last first.
Optionalarguments:modeCorrespondingcommand:avg-dup-last(,option=...)--cherry-pickTEXT
Install the cherry-pick-last command as a dataset hook (see dataset-hook): all points for which
the formula returns false for subsequent datasets will be removed.
Correspondingcommand:cherry-pick(text)--cherry-pick-lastTEXT
Removes the data from the last dataset in the data stack for which the formula returns false.
See also the cherry-pick command to apply the selection to all datasets.
You might find it much easier to use the /where option of the plot or load commands.
Correspondingcommand:cherry-pick-last(text)--smoothINTEGER
Install the smooth-last command as a dataset hook (see dataset-hook): from now on, the datasets
are all smoothed
Correspondingcommand:smooth(integer)--smooth-lastINTEGER
Smooth the data using a simple (naive even) gaussian filter. Good for producing 'lines to guide
the eye'
Correspondingcommand:smooth-last(integer)--sort Install the sort-last command as a dataset hook (see dataset-hook): all subsequent datasets will
be sorted according to their X values.
Correspondingcommand:sort()--sort-last
Sorts the last dataset pushed unto the stack according to X values. Can be used as a filter.
This command sorts in-place.
See also sort.
Correspondingcommand:sort-last()--trimINTEGER
Install the trim-last command as a dataset hook (see dataset-hook): all subsequent datasets will
be trimmed to keep only every n point.
Correspondingcommand:trim(integer)--trim-lastINTEGER
Only keeps one every ? data point on the last dataset pushed unto the data stack. Useful when
data have too many points to avoid creating heavy PDF files that take ages to display with no
additional benefits.
This operation is very crude and does not average data.
See also trim.
Correspondingcommand:trim-last(integer)Generalcommands
General scope commands
--debug With this on, ctioga2 writes a whole lot of debugging information. You probably will not need
that unless you intend to file a bug report or to tackle a problem yourself.
Be warned that it *will* slow down very significantly the processing of ctioga2 (up to hundreds
of times slower), especially if you are not redirecting the output to a file.
Correspondingcommand:debug()--echo Writes the whole command-line used to standard error, quoted in such a way that it should be
usable directly for copy/paste.
Correspondingcommand:echo()-e,--evalCOMMANDS
Runs the given strings as commands, as if given from a command file.
Correspondingcommand:eval(commands)-f,--fileFILE
Reads the file and runs commands found in them, using the ctioga language.
ctioga2 -f my_file.ct2 If the /log is on, then all messages are written to a -log.txt file
instead of to the terminal.
Optionalarguments:logCorrespondingcommand:include(file,option=...)-h,--help
Prints helps about short and long options available when run from the command-line.
Optionalarguments:pagerCorrespondingcommand:command-line-help(,option=...)--help-onTEXT
Prints help about the given command
Correspondingcommand:help-on(text)--[no-]pause
When this is on, the program will ask for confirmation before finishing, when errors or warnings
have been shown. This is especially useful on windows or other environments where the terminal
shuts down as soon as ctioga2 has finished.
Correspondingcommand:pause(boolean)--print-instructions
Writes the list of all the instructions run so far.
This is not very helpful for now, possibly.
Correspondingcommand:print-instructions()--ruby-runFILE
Reads the file and runs the Ruby code found inside, a bit like Ruby would do with the require
command, excepted that ctioga2 does not follow Ruby's file searching rules: you have to specify
the full path.
Correspondingcommand:ruby-run(file)--setTEXTTEXT
Sets the value of the variable (first argument) to the given second argument. No parsing is done.
Correspondingcommand:set(text,text)-v,--verbose
With this on, ctioga2 outputs quite a fair amount of informative messages.
Correspondingcommand:verbose()-V,--version
Prints the version of ctioga in use
Correspondingcommand:version()
Install Now
PNG Icons