summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/pgfplots/pgfplots.reference.tex
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/latex/pgfplots/pgfplots.reference.tex')
-rw-r--r--Master/texmf-dist/doc/latex/pgfplots/pgfplots.reference.tex3816
1 files changed, 3029 insertions, 787 deletions
diff --git a/Master/texmf-dist/doc/latex/pgfplots/pgfplots.reference.tex b/Master/texmf-dist/doc/latex/pgfplots/pgfplots.reference.tex
index e1afbddbef4..e2dd98148f5 100644
--- a/Master/texmf-dist/doc/latex/pgfplots/pgfplots.reference.tex
+++ b/Master/texmf-dist/doc/latex/pgfplots/pgfplots.reference.tex
@@ -1,50 +1,1291 @@
% main=manual.tex
-\section{Reference}
-\subsection{The axis--environments}
-There are four axis environments,
-\begin{enumerate}
-\item The axis environment for normal plots,
-\begin{lstlisting}
-\begin{axis}
+\section{Command Reference}
+\subsection{The Axis-environments}
+There is an axis environment for linear scaling, two for semi-logarithmic scaling and one for double-logarithmic scaling.
+\begin{environment}{{axis}\marg{options}}
+ The axis environment for normal plots with linear axis scaling.
+
+ The `|every linear axis|' style key can be modified with
+\begin{codeexample}[code only]
+\pgfplotsset{every linear axis/.append style={...}}
+\end{codeexample}
+to install styles specifically for linear axes. These styles can contain both \Tikz- and \PGFPlots\ options.
+\end{environment}
+
+\begin{environment}{{semilogxaxis}\marg{options}}
+The axis environment for logarithmic scaling of~$x$ and normal scaling of~$y$.
+Use
+\begin{codeexample}[code only]
+\pgfplotsset{every semilogx axis/.append style={...}}
+\end{codeexample}
+to install styles specifically for the case with |xmode=log|, |ymode=normal|.
+\end{environment}
+
+\begin{environment}{{semilogyaxis}\marg{options}}
+The axis environment for normal scaling of~$x$ and logarithmic scaling of~$y$,
+
+The style `|every semilogy axis|' will be installed for each such plot.
+\end{environment}
+
+\begin{environment}{{loglogaxis}\marg{options}}
+The axis environment for logarithmic scaling of both, $x$~and~$y$ axes,
+As for the other axis possibilities, there is a style `|every loglog axis|' which is installed at the environment's beginning.
+\end{environment}
+
+\noindent
+They are all equivalent to
+\begin{codeexample}[code only]
+\begin{axis}[
+ xmode=log|normal,
+ ymode=log|normal]
...
\end{axis}
-\end{lstlisting}
+\end{codeexample}
+\noindent
+with properly set variables `|xmode|' and `|ymode|' (see below).
+
+\subsection{The Plot Command}
+\label{sec:addplot}%
+\begin{codeexample}[]
+\begin{tikzpicture}
+\begin{axis}[ymin=0,ymax=1,enlargelimits=false]
+\addplot
+ [blue!80!black,fill=blue,fill opacity=0.5]
+coordinates
+{(0,0.1) (0.1,0.15) (0.2,0.5) (0.3,0.62)
+ (0.4,0.56) (0.5,0.58) (0.6,0.65) (0.7,0.6)
+ (0.8,0.58) (0.9,0.55) (1,0.52)}
+|- (axis cs:0,0) -- cycle;
+
+\addplot
+ [red,fill=red!90!black,opacity=0.5]
+coordinates
+{(0,0.25) (0.1,0.27) (0.2,0.24) (0.3,0.24)
+ (0.4,0.26) (0.5,0.3) (0.6,0.23) (0.7,0.2)
+ (0.8,0.15) (0.9,0.1) (1,0.1)}
+|- (axis cs:0,0) -- cycle;
+
+\addplot[green!20!black] coordinates
+ {(0,0.4) (0.2,0.75) (1,0.75)};
+\end{axis}
+\end{tikzpicture}
+\end{codeexample}
+
+\begin{codeexample}[]
+\begin{tikzpicture}
+\begin{axis}
+\addplot plot
+ [id=parable,domain=-5:5]
+ function{4*x**2 - 5}
+ node[pin=180:{$4x^2-5$}]{};
+\end{axis}
+\end{tikzpicture}
+\end{codeexample}
+
+\begin{command}{\addplot[\meta{style options}] \textcolor{gray}{plot[\meta{behavior options}]} \meta{input data} \meta{trailing path commands};}
+This is the main plotting command, available within each axis environment.
+
+It reads point coordinates from one of the available input sources specified by \meta{input data}, updates limits, remembers \meta{style options} for use in a legend (if any) and applies any necessary coordinate transformations (or logarithms).
+
+The \meta{style options} can be omitted in which case the next entry from the |cycle list| will be inserted as \meta{style options}. These keys characterize the plot's type like linear interpolation, smooth plot, constant interpolation or bar plot and define colors, markers and line specifications.
+
+The optional \meta{behavior options} can be used to modify plot variants, for example to add error bars. They are described when needed.
+
+The \meta{input data} is one of several coordinate input tools which are described in more detail below. Finally, if |\addplot| successfully processed all coordinates from \meta{input data}, it generates \Tikz-drawing commands (for example |plot coordinate {...}|). If \meta{trailing path commands} is not empty, these arguments are appended to the final drawing command.
+
+\noindent
+Some more details:
+\begin{itemize}
+ \item The style |/pgfplots/every axis plot| will be installed at the beginning of \meta{style options}. That means you can use
+\begin{codeexample}[code only]
+\pgfplotsset{every axis plot/.append style={...}}
+\end{codeexample}
+ to add options to all your plots - maybe to set line widths to |thick|. Furthermore, if you have more than one plot inside of an axis, you can also use
+\begin{codeexample}[code only]
+\pgfplotsset{every axis plot no 3/.append style={...}}
+\end{codeexample}
+ to modify options for the plot with number~$3$ only. The first plot has number~$0$.
+ \item The \meta{style options} are remembered for the legend. Furthermore, they are available as `|current plot style|' as long as the path is not yet finished or in associated error bars.
+ \item See subsection~\ref{sec:markers} for a list of available markers and line styles.
+ \item For log plots, \PGFPlots\ will compute the natural logarithm $\log(\cdot)$ numerically. This works with normal fixed point numbers or in scientific notation. For example, the following numbers are valid input to \lstinline!\addplot!.
+\begin{codeexample}[]
+\begin{tikzpicture}
+\begin{loglogaxis}
+\addplot coordinates {
+ (769, 1.6227e-04)
+ (1793, 4.4425e-05)
+ (4097, 1.2071e-05)
+ (9217, 3.2610e-06)
+ (2.2e5, 2.1E-6)
+ (1e6, 0.00003341)
+ (2.3e7, 0.00131415)
+};
+\end{loglogaxis}
+\end{tikzpicture}
+\end{codeexample}
+ You can represent arbitrarily small or very large numbers as long as its logarithm can be represented as a \TeX-length (up to about~$16384$). Of course, any coordinate~$x\le 0$ is not possible since the logarithm of a non-positive number is not defined. Such coordinates will be skipped automatically.
+
+ \item For normal plots, \PGFPlots\ applies floating point arithmetics to support large or small numbers like 0.00000001234 or $1.234\cdot 10^{24}$. Its number range is much larger than \TeX's native support for numbers. The relative precision is at least~$5$ significant decimal digits for the mantisse. As soon as the axes limits are completely known, \PGFPlots\ applies a transformation which maps these floating point numbers into \TeX-precision using transformations
+ \[ T_x(x) = 10^{s_x} \cdot x - a_x \text{ and } T_y(y) = 10^{s_y} \cdot y - a_y \]
+ with properly chosen integers $s_x, s_y \in \Z$ and shifts $a_x,a_y\in \R$. Section~\ref{sec:disabledatascaling} contains a description of |disabledatascaling| and provides more details about the transformation.
+
+ \item As a consequence of the coordinate parsing routines, you can't use the mathematical expression parsing method of \PGF\ as coordinates (that means: you will need to provide coordinates without suffixes like ``cm'' or ``pt'' and you can't invoke mathematical functions).
+
+ \item If you did not specify axis limits for $x$ and $y$ manually, \lstinline!\addplot! will compute them automatically.
+ The automatic computation of axis limits works as follows:
+ \begin{enumerate}
+ \item Every coordinate will be checked. Care has been taken to avoid \TeX's limited numerical capabilities.
+ \item Since more than one \lstinline!\addplot! command may be used inside an \lstinline!\begin{axis}...\end{axis}!, all drawing commands will be postponed until \lstinline!\end{axis}!.
+ \end{enumerate}
+\end{itemize}
+\end{command}
+
+\subsubsection{Providing Input Coordinates}
+
+\begin{addplotoperation}[noindex]{coordinates}{\marg{coordinate list}}
+The `|plot coordinates|' command is provided by \Tikz\ and reads its input data from a sequence of point coordinates.
+\begin{codeexample}[code only]
+\addplot plot coordinates {
+ (0,0)
+ (0.5,1)
+ (1,2)
+};
+\end{codeexample}
-\item The axis environment for logarithmic scaling of~$x$ and normal scaling of~$y$,
-\begin{lstlisting}
-\begin{semilogxaxis}
+You can also supply error coordinates (reliability bounds) if you are interested in error bars. Simply append the error coordinates with `|+- (|\marg{ex}|,|\marg{ey}|)|' to the associated coordinate:
+\begin{codeexample}[code only]
+\addplot plot coordinates {
+ (0,0) +- (0.1,0)
+ (0.5,1) +- (0.4,0.2)
+ (1,2)
+ (2,5) +- (1,0.1)
+};
+\end{codeexample}
+or
+\begin{codeexample}[code only]
+\addplot plot coordinates {
+ (1300,1e-6) +- (0.1,0.2)
+ (2600,5e-7) +- (0.2,0.5)
+ (4000,1e-7) +- (0.1,0.01)
+};
+\end{codeexample}
+These error coordinates are only used in case of error bars, see section~\ref{sec:errorbars}. You will also need to configure whether these values denote absolute or relative errors.
+
+The coordinates as such can be numbers as |+5|, |-1.2345e3|, |35.0e2|, |0.00000123| or |1e2345e-8|. They are not limited to \TeX's precision.
+\end{addplotoperation}
+
+
+\begin{addplotoperation}[noindex]{file}{\marg{name}}
+\PGFPlots\ supports two ways to read plot coordinates of external files, and one of them is the \Tikz-command `|plot file|'. It is to be used like
+\begin{codeexample}[code only]
+\addplot plot file {datafile.dat};
+\end{codeexample}
+where \marg{name} is a text file with at least two columns which will be used as $x$ and $y$ coordinates. Such files are often generated by \textsc{gnuplot}:
+\begin{codeexample}[code only]
+#Curve 0, 20 points
+#x y type
+0.00000 0.00000 i
+0.52632 0.50235 i
+1.05263 0.86873 i
+1.57895 0.99997 i
...
-\end{semilogxaxis}
-\end{lstlisting}
+9.47368 -0.04889 i
+10.00000 -0.54402 i
+\end{codeexample}
+This listing has been copied from~\cite[section~16.4]{tikz}. The mentioned section also contains some more details about using |plot file|.
+\end{addplotoperation}
+
+\begin{addplotoperation}[noindex]{table}{[\meta{column selection}]\marg{file}}
+\PGFPlots\ comes with a new plotting command, the `|plot table|' macro. It's usage is similar in spirit to `|plot file|', but its flexibility is higher. Given a data file like
+\begin{codeexample}[code only]
+dof L2 Lmax maxlevel
+5 8.31160034e-02 1.80007647e-01 2
+17 2.54685628e-02 3.75580565e-02 3
+49 7.40715288e-03 1.49212716e-02 4
+129 2.10192154e-03 4.23330523e-03 5
+321 5.87352989e-04 1.30668515e-03 6
+769 1.62269942e-04 3.88658098e-04 7
+1793 4.44248889e-05 1.12651668e-04 8
+4097 1.20714122e-05 3.20339285e-05 9
+9217 3.26101452e-06 8.97617707e-06 10
+\end{codeexample}
+one may want to plot `|dof|' versus `|L2|' or `|dof|' versus `|Lmax|'. This can be done by
+\begin{codeexample}[code only]
+\begin{tikzpicture}
+\begin{loglogaxis}[
+ xlabel=Dof,
+ ylabel=$L_2$ error$]
+\addplot table[x=dof,y=L2] {datafile.dat};
+\end{loglogaxis}
+\end{tikzpicture}
+\end{codeexample}
+or
+\begin{codeexample}[code only]
+\begin{tikzpicture}
+\begin{loglogaxis}[
+ xlabel=Dof,
+ ylabel=$L_infty$ error$]
+\addplot table[x=dof,y=Lmax] {datafile.dat};
+\end{loglogaxis}
+\end{tikzpicture}
+\end{codeexample}
+Alternatively, you can load the table \emph{once} and use it \emph{multiple} times:
+\begin{codeexample}[code only]
+\pgfplotstableread{datafile.dat}\table
+...
+\addplot table[x=dof,y=L2] from \table;
+...
+\addplot table[x=dof,y=Lmax] from \table;
+...
+\end{codeexample}
+I am not really sure how much time can be saved, but it works anyway.
+
+If you do prefer to access columns by column indices instead of column names (or your tables do not have column names), you can also use
+\begin{codeexample}[code only]
+\addplot table[x index=2,y index=3] {datafile.dat};
+\addplot table[x=dof,y index=2] {datafile.dat};
+\end{codeexample}
-\item The axis environment for normal scaling of~$x$ and logarithmic scaling of~$y$,
-\begin{lstlisting}
+Summary and remarks:
+\begin{itemize}
+ \item Use |plot table[x=|\marg{column name}|,y=|\marg{column name}|]}| to access column names. Those names are case sensitive and need to exist.
+ \item Use |plot table[x index=|\marg{column index}|,y index=|\marg{column index}|]}| to access column indices. Indexing starts with~$0$. You may also use an index for~$x$ and a column name for~$y$.
+ \item Use |plot table[header=false] |\marg{file name} if your input file has no column names. Otherwise, the first non-comment line is checked for column names: if all entries are numbers, they are treated as numerical data; if one of them is not a number, all are treated as column names.
+ \item It is possible to read error coordinates from tables as well. Simply add options `|x error|', `|y error|' or `|x error index|'/`|y error index|' to \marg{source columns}. See section~\ref{sec:errorbars} for details about error bars.
+ \item Use |plot table[|\meta{source columns}|] from |\marg{\textbackslash macro} to use a pre--read table. Tables can be read using
+\begin{codeexample}[code only]
+\pgfplotstableread{datafile.dat}\macroname.
+\end{codeexample}
+ \item The accepted input format of those tables is as follows:
+ \begin{itemize}
+ \item Columns are usually separated by white spaces (at least one tab or space).
+
+ If you need other column separation characters, you can use the
+
+ \declare{col sep}|=|\mchoice{space,comma,colon,semicolon,braces}
+
+ option which is documented in all detail in the manual for \PGFPlotstable\ which is part of \PGFPlots.
+ \item Any line starting with `\#' or `\%' is ignored.
+ \item The first line will be checked if it contains numerical data. If there is a column in the first line which is \emph{no} number, the complete line is considered to be a header which contains column names. Otherwise it belongs to the numerical data and you need to access column indices instead of names.
+
+ \item There is future support for a second header line which must start with `|$flags |'. Currently, such a line is ignored. It may be used to provide number formatting hints like precision and number format if those tables shall be typeset using |\pgfplotstabletypeset| (see the manual for \PGFPlotstable).
+ \item The accepted number format is the same as for `|plot coordinates|', see above.
+ \item If you omit column selectors, the default is to plot the first column against the second. That means |plot table| does exactly the same job as |plot file| for this case.
+ \end{itemize}
+\end{itemize}
+\end{addplotoperation}
+
+\begin{addplotoperation}[noindex]{function}{\marg{gnuplot code}}
+The plot function command uses the external program |gnuplot| to compute coordinates. The resulting coordinates are written to a text file which will be plotted with |plot file|. \PGF\ checks whether coordinates need to be re-generated and calls |gnuplot| whenever necessary (this is usually the case if you change the number of samples, the argument to |plot function| or the plotted domain\footnote{Please note that \PGFPlots\ produces slightly different files than \Tikz\ when used with |plot function| (it configures high precision output). You should use different ids to avoid conflicts in such a case.}).
+
+Since system calls are a potential danger, they need to be enabled explicitly using command line options, for example
+\begin{codeexample}[code only]
+pdflatex -shell-escape filename.tex.
+\end{codeexample}
+Sometimes it is called |shell-escape| or |enable-write18|.
+\begin{codeexample}[]
+\begin{tikzpicture}
+\begin{axis}
+\addplot plot[id=sin]
+ function{sin(x)};
+\end{axis}
+\end{tikzpicture}
+\end{codeexample}
+
+\begin{codeexample}[]
+\begin{tikzpicture}
\begin{semilogyaxis}
-...
+\addplot plot[id=exp,domain=0:10]
+ function{exp(x)};
\end{semilogyaxis}
-\end{lstlisting}
+\end{tikzpicture}
+\end{codeexample}
-\item The axis environment for logarithmic scaling of both, $x$~and~$y$ axes,
-\begin{lstlisting}
-\begin{loglogaxis}
-...
+The \meta{style options} determine the appearance of the plotted function; these parameters also affect the legend. The \meta{behavior options} are specific to the gnuplot interface. These options are described in all detail in \cite[section~18.6]{tikz}. A short summary is shown below.
+\end{addplotoperation}
+
+\begin{key}{/tikz/domain=[\meta{start}:\meta{end}] (initially [-5:5])}
+ Determines the plotted range. This is not necessarily the same as the axis limits (which are configured with the |xmin|/|xmax| options).
+
+ This option is also used for plot expression, see below.
+\end{key}
+
+\begin{key}{/tikz/id=\marg{unique string identifier}}
+ A unique identifier for the current plot. It is used to generate temporary filenames for |gnuplot| output.
+\end{key}
+
+\begin{key}{/tikz/prefix=\marg{file name prefix}}
+ A common path prefix for temporary filenames (see \cite[section~18.6]{tikz} for details).
+\end{key}
+
+\begin{key}{/tikz/samples=\marg{number}}
+ Sets the number of sample points.
+\end{key}
+
+\begin{key}{/tikz/raw gnuplot}
+ Disables the use of |samples| and |domain|.
+\end{key}
+
+\noindent
+Please refer to \cite[section~18.6]{tikz} for more details about |plot function| and the |gnuplot| interaction.
+
+\begin{addplotoperation}[noindex]{(\meta{$x$ expression},\meta{$y$ expression})}{}
+ Similar to |plot function|, this input method allows to provide expressions which will be sampled. But unlike |plot function|, the expressions are evaluated using the math parser of \PGF, no external program is required.
+\begin{codeexample}[]
+\begin{tikzpicture}
+\begin{axis}
+ \addplot (\x,\x^2 + 4);
+ \addplot (\x,-5*\x^3 - \x^2);
+\end{axis}
+\end{tikzpicture}
+\end{codeexample}
+The number of points and the sampled range is configured as for |plot function|, that means using |samples| and |domain|.
+
+Please note that \PGF's math parser uses degrees for trigonometric functions:
+\begin{codeexample}[]
+\begin{tikzpicture}
+\begin{axis}
+ \addplot plot[domain=0:360]
+ (\x,{sin(\x)});
+\end{axis}
+\end{tikzpicture}
+\end{codeexample}
+the braces are necessary to delimit the $y$ argument here. If you want to use radians, use
+\begin{codeexample}[]
+\begin{tikzpicture}
+\begin{axis}
+ \addplot plot[domain=-3.14159:3.14159]
+ (\x,{sin(\x r)});
+\end{axis}
+\end{tikzpicture}
+\end{codeexample}
+to convert the radians to degrees. The \Tikz\ plot expression parser also accepts some more options like |samples at=|\marg{coordinate list} or |variable=\t| which are described in the \Tikz\ manual.
+\end{addplotoperation}
+
+\begin{command}{\addplot+[\meta{style options}] \textcolor{gray}{\dots};}
+Does the same like |\addplot[|\meta{style options}|] ...;| except that \meta{style options} is \emph{appended} to the arguments which would have been taken for \lstinline!\addplot ...! (the element of the default list).
+
+\begin{codeexample}[]
+\begin{tikzpicture}
+\begin{axis}
+\addplot (\x,{sin(\x r)});
+\end{axis}
+\end{tikzpicture}
+
+\begin{tikzpicture}
+\begin{axis}
+\addplot+[only marks] (\x,{sin(\x r)});
+\end{axis}
+\end{tikzpicture}
+\end{codeexample}
+\end{command}
+
+\subsection{Accessing Axis Coordinates for Annotations}
+\label{sec:axis:coords}%
+\begin{coordinatesystem}{axis cs}
+\PGFPlots\ provides a new coordinate system for use inside of an axis, the ``axis coordinate system'', |axis cs|.
+
+It can be used to draw any \Tikz-graphics at axis coordinates. It is used like
+\begin{codeexample}[code only]
+\draw
+ (axis cs:18943,2.873391e-05)
+|- (axis cs:47103,8.437499e-06);
+\end{codeexample}
+\begin{codeexample}[]
+\tikzstyle{every pin}=[fill=white,
+ draw=black,
+ font=\footnotesize]
+\begin{tikzpicture}
+ \begin{loglogaxis}[
+ xlabel={\textsc{Dof}},
+ ylabel={$L_2$ Error}]
+
+ \addplot coordinates {
+ (11, 6.887e-02)
+ (71, 3.177e-02)
+ (351, 1.341e-02)
+ (1471, 5.334e-03)
+ (5503, 2.027e-03)
+ (18943, 7.415e-04)
+ (61183, 2.628e-04)
+ (187903, 9.063e-05)
+ (553983, 3.053e-05)
+ };
+
+ \node[coordinate,pin=above:Bad!]
+ at (axis cs:5503,2.027e-03) {};
+ \node[coordinate,pin=left:Good!]
+ at (axis cs:187903,9.063e-05) {};
+ \end{loglogaxis}
+\end{tikzpicture}
+\end{codeexample}
+
+\begin{codeexample}[]
+\begin{tikzpicture}
+\begin{loglogaxis}[
+ xlabel=\textsc{Dof},
+ ylabel=$L_2$ Error
+]
+\draw
+ (axis cs:1793,4.442e-05)
+ |- (axis cs:4097,1.207e-05)
+ node[near start,left]
+ {$\frac{dy}{dx} = -1.58$};
+
+\addplot coordinates {
+ (5, 8.312e-02)
+ (17, 2.547e-02)
+ (49, 7.407e-03)
+ (129, 2.102e-03)
+ (321, 5.874e-04)
+ (769, 1.623e-04)
+ (1793, 4.442e-05)
+ (4097, 1.207e-05)
+ (9217, 3.261e-06)
+};
\end{loglogaxis}
-\end{lstlisting}
-\end{enumerate}
-They are all equivalent to
-\begin{lstlisting}
+\end{tikzpicture}
+\end{codeexample}
+
+\paragraph{Attention:} Whenever you draw additional graphics, consider using |axis cs|! It applies any logarithms, data scaling transformations or whatever \PGFPlots\ usually does!
+\end{coordinatesystem}
+
+\begin{predefinednode}{current plot begin}
+ This coordinate will be defined for every plot and can be used is \meta{trailing path commands} or after a plot. It is the first coordinate of the current plot.
+\end{predefinednode}
+
+\begin{predefinednode}{current plot end}
+ This coordinate will be defined for every plot. It is the last coordinate of the current plot.
+\end{predefinednode}
+
+\subsection{Legend Commands}
+
+\begin{command}{\addlegendentry\marg{name}}
+Adds a single legend entry to the legend list. This will also enable legend drawing.
+\begin{codeexample}[]
+\begin{tikzpicture}
+\begin{axis}
+\addplot[smooth,mark=*,blue] coordinates {
+ (0,2)
+ (2,3)
+ (3,1)
+};
+\addlegendentry{Case 1}
+
+\addplot[smooth,color=red,mark=x]
+ coordinates {
+ (0,0)
+ (1,1)
+ (2,1)
+ (3,2)
+ };
+\addlegendentry{Case 2}
+\end{axis}
+\end{tikzpicture}
+\end{codeexample}
+It does not matter where |\addlegendentry| commands are placed, only the sequence matters. You will need one |\addlegendentry| for every |\addplot| command.
+
+
+Optional argument are accepted with|\addlegendentry|[\meta{key-value-list}]|{...}|. This does mainly affect some keys affecting the legend layout, support is very limited.
+\end{command}
+
+
+
+\label{sec:legenddef}%
+\begin{command}{\legend\marg{list}}
+You can use |\legend|\marg{list} to assign a complete legend.
+\begin{codeexample}[code only]
+\legend{$d=2$,$d=3$,$d=4$,$d=5$,$d=6$}
+\end{codeexample}
+The argument of |\legend| is a comma--separated list of entries, one for each plot. It is processed using the \PGF-foreach command\footnote{Older versions of \PGFPlots\ used \texttt{\textbackslash legend\{first\textbackslash\textbackslash second\textbackslash\textbackslash third\textbackslash\textbackslash\}} instead of comma--separated lists. This syntax is still accepted.}.
+The short marker/line combination shown in legends is acquired from the \marg{style options} argument of |\addplot|.
+\end{command}
+
+\subsubsection{Legend Appearance}
+{%
+\pgfplotsset{every axis/.append style={width=3cm,scale only axis,legend style={font=\footnotesize}}}%
+\begin{stylekey}{/pgfplots/every axis legend}
+The style ``|every axis legend|'' determines the legend's position and outer appearance:
+\begin{codeexample}[code only]
+\pgfplotsset{every axis legend/.append style={
+ at={(0,0)},
+ anchor=south west}}
+\end{codeexample}
+will draw it at the lower left corner of the axis while
+\begin{codeexample}[code only]
+\pgfplotsset{every axis legend/.append style={
+ at={(1,1)},
+ anchor=north east}}
+\end{codeexample}
+means the upper right corner. The `|anchor|' option determines which point \emph{of the legend} will be placed at $(0,0)$ or $(1,1)$.
+
+The legend is a \Tikz-matrix, so you can use any \Tikz\ option which affects
+nodes and matrizes (see~\cite[section 13~and~14]{tikz}). The matrix is created by something like
+\begin{codeexample}[code only]
+\matrix[style=every axis legend] {
+ draw plot specification 1 & \node{legend 1}\\
+ draw plot specification 2 & \node{legend 2}\\
+ ...
+};
+\end{codeexample}
+
+\begin{codeexample}[]
+\pgfplotsset{every axis legend/.append style={
+ at={(1.02,1)},
+ anchor=north west}}
+\begin{tikzpicture}
+\begin{axis}
+\addplot coordinates {(0,0) (1,1)};
+\addplot coordinates {(0,1) (1,2)};
+\addplot coordinates {(0,2) (1,3)};
+\legend{$l_1$,$l_2$,$l_3$}
+\end{axis}
+\end{tikzpicture}
+\end{codeexample}
+
+Use |legend columns=|\marg{number} to configure the number of horizontal legend entries.
+\begin{codeexample}[]
+\begin{tikzpicture}
+\pgfplotsset{every axis legend/.append style={
+ at={(0.5,1.03)},
+ anchor=south}}
+\begin{axis}[legend columns=4]
+\addplot coordinates {(0,0) (1,1)};
+\addplot coordinates {(0,1) (1,2)};
+\addplot coordinates {(0,2) (1,3)};
+\legend{$l_1$,$l_2$,$l_3$}
+\end{axis}
+\end{tikzpicture}
+\end{codeexample}
+\noindent
+Instead of the |.append style|, you can also use |legend style| as in the following example. It has the same effect.
+
+\begin{codeexample}[]
+\begin{tikzpicture}
\begin{axis}[
- xmode=log|normal,
- ymode=log|normal]
+ legend style={
+ at={(1,0.5)},
+ anchor=east}]
+\addplot coordinates {(0,0) (1,1)};
+\addplot coordinates {(0,1) (1,2)};
+\addplot coordinates {(0,2) (1,3)};
+\legend{$l_1$,$l_2$,$l_3$}
+\end{axis}
+\end{tikzpicture}
+\end{codeexample}
+
+\noindent
+The default |every axis legend| style is
+\begin{codeexample}[code only]
+\pgfplotsset{every axis legend/.style={%
+ cells={anchor=center},
+ inner xsep=3pt,inner ysep=2pt,nodes={inner sep=2pt,text depth=0.15em},
+ anchor=north east,%
+ shape=rectangle,%
+ fill=white,%
+ draw=black,
+ at={(0.98,0.98)}
+}}
+\end{codeexample}
+\paragraph{Attention:} you should \emph{not reset} the default style to stay compatible with future versions. If possible, use
+\begin{codeexample}[code only]
+\pgfplotsset{every axis legend/.append style={...}}
+\end{codeexample}
+\end{stylekey}
+
+}
+
+
+\begin{command}{\autoplotspeclist}
+This command should no longer be used, although it will be kept as technical implementation detail. Please use the `|cycle list|' option, section~\ref{sec:cycle:list}.
+\end{command}
+
+\begin{command}{\pgfmathlogtologten\meta{number}}
+Assigns the result of $\meta{number}/\log(10)$ to \lstinline!\pgfmathresult!.
+\end{command}
+
+\begin{command}{\logten}
+Expands to the constant $\log(10)$. Useful for logplots because $\log(10^i) = i\log(10)$. This command is only available inside of an \Tikz-picture.
+\end{command}
+
+\begin{command}{\pgfmathprintnumber\marg{number}}
+Generates pretty--printed output\footnote{This method was previously \texttt{\textbackslash prettyprintnumber}. It's functionality has been included into \PGF\ and the old command is now deprecated.} for \marg{number}. This method is used for every tick label.
+
+The number is printed using the current number printing options, see section~\ref{sec:number:printing} for the different number styles, rounding precision and rounding methods.
+\end{command}
+
+\subsection{Closing Plots}
+\begin{command}{\closedcycle}
+ Provide |\closedcycle| as \meta{trailing path commands} after |\addplot| to draw a closed line from the last plot coordinate to the first one.
+
+ Use |\closedcycle| whenevery you intend to fill the area under a plot.
+
+\begin{codeexample}[]
+\begin{tikzpicture}
+ \begin{axis}
+ \addplot (\x,\x^2+2) \closedcycle;
+ \end{axis}
+\end{tikzpicture}
+\end{codeexample}
+
+\begin{codeexample}[]
+\begin{tikzpicture}
+ \begin{axis}
+ \addplot+[fill] (\x,\x^2+2) \closedcycle;
+ \end{axis}
+\end{tikzpicture}
+\end{codeexample}
+ In case of stacked plots, |\closedcycle| connects the current plot with the previous plot instead of connecting with the $x$~axis\footnote{The implementation for stacked plots requires some additional logic to determine the filled area: \lstinline{\\closedcycle} will produce a \lstinline!plot coordinates! command with \emph{reversed} coordinates of the previous plot. This is usually irrelevant for end users, but it assumes that the plot's type is symmetric. Since constant plots are inherently unsymmetric, \lstinline{\\closedcycle} will use \texttt{const plot mark right} as reversed sequence for \texttt{const plot mark left}.}.
+\begin{codeexample}[]
+\begin{tikzpicture}
+ \begin{axis}[stack plots=y]
+ \addplot+[fill] coordinates
+ {(0,1) (1,1) (2,2) (3,2)} \closedcycle;
+ \addplot+[fill] coordinates
+ {(0,1) (1,1) (2,2) (3,2)} \closedcycle;
+ \end{axis}
+\end{tikzpicture}
+\end{codeexample}
+\end{command}
+
+\subsection{Other Commands}
+\begin{command}{\plotnum}
+ Inside of |\addplot| or any associated style, option or command, |\plotnum| expands to the current plot's number, starting with~$0$.
+\end{command}
+
+\begin{command}{\numplots}
+ Inside of any of the axis environments, associated style, option or command, |\numplots| expands to the total number of plots.
+\end{command}
+
+\begin{command}{\coordindex}
+ Inside of an |\addplot| command, this macro expands to the number of the actual coordinate (starting with~$0$).
+
+ It is useful together with |x filter| or |y filter| to (de-)select coordinates.
+\end{command}
+
+\begin{command}{\pgfplotstableread\marg{file}}
+ Please refer to the manual of \PGFPlotstable, |pgfplotstable.pdf|, which is part of the \PGFPlots-bundle.
+\end{command}
+\begin{command}{\pgfplotstabletypeset\marg{\textbackslash macro}}
+ Please refer to the manual of \PGFPlotstable, |pgfplotstable.pdf|, which is part of the \PGFPlots-bundle.
+\end{command}
+\begin{command}{\pgfplotstabletypesetfile\marg{file}}
+ Please refer to the manual of \PGFPlotstable, |pgfplotstable.pdf|, which is part of the \PGFPlots-bundle.
+\end{command}
+
+\section{Option Reference}
+There are several required and even more optional arguments to modify axes. They are used like
+\begin{codeexample}[code only]
+\begin{tikzpicture}
+\begin{axis}[key=value,key2=value2]
...
\end{axis}
-\end{lstlisting}
-with properly set variables `\texttt{xmode}' and `\texttt{ymode}' (see below).
+\end{tikzpicture}
+\end{codeexample}
+\noindent
+The overall appeareance can be changed with
+\begin{codeexample}[code only]
+\pgfplotsset{every axis/.append style={line width=1pt}}
+\end{codeexample}
+\noindent
+for example. There are several other styles predefined to modify the appearance, see section~\ref{sec:styles}.
+
+\subsection{Pgfplots Options and \Tikz\ Options}
+This section is more or less technical and can be skipped unless one really wants to know more about this topic.
+
+\Tikz\ options and \PGFPlots\ options can be mixed inside of the axis arguments and in any of the associated styles. For example,
+\begin{codeexample}[code only]
+\pgfplotsset{every axis legend/.append style={
+ legend columns=3,font=\Large}}
+\end{codeexample}
+\noindent
+assigns the `|legend columns|' option (a pgfplots option) and uses `|font|' for drawing the legend (a \Tikz\ option).
-\subsection{Available markers}
+The axis environments will process any known pgfplots options, and all `|every|'--styles will be parsed for pgfplots options. Every unknown option is supposed to be a \Tikz\ option and will be forward to the associated \Tikz\ drawing commands. For example, the `\lstinline{font=\Large}' above will be used as argument to the legend matrix, and the `\lstinline{font=\Large}' argument in
+\begin{codeexample}[code only]
+\pgfplotsset{every axis label/.append style={
+ ylabel=Error,xlabel=Dof,font=\Large}}
+\end{codeexample}
+will be used in the nodes for axis labels (but not the axis title, for example).
+
+It is an error if you assign incompatible options to axis labels, for example `|xmin|' and `|xmax|' can't be set inside of `|every axis label|'.
+
+
+\subsection{Plot Types}
+\PGFPlots\ supports several two-dimensional line-plots like piecewise linear line plots, piecewise constant plots, smoothed plots, bar plots and comb plots. Most of them use the \PGF\ plot handler library directly, see \cite[section 18.8]{tikz}.
+
+Plot types are part of the plot style, so they are set with options. The following list contains a short summary of the \PGF\ plot library, \cite[section 18.8]{tikz}.
+
+
+\subsubsection{Linear Plots}
+\begin{plottype}{sharp plot}
+Linear (`sharp') plots are the default. Point coordinates are simply connected by straight lines.
+\begin{codeexample}[]
+\begin{tikzpicture}
+\begin{axis}
+ \addplot+[sharp plot] coordinates
+ {(0,0) (1,2) (2,3)};
+\end{axis}
+\end{tikzpicture}
+\end{codeexample}
+
+The `|+|' here means to use the normal plot cycle list and append `|sharp plot|' to its option list.
+\end{plottype}
+
+\subsubsection{Smooth Plots}
+\begin{plottype}{smooth}
+Smooth plots interpolate smoothly between successive points.
+\begin{codeexample}[]
+\begin{tikzpicture}
+\begin{axis}
+ \addplot+[smooth] coordinates
+ {(0,0) (1,2) (2,3)};
+\end{axis}
+\end{tikzpicture}
+\end{codeexample}
+\end{plottype}
+
+\subsubsection{Constant Plots}
+Constant plots draw lines parallel to the $x$-axis to connect coordinates. The discontinuos edges may be drawn or not, and marks may be placed on left or right ends.
+
+\begin{plottype}{const plot}
+Connects all points with horizontal and vertical lines. Marks are placed left-handed on horizontal line segments, causing the plot to be right-sided continuous at all data points.
+
+\begin{codeexample}[]
+\begin{tikzpicture}
+\begin{axis}
+\addplot+[const plot]
+coordinates
+{(0,0.1) (0.1,0.15) (0.2,0.5) (0.3,0.62)
+ (0.4,0.56) (0.5,0.58) (0.6,0.65) (0.7,0.6)
+ (0.8,0.58) (0.9,0.55) (1,0.52)};
+\end{axis}
+\end{tikzpicture}
+\end{codeexample}
+
+
+\begin{codeexample}[]
+\begin{tikzpicture}
+\begin{axis}[ymin=0,ymax=1,enlargelimits=false]
+\addplot
+ [const plot,fill=blue,draw=black]
+coordinates
+{(0,0.1) (0.1,0.15) (0.2,0.5) (0.3,0.62)
+ (0.4,0.56) (0.5,0.58) (0.6,0.65) (0.7,0.6)
+ (0.8,0.58) (0.9,0.55) (1,0.52)}
+ \closedcycle;
+\end{axis}
+\end{tikzpicture}
+\end{codeexample}
+\end{plottype}
+
+\begin{plottype}{const plot mark left}
+An alias for `|const plot|'.
+\end{plottype}
+
+\begin{plottype}{const plot mark right}
+ A variant which places marks on the right of each line segment, causing plots to be left-sided continuous at coordinates.
+\begin{codeexample}[]
+\begin{tikzpicture}
+\begin{axis}
+\addplot+[const plot mark right]
+coordinates
+{(0,0.1) (0.1,0.15) (0.2,0.5) (0.3,0.62)
+ (0.4,0.56) (0.5,0.58) (0.6,0.65) (0.7,0.6)
+ (0.8,0.58) (0.9,0.55) (1,0.52)};
+\end{axis}
+\end{tikzpicture}
+\end{codeexample}
+\end{plottype}
+
+\begin{plottype}{jump mark left}
+A variant of `|const plot mark left|' which does not draw vertical lines.
+\begin{codeexample}[]
+\begin{tikzpicture}[samples=8]
+\begin{axis}
+\addplot+[jump mark left]
+ plot[id=parablex,domain=-5:0]
+ function{4*x**2 - 5};
+
+\addplot+[jump mark right]
+ plot[id=cubic,domain=-5:0]
+ function{0.7*x**3 + 50};
+\end{axis}
+\end{tikzpicture}
+\end{codeexample}
+\end{plottype}
+
+\begin{plottype}{jump mark right}
+A variant of `|const plot mark right|' which does not draw vertical lines.
+\end{plottype}
+
+\subsubsection{Bar Plots}
+Bar plots place horizontal or vertical bars at coordinates. Multiple bar plots in one axis can be stacked on top of each other or aligned next to each other.
+
+\begin{plottype}{xbar}
+ Places horizontal bars between the $(y=0)$ line and each coordinate.
+
+ This option is used on a per-plot basis and configures only the visualization of coordinates. The figure-wide style |/pgfplots/xbar| also sets reasonable options for ticks, legends and multiple plots.
+\begin{codeexample}[]
+\begin{tikzpicture}
+\begin{axis}
+\addplot+[xbar] coordinates
+ {(4,0) (1,1) (2,2)
+ (5,3) (6,4) (1,5)};
+\end{axis}
+\end{tikzpicture}
+\end{codeexample}
+ Bars are centered at plot coordinates with width |bar width|. Using bar plots usually means more than just a different way of how to connect coordinates, for example to draw ticks outside of the axis, change the legend's appearance or introduce shifts if multiple |\addplot| commands appear.
+
+ There is a preconfigured style for |xbar| which is installed automatically if you provide |xbar| as argument to the axis environment which provides this functionality.
+\begin{codeexample}[]
+\begin{tikzpicture}
+\begin{axis}[xbar,enlargelimits=0.15]
+\addplot
+[draw=blue,pattern=horizontal lines light blue]
+coordinates
+ {(10,5) (15,10) (5,15) (24,20) (30,25)};
+
+\addplot
+[draw=black,pattern=horizontal lines dark blue]
+coordinates
+ {(3,5) (5,10) (15,15) (20,20) (35,25)};
+\end{axis}
+\end{tikzpicture}
+\end{codeexample}
+Here |xbar| yields |/pgfplots/xbar| because it is an argument to the axis, not to a single plot.
+
+ Besides line-, fill- and colorstyles, bars can be configured with |bar width| and |bar shift|, see below.
+\end{plottype}
+
+\begin{stylekey}{/pgfplots/xbar=\marg{shift for multiple plots} (default 2pt)}
+ This style sets |/tikz/xbar| \emph{and} some commonly used options concerning horizontal bars for the complete axis. This is automatically done if you provide |xbar| as argument to an axis argument, see above.
+
+The |xbar| style defines shifts if multiple plots are placed into one axis. If draws bars adjacent to each other, separated by \marg{shift for multiple plots}. Furthermore, it sets the style |bar cycle list| and sets tick and legend appearance options.
+
+The style is defined as follows.
+\begin{codeexample}[code only]
+/pgfplots/xbar/.style={
+ bar cycle list,
+ tick align=outside,
+ /pgfplots/legend image code/.code=
+ {\draw[##1,bar width=3pt,yshift=-0.2em,bar shift=0pt]
+ plot coordinates {(0cm,0.8em) (2*\pgfplotbarwidth,0.6em)};},
+ /pgf/bar shift={%
+ -0.5*(\numplots*\pgfplotbarwidth + (\numplots-1)*#1) +
+ (.5+\plotnum)*\pgfplotbarwidth + \plotnum*#1},
+ /tikz/xbar},
+\end{codeexample}
+The formular for |bar shift| assigns shifts dependend on the total number of plots and the current plot's number. It is designed to fill a total width of $n \cdot $|bar width|$ + (n-1) \cdot $\marg{shift for multiple plots}. The $0.5$ compensates for centering.
+\end{stylekey}
+
+\begin{plottype}{ybar}
+ Like |xbar|, this option generates bar plots. It draws vertical bars between the ($x=0$) line and each input coordinate.
+\begin{codeexample}[]
+\begin{tikzpicture}
+\begin{axis}
+\addplot+[ybar] plot coordinates
+ {(0,3) (1,2) (2,4) (3,1) (4,2)};
+\end{axis}
+\end{tikzpicture}
+\end{codeexample}
+ The example above simply changes how input coordinates shall be visualized. As mentioned for |xbar|, one usually needs modified legends and shifts for multiple bars in the same axis.
+
+ There is a predefined style which installs these customizations when provided to the axis-environment:
+\begin{codeexample}[]
+\begin{tikzpicture}
+\begin{axis}[
+ x tick label style={
+ /pgf/number format/1000 sep=},
+ ylabel=Population,
+ enlargelimits=0.15,
+ legend style={at={(0.5,-0.15)},
+ anchor=north,legend columns=-1},
+ ybar,
+ bar width=7pt,
+]
+\addplot
+ coordinates {(1930,50e6) (1940,33e6)
+ (1950,40e6) (1960,50e6) (1970,70e6)};
+
+\addplot
+ coordinates {(1930,38e6) (1940,42e6)
+ (1950,43e6) (1960,45e6) (1970,65e6)};
+
+\addplot
+ coordinates {(1930,15e6) (1940,12e6)
+ (1950,13e6) (1960,25e6) (1970,35e6)};
+\legend{Far,Near,Here}
+\end{axis}
+\end{tikzpicture}
+\end{codeexample}
+Here |ybar| yields |/pgfplots/ybar| because it is an argument to the axis, not to a single plot.
+
+ As for |xbar|, the bar width and shift can be configured with |bar width| and |bar shift|.
+\end{plottype}
+
+\begin{stylekey}{/pgfplots/ybar=\marg{shift for multiple plots} (default 2pt)}
+ As |/pgfplots/xbar|, this style sets the |/tikz/ybar| option to draw vertical bars, but it also provides commonly used options for vertical bars.
+
+ If you supply |ybar| to an axis environment, |/pgfplots/ybar| will be chosen instead of |/tikz/ybar|.
+
+ It changes the legend, draws ticks outside of the axis lines and draws multiple |\addplot| arguments adjacent to each other; block--centered at the $x$ coordinate and separated by \marg{shift for multiple plots}. Furthermore, it installs the style |bar cycle list|. It is defined similarly to |/pgfplots/xbar|.
+\end{stylekey}
+
+\begin{key}{/tikz/bar width=\marg{dimension} (initially 10pt)}
+ Configures the width used by |xbar| and |ybar|. It is accepted to provide mathematical expressions.
+\end{key}
+
+\begin{key}{/tikz/bar shift=\marg{dimension} (initially 0pt)}
+ Configures a shift for |xbar| and |ybar|. Use |bar shift| together with |bar width| to draw multiple bar plots into the same axis. It is accepted to provide mathematical expressions.
+\end{key}
+
+
+\begin{plottype}{ybar interval}
+ This plot type produces vertical bars with width (and shift) relatively to intervals of coordinates.
+
+ It is installed on a per-plot basis and configures \emph{only} the visualization of coordinates. See the style |/pgfplots/ybar interval| which configures the appearance of the complete figure.
+\begin{codeexample}[]
+\begin{tikzpicture}
+\begin{axis}
+\addplot+[ybar interval] plot coordinates
+ {(0,2) (0.1,1) (0.3,0.5) (0.35,4) (0.5,3)
+ (0.6,2) (0.7,1.5) (1,1.5)};
+\end{axis}
+\end{tikzpicture}
+\end{codeexample}
+
+\begin{codeexample}[]
+\begin{tikzpicture}
+\begin{axis}[ybar interval,
+ xtick=data,
+ xticklabel interval boundaries,
+ x tick label style=
+ {rotate=90,anchor=east}
+ ]
+\addplot coordinates
+ {(0,2) (0.1,1) (0.3,0.5) (0.35,4) (0.5,3)
+ (0.6,2) (0.7,1.5) (1,1.5)};
+\end{axis}
+\end{tikzpicture}
+\end{codeexample}
+
+\begin{codeexample}[]
+\begin{tikzpicture}
+\begin{axis}[
+ x tick label style={
+ /pgf/number format/1000 sep=},
+ ylabel=Population,
+ enlargelimits=0.05,
+ legend style={at={(0.5,-0.1)},
+ anchor=north,legend columns=-1},
+ ybar interval=0.7,
+]
+\addplot
+ coordinates {(1930,50e6) (1940,33e6)
+ (1950,40e6) (1960,50e6) (1970,70e6)};
+
+\addplot
+ coordinates {(1930,38e6) (1940,42e6)
+ (1950,43e6) (1960,45e6) (1970,65e6)};
+
+\addplot
+ coordinates {(1930,15e6) (1940,12e6)
+ (1950,13e6) (1960,25e6) (1970,35e6)};
+\legend{Far,Near,Here}
+\end{axis}
+\end{tikzpicture}
+\end{codeexample}
+\end{plottype}
+
+\begin{stylekey}{/pgfplots/ybar interval=\marg{relative width} (default 1)}
+ A style which is intended to install options for |ybar interval| for a complete figure. This includes tick and legend appearance, management of multiple bar plots in one figure and a more adequate |cycle list| using the style |bar cycle list|.
+\end{stylekey}
+
+\begin{plottype}{xbar interval}
+ As |ybar interval|, just for horizontal bars.
+\begin{codeexample}[]
+\begin{tikzpicture}
+\begin{axis}[
+ xmin=0,xmax=53,
+ ylabel=Age,
+ xlabel=Quantity,
+ y label style={yshift=0.7cm},
+ enlargelimits=false,
+ ytick=data,
+ yticklabel interval boundaries,
+ xbar interval,
+]
+\addplot
+ coordinates {(10,5) (10.5,10) (15,13)
+ (24,18) (50,21) (23,25) (10,30)
+ (3,50) (3,70)};
+\end{axis}
+\end{tikzpicture}
+\end{codeexample}
+\end{plottype}
+
+\begin{stylekey}{/pgfplots/xbar interval=\marg{relative width} (default 1)}
+ A style which is intended to install options for |xbar interval| for a complete figure, see the style |/pgfplots/ybar interval| for details.
+\end{stylekey}
+
+\begin{pgfplotsxykey}{\x ticklabel interval boundaries}
+ These are style keys which set |x tick label as interval| and configure the tick appearance to be \marg{start} -- \marg{end} for each tick interval.
+\end{pgfplotsxykey}
+
+\subsubsection{Comb Plots}
+Comb plots are very similar to bar plots except that they emplot single horizontal/vertical lines instead of rectangles.
+
+\begin{plottype}{xcomb}
+\begin{codeexample}[]
+\begin{tikzpicture}
+\begin{axis}
+\addplot+[xcomb] coordinates
+ {(4,0) (1,1) (2,2)
+ (5,3) (6,4) (1,5)};
+\end{axis}
+\end{tikzpicture}
+\end{codeexample}
+\end{plottype}
+
+\begin{plottype}{ycomb}
+\begin{codeexample}[]
+\begin{tikzpicture}
+\begin{axis}
+\addplot+[ycomb] plot coordinates
+ {(0,3) (1,2) (2,4) (3,1) (4,2)};
+\end{axis}
+\end{tikzpicture}
+\end{codeexample}
+\end{plottype}
+
+\subsubsection{Stacked Plots}
+\begin{pgfplotskey}{stack plots=\mchoice{x,y,false} (initially false)}
+ Allows stacking of plots in either $x$ or $y$ direction. Stacking means add either $x$- or $y$ coordinates of successive |\addplot| commands on top of each other.
+\begin{codeexample}[]
+\begin{tikzpicture}
+ \begin{axis}[stack plots=y]
+ \addplot coordinates
+ {(0,1) (1,1) (2,2) (3,2)};
+ \addplot coordinates
+ {(0,1) (1,1) (2,2) (3,2)};
+ \addplot coordinates
+ {(0,1) (1,1) (2,2) (3,2)};
+ \end{axis}
+\end{tikzpicture}
+\end{codeexample}
+
+|stack plots| is particularly useful for bar plots. The following examples demonstrate its functionality. Normally, it is advisable to use the styles |ybar stacked| and |xbar stacked| which also set some other options.
+\begin{codeexample}[]
+\begin{tikzpicture}
+ \begin{axis}[stack plots=y,/tikz/ybar]
+ \addplot coordinates
+ {(0,1) (1,1) (2,3) (3,2) (4,1.5)};
+ \addplot coordinates
+ {(0,1) (1,1) (2,3) (3,2) (4,1.5)};
+ \addplot coordinates
+ {(0,1) (1,1) (2,3) (3,2) (4,1.5)};
+ \end{axis}
+\end{tikzpicture}
+\end{codeexample}
+
+\begin{codeexample}[]
+\begin{tikzpicture}
+ \begin{axis}[ybar stacked]
+ \addplot coordinates
+ {(0,1) (1,1) (2,3) (3,2) (4,1.5)};
+ \addplot coordinates
+ {(0,1) (1,1) (2,3) (3,2) (4,1.5)};
+ \addplot coordinates
+ {(0,1) (1,1) (2,3) (3,2) (4,1.5)};
+ \end{axis}
+\end{tikzpicture}
+\end{codeexample}
+
+\begin{codeexample}[]
+\begin{tikzpicture}
+ \begin{axis}[stack plots=x,/tikz/xbar]
+ \addplot coordinates
+ {(1,0) (2,1) (2,2) (3,3)};
+ \addplot coordinates
+ {(1,0) (2,1) (2,2) (3,3)};
+ \addplot coordinates
+ {(1,0) (2,1) (2,2) (3,3)};
+ \end{axis}
+\end{tikzpicture}
+\end{codeexample}
+\begin{codeexample}[]
+
+\begin{tikzpicture}
+ \begin{axis}[xbar stacked]
+ \addplot coordinates
+ {(1,0) (2,1) (2,2) (3,3)};
+ \addplot coordinates
+ {(1,0) (2,1) (2,2) (3,3)};
+ \addplot coordinates
+ {(1,0) (2,1) (2,2) (3,3)};
+ \end{axis}
+\end{tikzpicture}
+\end{codeexample}
+\end{pgfplotskey}
+
+\begin{pgfplotskey}{stack dir=\mchoice{plus,minus} (initially plus)}
+ Configures the direction of |stack plots|. The value |plus| will adds coordinates of successive plots while |minus| subtracts them.
+\end{pgfplotskey}
+
+\begin{pgfplotskey}{reverse stacked plots=\mchoice{true,false} (initially true, default true)}
+ Configures the sequence in which stacked plots are drawn. This is more or less a technical detail which should not be changed in any normal case.
+
+ The motivation is as follows: suppose multiple |\addplot| commands are stacked on top of each other and they are processed in the order of appearance. Than, the second plot could easily draw its lines (or fill area) on top of the first one - hiding its marker or line completely. Therefor, \PGFPlots\ reverses the sequence of drawing commands.
+
+ This has the side-effect that any normal \Tikz-paths inside of an axis will also be processed in reverse sequence.
+\end{pgfplotskey}
+
+\begin{stylekey}{/pgfplots/xbar stacked=\mchoice{plus,minus} (default plus)}
+ A figure-wide style which enables stacked horizontal bars (i.e. |xbar| and |stack plots=x|). It also adjusts the legend and tick appearance and assigns a useful |cycle list|.
+\end{stylekey}
+\begin{stylekey}{/pgfplots/ybar stacked=\mchoice{plus,minus} (default plus)}
+ A figure-wide style which enables stacked vertical bars (i.e. |ybar| and |stack plots=y|). It also adjusts the legend and tick appearance and assigns a useful |cycle list|.
+\end{stylekey}
+
+\begin{stylekey}{/pgfplots/xbar interval stacked=\mchoice{plus,minus} (default plus)}
+ A sttyle similar to |/pgfplots/xbar stacked| for the interval based bar plot variant.
+\end{stylekey}
+\begin{stylekey}{/pgfplots/ybar interval stacked=\mchoice{plus,minus} (default plus)}
+ A sttyle similar to |/pgfplots/ybar stacked| for the interval based bar plot variant.
+\end{stylekey}
+
+\subsubsection{Area Plots}
+Area plots are a combination of |\closedcycle| and |stack plots|. They can be combined with any other plot type.
+
+\begin{codeexample}[]
+\begin{tikzpicture}
+ \begin{axis}[
+ stack plots=y,
+ area cycle list]
+ \addplot coordinates
+ {(0,1) (1,1) (2,2) (3,2)}
+ \closedcycle;
+ \addplot coordinates
+ {(0,1) (1,1) (2,2) (3,2)}
+ \closedcycle;
+ \addplot coordinates
+ {(0,1) (1,1) (2,2) (3,2)}
+ \closedcycle;
+ \end{axis}
+\end{tikzpicture}
+\end{codeexample}
+
+\begin{codeexample}[]
+\begin{tikzpicture}
+ \begin{axis}[
+ const plot,
+ stack plots=y,
+ area cycle list]
+ \addplot coordinates
+ {(0,1) (1,1) (2,2) (3,2)}
+ \closedcycle;
+ \addplot coordinates
+ {(0,1) (1,1) (2,2) (3,2)}
+ \closedcycle;
+ \addplot coordinates
+ {(0,1) (1,1) (2,2) (3,2)}
+ \closedcycle;
+ \end{axis}
+\end{tikzpicture}
+\end{codeexample}
+
+\begin{codeexample}[]
+\begin{tikzpicture}
+ \begin{axis}[
+ smooth,
+ stack plots=y,
+ area cycle list]
+ \addplot coordinates
+ {(0,1) (1,1) (2,2) (3,2)}
+ \closedcycle;
+ \addplot coordinates
+ {(0,1) (1,1) (2,2) (3,2)}
+ \closedcycle;
+ \addplot coordinates
+ {(0,1) (1,1) (2,2) (3,2)}
+ \closedcycle;
+ \end{axis}
+\end{tikzpicture}
+\end{codeexample}
+
+\begin{codeexample}[]
+\pgfplotstableread{pgfplots.timeseries.dat}\table
+\pgfplotstabletypeset\table
+\end{codeexample}
+\begin{codeexample}[]
+\pgfplotstableread
+ {pgfplots.timeseries.dat}
+ {\table}
+
+\begin{tikzpicture}
+ \begin{axis}[
+ ymin=0,ymax=210,
+ minor tick num=4,
+ enlargelimits=false,
+ tick align=outside,
+ every axis plot post/.append style=
+ {mark=none},
+ const plot,
+ legend style={
+ at={(0.5,-0.15)},
+ anchor=north,
+ legend columns=-1}]
+
+ \addplot[draw=blue,fill=blue!30!white]
+ table[x=time,y=1minload] from \table
+ \closedcycle;
+ \addplot table[x=time,y=nodes] from \table;
+ \addplot table[x=time,y=cpus] from \table;
+ \addplot table[x=time,y=processes]
+ from \table;
+ \legend{1min load,nodes,cpus,processes}
+ \end{axis}
+\end{tikzpicture}
+\end{codeexample}
+
+\begin{codeexample}[width=4cm]
+\pgfplotstableread{pgfplots.timeseries.dat}\table
+
+\begin{tikzpicture}
+ \begin{axis}[
+ ymin=0,ymax=160,
+ minor tick num=4,
+ enlargelimits=false,
+ tick align=outside,
+ const plot,
+ stack plots=y,
+ cycle list={%
+ {blue!70!black,fill=blue},%
+ {green,fill=green!50!black},%
+ {green!30!white,fill=green!80!white},%
+ {red,thick}%
+ },
+ ylabel={Mem [GB]},
+ legend style={
+ at={(0.5,-0.15)},
+ anchor=north,
+ legend columns=2}]
+
+ \addplot table[x=time,y=memused] from \table \closedcycle;
+ \addplot table[x=time,y=memcached] from \table \closedcycle;
+ \addplot table[x=time,y=membuf] from \table \closedcycle;
+ \addplot plot[/pgfplots/stack plots=false]
+ table[x=time,y=memtotal] from \table;
+ \legend{Memory used,Memory cached,Memory buffered,Total memory}
+ \end{axis}
+\end{tikzpicture}
+\end{codeexample}
+
+\subsection{Markers and Linestyles}
\label{sec:markers}%
-The following options of \Tikz\ may be useful for plots.
+The following options of \Tikz\ are available to plots.
\subsubsection{Markers}
This list is copied from~\cite[section~29]{tikz}:
\begingroup
@@ -70,12 +1311,12 @@ This list is copied from~\cite[section~29]{tikz}:
\item[mark=*] \showit{mark=*}
\item[mark=x] \showit{mark=x}
\item[mark=+] \showit{mark=+}
- \item[mark=ball] \showit{mark=ball}
+% \item[mark=ball] \showit{mark=ball}
\end{longdescription}
And with \lstinline!\usetikzlibrary{plotmarks}!:
\begin{longdescription}
\item[mark=$-$] \showit{mark=-}
- \item[mark=$|$] \showit{mark=|}
+ \item[mark=$\vert$] \showit{mark=|}
\item[mark=o] \showit{mark=o}
\item[mark=asterisk] \showit{mark=asterisk}
\item[mark=star] \showit{mark=star}
@@ -93,7 +1334,7 @@ And with \lstinline!\usetikzlibrary{plotmarks}!:
\item[mark=pentagon*] \showit{mark=pentagon*}
\end{longdescription}
All these options have been drawn with the additional options
-\begin{lstlisting}
+\begin{codeexample}[code only]
\draw[
gray,
thin,
@@ -101,9 +1342,9 @@ All these options have been drawn with the additional options
scale=2,fill=yellow!80!black,draw=black
}
]
-\end{lstlisting}
+\end{codeexample}
-\subsubsection{Line styles}
+\subsubsection{Line Styles}
\def\showit#1{%
\tikz\draw[%
black,
@@ -111,563 +1352,1090 @@ All these options have been drawn with the additional options
#1]
plot coordinates {(0,0) (1,1) (2,0) (3,1)};%
}%
-The following line styles are predefined in \Tikz:
-\begin{longdescription}
- \item[style=solid] \showit{style=solid}
- \item[style=dotted] \showit{style=dotted}
- \item[style=densely dotted] \showit{style=densely dotted}
- \item[style=loosely dotted] \showit{style=loosely dotted}
- \item[style=dashed] \showit{style=dashed}
- \item[style=densely dashed] \showit{style=densely dashed}
- \item[style=loosely dashed] \showit{style=loosely dashed}
-\end{longdescription}
-You may need the option \lstinline!mark options={solid}! to avoid dotted or dashed marker boundaries. The string ``\texttt{style=}'' can be omitted.
+The following line styles are predefined in \Tikz.
+\begin{stylekey}{/tikz/solid}
+ \showit{style=solid}
+\end{stylekey}
+
+\begin{stylekey}{/tikz/dotted}
+ \showit{style=dotted}
+\end{stylekey}
+
+\begin{stylekey}{/tikz/densely dotted}
+ \showit{style=densely dotted}
+\end{stylekey}
+
+\begin{stylekey}{/tikz/loosely dotted}
+ \showit{style=loosely dotted}
+\end{stylekey}
+
+\begin{stylekey}{/tikz/dashed}
+ \showit{style=dashed}
+\end{stylekey}
+
+\begin{stylekey}{/tikz/densely dashed}
+ \showit{style=densely dashed}
+\end{stylekey}
+
+\begin{stylekey}{/tikz/loosely dashed}
+ \showit{style=loosely dashed}
+\end{stylekey}
+You may need the option \lstinline!mark options={solid}! to avoid dotted or dashed marker boundaries.
\endgroup
-\subsection{\texttt{\textbackslash addplot[OPTIONS] PATH}}
-This is the main plotting command. It is used as
-\begin{lstlisting}
-\addplot
- plot coordinates {
- (0,0)
- (1,1)
- };
-\end{lstlisting}
-or
-\begin{lstlisting}
-\addplot[color=blue,mark=*]
- plot coordinates {
- (0,0)
- (1,1)
- };
-\end{lstlisting}
-The first syntax chooses the next unused plot specification of the list \lstinline!\autoplotspeclist! (see below) and the second syntax specifies a plot specification explicitly. This specification will be used inside of the legend (if any).
+\subsubsection{Font Size and Line Width}
+Often, one wants to change line width and font sizes for plots. This can be done using the following options of \Tikz.
+
+\begin{key}{/tikz/font=\marg{font name} (initially \textbackslash normalfont)}
+ Sets the font which is to be used for text in nodes (like tick labels, legends or descriptions).
+\end{key}
+
+\begin{key}{/tikz/line width=\marg{dimension} (initially 0.4pt)}
+ Sets the line width. Please note that line widths for tick lines and grid lines are predefined, so you may need to override the styles |every tick| and |every axis grid|.
+
+ The |line width| key is changed quite often in \Tikz. You should use
+\begin{codeexample}[code only]
+\pgfplotsset{every axis/.append style={line width=1pt}}
+\end{codeexample}
+ or
+\begin{codeexample}[code only]
+\pgfplotsset{every axis/.append style={thick}}
+\end{codeexample}
+ to change the overall line width. To also adjust ticks and grid lines, you can use
+\begin{codeexample}[code only]
+\pgfplotsset{every axis/.append style={
+ line width=1pt,
+ tick style={line width=0.6pt}}}
+\end{codeexample}
+ or styles like
+\begin{codeexample}[code only]
+\pgfplotsset{every axis/.append style={
+ thick,
+ tick style={semithick}}}
+\end{codeexample}
+ The `|every axis plot|' style can be used to change line widths for plots only.
+\end{key}
+
+\begin{keylist}[/tikz]{ultra thin,very thin,semithick,thick,very thick,ultra thick}
+ These \Tikz\ styles provide different predefined line widths.
+\end{keylist}
+
+This example shows the same plots as on page~\pageref{page:plotcoords:src} (using |\plotcoords| as place holder for the commands on page~\pageref{page:plotcoords:src}), with different line width and font size.
+\begin{codeexample}[]
+\pgfplotsset{every axis/.append style={
+ font=\large,
+ line width=1pt,
+ tick style={line width=0.8pt}}}
+\begin{tikzpicture}
+ \begin{loglogaxis}[
+ legend style={at={(0.03,0.03)},
+ anchor=south west},
+ xlabel=\textsc{Dof},
+ ylabel=$L_2$ Error
+ ]
+ \plotcoords
+ \legend{$d=2$,$d=3$,$d=4$,$d=5$,$d=6$}
+ \end{loglogaxis}
+\end{tikzpicture}
+\end{codeexample}
-\noindent
-Some more details:
-\begin{itemize}
- \item You can modify \texttt{OPTIONS} with
- \begin{lstlisting}[gobble=1]
- \tikzstyle{every axis plot}=[...]
- \end{lstlisting}
- or, even better, with
- \begin{lstlisting}[gobble=1]
- \tikzstyle{every axis plot}+=[...]
- \end{lstlisting}
- \item The \texttt{OPTIONS} are remembered for the legend.
- \item See subsection~\ref{sec:markers} for a list of available markers and line styles.
- \item For log plots, \PGFPlots\ will compute the natural logarithm $\log(\cdot)$ numerically. This works with normal fixed point numbers or in scientific notation. For example, the following numbers are valid input to \lstinline!\addplot!.
-\begin{lstlisting}
+\begin{codeexample}[]
+\pgfplotsset{every axis/.append style={
+ font=\footnotesize,
+ thin,
+ tick style={ultra thin}}}
\begin{tikzpicture}
-\begin{loglogaxis}
-\addplot plot coordinate {
- (769, 1.6227e-04)
- (1793, 4.4425e-05)
- (4097, 1.2071e-05)
- (9217, 3.2610e-06)
- (1e6, 0.00003341)
- (2.3e7, 0.00131415)
-;
-\end{loglogaxis}
+ \begin{loglogaxis}[
+ xlabel=\textsc{Dof},
+ ylabel=$L_2$ Error
+ ]
+ \plotcoords
+ \legend{$d=2$,$d=3$,$d=4$,$d=5$,$d=6$}
+ \end{loglogaxis}
\end{tikzpicture}
-\end{lstlisting}
- You can represent arbirtrarily small or very large numbers as long as its logarithm can be represented as a \TeX-length (up to about~$16384$). Of course, any coordinate~$x\le 0$ is not possible since the logarithm of a non-positive number is not defined. Such coordinates will be skipped automatically.
+\end{codeexample}
- \item For normal plots, \PGFPlots\ understands arbirtrarily large or small numbers like 0.00000001234 or $1.234\cdot 10^{24}$. \PGFPlots\ has its own number parsing tools which are complete text based and do not rely on \TeX's limited numerical number representation. Before the plots are actually drawn, any input coordinate is transformed into \TeX-precision using transformations
- \[ T_x(x) = 10^{s_x} \cdot x \text{ and } T_y(y) = 10^{s_y} \cdot y \]
- with properly chosen integers $s_x, s_y \in \Z$. This ensures invariance of axis ranges. See section~\ref{sec:disabledatascaling} for more details.
+\subsubsection{Options Controlling Linestyles}
- \item As a consequence of the coordinate parsing routines, you can't use the mathematical expression parsing method of \PGF\ as coordinates (that means: you will need to provide coordinates without suffixes like ``cm'' or ``pt'' and you can't invoke mathematical functions).
-
- \item If you did not specify axis limits for $x$ and $y$ manually, \lstinline!\addplot! will compute them automatically.
+\label{sec:cycle:list}%
+\begin{pgfplotskeylist}{cycle list=\marg{list},cycle list name=\marg{\textbackslash macro}}
+Allows to specify a list of plot specifications which will be used for each \hbox{\lstinline!\addplot!}-command without explicit plot specification.
- The automatic computation of axis limits works as follows:
- \begin{enumerate}
- \item In case of \lstinline!\addplot plot coordinates {...};!, every coordinate will be checked.
- Any other \Tikz-plot mode is not (yet) supported (had no time yet).
- \item Since more than one \lstinline!\addplot! command may be used inside an \lstinline!\begin{axis}...\end{axis}!, all drawing commands will be postponed until \lstinline!\end{axis}!.
+There are several possiblities to change it:
+\begin{enumerate}
+ \item Use one of the predefined lists,
+\begin{codeexample}[]
+\begin{tikzpicture}
+\begin{loglogaxis}[
+ cycle list name=\coloredplotspeclist]
+\plotcoords
+\legend{$d=2$,$d=3$,$d=4$,$d=5$,$d=6$}
+\end{loglogaxis}
+\end{tikzpicture}
+\end{codeexample}
+These examples employs the same coords as in the example on page~\pageref{page:plotcoords:src}.
+\begin{codeexample}[]
+\begin{tikzpicture}
+\begin{loglogaxis}[
+ cycle list name=\blackwhiteplotspeclist]
+\plotcoords
+\legend{$d=2$,$d=3$,$d=4$,$d=5$,$d=6$}
+\end{loglogaxis}
+\end{tikzpicture}
+\end{codeexample}
+ \item Provide the list explicitly,
+\begin{codeexample}[]
+\begin{tikzpicture}
+\begin{loglogaxis}[cycle list={%
+ {blue,mark=*},
+ {red,mark=square},
+ {dashed,mark=o},
+ {loosely dotted,mark=+},
+ {brown!60!black,
+ mark options={fill=brown!40},
+ mark=otimes*}}
+]
+\plotcoords
+\legend{$d=2$,$d=3$,$d=4$,$d=5$,$d=6$}
+\end{loglogaxis}
+\end{tikzpicture}
+\end{codeexample}
+ (This example list requires \lstinline!\usetikzlibrary{plotmarks}!).
+ \item Define macro names and use them with `|cycle list name|':
+\begin{codeexample}[code only]
+\pgfcreateplotcyclelist{\mylist}{%
+ {blue,mark=*},
+ {red,mark=square},
+ {dashed,mark=o},
+ {loosely dotted,mark=+},
+ {brown!60!black,mark options={fill=brown!40},mark=otimes*}}
+}
+...
+\begin{axis}[cycle list name=\mylist]
+ ...
+\end{axis}
+\end{codeexample}
+\end{enumerate}
- See the \lstinline!\axispath!-command for more information about automatic axis limits and the postponed drawing.
- \end{enumerate}
-\end{itemize}
+\paragraph{Remark:} You can also terminate single entries with `\lstinline!\\!' as in
+\begin{codeexample}[code only]
+\begin{axis}[cycle list={%
+ blue,mark=*\\%
+ red,mark=square\\%
+ dashed,mark=o\\%
+ loosely dotted,mark=+\\%
+ brown!60!black,
+ mark options={fill=brown!40},
+ mark=otimes*\\}
+]
+...
+\end{axis}
+\end{codeexample}
+In this case, the \emph{last} entry also needs a terminating `\lstinline!\\!', but you can omit braces around the single entries.
+\end{pgfplotskeylist}
-\subsection{\texttt{\textbackslash addplot+[OPTIONS] ...}}
-Does the same like \lstinline!\addplot[OPTIONS] ...! except that \texttt{OPTIONS} is \emph{appended} to the arguments which would have been taken for \lstinline!\addplot ...! (the element of the default list).
-
-Example:
-\begin{lstlisting}
-\addplot+[only marks] plot coordinates {...};
-\end{lstlisting}
-will use the same line style, markers, colors as
-\begin{lstlisting}
-\addplot plot coordinates {...};
-\end{lstlisting}
-but it will only draw markers, no lines.
-
-\subsection{\texttt{\textbackslash axispath...;}}
-\label{sec:axispath}%
-This command allows to draw custom content into an axis. The argument to \lstinline!\axispath! may be any \Tikz-command like
-\begin{lstlisting}
-\axispath\node at (axis cs:12.14368,-9.30872) {};
-\end{lstlisting}
-or
-\begin{lstlisting}
-\axispath\draw
- (axis cs:12.14368,-9.30872)
- -- (axis cs:0,1);
-\end{lstlisting}
-A useful example is presented in section~\ref{sec:annot:plot} where annotations are placed near some data points.
-The \lstinline!\axispath! command is necessary to communicate drawing commands to \PGFPlots. If \PGFPlots\ needs to determine the $x$~and/or~$y$ limits automatically, any plotting commands (including those with \lstinline!\axispath!) will be postponed until \lstinline!\end{axis}!.
-A missing \lstinline!\axispath! may corrupt your graphics because the clipping area may not yet be known.
-The ``\texttt{axis cs}'' coordinate system allows you to access axis coordinates. You can use the same numbers as in \lstinline!\addplot! all required transformations like logarithms or data scaling transformations will be applied. All \lstinline!\axispath! commands should use these coordinate systems. See section~\ref{sec:axis:coords} for more information and section~\ref{sec:annot:plot} for examples.
+\subsection{Axis Descriptions}
-\subsection{Accessing axis coordinates with \texttt{axis cs}}
-\label{sec:axis:coords}%
-\PGFPlots\ provides a new coordinate system for use inside of an axis, the ``axis coordinate system'', \texttt{axis cs}.
+\subsubsection{Labels}
-Its can be used in conjunction with \lstinline!\axispath! to draw any \Tikz-graphics at axis coordinates. It is used like
-\begin{lstlisting}
- \axispath\draw
- (axis cs:18943,2.873391e-05)
- |- (axis cs:47103,8.437499e-06);
-\end{lstlisting}
-see section~\ref{sec:annot:plot} for example graphics.
+\begin{pgfplotsxykey}{\x label=\marg{text}}
+The options |xlabel| and |ylabel| change axis labels to \marg{text} which is any \TeX\ text. Use |xlabel={, = characters}| if you need to include `|=|' or `|,|' literally.
-\paragraph{Attention:} Whenever you draw additional graphics, consider using \texttt{axis cs}! It applies any logarithms, data scaling transformations or whatever \PGFPlots\ usually does!
+Labels are \Tikz-Nodes which are placed with
+\begin{codeexample}[code only]
+\node
+ [style=every axis label,
+ style=every axis x label]
+\node
+ [style=every axis label,
+ style=every axis y label]
+\end{codeexample}
+so their position and appearance can be customized. As for legends, the coordinate \lstinline!(0,0)! denotes the lower left axis corner and \lstinline!(1,1)! the upper right.
-\subsection{\texttt{\textbackslash addlegendentry\{name\}}}
-Adds a single legend entry to the legend list. Example:
-\begin{lstlisting}
+The default styles are
+\begin{codeexample}[code only]
+\pgfplotsset{every axis label/.style={}}
+\pgfplotsset{every axis x label/.style={
+ at={(0.5,0)},
+ below,
+ yshift=-15pt}}
+\pgfplotsset{every axis y label/.style={
+ at={(0,0.5)},
+ xshift=-35pt,
+ rotate=90}}
+\end{codeexample}
+Please add options using |.append style| instead of overwriting the default styles to ensure compatibility with future versions.
+\begin{codeexample}[code only]
+\pgfplotsset{every axis label/.append style={...}}
+\pgfplotsset{every axis x label/.append style={...}}
+\pgfplotsset{every axis y label/.append style={...}}
+\end{codeexample}
+\end{pgfplotsxykey}
+
+\begin{pgfplotskey}{title=\marg{text}}
+Adds a caption to the plot. This will place a \Tikz-Node with
+\begin{codeexample}[code only]
+\node[style=every axis title] {text};
+\end{codeexample}
+to the current axis.
+\begin{codeexample}[]
\begin{tikzpicture}
-\begin{axis}
-\addplot[smooth,mark=*,blue] plot coordinates {
- (0,2)
- (2,3)
- (3,1)
-};
-\addlegendentry{Case 1}
-
-\addplot[smooth,color=red,mark=x]
- plot coordinates {
- (0,0)
- (1,1)
- (2,1)
- (3,2)
+\begin{loglogaxis}[
+ xlabel=Dof,ylabel=Error,
+ title={$\mu=0.1$, $\sigma=0.2$}]
+
+ \addplot coordinates {
+ (5, 8.312e-02)
+ (17, 2.547e-02)
+ (49, 7.407e-03)
+ (129, 2.102e-03)
+ (321, 5.874e-04)
+ (769, 1.623e-04)
+ (1793, 4.442e-05)
+ (4097, 1.207e-05)
+ (9217, 3.261e-06)
};
-\addlegendentry{Case 2}
-\end{axis}
-\end{tikzpicture}
-\end{lstlisting}
-The outcome of this listing is shown in figure~\ref{fig:addlegendentry}.
-\begin{figure}
- \centering
- \begin{tikzpicture}
- \begin{axis}
- \addplot[smooth,mark=*,blue] plot coordinates {
- (0,2)
- (2,3)
- (3,1)
- };
- \addlegendentry{Case 1}
+\end{loglogaxis}
+\end{tikzpicture}%
+\end{codeexample}
+%--------------------------------------------------
+% \hfill
+% \begin{tikzpicture}
+% \begin{loglogaxis}[
+% width=0.48\linewidth,
+% xlabel=Dof,ylabel=Error,
+% title={$\mu=1$, $\sigma=\frac{1}{2}$}]
+%
+% \addplot[color=red,mark=*] coordinates {
+% (7, 8.472e-02)
+% (31, 3.044e-02)
+% (111, 1.022e-02)
+% (351, 3.303e-03)
+% (1023, 1.039e-03)
+% (2815, 3.196e-04)
+% (7423, 9.658e-05)
+% (18943, 2.873e-05)
+% (47103, 8.437e-06)
+% };
+% \end{loglogaxis}
+% \end{tikzpicture}
+%--------------------------------------------------
+ The title is placed in the middle of the axis (the placing does not incorporate any axis descriptions). You can reconfigure the appearance and/or placing of the title for example with
+\begin{codeexample}[code only]
+\pgfplotsset{every axis title/.append style={at={(0.75,1)}}}
+\end{codeexample}
+This will place the title at~75\% of the $x$-axis. The coordinate~$(0,0)$ is the lower left corner and~$(1,1)$ the upper right one.
+\end{pgfplotskey}
+
+\subsubsection{Legend}
+
+\begin{pgfplotskey}{legend columns=\marg{number} (default 1)}
+Allows to configure the maximum number of adjacent legend entries. The default value~|1| places legend entries vertically below each other.
+
+Use |legend columns=-1| to draw all entries horizontally.
+\end{pgfplotskey}
+
+\begin{pgfplotskey}{legend plot pos=\mchoice{left,right,none} (initially left)}
+Configures where the small line specifications will be drawn: left of the description, right of the description or not at all.
+\end{pgfplotskey}
- \addplot[smooth,color=red,mark=x]
+\begin{pgfplotscodekey}{legend image code}
+\label{opt:legend:image:code}
+Allows to replace the default images which are drawn inside of legends. The first argument to this option is the plot specification, a key-value list which has been determined by \lstinline!\addplot!.
+
+The default is
+\begin{codeexample}[code only]
+/pgfplots/legend image code/.code={%
+ \draw[#1,mark repeat=2,mark phase=2]
plot coordinates {
- (0,0)
- (1,1)
- (2,1)
- (3,2)
- };
- \addlegendentry{Case 2}
- \end{axis}
- \end{tikzpicture}
+ (0cm,0cm)
+ (0.3cm,0cm)
+ (0.6cm,0cm)%
+ };%
+}
+\end{codeexample}
+\end{pgfplotscodekey}
- \caption{An example for the \texttt{\textbackslash addlegendentry} command}%
- \label{fig:addlegendentry}%
-\end{figure}%
-It does not matter where \lstinline[breaklines=false]!\addlegendentry! commands are placed, only the sequence matters. You will need one \lstinline[breaklines=false]!\addlegendentry! for every \lstinline!\addplot! command.
+\subsubsection{Axis Lines}
+By default the axis lines are drawn as a |box|, but it is possible to change the appearance of the $x$~and~$y$ axis lines.
+\begin{codeexample}[]
+\begin{tikzpicture}
+\begin{axis}[
+ axis x line=middle,
+ axis y line=right,
+ tick align=center,
+ ymax=1.1, ymin=-1.1,
+ enlargelimits=false
+]
+ \addplot[blue,mark=none]
+ plot[id=sinneg,domain=-10:0,samples=40]
+ function{sin(x)};
+\end{axis}
+\end{tikzpicture}
+\end{codeexample}
-\subsection{\texttt{\textbackslash legend[OPTIONS]\{LIST\}}}
-\label{sec:legenddef}%
-You can use
-\begin{lstlisting}
+\begin{codeexample}[]
\begin{tikzpicture}
-\begin{axis}
-...
-\legend{$d=2$\\$d=3$\\$d=4$\\$d=5$\\$d=6$\\}
-...
+\begin{axis}[
+ enlargelimits=false,
+ minor tick num=3,
+ axis y line=center,
+ axis x line=middle
+ ]
+ \addplot[blue,mark=none]
+ plot[domain=-5:5,samples=40]
+ (\x,{sin(\x r)});
\end{axis}
\end{tikzpicture}
-\end{lstlisting}
-to assign a complete legend. \textbf{Attention:} the final \lstinline!\\! is necessary! The \lstinline[breaklines=false]!\legend! command takes the following arguments:
-\begin{lstlisting}
-\legend[OPTIONS]{TEXT1\\TEXT2\\TEXT3\\...\\}
-\end{lstlisting}
-where each legend element needs to be terminated by \lstinline[breaklines=false]!\\!. The short marker/line combination shown in legends is acquired from the argument to \lstinline[breaklines=false]!\addplot[...]!.
-
-\subsubsection{Legend appearance}
-The style ``\texttt{every axis legend}'' determines the legend's position and outer appearance:
-\begin{lstlisting}
-\tikzstyle{every axis legend}+=[
- at={(0,0)},
- anchor=south west]
-\end{lstlisting}
-will draw it at the lower left corner of the axis while
-\begin{lstlisting}
-\tikzstyle{every axis legend}+=[
- at={(1,1)},
- anchor=north east]
-\end{lstlisting}
-means the upper right corner. The `\texttt{anchor}' option determines which point \emph{of the legend} will be placed at $(0,0)$ or $(1,1)$ (see below for more examples).
+\end{codeexample}
-The legend is a \Tikz-matrix, so you can use any \Tikz\ option which affects
-nodes and matrizes (see~\cite[section 13~and~14]{tikz}). The matrix is created by something like
-\begin{lstlisting}
-\matrix[style=every axis legend] {
- draw plot specification 1 & \node{legend 1}\\
- draw plot specification 2 & \node{legend 2}\\
- ...
-};
-\end{lstlisting}
-You can configure the number of horizontal legend entries with the axis-option ``\texttt{legend columns=NUMBER}''. For example,
-\begin{lstlisting}
+In case the range of either of the axis do not include the zero value, it is possible to visualize this with a discontinuity decoration on the corresponding axis line.
+
+\begin{codeexample}[]
\begin{tikzpicture}
-\begin{axis}[legend columns=4]
-...
-\legend{legend 1\\legend 2\\legend 3\\}
+\begin{axis}[
+ axis x line=bottom,
+ axis x discontinuity=parallel,
+ axis y line=left,
+ xmin=360, xmax=600,
+ ymin=0, ymax=7,
+ enlargelimits=false
+]
+ \addplot coordinates {
+ (420,2)
+ (500,6)
+ (590,4)
+ };
+\end{axis}
+\end{tikzpicture}
+\end{codeexample}
+
+\begin{codeexample}[]
+\begin{tikzpicture}
+\begin{axis}[
+ axis x line=bottom,
+ axis y line=center,
+ tick align=outside,
+ axis y discontinuity=crunch,
+ ymin=95, enlargelimits=false
+]
+ \addplot[blue,mark=none]
+ plot[id=square,domain=-4:4,samples=20]
+ function{x*x+x+104};
\end{axis}
\end{tikzpicture}
-\end{lstlisting}
-would use (up to)~$4$ adjacent legend entries.
+\end{codeexample}
+
+\begin{pgfplotskey}{axis x line=\mchoice{box,top,middle,bottom,none} (initially box)}
+Allows to choose the location of the $x$ axis line(s).
+The labels and ticks are placed accordingly.
+Bottom will draw only a line at y=ymin, middle will draw a line at y=0, and top will draw only a line at y=ymax.
+Box is a combination of options top and bottom.
+\end{pgfplotskey}
+
+\begin{pgfplotskey}{axis y line=\mchoice{box,left,center,right,none} (initially box)}
+Allows to choose the location of the $y$ axis line(s).
+The labels and ticks are placed accordingly.
+Left will draw only a line at x=xmin, center will draw a line at x=0, and right will draw only a line at x=xmax.
+Box is a combination of options left and right.
+\end{pgfplotskey}
+
+\begin{pgfplotskey}{axis x discontinuity=\mchoice{crunch,parallel,none} (initially none)}
+Insert a discontinuity decoration on the $x$ axis.
+This is to visualize that the $y$ axis does cross the $x$ axis at its 0 value, because the minimum $x$ axis value is positive or the maximum value is negative.
+\end{pgfplotskey}
+
+\begin{pgfplotskey}{axis y discontinuity=\mchoice{crunch,parallel,none} (initially none)}
+Similar to |axis x discontinuity|, but now for the $y$ axis.
+\end{pgfplotskey}
+
+\begin{pgfplotskey}{hide axis=\mchoice{true,false} (initially false)}
+Allows to hide the axis. No outer rectangle, no tick marks and no labels will be drawn. Only titles and legends will be processed as usual.
+
+Axis scaling and clipping will be done as if you did not use |hide axis|.
+\end{pgfplotskey}
+
-Examples:
+\subsection{Scaling Options}
+
+\begin{pgfplotskey}{width=\marg{dimen}}
+Sets the width of the final picture to \marg{dimen}. If no |height| is specified, scaling will respect aspect ratios.
+
+\noindent\underline{Remarks:}
\begin{itemize}
-\item
-\begin{lstlisting}
-\tikzstyle{every axis legend}+=[
- at={(1.02,1)},
- anchor=north west]
-\end{lstlisting}
-draws the legend OUTSIDE TOP RIGHT.
+ \item The scaling only affects the width of one unit in $x$-direction or the height for one unit in $y$-direction. Axis labels and tick labels won't be resized, but their size is used to determine the axis scaling.
-\item
-\begin{lstlisting}
-\tikzstyle{every axis legend}+=[
- at={(1,0.5)},
- anchor=east,outer sep=0.5cm]
-\end{lstlisting}
-draws the legend INSIDE MIDDLE RIGHT, separated by 0.5cm from the axis.
-\end{itemize}
+ \item You can use the |scale=|\marg{number} option,
+\begin{codeexample}[code only]
+\begin{tikzpicture}[scale=2]
+\begin{axis}
+...
+\end{axis}
+\end{tikzpicture}
+\end{codeexample}
+ to scale the complete picture.
-\noindent
-The default is
-\begin{lstlisting}
-\tikzstyle{every axis legend}=[%
- cells={anchor=center},
- inner xsep=3pt,inner ysep=2pt,nodes={inner sep=2pt,text depth=0.15em},
- anchor=north east,%
- shape=rectangle,%
- fill=white,%
- draw=black,
- at={(0.98,0.98)}
- ]
-\end{lstlisting}
-\paragraph{Attention:} you should \emph{not reset} the default style to stay compatible with future versions. If possible, use
-\begin{lstlisting}
-\tikzstyle{every axis legend}+=[...]
-\end{lstlisting}
+ \item The \Tikz-options \lstinline!x! and \lstinline!y! which set the unit dimensions in $x$ and $y$ directions can be specified as arguments to \lstinline!\begin{axis}[x=1.5cm,y=2cm]! if needed (see below). These settings override the \lstinline!width! and \lstinline!height! options.
+ \item You can also force a fixed width/height of the axis (without looking at labels) with
+ \begin{codeexample}[code only]
+\begin{tikzpicture}
+\begin{axis}[width=5cm,scale only axis]
+ ...
+\end{axis}
+\end{tikzpicture}
+ \end{codeexample}
-\subsection{\texttt{\textbackslash autoplotspeclist}}
-Allows to specify a list of plot specifications which will be used for each \lstinline!\addplot!-command without explicit plot specification.
+ \item Please note that up to the writing of this manual, \PGFPlots\ only estimates the size needed for axis- and tick labels. It does not include legends which have been placed outside of the axis\footnote{I.e. the `|width|' option will not work as expected, but the bounding box is still ok.}. This may be fixed in future versions.
-There are several possiblities to change it:
-\begin{enumerate}
- \item Use one of the predefined lists,
-\begin{lstlisting}
-\listcopy\coloredplotspeclist\to\autoplotspeclist%
-\listcopy\blackwhiteplotspeclist\to\autoplotspeclist%
-\end{lstlisting}
- \item Define your own one,
-\begin{lstlisting}
-\listnew{\autoplotspeclist}{%
- blue,mark=*\\%
- red,mark=square\\%
- dashed,mark=o\\%
- loosely dotted,mark=+\\%
- brown!60!black,mark options={fill=brown!40},mark=otimes*\\%
-}
-\end{lstlisting}
- (This example list requires \lstinline!\usetikzlibrary{plotmarks}!).
-\end{enumerate}
-Please note that the `\lstinline!\\!' is required to separate each element. Please note that comment characters~`\%' are necessary if the elements are on different lines.
+ Use the |x=|\marg{dimension}, |y=|\marg{dimension} and |scale only axis| options if the scaling happens to be wrong.
+\end{itemize}
+\end{pgfplotskey}
-\subsection{\texttt{\textbackslash logtologten\{ARG\}}}
-Expands to the result of $\texttt{ARG}/\log(10)$. You can also use
-\begin{lstlisting}
-\logtologtentomacro{9.5}{\result}
-\end{lstlisting}
-and \lstinline!\result! will be filled with the result.
+\begin{pgfplotskey}{height=\marg{dimen}}
+ See |width|.
+\end{pgfplotskey}
-\subsection{\texttt{\textbackslash logten}}
-Expands to the constant $\log(10)$. Useful for logplots because $\log(10^i) = i\log(10)$.
+\begin{pgfplotskey}{scale only axis=\mchoice{true,false} (initially false)}
+If |scale only axis| is enabled, label, tick and legend dimensions won't influence the size of the axis rectangle, that means |width| and |height| apply only to the axis rectangle
-\subsection{\texttt{\textbackslash prettyprintnumber\{NUM\}}}
-Allows to generate pretty--printed output for the number \texttt{NUM}. Examples:
-\begin{lstlisting}
-\prettyprintnumber{1.0}
+If |scale only axis=false| (the default), \PGFPlots\ will try to produce the desired width \emph{including} labels, titles and ticks.
+\end{pgfplotskey}
-\prettyprintnumber{151.015341}
+\begin{pgfplotsxykey}{\x=\marg{dimen}}
+Sets the unit size for one $x$ (or $y$) coordinate to \marg{dimen}.
-\prettyprintnumber{90.99999}
-\end{lstlisting}
-results in
+ Setting $x$ explicitly overrides the \lstinline!width! option. Setting $y$ explicitly overrides the \lstinline!height! option.
+\begin{codeexample}[]
+\begin{tikzpicture}
+\begin{axis}[x=1cm,y=1cm]
+\addplot plot[domain=0:3] (\x,2*\x);
+\end{axis}
+\end{tikzpicture}
+\end{codeexample}
+ Setting |x| and/or |y| for logarithmic axis will set the dimension used for $1 \cdot e \approx 2.71828$.
-\prettyprintnumber{1.0},
+ Please note that it is \emph{not} possible to specify \lstinline!x! as argument to \lstinline!tikzpicture!. The option
+\begin{codeexample}[code only]
+\begin{tikzpicture}[x=1.5cm]
+\begin{axis}
+ ...
+\end{axis}
+\end{tikzpicture}
+\end{codeexample}
+ won't have any effect because an axis rescales its coordinates (see the \lstinline!width! option).
+\end{pgfplotsxykey}
-\prettyprintnumber{151.015341},
+\subsection{Error Bars}
+\label{sec:errorbars}
+{%
+\def\pgfplotserror#1{\ensuremath{\epsilon_{#1}}}%
+\PGFPlots\ supports error bars for normal and logarithmic plots.
-\prettyprintnumber{90.99999}.
+Error bars are enabled for each plot separately, using \meta{behavior options} after \lstinline!\addplot!:
+\begin{codeexample}[code only]
+\addplot plot[/pgfplots/error bars/.cd,x dir=both,y dir=both] ...
+\end{codeexample}
+Error bars inherit all drawing options of the associated plot, but they use their own marker and style arguments additionally.
-It is used to display axis ticks. The default rounding precision is defined by
-\begin{lstlisting}
-\def\prettyprintnumberprecision{2}
-\end{lstlisting}
-and can be reconfigured if needed (the highest precision is~$5$ due to \TeX's restricted numerical capabilities).
+\begin{codeexample}[]
+\begin{tikzpicture}
+\begin{axis}
+\addplot plot[/pgfplots/error bars/.cd,
+ y dir=plus,y explicit]
+coordinates {
+ (0,0) +- (0.5,0.1)
+ (0.1,0.1) +- (0.05,0.2)
+ (0.2,0.2) +- (0,0.05)
+ (0.5,0.5) +- (0.1,0.2)
+ (1,1) +- (0.3,0.1)};
+\end{axis}
+\end{tikzpicture}
+\end{codeexample}
-\subsection{\texttt{\textbackslash axispreset\{key=value,key=value\}}}
-Allows to define default options for any axis. For example,
-\begin{lstlisting}
-...
-\axispreset{width=\textwidth}%
-...
+\begin{codeexample}[]
\begin{tikzpicture}
\begin{axis}
-...
+\addplot plot[/pgfplots/error bars/.cd,
+ y dir=both,y explicit,
+ x dir=both,x fixed=0.05,
+ error mark=diamond*]
+coordinates {
+ (0,0) +- (0.5,0.1)
+ (0.1,0.1) +- (0.05,0.2)
+ (0.2,0.2) +- (0,0.05)
+ (0.5,0.5) +- (0.1,0.2)
+ (1,1) +- (0.3,0.1)};
\end{axis}
\end{tikzpicture}
-\end{lstlisting}
-will produce a width of \lstinline!\textwidth! for any following axis. You can preset any of the \texttt{axis}-options described below.
+\end{codeexample}
+
+\begin{codeexample}[]
+\pgfplotstabletypesetfile{pgfplots.testtable2.dat}
-\subsection{Axis options}
-There are several required and even more optional arguments to modify axes. They are used like
-\begin{lstlisting}
\begin{tikzpicture}
-\begin{axis}[key=value,key2=value2]
-...
+\begin{loglogaxis}
+\addplot plot[/pgfplots/error bars/.cd,
+ x dir=both,x fixed relative=0.5,
+ y dir=both,y explicit relative,
+ error mark=triangle*]
+ table[x=x,y=y,y error=errory]
+ {pgfplots.testtable2.dat};
+\end{loglogaxis}
+\end{tikzpicture}
+\end{codeexample}
+%--------------------------------------------------
+% coordinates {
+% (32,32)
+% (64,64)
+% (128,128) +- (0,0.3)
+% (1024,1024) +- (0,0.2)
+% (32068,32068) +- (0,0.6)
+% (64000,64000) +- (0,0.6)
+% (128000,128000) +- (0,0.6)
+% };
+%--------------------------------------------------
+
+\begin{codeexample}[]
+\begin{tikzpicture}
+\begin{axis}[enlargelimits=false]
+\addplot[red,mark=*]
+ plot[/pgfplots/error bars/.cd,
+ y dir=minus,y fixed relative=1,
+ x dir=minus,x fixed relative=1,
+ error mark=none,
+ error bar style={dotted}]
+coordinates
+ {(0,0) (0.1,0.1) (0.2,0.2)
+ (0.5,0.5) (1,1)};
\end{axis}
\end{tikzpicture}
-\end{lstlisting}
-The overall appeareance can be changed with
-\begin{lstlisting}
-\tikzstyle{every axis}+=[line width=1pt]
-\end{lstlisting}
-for example.
+\end{codeexample}
-\subsubsection{\texttt{[xy]min=COORD}, \texttt{[xy]max=COORD}}
-The options \texttt{xmin}, \texttt{xmax} and \texttt{ymin}, \texttt{ymax} allow to define the axis limits, i.e. the lower left and the upper right corner. Some remarks:
-\begin{itemize}
- \item The axis limits determine the plotted range. Everything else will be clipped away.
- \item The width of every unit $x$-coordinate will be scaled such that the plot has width \lstinline!\axisdefaultwidth! (including the tick- and axis labels). The height of every unit $y$-coordinate will be scaled such that the plot has height \lstinline!\axisdefaultheight!.
+\begin{pgfplotsxykey}{error bars/\x\ dir=\mchoice{none,plus,minus,both} (initially none)}
+Draws either no error bars at all, only marks at $x+\pgfplotserror x$, only marks at $x-\pgfplotserror x$ or marks at both, $x+\pgfplotserror x$ and $x-\pgfplotserror x$. The $x$-error $\pgfplotserror x$ is acquired using one of the following options.
+
+The same holds for the |y dir| option.
+\end{pgfplotsxykey}
+
+\begin{pgfplotsxykey}{error bars/\x\ fixed=\marg{value} (initially 0)}
+Provides a common, absolute error $\pgfplotserror x=\text{\meta{value}}$ for all input coordinates.
- You can override this default behavior with the options \lstinline!width=DIMEN!, \lstinline!height=DIMEN!, \lstinline!x=DIMEN! and \lstinline!y=DIMEN!, see below.
- \item If one of \lstinline!xmin! or \lstinline!xmax! is missing, the $x$-interval will be determined automatically (see \lstinline!\addplot!). The same holds true if one of \lstinline!ymin! or \lstinline!ymax! is missing: in this case, the $y$-interval will be determined automatically.
+For linear $x$~axes, the error mark is drawn at $x \pm \pgfplotserror x$ while for logarithmic $x$~axes, it is drawn at $\log( x \pm \pgfplotserror x)$. Computations are performed in \PGF's floating point arithmetics.
+\end{pgfplotsxykey}
- \item The option \lstinline!enlargelimits! will automatically increase the plotted range.
+\begin{pgfplotsxykey}{error bars/\x\ fixed relative=\marg{percent} (initially 0)}
+Provides a common, relative error $\pgfplotserror x = \text{\meta{percent}} \cdot x$ for all input coordinates. The argument \meta{percent} is thus given relatively to input $x$ coordinates such that $\text{\meta{percent}} = 1$ means $100\%$.
+
+Error marks are thus placed at $x \cdot (1 \pm \pgfplotserror x)$ for linear axes and at $\log(x \cdot (1 \pm \pgfplotserror x))$ for logarithmic axes. Computations are performed in floating point for linear axis and using the identity $\log(x \cdot (1 \pm \pgfplotserror x)) = \log(x) + \log( 1 \pm \pgfplotserror x)$ for logarithmic scales.
+\end{pgfplotsxykey}
+
+\begin{pgfplotsxykey}{error bars/\x\ explicit}
+Configures the error bar algorithm to draw $x$-error bars at any input coordinate for which user-specified errors are available.
+ Each error is interpreted as absolute error, see |x fixed| for details.
+
+The different input formats of errors are described in section~\ref{sec:errorbar:input}.
+\end{pgfplotsxykey}
+
+\begin{pgfplotsxykey}{error bars/\x\ explicit relative}
+Configures the error bar algorithm to draw $x$-error bars at any input coordinate for which user-specified errors are available.
+ Each error is interpreted as relative error, that means error marks are placed at $x (1 \pm \text{\meta{value}}(x))$ (works as for |error bars/x fixed relative|).
+\end{pgfplotsxykey}
+
+
+\begin{pgfplotskey}{error bars/error mark=\meta{marker}}
+Sets an error marker for any error bar. \marg{marker} is expected to be a valid plot mark, see section~\ref{sec:markers}.
+\end{pgfplotskey}
+
+\begin{pgfplotskey}{error bars/error mark options=\marg{key-value-list}}
+Sets a key-value list of options for any error mark. This option works similary to the \Tikz\ `|mark options|' key.
+\end{pgfplotskey}
+
+\begin{pgfplotskey}{error bars/error bar style=\marg{key-value-list}}
+Appends the argument to `|/pgfplots/every error bar|' which is installed at the beginning of every error bar.
+\end{pgfplotskey}
+
+\begin{pgfplotscodetwokey}{error bars/draw error bar}
+Allows to change the default drawing commands for error bars. The two arguments are
+\begin{itemize}
+\item the source point, $(x,y)$ and
+\item the target point, $(\tilde x,\tilde y)$.
\end{itemize}
+Both are determined by \PGFPlots\ according to the options described above. The default code is
+\begin{codeexample}[code only][basicstyle=\footnotesize\ttfamily]
+/pgfplots/error bars/draw error bar/.code 2 args={%
+ \pgfkeysgetvalue{/pgfplots/error bars/error mark}%
+ {\pgfplotserrorbarsmark}%
+ \pgfkeysgetvalue{/pgfplots/error bars/error mark options}%
+ {\pgfplotserrorbarsmarkopts}%
+ \draw #1 -- #2 node[pos=1,sloped,allow upside down] {%
+ \expandafter\tikz\expandafter[\pgfplotserrorbarsmarkopts]{%
+ \expandafter\pgfuseplotmark\expandafter{\pgfplotserrorbarsmark}%
+ \pgfusepath{stroke}}%
+ };
+}
+\end{codeexample}
+\end{pgfplotscodetwokey}
+
+\subsubsection{Input Formats of Error Coordinates}
+\label{sec:errorbar:input}%
+Error bars with explicit error estimations for single data points require some sort of input format. This applies to `|error bars/|\meta{[xy]}| explizit|' and `|error bars/|\meta{[xy]}| explizit relative|'.
+
+Error bar coordinates can be read from `|plot coordinates|' or from `|plot table|'. The inline plot coordinates format is
+\begin{codeexample}[code only]
+\addplot coordinates {
+ (1,2) +- (0.4,0.2)
+ (2,4) +- (1,0)
+ (3,5)
+ (4,6) +- (0.3,0.001)
+}
+\end{codeexample}
+where $(1,2) \pm (0.4,0.2)$ is the first coordinate, $(2,4) \pm (1,0)$ the second and so forth. The point $(3,5)$ has no error coordinate.
-\subsubsection{\texttt{[xy]label=TEXT}}
-The options \texttt{xlabel} and \texttt{ylabel} change axis labels to `\texttt{TEXT}' which is any \LaTeX\ text. Use `\lstinline!{TEXT}!' if you need grouping.
+The `|plot table|' format is
+\begin{codeexample}[code only]
+\addplot table[x error=COLNAME,y error=COLNAME]
+\end{codeexample}
+or
+\begin{codeexample}[code only]
+\addplot table[x error index=COLINDEX,y error index=COLINDEX]
+\end{codeexample}
+These options are used as the `|x|' and `|x index|' options.
-Labels are \Tikz-Nodes which are placed with
-\begin{lstlisting}
-\node
- [style=every axis label,
- style=every axis x label]
-\node
- [style=every axis label,
- style=every axis y label]
-\end{lstlisting}
-so you can reconfigure their position and appearance. As for legends, the coordinate \lstinline!(0,0)! denotes the lower left axis corner and \lstinline!(1,1)! the upper right.
+You can supply error coordinates even if they are not used at all; they will be ignored silently in this case.
-The default styles are
-\begin{lstlisting}
-\tikzstyle{every axis label}=[]
-\tikzstyle{every axis x label}=[
- at={(0.5,0)},
- below,
- yshift=-15pt]
-\tikzstyle{every axis y label}=[
- at={(0,0.5)},
- xshift=-35pt,
- rotate=90]
-\end{lstlisting}
-You should use
-\begin{lstlisting}
-\tikzstyle{every axis label}+=[...]
-\tikzstyle{every axis x label}+=[...]
-\tikzstyle{every axis y label}+=[...]
-\end{lstlisting}
-to modify options to ensure compatibility with future versions.
-
-\subsubsection{\texttt{title=TEXT}}
-Adds a caption to the plot. This will place a \Tikz-Node with
-\begin{lstlisting}
-\node[style=every axis title] {TEXT};
-\end{lstlisting}
-to the current axis. An example is shown in figure~\ref{fig:titleexample}. The title is placed in the middle of the axis (the placing does not incorporate any axis descriptions). You can reconfigure the appearance and/or placing of the title for example with
-\begin{lstlisting}
-\tikzstyle{every axis title}+=[at={(0.75,1)}]
-\end{lstlisting}
-This will place the title at~75\% of the $x$-axis. The coordinate~$(0,0)$ is the lower left corner and~$(1,1)$ the upper right one.
+}%
-Please note that using the \LaTeX\ floating figures together with \lstinline!\caption{TEXT}! may be more appropriate in many situation. However, `\texttt{title}' allows access to the axis' size without any axis descriptions which is useful if more than one plot needs a caption.
-\begin{figure}
- \centering
- \begin{tikzpicture}
+\subsection{Number Formatting Options}
+\label{sec:number:printing}%
+\PGFPlots\ typeset tick labels rounded to given precision and in configurable number formats. The command to do so is |\pgfmathprintnumber|; it uses the current set of number formatting options.
+
+These options are described in all detail in the manual for \PGFPlotstable, which comes with \PGFPlots. Please refer to that manual.
+
+\begin{command}{\pgfmathprintnumber\marg{x}}
+Generates pretty-printed output for the (real) number \marg{x}. The input number \marg{x} is parsed using |\pgfmathfloatparsenumber| which allows arbitrary precision.
+
+Numbers are typeset in math mode using the current set of number printing options, see below. Optional arguments can also be provided using |\pgfmathprintnumber[|\meta{options}|]|\marg{x}.
+
+Please refer to the manual of \PGFPlotstable\ (shipped with this package) for details about the number options.
+\end{command}
+
+\label{sec:identify:minor:log}%
+\begin{pgfplotskey}{log identify minor tick positions=\mchoice{true,false} (initially true)}
+Set this to |true| if you want to identify log--plot tick labels at positions
+\[ i \cdot 10^j \]
+with $i \in \{2,3,4,5,6,7,8,9\},\, j \in \Z$. This may be valueable in conjunction with the `|extra x ticks|' and `|extra y ticks|' options. An example is shown below: The axis range is so small that only one tick label $10^j$ is inside of it. Extra tick labels can be placed on top of the normal ticks, and placing ticks at $i \cdot 10^j $ may be appropriate.
+\begin{codeexample}[]
+\pgfplotsset{every axis/.append style={%
+ width=6cm,
+ xmin=7e-3,xmax=7e-2,
+ extra x ticks={3e-2,6e-2},
+ extra x tick style={major tick length=0pt,font=\footnotesize}
+}}%
+\begin{tikzpicture}%
\begin{loglogaxis}[
- width=0.48\textwidth,
- xlabel=Dof,ylabel=Error,
- title={$\mu=0.1$, $\sigma=0.2$}]
-
- \addplot plot coordinates {
- (5, 8.312e-02)
- (17, 2.547e-02)
- (49, 7.407e-03)
- (129, 2.102e-03)
- (321, 5.874e-04)
- (769, 1.623e-04)
- (1793, 4.442e-05)
- (4097, 1.207e-05)
- (9217, 3.261e-06)
- };
- \end{loglogaxis}
- \end{tikzpicture}%
- \hfill
- \begin{tikzpicture}
- \begin{loglogaxis}[
- width=0.48\textwidth,
- xlabel=Dof,ylabel=Error,
- title={$\mu=1$, $\sigma=\frac{1}{2}$}]
-
- \addplot[color=red,mark=*] plot coordinates {
- (7, 8.472e-02)
- (31, 3.044e-02)
- (111, 1.022e-02)
- (351, 3.303e-03)
- (1023, 1.039e-03)
- (2815, 3.196e-04)
- (7423, 9.658e-05)
- (18943, 2.873e-05)
- (47103, 8.437e-06)
- };
+ title=with minor tick identification]
+ \addplot coordinates {
+ (1e-2,10)
+ (3e-2,100)
+ (6e-2,200)
+ };
\end{loglogaxis}
- \end{tikzpicture}
+\end{tikzpicture}%
- \begin{lstlisting}
- \begin{tikzpicture}
- \begin{loglogaxis}[
- width=0.48\textwidth,
- xlabel=Dof,ylabel=Error,
- title={$\mu=0.1$, $\sigma=0.2$}]
-
- \addplot plot coordinates {
- (5, 8.312e-02)
- (17, 2.547e-02)
- ...
- (4097, 1.207e-05)
- (9217, 3.261e-06)
- };
- \end{loglogaxis}
- \end{tikzpicture}%
- \hfill
- \begin{tikzpicture}
+\begin{tikzpicture}%
\begin{loglogaxis}[
- width=0.48\textwidth,
- xlabel=Dof,ylabel=Error,
- title={$\mu=1$, $\sigma=\frac{1}{2}$}]
-
- \addplot[color=red,mark=*] plot coordinates {
- (7, 8.472e-02)
- (31, 3.044e-02)
- ...
- (18943, 2.873e-05)
- (47103, 8.437e-06)
- };
- \end{loglogaxis}
- \end{tikzpicture}
- \end{lstlisting}
- \caption{An example for the `\texttt{title}' option. Some data points have not been listed, the `\texttt{...}' is not part of the plot.}
- \label{fig:titleexample}
-\end{figure}
+ title=without minor tick identification,
+ log identify minor tick positions=false]
+ \addplot coordinates {
+ (1e-2,10)
+ (3e-2,100)
+ (6e-2,200)
+ };
+ \end{loglogaxis}%
+\end{tikzpicture}%
+\end{codeexample}
+\end{pgfplotskey}
+
+\begin{pgfplotscodekey}{log number format code}
+Provides \TeX-code to generate log plot tick labels. Argument `|#1|' is the (natural) logarithm of the tick position.
+The default implementation invokes |log base 10 number format code| after it changed the log basis to~$10$. It also checks the other log plot options.
+\end{pgfplotscodekey}
+
+
+\begin{pgfplotscodekey}{log base 10 number format code}
+Allows to change the overall appearance of base 10 log plot tick labels. The default is
+\begin{codeexample}[code only]
+log base 10 number format code/.code={%
+ $10^{\pgfmathprintnumber{#1}}$}
+\end{codeexample}
+where the `|log plot exponent style|' allows to change number formatting options.
+\end{pgfplotscodekey}
+
+\begin{pgfplotskey}{log plot exponent style=\marg{key-value-list}}
+Allows to configure the number format of log plot exponents. This style is installed just before `|log base 10 number format code|' will be invoked. Please note that this style will be installed within the default code for `|log number format code|'.
+\begin{codeexample}[]
+\tikzset{samples=15}
+\pgfplotsset{every axis/.append style={
+ width=7cm,
+ xlabel=$x$,
+ ylabel=$f(x)$,
+ extra y ticks={45},
+ legend style={at={(0.03,0.97)},
+ anchor=north west}}}
+
+\begin{tikzpicture}
+\begin{semilogyaxis}[
+ log plot exponent style/.style={
+ /pgf/number format/fixed zerofill,
+ /pgf/number format/precision=1}]
+ \addplot plot[id=gnuplot_exp,domain=-5:10]
+ function{exp(x)};
+ \addplot plot[id=gnuplot_expv,domain=-5:10]
+ function{exp(2*x)};
-\subsubsection{\texttt{[xy]mode=normal$|$log}}
-Allows to choose between normal plots or logplots for each $x,y$-combination. Default is \lstinline!xmode=normal!, \lstinline!ymode=normal!.
+ \legend{$e^x$,$e^{2x}$}
+\end{semilogyaxis}
+\end{tikzpicture}
+\end{codeexample}
+
+\begin{codeexample}[]
+\tikzset{samples=15}
+\pgfplotsset{every axis/.append style={
+ width=7cm,
+ xlabel=$x$,
+ ylabel=$f(x)$,
+ extra y ticks={45},
+ legend style={at={(0.03,0.97)},
+ anchor=north west}}}
+
+\begin{tikzpicture}
+\begin{semilogyaxis}[
+ log plot exponent style/.style={
+ /pgf/number format/fixed,
+ /pgf/number format/use comma,
+ /pgf/number format/precision=2}]
+
+ \addplot plot[id=gnuplot_exp,domain=-5:10]
+ function{exp(x)};
+ \addplot plot[id=gnuplot_expv,domain=-5:10]
+ function{exp(2*x)};
+
+ \legend{$e^x$,$e^{2x}$}
+\end{semilogyaxis}
+\end{tikzpicture}
+\end{codeexample}
+\end{pgfplotskey}
+
+%--------------------------------------------------
+% \subsubsection{Defining Own Display Styles}
+% You can define own display styles, although this may require some insight into \TeX-programming. Here are two examples:
+% \begin{enumerate}
+% \item A new fixed point display style: The following code defines a new style named `\texttt{my own fixed point style}' which uses $1{\cdot}00$ instead of $1.00$.
+% \begin{lstlisting}
+% \def\myfixedpointstyleimpl#1.#2\relax{%
+% #1{\cdot}#2%
+% }%
+% \def\myfixedpointstyle#1{%
+% \pgfutilensuremath{%
+% \ifpgfmathfloatroundhasperiod
+% \expandafter\myfixedpointstyleimpl#1\relax
+% \else
+% #1%
+% \fi
+% }%
+% }
+% \pgfkeys{/my own fixed point style/.code={%
+% \let\pgfmathprintnumber@fixed@style=\myfixedpointstyle}
+% }%
+% \end{codeexample}
+% You only need to overwrite the macro \lstinline!\pgfmathprintnumber@fixed@style!. This macro takes one argument (the result of any numerical computations). The \TeX-boolean \lstinline!\ifpgfmathfloatroundhasperiod! is true if and only if the input number contains a period.
+%
+% \item An example for a new scientific display style:
+% \begin{lstlisting}
+% % #1:
+% % 0 == '0' (the number is +- 0.0),
+% % 1 == '+',
+% % 2 == '-',
+% % 3 == 'not a number'
+% % 4 == '+ infinity'
+% % 5 == '- infinity'
+% % #2: the mantisse
+% % #3: the exponent
+% \def\myscistyle#1#2e#3\relax{%
+% ...
+% }
+% \pgfkeys{/my own sci style/.code={%
+% \let\pgfmathfloatrounddisplaystyle=\myscistyle},
+% }%
+% \end{codeexample}
+% \end{enumerate}
+%--------------------------------------------------
+
+
+
+
+\subsection{Specifying the Plotted Range}
+
+\begin{pgfplotsxykeylist}{\x min=\marg{coord},\x max=\marg{coord}}
+The options |xmin|, |xmax| and |ymin|, |ymax| allow to define the axis limits, i.e. the lower left and the upper right corner. Everything outside of the axis limits will be clipped away.
+
+If one of \lstinline!xmin! or \lstinline!xmax! is missing, the $x$-interval will be determined automatically. The same holds true if one of \lstinline!ymin! or \lstinline!ymax! is missing: in this case, the $y$-interval will be determined automatically.
+
+If $x$-limits have been specified explicitly and $y$-limits are computed automatically, the automatic computation of $y$-limits will only considers points which fall into the specified $x$-range (and vice--versa). This can be disable using |clip limits=false|.
+
+Axis limits can be increased automatically using the |enlargelimits| option.
+\end{pgfplotsxykeylist}
+
+\begin{pgfplotsxykey}{\x mode=\mchoice{normal,linear,log} (initially normal)}
+Allows to choose between linear (=normal) or logarithmic axis scaling or logplots for each $x,y$-combination.
+\end{pgfplotsxykey}
+
+\begin{pgfplotskey}{clip limits=\mchoice{true,false} (initially true)}
+ Configures what to do if some, but not all axis limits have been specified explicitly. In case |clip limits=true|, the automatic limit computation will \emph{only} consider points which do not contradict the explicitly set limits.
+
+ This option has nothing to do with path clipping, it only affects how the axis limits are computed.
+\end{pgfplotskey}
+
+\begin{pgfplotskey}{enlargelimits=\mchoice{true,false,auto,\marg{val}}}
+Enlarges the axis size somewhat if enabled.
-\subsubsection{\texttt{[xy]tick=\{LIST\}}}
-The options \texttt{xtick} and \texttt{ytick} assigns a list of \emph{Positions} where ticks shall be placed. The argument \texttt{LIST} will be used inside of a \lstinline!\foreach \x in {LIST}! statement, and \texttt{LIST} contains one of the following formats:
+You can set |xmin|, |xmax| and |ymin|, |ymax| to the minimum/maximum values of your data and |enlargelimits| will enlarge the canvas such that the axis doesn't touch the plots.
+
+\begin{itemize}
+ \item The value |true| enlarges all axes.
+ \item The value |false| uses tight axis limits as specified by the user (or read from input coordinates).
+ \item The value |auto| will enlarge limits only for axis for which axis limits have been determined automatically.
+ \item All other values like `|enlargelimits=0.1|' will enlarge all axis limits relatively (in this example, 10\% of the axis limits will be added at all sides).
+\end{itemize}
+A small value of |enlargelimits| may avoid problems with large markers near the boundary.
+\end{pgfplotskey}
+
+
+\subsection{Tick and Grid Options}
+
+\begin{pgfplotsxykey}{\x tick=\mchoice{\textbackslash empty,data,\marg{coordinate list}} (initially \marg{})}
+The options |xtick| and |ytick| assigns a list of \emph{Positions} where ticks shall be placed. The argument is either the command |\empty|, |data| or a list of coordinates. The choice |\empty| will result in no tick at all. The special value |data| will produce tick marks at every coordinate of the first plot. Otherwise, tick marks will be placed at every coordinate in \marg{coordinate list}. If this list is empty, \PGFPlots\ will compute a default list.
+
+\marg{coordinate list} will be used inside of a \lstinline!\foreach \x in !\marg{coordinate list} statement. The format is as follows:
\begin{itemize}
- \item \lstinline!{0,1,2,5,8}! (a series of coordinates),
+ \item \lstinline!{0,1,2,5,8,1e1,1.5e1}! (a series of coordinates),
\item \lstinline!{0,...,5}! (the same as \lstinline!{0,1,2,3,4,5}!),
\item \lstinline!{0,2,...,10}! (the same as \lstinline!{0,2,4,6,8,10}!),
\item \lstinline!{9,...,3.5}! (the same as \lstinline!{9, 8, 7, 6, 5, 4}!),
\item See \cite[Section~34]{tikz} for a more detailed definition of the options.
- \item Use `\texttt{xtick=}' to use the default tick placement rules.
- \item Use `\lstinline!xtick=\empty!' to disable any ticks.
\end{itemize}
-For logplots, \PGFPlots\ will apply $\log(\cdot)$ to each element in `\texttt{LIST}'.
+For logplots, \PGFPlots\ will apply $\log(\cdot)$ to each element in `\marg{coordinate list}'.
+\begin{codeexample}[]
+\begin{tikzpicture}
+ \begin{loglogaxis}[xtick={12,9897,1468864}]
+ \plotcoords
+ \end{loglogaxis}
+\end{tikzpicture}
+\end{codeexample}
-\paragraph{Attention:} You can't use the `\texttt{...}' syntax if the elements are too large for \TeX! For example, `\texttt{xtick=1.5e5,2e7,3e8}' will work (because the elements are interpreted as strings, not as numbers), but `\texttt{xtick=1.5,3e5,...,1e10}' will fail because it involves real number arithmetics beyond \TeX's capacities.
+\begin{codeexample}[]
+\begin{tikzpicture}
+\begin{axis}[
+ xtick=\empty,
+ ytick={-2,0.3,3,3.7,4.5}]
+\addplot+[smooth] coordinates {
+ (-2,3) (-1.5,2) (-0.3,-0.2)
+ (1,1.2) (2,2) (3,5)};
+\end{axis}
+\end{tikzpicture}
+\end{codeexample}
+
+\paragraph{Attention:} You can't use the `|...|' syntax if the elements are too large for \TeX! For example, `|xtick=1.5e5,2e7,3e8|' will work (because the elements are interpreted as strings, not as numbers), but `|xtick=1.5,3e5,...,1e10|' will fail because it involves real number arithmetics beyond \TeX's capacities.
\vspace*{0.3cm}
\noindent
-The default choice for tick \emph{positions} in normal plots is to place a tick at each coordinate~$i\cdot h$. The step size~$h$ depends on the axis scaling and the axis limits. It is chosen from a list a ``feasable'' step sizes such that neither too much nor too few ticks will be generated. The default for logplots it to place ticks at each $10^i$ in the axis' range. The default tick positions can be reconfigured with
+The default choice for tick \emph{positions} in normal plots is to place a tick at each coordinate~$i\cdot h$. The step size~$h$ depends on the axis scaling and the axis limits. It is chosen from a list a ``feasable'' step sizes such that neither too much nor too few ticks will be generated. The default for logplots is to place ticks at positions $10^i$ in the axis' range. Which positions depends on the axis scaling and the dimensions of the picture. The default tick positions can be reconfigured with
\begin{itemize}
- \item \lstinline!\renewcommand{\axisdefaulttickwidth}{35}! where the integer argument denotes the maximum space between adjacent ticks in full points. The suffix ``\texttt{pt}'' has to be omitted and fractional numbers are not supported.
- \item \lstinline!\renewcommand{\axisdefaulttryminticks}{4}! configures a loose lower bound on the number of ticks. It should be considered as a suggestion, not a tight limit.
+ \item `\lstinline!max space between ticks=!\marg{number}' where the integer argument denotes the maximum space between adjacent ticks in full points. The suffix ``|pt|'' has to be omitted and fractional numbers are not supported. The default is~\axisdefaulttickwidth.
+ \item `\lstinline!try min ticks=!\marg{number}' configures a loose lower bound on the number of ticks. It should be considered as a suggestion, not a tight limit. The default is~\axisdefaulttryminticks. This number will increase the number of ticks if `|max space between ticks|' produces too few of them.
+ \item `\lstinline!try min ticks log=!\marg{number}' The same for logarithmic axis.
\end{itemize}
+The total number of ticks may still vary because not all fractional numbers in the axis' range are valid tick positions.
\noindent
The tick \emph{appearance} can be (re-)configured with
-\begin{lstlisting}
-\tikzstyle{every tick}=[very thin,gray]
-\tikzstyle{every minor tick}=[]
-\end{lstlisting}
+\begin{codeexample}[code only]
+\pgfplotsset{every tick/.style={very thin,gray}}
+\pgfplotsset{every minor tick/.style={}}
+\end{codeexample}
or
-\begin{lstlisting}
-\tikzstyle{every tick}+=[very thin,gray]
-\tikzstyle{every minor tick}+=[black]
-\end{lstlisting}
-Please prefer the `\texttt{+=}' versions to ensure compatibility with future versions.
+\begin{codeexample}[code only]
+\pgfplotsset{every tick/.append style={very thin,gray}}
+\pgfplotsset{every minor tick/.append style={black}}
+\end{codeexample}
+Please prefer the `|.append style|' versions to ensure compatibility with future versions.
+
+This style commands can be used at any time. The tick line width can be configured with `|major tick length|' and `|minor tick length|'.
+\end{pgfplotsxykey}
+
+\begin{pgfplotskey}{minor tick num=\marg{number}}
+ Sets both, |minor x tick num| and |minor y tick num| to \marg{number}.
+
+ Minor ticks will be disabled if the major ticks don't have the same distance.
+\begin{codeexample}[]
+\begin{tikzpicture}
+ \begin{axis}[minor tick num=1]
+ \addplot (\x,\x^3);
+ \addplot (\x,-20*\x);
+ \end{axis}
+\end{tikzpicture}
+\end{codeexample}
+
+\begin{codeexample}[]
+\begin{tikzpicture}
+ \begin{axis}[minor tick num=3]
+ \addplot (\x,\x^3);
+ \addplot (\x,-20*\x);
+ \end{axis}
+\end{tikzpicture}
+\end{codeexample}
+
+\end{pgfplotskey}
+
+\begin{pgfplotsxykey}{minor \x~tick num=\marg{number} (initially 0)}
+ Sets the number of minor tick lines used for linear $x$~or~$y$ axis separately.
+
+ Minor ticks will be disabled if the major ticks don't have the same distance.
+\begin{codeexample}[]
+\begin{tikzpicture}
+ \begin{axis}[minor x tick num=1,
+ minor y tick num=3]
+ \addplot (\x,\x^3);
+ \addplot (\x,-20*\x);
+ \end{axis}
+\end{tikzpicture}
+\end{codeexample}
-This style commands can be used at any time. The tick line width can be configured with the \lstinline!axis!-options `\texttt{tickwidth}' and `\texttt{subtickwidth}'.
+\end{pgfplotsxykey}
-\subsubsection{\texttt{[xy]tickten=\{LIST\}}}
-The options \texttt{xtickten} and \texttt{ytickten} allow to place ticks at selected positions $10^k, k \in \text{\texttt{LIST}}$. They are only used for logplots. The syntax for `\texttt{LIST}' is the same as above for `\texttt{xtick=LIST}' or `\texttt{ytick=LIST}'.
+\begin{pgfplotsxykey}{extra \x\ ticks=\marg{coordinate list}}
+Adds \emph{additional} tick positions and tick labels to the $x$~or~$y$ axis. `Additional' tick positions do not affect the normal tick placement algorithms, they are drawn after the normal ticks. This has two benefits: first, you can add single, important tick positions without disabling the default tick label generation and second, you can draw tick labels `on top' of others, possibly using different style flags.
-\subsubsection{\texttt{[xy]ticklabels=\{LIST\}}}
-Assigns a \emph{list} of tick \emph{labels} to each tick position. Tick \emph{positions} are assigned using the \texttt{xtick} and \texttt{ytick}-options.
-This is one of two options to assign tick labels directly. The other option is `\texttt{xticklabel=\{COMMAND\}}' (or \texttt{yticklabel=\{COMMAND\}}).
-Option `\texttt{\*ticklabel}' offers higher flexibility while `\texttt{\*ticklabels}' is easier to use.
+\begin{codeexample}[]
+\begin{tikzpicture}
+\begin{axis}[
+ xmin=0,xmax=3,ymin=0,ymax=15,
+ extra y ticks={2.71828},
+ extra y tick labels={$e$},
+ extra x ticks={2.2},
+ extra x tick style={grid=major,
+ /pgfplots/tick label style={
+ rotate=90,anchor=east}},
+ extra x tick labels={Cut},
+]
+ \addplot (\x,{exp(\x)});
+ \addlegendentry{$e^x$}
+\end{axis}
+\end{tikzpicture}
+\end{codeexample}
+\begin{codeexample}[]
+\pgfplotsset{every axis/.append style={width=5.3cm}}
+\begin{tikzpicture}
+\begin{loglogaxis}
+\addplot coordinates
+ {(10,1e-5) (20,5e-6) (40,2.5e-6)};
+\end{loglogaxis}
+\end{tikzpicture}
-The argument \texttt{LIST} has the same format as for ticks, that means
-\begin{lstlisting}
+\begin{tikzpicture}
+\begin{loglogaxis}[
+ extra x ticks={20,40},
+ extra y ticks={5e-6,2.5e-6}]
+\addplot coordinates
+ {(10,1e-5) (20,5e-6) (40,2.5e-6)};
+\end{loglogaxis}
+\end{tikzpicture}
+
+\begin{tikzpicture}
+\begin{loglogaxis}[
+ log identify minor tick positions=false,
+ extra x ticks={20,40},
+ extra y ticks={5e-6,2.5e-6}]
+\addplot coordinates
+ {(10,1e-5) (20,5e-6) (40,2.5e-6)};
+\end{loglogaxis}
+\end{tikzpicture}
+\end{codeexample}
+
+Remarks:
+\begin{itemize}
+\item Use |extra x ticks| to highlight special tick positions. The use of |extra x ticks| does not affect minor tick/grid line generation, so you can place extra ticks at positions $j\cdot 10^i$ in log--plots.
+\item Extra ticks are always typeset as major ticks.
+
+They are affected by |major tick length| or options like |grid=major|.
+\item Use the style |every extra x tick| (|every extra y tick|) to configure the appearance.
+\item You can also use `|extra x tick style=|\marg{...}' which has the same effect.
+\end{itemize}
+\end{pgfplotsxykey}
+
+\begin{pgfplotskeylist}{
+ space between ticks=\marg{number} (initially 35),
+ try min ticks=\marg{number} (initially 4),
+ try min ticks log=\marg{number} (initially 3)}
+see Options |xtick| and |ytick| for a description.
+\end{pgfplotskeylist}
+
+\begin{pgfplotskeylist}{tickwidth=\marg{dimension} (initially 0.15cm),major tick length=\marg{dimension} (initially 0.15cm)}
+ Sets the width of major tick lines.
+\end{pgfplotskeylist}
+
+\begin{pgfplotskeylist}{subtickwidth=\marg{dimension} (initially 0.1cm),minor tick length=\marg{dimension} (initially 0.1cm)}
+ Sets the width of minor tick lines.
+\end{pgfplotskeylist}
+
+\begin{pgfplotsxykey}{\x tickten=\marg{exponent base 10 list}}
+These options allow to place ticks at selected positions $10^k, k \in \text{\marg{exponent base 10 list}}$. They are only used for logplots. The syntax for \marg{exponent base 10 list} is the same as above for |xtick=|\marg{list} or |ytick=|\marg{list}.
+
+Using `|xtickten={1,2,3,4}|' is equivalent to `|xtick={1e1,1e2,1e3,1e4}|', but it requires fewer computational time and it allows to use the short syntax `|xtickten={1,...,4}|'.
+\begin{codeexample}[]
+\begin{tikzpicture}[samples=8]
+\begin{semilogyaxis}[
+ ytickten={-6,-4,...,4},
+ domain=0:10]
+
+% invoke gnuplot to generate coordinates:
+\addplot plot[id=pow1]
+ function {2**(-2*x + 6)};
+\addlegendentry{$2^{-2x + 6}$}
+
+\addplot plot[id=pow2]
+ function {2**(-1.5*x -3)};
+\addlegendentry{$2^{-1.5x -3}$}
+\end{semilogyaxis}
+\end{tikzpicture}
+\end{codeexample}
+\end{pgfplotsxykey}
+
+\begin{pgfplotsxykey}{\x ticklabels=\marg{label list}}
+Assigns a \emph{list} of tick \emph{labels} to each tick position. Tick \emph{positions} are assigned using the |xtick| and |ytick|-options.
+
+This is one of two options to assign tick labels directly. The other option is |xticklabel=|\marg{command} (or |yticklabel=|\marg{command}).
+Option `|xticklabel|' offers higher flexibility while `|xticklabels|' is easier to use.
+
+The argument \marg{label list} has the same format as for ticks, that means
+\begin{codeexample}[code only]
xticklabels={$\frac{1}{2}$,$e$}
-\end{lstlisting}
+\end{codeexample}
Denotes the two--element--list $\{\frac 12, e\}$. The list indices match the indices of the tick positions. If you need commas inside of list elements, use
-\begin{lstlisting}
+\begin{codeexample}[code only]
xticklabels={{0,5}, $e$}.
-\end{lstlisting}
+\end{codeexample}
-Example:
-\begin{lstlisting}
+\begin{codeexample}[]
\begin{tikzpicture}
\begin{axis}[
xtick={-1.5,-1,...,1.5},
@@ -679,76 +2447,33 @@ Example:
$\frac 12$,
$1$}
]
-\addplot[smooth,blue,mark=*] plot coordinates {
- (-1, 1)
- (-0.75, 0.5625)
- (-0.5, 0.25)
- (-0.25, 0.0625)
- (0, 0)
- (0.25, 0.0625)
- (0.5, 0.25)
- (0.75, 0.5625)
- (1, 1)
+\addplot[smooth,blue,mark=*] coordinates {
+ (-1, 1)
+ (-0.75, 0.5625)
+ (-0.5, 0.25)
+ (-0.25, 0.0625)
+ (0, 0)
+ (0.25, 0.0625)
+ (0.5, 0.25)
+ (0.75, 0.5625)
+ (1, 1)
};
\end{axis}
\end{tikzpicture}
-\end{lstlisting}
-yields figure~\ref{fig:ticklistexample}.
-\begin{figure}
- \centering
- \begin{tikzpicture}[baseline]
- \begin{axis}[
- anchor=north east,
- width=6cm,
- xtick={-1.5,-1,...,1.5},
- xticklabels={%
- $-1\frac 12$,
- $-1$,
- $-\frac 12$,
- $0$,
- $\frac 12$,
- $1$}
- ]
- \addplot[smooth,blue,mark=*] plot coordinates {
- (-1, 1)
- (-0.75, 0.5625)
- (-0.5, 0.25)
- (-0.25, 0.0625)
- (0, 0)
- (0.25, 0.0625)
- (0.5, 0.25)
- (0.75, 0.5625)
- (1, 1)
- };
- \end{axis}
- \end{tikzpicture}
- \hspace{10pt}%
- \begin{minipage}[t]{6cm}%
- \vspace{0pt}%
- \begin{lstlisting}
-xtick={-1.5,-1,...,1.5},
-xticklabels={%
- $-1\frac 12$,
- $-1$,
- $-\frac 12$,
- $0$,
- $\frac 12$,
- $1$}
- \end{lstlisting}
- \end{minipage}
- \caption{An example for the \texttt{xticklabels} option.}
- \label{fig:ticklistexample}
-\end{figure}
-
-\subsubsection{\texttt{[xy]ticklabel=\{COMMAND\}}}
-Use \texttt{xticklabel} or \texttt{yticklabel} to change the \LaTeX-command which creates the tick \emph{labels} assigned to each tick position (see options \texttt{xtick} and \texttt{ytick}).
-
-This is one of two options to assign tick labels directly. The other option is `\texttt{xticklabels=\{LIST\}}' (or \texttt{yticklabels=\{LIST\}}). Option `\texttt{\*ticklabel}' offers higher flexibility while `\texttt{\*ticklabels}' is easier to use.
-
-The argument `\texttt{COMMAND}' can be any \LaTeX-text. The following commands are valid inside of \texttt{COMMAND}:
+\end{codeexample}
+\end{pgfplotsxykey}
+
+
+\begin{pgfplotsxykey}{\x ticklabel=\marg{command}}
+Use |xticklabel| or |yticklabel| to change the \TeX-command which creates the tick \emph{labels} assigned to each tick position (see options |xtick| and |ytick|).
+
+This is one of two options to assign tick labels directly. The other option is `|xticklabels=|\marg{label list}' (or |yticklabels=|\marg{label list}). Option `|xticklabel|' offers higher flexibility while `|xticklabels|' is easier to use.
+
+The argument \marg{command} can be any \TeX-text. The following commands are valid inside of \marg{command}:
\begin{description}
\item[\textbackslash tick] The current element of option \lstinline!xtick! (or \lstinline!ytick!).
\item[\textbackslash ticknum] The current tick number, starting with~0 (a counter).
+ \item[\textbackslash nexttick] This command is only valid in case if the |x tick label as interval| option is set (or the corresponding variable for~$y$). It will contain the position of the next tick position, that means the right boundary of the tick interval.
\end{description}
The default argument is
\begin{itemize}
@@ -756,288 +2481,805 @@ The default argument is
\item \lstinline!\axisdefaultticklabellog! for logplots, see below.
\end{itemize}
(the same holds for \lstinline!yticklabel!). The defaults are set to
-\begin{lstlisting}
-\newcommand{\axisdefaultticklabel}[0]{%
- $\prettyprintnumber{\tick}$%
+\begin{codeexample}[code only]
+\def\axisdefaultticklabel{%
+ $\pgfmathprintnumber{\tick}$%
}
-\newcommand{\axisdefaultticklabellog}[0]{{%
- \logtologtentomacro{\tick}{\roundedtick}%
- $10^{\prettyprintnumber{\roundedtick}}$%
-}}
-\end{lstlisting}
+\def\axisdefaultticklabellog{%
+ \pgfkeysgetvalue{/pgfplots/log number format code/.@cmd}\pgfplots@log@label@style
+ \expandafter\pgfplots@log@label@style\tick\pgfeov
+}
+\end{codeexample}
+that means you can configure the appearance of linear axis with the number formatting options described in section~\ref{sec:number:printing} and logarithmic axis with |log number format code|, see below.
+
You can change the appearance of tick labels with
-\begin{lstlisting}
-\tikzstyle{every tick label}+=[font=\tiny]
-\end{lstlisting}
+\begin{codeexample}[code only]
+\pgfplotsset{every tick label/.append style={
+ font=\tiny,
+ /pgf/number format/sci}}
+\end{codeexample}
and/or
-\begin{lstlisting}
-\tikzstyle{every x tick label}+=[above]
-\end{lstlisting}
+\begin{codeexample}[code only]
+\pgfplotsset{every x tick label/.append style={
+ above,
+ /pgf/number format/fixed zerofill}}
+\end{codeexample}
and
-\begin{lstlisting}
-\tikzstyle{every y tick label}+=[font=\bfseries]
-\end{lstlisting}
-
-\subsubsection{\texttt{tickpos=left$|$right$|$both}}
-Allows to choose where to place the small tick lines. Default is ``\texttt{both}''. This setting applies to both $x$~and~$y$ axis where ``left'' and ``right'' mean ``bottom'' and ``top'' for~$y$.
-
-\subsubsection{\texttt{[xy]minorticks=true$|$false}}
-\subsubsection{\texttt{[xy]majorticks=true$|$false}}
-\subsubsection{\texttt{ticks=minor$|$major$|$both$|$none}}
-Enables/disables the small tick lines either for single axis or for all of them. Major ticks are those placed at the tick positions and minor ticks are only used in log plots. Please note that minor ticks are automatically disabled if \texttt{xtick} is not a uniform range\footnote{A uniform list means the difference between all elements is~$1$ for normal plots or, for logplots, $\log(10)$.}. Default is to use minor and major ticks.
-
-You can configure the length of the tick line with `\texttt{minor tick length=DIMEN}' and `\texttt{major tick length=DIMEN}' (where DIMEN is a \TeX-length like 1cm) and its appearance using the following styles:
-\begin{lstlisting}
-\tikzstyle{every tick}+=[color=black] % applies to major and minor ticks,
-\tikzstyle{every minor tick}+=[thin] % applies only to minor ticks,
-\tikzstyle{every major tick}+=[thick] % applies only to major ticks.
-\end{lstlisting}
-There is also the style ``\texttt{every tick}'' which applies to both, major and minor ticks.
-
-\subsubsection{\texttt{major tick length=DIMEN}}
-\subsubsection{\texttt{minor tick length=DIMEN}}
-Allows to configure the length of the small tick lines. Minor ticks are only displayed for logarithmic plots. See option ``\texttt{ticks}'' for appearance styles for ticks.
-
-\subsubsection{\texttt{[xy]minorgrids=true$|$false}}
-\subsubsection{\texttt{[xy]majorgrids=true$|$false}}
-\subsubsection{\texttt{grid=minor$|$major$|$both$|$none}}
-Enables/disables different grid lines. Major grid lines are placed at the normal tick positions (see \texttt{xmajorticks}) while minor grid lines are placed at minor ticks (see \texttt{xminorticks}).
+\begin{codeexample}[code only]
+\pgfplotsset{every y tick label/.append style={font=\bfseries}}
+\end{codeexample}
+Another possibility is to use
+\begin{codeexample}[code only]
+\begin{axis}[y tick label style={above,
+ /pgf/number format/fixed zerofill}
+]
+...
+\end{axis}
+\end{codeexample}
+which has the same effect as the `|every x tick label|' statement above. This is possible for all \PGFPlots-|every|-styles, see section~\ref{sec:styles}.
+\end{pgfplotsxykey}
+
+\begin{pgfplotsxykey}{\x\ tick label as interval=\mchoice{true,false} (initially false)}
+ Allows to treat tick labels as intervals; that means the tick positions denote the interval boundaries. If there are $n$ positions, $(n-1)$ tick labels will be generated, one for each interval.
+\begin{codeexample}[]
+\begin{tikzpicture}
+\begin{axis}[x tick label as interval]
+ \addplot (\x,3*\x);
+\end{axis}
+\end{tikzpicture}
+\end{codeexample}
+ This mode enables the use of |\nexttick| inside of |xticklabel| (or |yticklabel|). A common application might be a bar plot.
+\begin{codeexample}[]
+\begin{tikzpicture}
+\begin{axis}[
+ ybar interval=0.9,
+ x tick label as interval,
+ xmin=2003,xmax=2030,
+ ymin=0,ymax=140,
+ xticklabel={
+ $\pgfmathprintnumber{\tick}$
+ -- $\pgfmathprintnumber{\nexttick}$},
+ xtick=data,
+ x tick label style={
+ rotate=90,anchor=east,
+ /pgf/number format/1000 sep=}
+]
+
+ \addplot[draw=blue,fill=blue!40!white]
+ coordinates
+ {(2003,40) (2005,100) (2006,15)
+ (2010,90) (2020,120) (2030,3)};
+\end{axis}
+\end{tikzpicture}
+\end{codeexample}
+\end{pgfplotsxykey}
+
+\label{sec:scaled:ticks}%
+\begin{pgfplotskey}{scaled ticks=\mchoice{true,false} (initially true)}
+Allows to factor out common exponents in tick labels. For example, if you have tick labels $20000,40000$ and $60000$, you may want to save some space and write $2,4,6$ with a separate factor `$\cdot 10^4$'. Use `|scaled ticks=true|' to enable this feature (default is |true|).
+
+\begin{codeexample}[]
+\begin{tikzpicture}
+\begin{axis}[scaled ticks=true]
+ \addplot coordinates {
+ (20000,0.0005)
+ (40000,0.0010)
+ (60000,0.0020)
+ };
+\end{axis}
+\end{tikzpicture}%
+\end{codeexample}
+
+\begin{codeexample}[]
+\begin{tikzpicture}
+\begin{axis}[scaled ticks=false]
+ \addplot coordinates {
+ (20000,0.0005)
+ (40000,0.0010)
+ (60000,0.0020)
+ };
+\end{axis}
+\end{tikzpicture}
+\end{codeexample}
+\end{pgfplotskey}
+
+\begin{pgfplotscodekey}{tick scale label code}
+Allows to change the default code for scaled tick labels. The default is
+\begin{codeexample}[code only]
+tick scale label code/.code={$\cdot 10^{#1}$}.
+\end{codeexample}
+\end{pgfplotscodekey}
+
+\begin{pgfplotskey}{scale ticks below=\marg{exponent}}
+Allows fine tuning of the `|scaled ticks|' algorithm: if the axis limits are of magnitude $10^e$ and $e<$\marg{exponent}, the common prefactor~$10^e$ will be factored out. The default is
+\makeatletter
+\pgfplots@scale@ticks@below@exponent
+\makeatother.
+\end{pgfplotskey}
+
+\begin{pgfplotskey}{scale ticks above=\marg{exponent}}
+Allows fine tuning of the '|scaled ticks|' algorithm: if the axis limits are of magnitude $10^e$ and $e>$\marg{exponent}, the common prefactor~$10^e$ will be factored out. The default is
+\makeatletter
+\pgfplots@scale@ticks@above@exponent
+\makeatother.
+\end{pgfplotskey}
+
+
+\begin{pgfplotskey}{tickpos=\mchoice{left,right,both} (initially both)}
+Allows to choose where to place the small tick lines. Default is ``|both|''. This setting applies to both $x$~and~$y$ axis where ``left'' and ``right'' mean ``bottom'' and ``top'' for~$y$.
+\end{pgfplotskey}
+
+\begin{pgfplotskey}{tick align=\mchoice{inside,center,outside} (initially inside)}
+Allows to change the location of the ticks relative to the axis lines.
+Default is ``|inside|''. this setting applies to both $x$~and~$y$ axis.
+\end{pgfplotskey}
+
+
+\begin{pgfplotsxykeylist}{\x minorticks=\mchoice{true,false} (initially true),\x majorticks=\mchoice{true,false} (initially true),ticks=\mchoice{minor,major,both,none} (initially both)}
+Enables/disables the small tick lines either for single axis or for all of them. Major ticks are those placed at the tick positions and minor ticks are between tick positions. Please note that minor ticks are automatically disabled if |xtick| is not a uniform range\footnote{A uniform list means the difference between all elements is the same for linear axis or, for logarithmic axes, $\log(10)$.}.
+
+The key |minor tick length=|\marg{dimen} configures the tick length for minor ticks while the |major| variant applies to major ticks.
+You can configure the appearance using the following styles:
+\begin{codeexample}[code only]
+\pgfplotsset{every tick/.append style={color=black}} % applies to major and minor ticks,
+\pgfplotsset{every minor tick/.append style={thin}} % applies only to minor ticks,
+\pgfplotsset{every major tick/.append style={thick}} % applies only to major ticks.
+\end{codeexample}
+There is also the style ``|every tick|'' which applies to both, major and minor ticks.
+\end{pgfplotsxykeylist}
+
+
+\begin{pgfplotsxykeylist}{\x minorgrids=\mchoice{true,false} (initially true),\x majorgrids=\mchoice{true,false} (initially true),grids=\mchoice{minor,major,both,none} (initially both)}
+Enables/disables different grid lines. Major grid lines are placed at the normal tick positions (see |xmajorticks|) while minor grid lines are placed at minor ticks (see |xminorticks|).
+
+This example employs the coordinates defined on page~\pageref{page:plotcoords:src}.
+\begin{codeexample}[]
+\begin{tikzpicture}
+\begin{loglogaxis}[
+ xlabel={\textsc{Dof}},
+ ylabel={$L_2$ Error},
+ grid=major
+]
+\plotcoords
+\end{loglogaxis}
+\end{tikzpicture}
+\end{codeexample}
+
+\begin{codeexample}[]
+\begin{tikzpicture}
+\begin{loglogaxis}[
+ grid=both,
+ tick align=outside,
+ tickpos=left]
+\addplot coordinates
+ {(100,1e-4) (500,1e-5) (1000,3e-6)};
+\addplot coordinates
+ {(100,1e-5) (500,4e-6) (1000,2e-6)};
+\end{loglogaxis}
+\end{tikzpicture}
+\end{codeexample}
Grid lines will be drawn before tick lines are processed, so ticks will be drawn on top of grid lines. You can configure the appearance of grid lines with the styles
-\begin{lstlisting}
-\tikzstyle{every axis grid}=[style=help lines] % applies to major and minor grids,
-\tikzstyle{every minor grid}+=[color=blue] % applies only to minor grid lines,
-\tikzstyle{every major grid}+=[thick] % applies only to major grid lines.
-\end{lstlisting}
-An example for grid lines can be found in section~\ref{sec:gridlines}.
-
-\subsubsection{\texttt{enlargelimits=[true$|$false$|$auto$|$VAL]}}
-Enlarges the axis size somewhat if enabled.
+\begin{codeexample}[code only]
+\pgfplotsset{every axis grid/.style={style=help lines}}
+\pgfplotsset{every minor grid/.append style={color=blue}}
+\pgfplotsset{every major grid/.append style={thick}}
+\end{codeexample}
+\end{pgfplotsxykeylist}
-You can set \texttt{xmin}, \texttt{xmax} and \texttt{ymin}, \texttt{ymax} to the minimum/maximum values of your data and \texttt{enlargelimits} will enlarge the canvas such that the axis doesn't touch the plots.
-\begin{itemize}
- \item The value \texttt{true} enlarges all axes.
- \item The value \texttt{false} uses tight axis limits as specified by the user (or read from input coordinates).
- \item The value \texttt{auto} will enlarge limits only for axis for which axis limits have been determined automatically.
- \item All other values like `\texttt{enlargelimits=0.1}' will enlarge all axis limits relatively (in this example, 10\% of the axis limits will be added at all sides).
- \item If no relative threshold is provided, axis enlargement is done relatively to $x_\text{max}-x_\text{min}$ for normal plots and absolutely for log--plots up to now.
-\end{itemize}
-A small value of \texttt{enlargelimits} may avoid problems with large markers near the boundary.
-\subsubsection{\texttt{legend columns=NUMBER}}
-Allows to configure the maximum number of adjacent legend entries. The default is \texttt{legend columns=1}, so legends are placed vertically below each other. Examples can be found in section~\ref{sec:legendexamples:cols}.
-\subsubsection{\texttt{legend plot pos=left$|$right$|$none}}
-Configures where the small line specifications will be drawn: left of the description, right of the description or not at all. See an example in section~\ref{sec:legendexamples:plotpos}.
-\subsubsection{\texttt{disablelogfilter}}
-Disables numerical evaluation of $\log(x)$ in \LaTeX. If you specify this option, any plot coordinates and tick positions must be provided as $\log(x)$ instead of $x$. This may be faster and -- possibly -- more accurate than the numerical log. The current implementation of $\log(x)$ normalizes~$x$ to $m\cdot 10^e$ and computes
-\[ \log(x) = \log(m) + e \log(10) \]
-where $y = \log(m)$ is computed with a newton method applied to $\exp(y) - m$. The normalization involves string parsing without \TeX-registers. You can savely evaluate $\log(1\cdot 10^{-7})$ although \TeX-registers would produce an underflow for such small numbers.
-The exponential function is implemented in pgf using a truncated Euler McLaurin--series.
+\subsection{Style Options}
+\label{sec:styles}
+\subsubsection{All Supported Styles}
+\PGFPlots\ provides many styles to customize its appearance and behavior. They can be defined and changed in any place where keys are allowed.
-The current implementation of $\log(\cdot)$ is done by the macro \lstinline!\pgfmathlog! which is provided by package \lstinline!pgfmathlog.sty! (contained in the \PGFPlots-bundle).
+\begin{handler}{.style=\marg{key-value-list}}
+ Defines or redefines a style \meta{key}. A style is a normal key which will set all options in \marg{key-value-list} when it is set.
-\subsubsection{\texttt{disabledatascaling}}
-\label{sec:disabledatascaling}%
-Disables internal re-scaling of input data. Normally, every input data like plot coordinates, tick positions or whatever, are parsed without using \TeX's limited number precision. Then, a transformation like
- \[ T(x) = 10^{q-m} \cdot x \]
-is applied to every input coordinate/position where $m$ is ``the order of $x$'' base~$10$. Example: $x=1234 = 1.234\cdot 10^3$ has order~$m=4$ while $x=0.001234 = 1.234\cdot 10^{-3}$ has order $m=-2$. The parameter~$q$ is the order of the axis' width/height.
+ Use |\pgfplotsset{|\meta{key}|/.style={|\meta{key-value-list}|}}| to (re-) define a style \meta{key} in the namespace |/pgfplots|.
+\end{handler}
-The \textbf{effect} is that your plot coordinates can be of \emph{arbitrary precision} like $0.0000001$ and $0.0000004$. For these two coordinates, \PGFPlots\ will use 100pt and 400pt internally. The transformation is quit fast since it relies only on period shifts.
+\begin{handler}{.append style=\marg{key-value-list}}
+ Appends \marg{key-value-list} to an already existing style \meta{key}. This is the preferred method to change the predefined styles: if you only append, you maintain compatibility with future versions.
-The option ``\texttt{disabledatascaling}'' disables this data transformation. That means you are restricted to coordinates which \TeX\ can handle\footnote{Please note that the axis' scaling requires to compute $1/( x_\text{max} - x_{\text{min}} )$. The option \texttt{disabledatascaling} may lead to overflow or underflow in this context, so use it with care! Normally, the data scale transformation avoids this problem.}.
+ Use |\pgfplotsset{|\meta{key}|/.append style={|\meta{key-value-list}|}}| to append \marg{key-value-list} to the style \meta{key}. This will assume the prefix |/pgfplots|.
+\end{handler}
-So far, the data scale transformation applies only to normal axis (logarithmic scales do not need it).
+\begin{command}{\pgfplotsset\marg{key-value-list}}
+ Defines or sets all options in \marg{key-value-list}.
+
+ It is a shortcut for |\pgfqkeys{/pgfplots}|\marg{key-value-list}, that means it inserts the prefix |/pgfplots| to any option which has no full path.
-\subsubsection{\texttt{anchor=NAME}}
-This option shifts the axis horizontally and vertically such that the axis anchor (a point on the axis) is placed at coordinate $(0,0)$\footnote{I haven't understood how to implement an axis as a path command. In the future, the last path coordinate may be used in this place.}.
+ You can define new style keys with |.style| and |.append style|, see above.
+\end{command}
-\begin{itemize}
- \item
-Anchors are useful in conjunction with horizontal or vertical alignment of plots, see the examples in section~\ref{sec:align} and section~\ref{sec:halign}.
-
- \item Anchors are placed on the axis rectangle; any axis labels, titles or legends are completely unaffected.
-
- \item Valid choices for \texttt{NAME} are
- \texttt{north},
- \texttt{north west},
- \texttt{west},
- \texttt{south west},
- \texttt{south},
- \texttt{south east},
- \texttt{east},
- \texttt{north east},
- \texttt{center}.
- They denote the places
+\begin{stylekey}{/pgfplots/every axis}
+ Installed at the beginning of every axis. \Tikz\ options inside of it will be used for anything inside of the axis rectangle and any axis descriptions.
+\end{stylekey}
+
+\begin{stylekey}{/pgfplots/every semilogx axis}
+ Installed at the beginning of every plot with linear $x$~axis and logarithmic $y$~axis, but after `|every axis|'.
+\end{stylekey}
+
+\begin{stylekey}{/pgfplots/every semilogy axis}
+ Likewise, but with interchanged roles for $x$~and~$y$.
+\end{stylekey}
+
+\begin{stylekey}{/pgfplots/every loglog axis}
+ Installed at the beginning of every double--logarithmic plot.
+\end{stylekey}
+
+\begin{stylekey}{/pgfplots/every linear axis}
+ Installed at the beginning of every plot with normal axis scaling.
+\end{stylekey}
+
+\begin{stylekey}{/pgfplots/every axis plot}
+ Used for the \Tikz-drawing command in any `\lstinline!\addplot!' command. May only contain \Tikz\ options.
+\end{stylekey}
+
+\begin{stylekey}{/pgfplots/every axis plot post}
+ This style is very similar to |every axis plot| in that is applies to any drawing command in |\addplot|. However, it is set \emph{after} any user defined styles or |cycle list| options.
+\begin{codeexample}[]
+\begin{tikzpicture}
+\pgfplotsset{
+ every axis plot post/.append style=
+ {mark=none}}
+
+\begin{axis}[
+ legend style={
+ at={(0.03,0.97)},anchor=north west},
+ domain=0:1]
+ \addplot (\x,\x^2);
+ \addplot (\x,{exp(\x)});
+ \legend{$x^2$,$e^x$}
+\end{axis}
+\end{tikzpicture}
+\end{codeexample}
+\end{stylekey}
+
+\begin{stylekey}{/pgfplots/every axis plot no \#}
+ Used for every \#th plot where $\#=1,2,3,4,\dotsc$.
+\end{stylekey}
+
+\begin{stylekey}{/pgfplots/every axis label}
+ Used for $x$~and~$y$ axis label. You can use `|at=|\marg{(x,y)} to set its position where $(0,0)$ refers to the lower left corner and $(1,1)$ to the upper right one.
+\end{stylekey}
+
+\begin{stylekey}{/pgfplots/every axis x label}
+ Used for $x$~labels, installed after `|every axis label|'.
+\end{stylekey}
+
+\begin{stylekey}{/pgfplots/every axis y label}
+ Like `|every axis x label|', just for~$y$.
+\end{stylekey}
+
+\begin{stylekey}{/pgfplots/every axis title}
+ Used for any axis title. The |at=|\marg{(x,y)} command works as for `|every axis label|'.
+\end{stylekey}
+
+\begin{stylekey}{/pgfplots/every tick}
+ Installed for each of the small tick lines.
+\end{stylekey}
+
+\begin{stylekey}{/pgfplots/every minor tick}
+ Used for each minor tick line, installed after `|every tick|'.
+\end{stylekey}
+
+\begin{stylekey}{/pgfplots/every major tick}
+ Used for each major tick line, installed after `|every tick|'.
+\end{stylekey}
+
+\begin{stylekey}{/pgfplots/every x tick}
+
+\end{stylekey}
+
+\begin{stylekey}{/pgfplots/every minor x tick}
+
+\end{stylekey}
+
+\begin{stylekey}{/pgfplots/every major x tick}
+
+\end{stylekey}
+
+\begin{stylekey}{/pgfplots/every y tick}
+
+\end{stylekey}
+
+\begin{stylekey}{/pgfplots/every minor y tick}
+
+\end{stylekey}
+
+\begin{stylekey}{/pgfplots/every major y tick}
+
+\end{stylekey}
+
+\begin{stylekey}{/pgfplots/every axis grid}
+ Used for each grid line.
+\end{stylekey}
+
+\begin{stylekey}{/pgfplots/every minor grid}
+ Used for each minor grid line, installed after `|every axis grid|'.
+\end{stylekey}
+
+\begin{stylekey}{/pgfplots/every major grid}
+ Likewise, for major grid lines.
+\end{stylekey}
+
+\begin{stylekey}{/pgfplots/every axis x grid}
+
+\end{stylekey}
+
+\begin{stylekey}{/pgfplots/every minor x grid}
+
+\end{stylekey}
+
+\begin{stylekey}{/pgfplots/every major x grid}
+
+\end{stylekey}
+
+\begin{stylekey}{/pgfplots/every axis y grid}
+
+\end{stylekey}
+
+\begin{stylekey}{/pgfplots/every minor y grid}
+
+\end{stylekey}
+
+\begin{stylekey}{/pgfplots/every major y grid}
+
+\end{stylekey}
+
+\begin{stylekey}{/pgfplots/every tick label}
+ Used for each $x$~and~$y$ tick labels.
+\end{stylekey}
+
+\begin{stylekey}{/pgfplots/every x tick label}
+ Used for each $x$~tick label, installed after `|every tick label|'.
+\end{stylekey}
+
+\begin{stylekey}{/pgfplots/every y tick label}
+ Likewise, for $y$~tick labels.
+\end{stylekey}
+
+\begin{stylekey}{/pgfplots/every x tick scale label}
+ Configures placement and display of the nodes containing the order of magnitude of $x$~tick labels, see~\ref{sec:scaled:ticks} for more information about |scaled ticks|.
+\end{stylekey}
+
+\begin{stylekey}{/pgfplots/every y tick scale label}
+ Likewise, but for $y$-tick scale labels.
+\end{stylekey}
+
+\begin{stylekey}{/pgfplots/every extra x tick}
+ Allows to configure the appearance of `|extra x ticks|'. This style is installed before touching the first extra $x$~tick, so you can set any option which affects tick generation, for example
+\end{stylekey}
+
+\begin{stylekey}{/pgfplots/every error bar}
+ Installed for every error bar.
+\begin{codeexample}[code only]
+\pgfplotsset{every extra x tick/.append style={grid=major}}
+\pgfplotsset{every extra x tick/.append style={major tick length=0pt}}
+\pgfplotsset{every extra x tick/.append style={/pgf/number format=sci subscript}}
+\end{codeexample}
+or something like that.
+\end{stylekey}
+
+\begin{stylekey}{/pgfplots/every extra y tick}
+ Likewise, but for extra $y$-ticks.
+\end{stylekey}
+
+\begin{stylekey}{/pgfplots/every axis legend}
+ Installed for each legend. As for |every axis label|, the legend's position can be placed using coordinates between $0$~and~$1$, see above.
+\end{stylekey}
+
+
+\begin{pgfplotsxykeylist}{%
+ \x\ tick label style=\marg{$\dots$},
+ \x\ tick scale label style=\marg{$\dots$},
+ label style=\marg{$\dots$},
+ \x\ label style=\marg{$\dots$},
+ title style=\marg{$\dots$},
+ tick style=\marg{$\dots$},
+ minor tick style=\marg{$\dots$},
+ major tick style=\marg{$\dots$},
+ \x\ tick style=\marg{$\dots$},
+ minor \x\ tick style=\marg{$\dots$},
+ major \x\ tick style=\marg{$\dots$},
+ grid style=\marg{$\dots$},
+ minor grid style=\marg{$\dots$},
+ major grid style=\marg{$\dots$},
+ \x\ grid style=\marg{$\dots$},
+ minor \x\ grid style=\marg{$\dots$},
+ major \x\ grid style=\marg{$\dots$},
+ extra \x\ tick style=\marg{$\dots$}}
+
+All these options are equivalent to the corresponding `|every ...|'--styles.
+
+For example, |label style=|\marg{...} has the same effect as
+\begin{codeexample}[code only]
+\pgfplotsset{every axis label/.append style={...}}
+\end{codeexample}
+but can be provided as an option (or as part of a user defined style).
+See section~\ref{sec:styles} for more information about the available styles.
+\end{pgfplotsxykeylist}
+
+\subsubsection{Assigning Own Styles}
+\label{sec:styles:own}%
+Use |\pgfplotsset{|\meta{style name}|/.style=|\marg{key-value-list}|}|
+to create own styles. You \emph{can't use} |\tikzstyle|\marg{style name}|=[]|.
+\begin{codeexample}[]
+\pgfplotsset{my personal style/.style=
+ {grid=major,font=\large}}
+
+\begin{tikzpicture}
+\begin{axis}[my personal style]
+ \addplot coordinates {(0,0) (1,1)};
+\end{axis}
+\end{tikzpicture}
+\end{codeexample}
+
+\subsection{Alignment Options}
+
+\begin{pgfplotskey}{anchor=\marg{name} (initially south west)}
+\label{option:anchor}%
+This option shifts the axis horizontally and vertically such that the axis anchor (a point on the axis) is placed at coordinate $(0,0)$.
+
+Anchors are useful in conjunction with horizontal or vertical alignment of plots, see the examples below.
+
+There are three sets of anchors available: anchors positioned on the axis rectangle, anchors on the outer bounding box and anchors which have one coordinate on the outer bounding box and the other one at a position of the axis rectangle.
+
+{%
+%\pgfplotsset{every picture/.append style={background rectangle/.style={help lines},show background rectangle}}%
+\pgfplotstableread{pgfplots.testplot}\plottable
+\def\plot{%
+ \begin{axis}[
+ width=5cm,
+ name=test plot,
+ xlabel=$x$,
+ ylabel={$y$},% = \frac 12 \cdot x^3 - 4 x^2 -16 x$},
+ y label style={yshift=-15pt},
+ legend style={at={(1.03,1)},anchor=north west},
+ title=A test plot.
+ ]
+ \addplot table from{\plottable};
+ %\addplot coordinates {(0,0) (1,1)};
+ \addlegendentry{$f(x)$}
+ \addplot[red] plot[id=gnuplot_ppp,domain=-40:40,samples=120] function{10000*sin(x/3)};
+ \addlegendentry{$g(x)$}
+ \end{axis}
+}%
+\def\showit#1#2{%
+ %\node[show them,#2] at (test plot.#1) {(s.#1)};
+ \node[pin=#2:(s.#1),fill=black,circle,scale=0.3] at (test plot.#1) {};
+}%
+In more detail, we have
+\tikzstyle{every pin}=[opacity=0.5,fill=yellow,rectangle,rounded corners=3pt,font=\tiny]
+Anchors on the axis rectangle,
\begin{center}
- \begin{tikzpicture}[x=3cm,y=3cm]
- \draw (0,0) rectangle (1,1);
- \node[above] at (0.5,1) {N};
- \node[above left] at (0,1) {NW};
- \node[left] at (0,0.5) {W};
- \node[below left] at (0,0) {SW};
- \node[below] at (0.5,0) {S};
- \node[below right] at (1,0) {SE};
- \node[right] at (1,0.5) {E};
- \node[above right] at (1,1) {NE};
- \node at (0.5,0.5) {C};
+ \begin{tikzpicture}
+ \plot
+ \showit{north}{90}
+ \showit{north west}{135}
+ \showit{west}{180}
+ \showit{south west}{225}
+ \showit{south}{270}
+ \showit{south east}{305}
+ \showit{east}{0}
+ \showit{north east}{45}
+ \showit{center}{90}
\end{tikzpicture}
\end{center}
- \item The default value is \texttt{anchor=south west}.
+Anchors on the outer bounding box,
+ \begin{center}
+ \begin{tikzpicture}
+ \plot
+ \showit{outer north}{90}
+ \showit{outer north west}{135}
+ \showit{outer west}{180}
+ \showit{outer south west}{225}
+ \showit{outer south}{270}
+ \showit{outer south east}{305}
+ \showit{outer east}{0}
+ \showit{outer north east}{45}
+ \showit{outer center}{90}
+ \end{tikzpicture}
+ \end{center}
+Finally there are anchors which have one coordinate on the outer bounding box, and one on the axis rectangle,
+ \begin{center}
+ \begin{tikzpicture}[show background rectangle]
+ \plot
+ {\pgfplotsset{every pin/.append style={pin distance=1cm}}%
+ \showit{above north}{90}
+ }%
+ \showit{above north east}{90}
+ \showit{right of north east}{0}
+ \showit{right of east}{0}
+ \showit{right of south east}{0}
+ \showit{below south east}{-90}
+ {\pgfplotsset{every pin/.append style={pin distance=1cm}}%
+ \showit{below south}{-90}
+ }%
+ \showit{below south west}{-90}
+ \showit{left of south west}{180}
+ \showit{left of west}{180}
+ \showit{left of north west}{180}
+ \showit{above north west}{90}
+ \end{tikzpicture}
+ \end{center}
+The default value is |anchor=south west|. You can use anchors in conjunction with the \Tikz\ |baseline| option and/or \lstinline!\begin{pgfinterruptboundingbox}! to perform alignment.
+}
-\end{itemize}
+\begin{description}
+\item[Vertical alignment with \texttt{baseline}]
+\label{sec:align}%
+The default axis anchor is |south west|, which means that the picture coordinate $(0,0)$ is the lower left corner of the axis. As a consequence, the \Tikz\ option ``|baseline|'' allows vertical alignment of adjacent plots:
+\begin{codeexample}[]
+\tikzset{domain=-1:1}
+\begin{tikzpicture}
+ \begin{axis}[xlabel=A normal sized $x$ label]
+ \addplot[smooth,blue,mark=*] (\x,\x^2);
+ \end{axis}
+\end{tikzpicture}%
+\hspace{0.15cm}
+\begin{tikzpicture}
+ \begin{axis}[xlabel={$\displaystyle \sum_{i=0}^N n_i $ }]
+ \addplot[smooth,blue,mark=*] (\x,\x^2);
+ \end{axis}
+\end{tikzpicture}
+\end{codeexample}
-\subsubsection{\texttt{width=DIMEN}, \texttt{height=DIMEN}}
-The axis is always scaled such that its dimension is
+\begin{codeexample}[]
+\tikzset{domain=-1:1}
+\begin{tikzpicture}[baseline]
+ \begin{axis}[xlabel=A normal sized $x$ label]
+ \addplot[smooth,blue,mark=*] (\x,\x^2);
+ \end{axis}
+\end{tikzpicture}%
+\hspace{0.15cm}
+\begin{tikzpicture}[baseline]
+ \begin{axis}[xlabel={$\displaystyle \sum_{i=0}^N n_i $ }]
+ \addplot[smooth,blue,mark=*] (\x,\x^2);
+ \end{axis}
+\end{tikzpicture}
+\end{codeexample}
+The |baseline| option configures \Tikz\ to shift position $y=0$ to the text's baseline and the |south west| anchor shifts the axis such the $y=0$ is at the lower left axis corner.
+
+
+\item[Horizontal Alignment]
+\label{sec:halign}%
+If you place multiple |axes| into a single |tikzpicture| and use the `|anchor|'-option, you can control horizontal alignment:
+\begin{codeexample}[]
+\begin{tikzpicture}
+\pgfplotsset{every axis/.append style={
+cycle list={
+ {red,only marks,mark options={
+ fill=red,scale=0.8},mark=*},
+ {black,only marks,mark options={
+ fill=black,scale=0.8},mark=square*}}}}
+
+\begin{axis}[width=4cm,scale only axis,
+ name=main plot]
+\addplot file
+ {plotdata/pgfplots_scatterdata1.dat};
+\addplot file
+ {plotdata/pgfplots_scatterdata2.dat};
+\addplot[blue] coordinates {
+ (0.093947, -0.011481)
+ (0.101957, 0.494273)
+ (0.109967, 1.000027)};
+\end{axis}
+
+% introduce named coordinate:
+\path (main plot.below south west) ++(0,-0.1cm)
+ coordinate (lower plot position);
-{\centering\lstinline!(\axisdefaultwidth,\axisdefaultheight)!.
+\begin{axis}[at={(lower plot position)},
+ anchor=north west,
+ width=4cm,scale only axis,height=0.8cm,
+ ytick=\empty]
+\addplot file
+ {plotdata/pgfplots_scatterdata1_latent.dat};
+\addplot file
+ {plotdata/pgfplots_scatterdata2_latent.dat};
+\end{axis}
+\end{tikzpicture}
+\end{codeexample}
+
+
+\item[Bounding box restrictions]
+\label{sec:bounding:box:example}%
+{%
+The following figure is centered and encapsulated with an \lstinline!\fbox! to show its bounding box.
+\setlength{\fboxsep}{0pt}%
+\begin{codeexample}[]
+\fbox{%
+\begin{tikzpicture}%
+ \begin{pgfinterruptboundingbox}
+ \begin{axis}[
+ name=my plot,
+ title=A title,
+ xlabel={$x$},
+ ylabel={$y$},
+ legend style={at={(0.5,0.97)},
+ anchor=north,legend columns=-1},
+ domain=-2:2
+ ]
+ \addplot (\x,\x^2);
+ \addplot (\x,\x^3);
+ \addplot (\x,\x^4);
+ \legend{$x^2$,$x^3$,$x^4$}
+ \end{axis}
+ \end{pgfinterruptboundingbox}
+
+ \useasboundingbox
+ (my plot.below south west)
+ rectangle (my plot.above north east);
+\end{tikzpicture}%
}%
-\noindent
-The options \lstinline!width=DIMEN! and \lstinline!height=DIMEN! override the default scaling. If just one of them is specified, the other one is scaled such that the aspect ratio stays the same.
+\end{codeexample}%
+}%
+The |pgfinterruptboundingbox| environment does not include its content into the image's bounding box, and |\useasboundingbox| sets the pictures bounding box to the following argument.
-\noindent\underline{Remarks:}
-\begin{itemize}
- \item The scaling only affects the width of one unit in $x$-direction or the height for one unit in $y$-direction. Axis labels and tick labels won't be resized, but their size is used to determine the axis scaling.
+\end{description}
+\end{pgfplotskey}
- \item You can use the \Tikz-\lstinline!scale=NUMBER! option,
- \begin{lstlisting}
- \begin{tikzpicture}[scale=2]
- \begin{axis}
- ...
- \end{axis}
- \end{tikzpicture}
- \end{lstlisting}
- to scale the complete picture.
+\begin{pgfplotskey}{at=\marg{coordinate expression}}
+Assigns a position for the complete axis image. This option works similarly to the |at|-option of |\node[at=|\marg{coordinate expression}|]|, see~\cite{tikz}. The common syntax is |at=|\marg{(x,y)}.
+\end{pgfplotskey}
- \item The \Tikz-options \lstinline!x! and \lstinline!y! which set the unit dimensions in $x$ and $y$ directions can be specified as arguments to \lstinline!\begin{axis}[x=1.5cm,y=2cm]! if needed (see below). These settings override the \lstinline!width! and \lstinline!height! options.
- \item You can also force a fixed width/height of the axis (without looking at labels) with
- \begin{lstlisting}
- \begin{tikzpicture}
- \begin{axis}[width=5cm,scale only axis]
- ...
- \end{axis}
- \end{tikzpicture}
- \end{lstlisting}
-
- \item Use
- \begin{lstlisting}
- \renewcommand{\axisdefaultwidth}{3cm}
- \renewcommand{\axisdefaultheight}{6cm}
- \begin{axis}
- ...
- \end{axis}
- \end{lstlisting}
- to replace the default dimension.
-
- \item Please note that up to the writing of this manual, \PGFPlots\ only estimates the size needed for axis- and tick labels. It does not include legends which have been placed outside of the axis\footnote{I.e. the `\texttt{width}' option will not work as expected, but the bounding box is still ok.}. This may be fixed in future versions.
-
- Use the \lstinline!x=DIMEN!, \lstinline!y=DIMEN! and \lstinline!scale only axis! options if the scaling happens to be wrong.
-\end{itemize}
-\subsubsection{\texttt{scale only axis=[true$|$false]}}
-This boolean option allows to apply \texttt{width} and \texttt{height} only to the axis rectangle. If `\texttt{scale only axis}' is enabled, label, tick and legend dimensions won't influence the size of the axis rectangle.
+\subsection{Miscellaneous Options}
-If \texttt{scale only axis=false} (the default), \PGFPlots\ will try to produce the desired width \emph{including} labels, titles and ticks.
+\begin{pgfplotskey}{disablelogfilter=\mchoice{true,false} (initally false, default true)}
+Disables numerical evaluation of $\log(x)$ in \TeX. If you specify this option, any plot coordinates and tick positions must be provided as $\log(x)$ instead of $x$. This may be faster and -- possibly -- more accurate than the numerical log. The current implementation of $\log(x)$ normalizes~$x$ to $m\cdot 10^e$ and computes
+\[ \log(x) = \log(m) + e \log(10) \]
+where $y = \log(m)$ is computed with a newton method applied to $\exp(y) - m$. The normalization involves string parsing without \TeX-registers. You can savely evaluate $\log(1\cdot 10^{-7})$ although \TeX-registers would produce an underflow for such small numbers.
+\end{pgfplotskey}
-\subsubsection{\texttt{x=DIMEN}, \texttt{y=DIMEN}}
-Use
- \begin{lstlisting}
- \begin{tikzpicture}
- \begin{axis}[x=1.5cm,...]
- ...
- \end{axis}
- \end{tikzpicture}
- \end{lstlisting}
- to set the unit size for one $x$-coordinate to 1.5cm. The same is possible for the $y$-coordinate.
+\label{sec:disabledatascaling}%
+\begin{pgfplotskey}{disabledatascaling=\mchoice{true,false} (initally false, default true)}
+Disables internal re-scaling of input data. Normally, every input data like plot coordinates, tick positions or whatever, are parsed without using \TeX's limited number precision. Then, a transformation like
+ \[ T(x) = 10^{q-m} \cdot x - a \]
+is applied to every input coordinate/position where $m$ is ``the order of $x$'' base~$10$. Example: $x=1234 = 1.234\cdot 10^3$ has order~$m=4$ while $x=0.001234 = 1.234\cdot 10^{-3}$ has order $m=-2$. The parameter~$q$ is the order of the axis' width/height.
- Setting $x$ explicitly overrides the \lstinline!width! option. Setting $y$ explicitly overrides the \lstinline!height! option.
+The \textbf{effect} is that your plot coordinates can be of \emph{arbitrary magnitude} like $0.0000001$ and $0.0000004$. For these two coordinates, \PGFPlots\ will use 100pt and 400pt internally. The transformation is quit fast since it relies only on period shifts. This scaling allows precision beyond \TeX's capabilities.
+%\footnote{Please note that while plot coordinates can be of quite large magnitude like $10^12$ or $10^{-9}$, \PGFPlots\ still uses \TeX-registers internally (the math parser of \PGF). If your axis interval is $[1234567.8, 1234567.9]$ or something like that, }.
- Please note that it is \emph{not} possible to specify \lstinline!x! as argument to \lstinline!tikzpicture!. The option
- \begin{lstlisting}
- \begin{tikzpicture}[x=1.5cm]
- \begin{axis}
- ...
- \end{axis}
- \end{tikzpicture}
- \end{lstlisting}
- won't have any effect because an axis is always scale to the final size
-
- {\centering\lstinline!(\axisdefaultwidth,\axisdefaultheight)!
-
- }%
- \noindent
- (see the \lstinline!width! option).
+The option ``|disabledatascaling|'' disables this data transformation. That means you are restricted to coordinates which \TeX\ can handle\footnote{Please note that the axis' scaling requires to compute $1/( x_\text{max} - x_{\text{min}} )$. The option |disabledatascaling| may lead to overflow or underflow in this context, so use it with care! Normally, the data scale transformation avoids this problem.}.
-\subsubsection{\texttt{hide axis=[true$|$false]}}
-Allows to hide the axis. No outer rectangle, no tick marks and no labels will be drawn. Only titles and legends will be processed as usual.
+So far, the data scale transformation applies only to normal axis (logarithmic scales do not need it).
+\end{pgfplotskey}
-Axis scaling and clipping will be done as if you did not use \texttt{hide axis}.
-\subsubsection{\texttt{[xy]filter=CMD}}
-The option \texttt{xfilter} and \texttt{yfilter} allow coordinate filtering. A coordinate filter maps an input coordinate to an output coordinate (or discards it completely).
+\begin{pgfplotsxykey}{\x\ filter/.code=\marg{...}} % FIXME create a xycodekey environment
+The code keys |x filter| and |y filter| allow coordinate filtering. A coordinate filter gets an input coordinate as |#1|, applies some operation and writes the result into the macro |\pgfmathresult|. If |\pgfmathresult| is empty afterwards, the coordinate is discarded.
-Coordinate filters are useful in automatic processing system, where \PGFPlots\ is used to display automatically generated plots. You may not want to filter your coordinates by hand, so these options provide a tool to do this automatically.
+It is allowed if filters do not |\pgfmathresult|. In this case, the unfiltered coordinate will be used.
-Be warned: `\texttt{xfilter}' and `\texttt{yfilter}' are advanced options and may require advanced knowledge about \TeX.
+Coordinate filters are useful in automatic processing system, where \PGFPlots\ is used to display automatically generated plots. You may not want to filter your coordinates by hand, so these options provide a tool to do this automatically.
-They are used as in the following example. The code
-\begin{lstlisting}
-\def\myOwnXfilter#1\to#2{%
- \def#2{0.5}%
-}%
+The following filter adds $0.5$ to every $x$ coordinate.
+\begin{codeexample}[]
\begin{tikzpicture}
-\begin{axis}[xfilter={\myOwnXfilter}]
-\addplot plot coordinates {
+\begin{axis}[x filter/.code=
+ {\pgfmathadd{#1}{0.5}}]
+\addplot coordinates {
(4,0)
(6,1)
};
\end{axis}
\end{tikzpicture}
-\end{lstlisting}
-will result in
-\begin{center}
-{%
-\def\myOwnXfilter#1\to#2{%
- \def#2{0.5}%
-}%
+\end{codeexample}
+Please refer to~\cite[pgfmath manual]{tikz} for details about the math engine of \PGF. Please keep in mind that the math engine works with limited \TeX\ precision.
+
+During evaluation of the filter, the macro |\coordindex| contains the number of the current coordinate (starting with~$0$). Thus, the following filter discards all coordinates after the $5$th and before the $10$th.
+\begin{codeexample}[]
\begin{tikzpicture}
-\begin{axis}[xfilter={\myOwnXfilter}]
-\addplot plot coordinates {
- (4,0)
- (6,1)
-};
+\begin{axis}[
+ samples=20,
+ x filter/.code={
+ \ifnum\coordindex>4\relax
+ \ifnum\coordindex<11\relax
+ \def\pgfmathresult{}
+ \fi
+ \fi
+ }]
+\addplot (\x,\x^2);
\end{axis}
\end{tikzpicture}
-}%
-\end{center}
-because all $x$-coordinates are replaced by~$0.5$.
+\end{codeexample}
+There is also a style key which simplifies selection by index, see below.
-The Argument `\texttt{CMD}' is the name of a \TeX-macro which takes exactly two arguments which are separated by the string `\texttt{\string\to}'. Such a macro is defined as
-\begin{lstlisting}
-\def\exampleFilter#1\to#2{%
- \def#2{#1}%
-}%
-\end{lstlisting}
-This example uses the \TeX-command \lstinline!\def! to define variables and commands. The arguments are used as follows:
-\begin{itemize}
- \item \PGFPlots\ invokes the filter with argument \texttt{\#1} set to the input coordinate. For $x$-filters, this is the $x$-coordinate as it is specified to \lstinline!\addplot!, for $y$-filters it is the $y$-coordinate.
- \item If the corresponding axis is logarithmic, \texttt{\#1} is the \emph{logarithm} of the coordinate as a real number, for example \texttt{\#1=4.2341}.
- \item The arguments to coordinate filters are not transformed. You may need to call coordinate parsing routines.
- \item Argument \texttt{\#2} is the name of a \TeX\ command. The filter should assign this command. The first filter above assigned the constant~$0.5$ and the second filter did not filter anything because it is the identity.
+ \PGFPlots\ invokes the filter with argument |#1| set to the input coordinate. For $x$-filters, this is the $x$-coordinate as it is specified to \lstinline!\addplot!, for $y$-filters it is the $y$-coordinate.
- The replacement text of \texttt{\#2} is expected to be \emph{either} empty \emph{or} a real number (without any length-suffix like `cm' or `pt'). If it is empty, the coordinate won't be drawn at all, it will be thrown away.
-\end{itemize}
+ If the corresponding axis is logarithmic, |#1| is the \emph{logarithm} of the coordinate as a real number, for example |#1=4.2341|.
-\subsection{\texttt{execute at begin plot=COMMANDS}}
-This axis option allows to invoke `\texttt{COMMANDS}' at the beginning of each \lstinline!\addplot! command. The argument `\texttt{COMMANDS}' can be any \LaTeX\ content.
+ The arguments to coordinate filters are not transformed. You may need to call coordinate parsing routines.
+\end{pgfplotsxykey}
-You may use this in conjunction with \texttt{xfilter=...} to reset any counters or whatever. An example would be to change every 4th coordinate.
+\begin{stylekey}{/pgfplots/skip coords between index=\marg{begin}\marg{end}}
+ A style which appends an |x filter| which discards selected coordinates. The selection is done by index where indexing starts with~$0$, see |\coordindex|. Every coordinate with index $\meta{begin} \le i < \meta{end}$ will be skipped.
+\begin{codeexample}[]
+\begin{tikzpicture}
+\begin{axis}[
+ samples=20,
+ skip coords between index={5}{11},
+ skip coords between index={15}{18}]
-\subsection{\texttt{execute at end plot=COMMANDS}}
-This axis option allows to invoke `\texttt{COMMANDS}' after each \lstinline!\addplot! command. The argument `\texttt{COMMANDS}' can be any \LaTeX\ content.
+\addplot (\x,\x^2);
+\end{axis}
+\end{tikzpicture}
+\end{codeexample}
+\end{stylekey}
+
+\begin{pgfplotskey}{filter discard warning=\mchoice{true,false} (initially true)}
+ Issues a notification in your logfile whenever coordinate filters discard coordinates.
+\end{pgfplotskey}
+
+\begin{pgfplotskey}{execute at begin plot=\marg{commands}}
+This axis option allows to invoke \marg{commands} at the beginning of each \lstinline!\addplot! command. The argument \marg{commands} can be any \TeX\ content.
+
+You may use this in conjunction with |xfilter=...| to reset any counters or whatever. An example would be to change every $4$th coordinate.
+\end{pgfplotskey}
+
+\begin{pgfplotskey}{execute at end plot=\marg{commands}}
+This axis option allows to invoke \marg{commands} after each \lstinline!\addplot! command. The argument \marg{commands} can be any \TeX\ content.
+\end{pgfplotskey}
+
+\begin{pgfplotscodekey}{before end axis}
+Allows to insert \marg{commands} just before the axis is ended. This option takes effect inside of the clipped area.
+\begin{codeexample}[]
+\pgfplotsset{every axis/.append style={
+ before end axis/.code={
+ \fill[red] (axis cs:1,10) circle(5pt);
+ \node at (axis cs:-4,10)
+ {\large This text has been inserted
+ using \texttt{before end axis}.};
+ }}}
+\begin{tikzpicture}
+ \begin{axis}
+ \addplot (\x,\x^2);
+ \end{axis}
+\end{tikzpicture}
+\end{codeexample}
+\end{pgfplotscodekey}
+
+\begin{pgfplotscodekey}{after end axis}
+Allows to insert \marg{commands} right after the end of the clipped drawing commands. While |befor end axis| has the same effect as if \marg{commands} had been placed inside of your axis, |after end axis| allows to access axis coordinates without being clipped.
+\begin{codeexample}[]
+\pgfplotsset{every axis/.append style={
+ after end axis/.code={
+ \fill[red] (axis cs:1,10) circle(5pt);
+ \node at (axis cs:-4,10)
+ {\large This text has been inserted using \texttt{after end axis}.};
+ }}}
+\begin{tikzpicture}
+ \begin{axis}
+ \addplot (\x,\x^2);
+ \end{axis}
+\end{tikzpicture}
+\end{codeexample}
+\end{pgfplotscodekey}
+
+\begin{pgfplotscodekey}{extra description}
+Allows to insert \marg{commands} after axis labels, titles and legends have been typeset.
+
+The code can thus use $(0,0)$ to access the lower left corner and $(1,1)$ to access the upper right one. It won't be clipped.
+\begin{codeexample}[]
+\pgfplotsset{every axis/.append style={
+ extra description/.code={
+ \node at (0.5,0.5) {Center!};
+ }}}
+\begin{tikzpicture}
+ \begin{axis}
+ \addplot (\x,\x^2);
+ \end{axis}
+\end{tikzpicture}
+\end{codeexample}
+\end{pgfplotscodekey}