changeset 22628:a918e983a943 stable

doc: Add list of built-in colormaps to colormap documentation (bug #49363). * NEWS: Announce removal of 'list' option to colormap. * colormap.m: Put a table of the built-in colormaps into the docstring. Add seealso links to all of the built-in colormaps.
author Rik <rik@octave.org>
date Sun, 16 Oct 2016 12:01:38 -0700
parents 7b190a2f11cb
children ddbc3f9f0136 0b21aece4b93
files NEWS scripts/image/colormap.m
diffstat 2 files changed, 37 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/NEWS	Sun Oct 16 10:51:45 2016 -0700
+++ b/NEWS	Sun Oct 16 12:01:38 2016 -0700
@@ -28,6 +28,10 @@
     "luminance profile" and is also more similar to Matlab's new default
     colormap "parula".
 
+ ** The colormap function no longer supports the input argument "list"
+    to show built-in colormaps.  Use "help colormap" to find the
+    built-in colormaps.
+
  ** The graphics command "hold on" now ensures that each new plot added
     to an existing plot has a different color or linestyle according to
     the "ColorOrder" and/or "LineStyleOrder" properties.  This is
--- a/scripts/image/colormap.m	Sun Oct 16 10:51:45 2016 -0700
+++ b/scripts/image/colormap.m	Sun Oct 16 12:01:38 2016 -0700
@@ -45,7 +45,39 @@
 ## For convenience, it is also possible to use this function with the
 ## command form, @code{colormap @var{map_name}}.
 ##
-## @seealso{viridis}
+## The list of built-in colormaps is:
+##
+## @c FIXME: It would be nice to display the actual colormap as an image
+## @c        in the PDF version of the documentation.
+## @multitable @columnfractions 0.15 .85
+## @headitem Map @tab Description
+## @item viridis @tab default
+## @item jet @tab colormap traversing blue, cyan, green, yellow, red.
+## @item cubehelix @tab colormap traversing black, blue, green, red, white with increasing intensity.
+## @item hsv @tab cyclic colormap traversing Hue, Saturation, Value space.
+## @item rainbow @tab colormap traversing red, yellow, blue, green, violet.
+## @item ------------- @tab ---------------------------------------------------------------------------------------------
+## @item hot @tab colormap traversing black, red, orange, yellow, white.
+## @item cool @tab colormap traversing cyan, purple, magenta.
+## @item spring @tab colormap traversing magenta to yellow.
+## @item summer @tab colormap traversing green to yellow.
+## @item autumn @tab colormap traversing red, orange, yellow.
+## @item winter @tab colormap traversing blue to green.
+## @item ------------- @tab ---------------------------------------------------------------------------------------------
+## @item gray @tab colormap traversing black to white in shades of gray.
+## @item bone @tab colormap traversing black, gray-blue, white.
+## @item copper @tab colormap traversing black to light copper.
+## @item pink @tab colormap traversing black, gray-pink, white.
+## @item ocean @tab colormap traversing black, dark-blue, white.
+## @item ------------- @tab ---------------------------------------------------------------------------------------------
+## @item colorcube @tab equally spaced colors in RGB color space.
+## @item flag @tab cyclic 4-color map of red, white, blue, black.
+## @item lines @tab cyclic colormap with colors from axes @qcode{"ColorOrder"} property.
+## @item prism @tab cyclic 6-color map of red, orange, yellow, green, blue, violet.
+## @item ------------- @tab ---------------------------------------------------------------------------------------------
+## @item white @tab all white colormap (no colors).
+## @end multitable  
+## @seealso{viridis, jet, cubehelix, hsv, rainbow, hot, cool, spring, summer, autumn, winter, gray, bone, copper, pink, ocean, colorcube, flag, lines, prism, white}
 ## @end deftypefn
 
 ## Author: Tony Richardson <arichard@stark.cc.oh.us>