Commit 241ff120 authored by Cory Quammen's avatar Cory Quammen

Add descriptions of color legend parameters

parent 3020f611
......@@ -261,10 +261,14 @@ support the following actions:
The \ui{Color Mapping Parameters} group of properties provides additional
control over the color transfer function, including control over the color
interpolation space: RGB, HSV, Lab, or diverging. When color mapping floating
point arrays with NaNs, you can select the color to use for NaN values. You can
also affect whether the color transfer function uses smooth interpolation or
a discretization of the same into a fixed number of bins.
interpolation space: RGB, HSV, Lab, or diverging. To color data values falling
below or above the range of the color map with special colors, enable the
advanced \ui{Use Below Range Color} and \ui{Use Above Range Color} options,
respectively. You can choose different colors for data falling on either side of
the range. When color mapping floating point arrays with NaNs, you can select
the color to use for NaN values. You can also affect whether the color transfer
function uses smooth interpolation or a discretization of the same into a fixed
number of bins.
\section{Editing the transfer functions in \texttt{pvpython}}
......@@ -370,14 +374,13 @@ Figure~\ref{fig:colormaplegenddetail} shows the various components of the color
legend. By default, the title is typically the name of the array (and component
number or magnitude for non-scalar data arrays) being mapped. On one side are
the automatically generated labels, while on the other side are the annotations,
including the start and end annotations, which correspond to the data range
being mapped.
optionally including start and end annotations depicting the minimum and maximum
of the color legend range.
You can control the characteristics of the color legend using the
\icon{Images/pqEditScalarBar16.png} button. The color legend is interactive. You
can click and drag the legend to place it interactively at any position in the
view. Additionally, you can change the length of the legend by dragging the
end-markers shown when you hover the mouse pointer over the legend.
The color legend is interactive. You can click and drag the legend to place it
interactively at any position in the view. Additionally, you can change the
length of the legend by dragging the end-markers shown when you hover the mouse
pointer over the legend.
\subsection{Color legend parameters}
\label{sec:ColorLegendParameters}
......@@ -392,15 +395,28 @@ end-markers shown when you hover the mouse pointer over the legend.
You can edit the color legend parameters by clicking on the
\icon{Images/pqEditScalarBar16.png} button on the \ui{Color Map Editor} panel. This
will pop up a dialog that shows the available parameters. Any changes made only
affect the particular color legend in the active view.
will pop up a dialog that shows the available parameters. Any changes made will
affect only the particular color legend in the active view.
The first few options in the \ui{Edit Color Legend Properties} control the
orientation and location of the color legend in the render view. \ui{Auto
Orient} turns on automatic determination of the color legend's orientation. The
color legend will change orientation to horizontal when it is dragged to the
bottom or the top of the render view, and it will change to vertical when it is
dragged to the left or right side. When disabled, you can choose the orientation
you want the color legend to have by choosing an option in the \ui{Orientation}
combo-box. The \ui{Window Location} option will make the color legend appear in
the chosen location; if the value \ui{AnyLocation} is selected, then the color
legend will not be forced into any particular position. Note that if the color
legend is placed interactively with the mouse, this location will automatically
change to \ui{AnyLocation}.
Besides the obvious changing of title text and font properties for the title,
labels, and annotations, some of the other parameters that the user can change
are as follows: \ui{Draw Annotations} controls whether the annotations (including the
start and end annotations) are to be drawn at all.
are as follows: \ui{Draw Annotations} controls whether the annotations
(including the start and end annotations) are to be drawn at all.
When checked, \ui{Draw NaN Annotations} results in the color legend showing the
When checked, \ui{Draw NaN Annotation} results in the color legend showing the
NaN color setup in the \ui{Color Map Editor} panel in a separate box right beside the
color legend. The annotation text shown for that box can be modified by changing
the \ui{NaN Annotation} text.
......@@ -416,11 +432,14 @@ the \ui{NaN Annotation} text.
If \ui{Automatic Label Format} is checked, \ParaView will try to pick an optimal
representation for numerical values based on the value and available screen
space. By unchecking it, you can explicitly specify the \texttt{printf}-style
format to use for numeric values. Number of Labels is a suggestion for maximum
number of labels to show on the legend. Note that this is a suggestion and may not
exactly match the number of labels shown. To explicitly label values of
interest, use the annotations discussed later in this post. \ui{Aspect Ratio} is used
to control the thickness of the legend: The greater the number, the thinner the legend.
format to use for numeric values. To explicitly label values of interest, enable
the \ui{Use Custom Labels} option. You can specify exactly the labeled values
you wish to display in the table that appears when this option is chosen.
\ui{Color Bar Thickness} is used to control the thickness of the legend. It is
defined in terms of points just like font sizes are specified. Use \ui{Color Bar
Length} to explicitly set the length of the color bar. This property is defined
as a fraction in the range [0, 1] of the window width(when the color legend is
oriented horizontally) or height (when oriented vertically).
\subsection{Color legend in \texttt{pvpython}}
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment