Navigation

Operators and Keywords

Function List:

C++ API

: caxis ([cmin cmax])
: caxis ("auto")
: caxis ("manual")
: caxis (hax, …)
: limits = caxis ()

Query or set color axis limits for plots.

The limits argument should be a 2-element vector specifying the lower and upper limits to assign to the first and last value in the colormap. Data values outside this range are clamped to the first and last colormap entries.

If the "auto" option is given then automatic colormap limits are applied. The automatic algorithm sets cmin to the minimum data value and cmax to the maximum data value. If "manual" is specified then the "climmode" property is set to "manual" and the numeric values in the "clim" property are used for limits.

If the first argument hax is an axes handle, then operate on this axis rather than the current axes returned by gca.

Called without arguments the current color axis limits are returned.

Programming Note: The color axis affects the display of image, patch, and surface graphics objects, but only if the "cdata" property has indexed data and the "cdatamapping" property is set to "scaled". Graphic objects with true color cdata, or "direct" cdatamapping are not affected.

See also: colormap, axis.

Package: octave