summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/pgfplots/pgfplots.reference.coordfiltering.tex
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/latex/pgfplots/pgfplots.reference.coordfiltering.tex')
-rw-r--r--Master/texmf-dist/doc/latex/pgfplots/pgfplots.reference.coordfiltering.tex23
1 files changed, 16 insertions, 7 deletions
diff --git a/Master/texmf-dist/doc/latex/pgfplots/pgfplots.reference.coordfiltering.tex b/Master/texmf-dist/doc/latex/pgfplots/pgfplots.reference.coordfiltering.tex
index b0377e3e004..baceab56f8e 100644
--- a/Master/texmf-dist/doc/latex/pgfplots/pgfplots.reference.coordfiltering.tex
+++ b/Master/texmf-dist/doc/latex/pgfplots/pgfplots.reference.coordfiltering.tex
@@ -75,13 +75,17 @@ There is also a style key which simplifies selection by index, see below.
\index{Downsampling}
\end{pgfplotskey}
-\begin{pgfplotsxykey}{restrict \x\space to domain=\meta{min}:\meta{max}}
+\begin{pgfplotsxykeylist}{
+ restrict \x\space to domain=\meta{min}:\meta{max},
+ restrict \x\space to domain*=\meta{min}:\meta{max}}
\label{key:restrict:x:to:domain}
- Appends $x$ (or $y$ or $z$) coordinate filters which set the respective coordinate to |-inf| if it is below \meta{min} and to |+inf| if it is above \meta{max}.
+ These keys append $x$ (or $y$ or $z$) coordinate filters to restrict the respective coordinate to a domain.
+
+ The versions without star (like |restrict x to domain|) will assign the value |-inf| if the coordinate is below \meta{min} and |+inf| if the coordinate is above \meta{max}. The starred versions (like |restrict x to domain*|) will truncate coordinates to $[\hbox{\meta{min}}, \hbox{\meta{max}}]$, i.e.\ they assign the value \meta{min} if the coordinate falls outside of the lower limit and \meta{max} if the value falls outside of the upper limit.
For logarithmic axes, \meta{min} and \meta{max} are \emph{logs} of the respective values. A variant which uses the non-logarithmic number might be to use |restrict expr to domain={\pgfmathrawx}|\marg{min}\marg{max}.
- Furthermore, it sets the |unbounded coords=jump| key which leads to interrupted plots.
+ The non-starred versions also set |unbounded coords=jump| which leads to interrupted plots.
\begin{codeexample}[]
\begin{tikzpicture}
\begin{axis}[
@@ -100,15 +104,20 @@ There is also a style key which simplifies selection by index, see below.
\end{axis}
\end{tikzpicture}
\end{codeexample}
-\end{pgfplotsxykey}
+\end{pgfplotsxykeylist}
-\begin{pgfplotskey}{restrict expr to domain=\marg{expression}\marg{\meta{min}:\meta{max}}}
+\begin{pgfplotskeylist}{%
+ restrict expr to domain=\marg{expression}\marg{\meta{min}:\meta{max}},%
+ restrict expr to domain*=\marg{expression}\marg{\meta{min}:\meta{max}}%
+ }
Appends an $x$ coordinate filter which sets the $x$ coordinate to |-inf| if the \meta{expression} evaluates to something less than \meta{min} and to |inf| if \meta{expression} evaluates to something larger than \meta{max}.
- Furthermore, it sets the |unbounded coords=jump| key which leads to interrupted plots.
+ The starred variant, |restrict to domain*| assigns \meta{min} if \meta{expression} is less then the lower limit and \meta{max} if it is larger than the upper limit.
+
+ The non-starred version also sets |unbounded coords=jump| which leads to interrupted plots.
In contrast to |restrict x to domain|, \meta{expression} can depend on anything which is valid during |\addplot|, in particular |\coordindex| or table columns (|\thisrow|\marg{column name} and friends). The expression doesn't need to depend on $x$ at all.
-\end{pgfplotskey}
+\end{pgfplotskeylist}
\begin{pgfplotskey}{filter discard warning=\mchoice{true,false} (initially true)}
Issues a notification in your logfile whenever coordinate filters discard coordinates.