BarLegend

BarLegend[cf]
generates a legend that identifies colors from the color function cf with an automatic range of values.

BarLegend[{cf,{min,max}}]
generates a legend that identifies colors from the color function cf with the range of values between min and max.

BarLegend[cf,contours]
generates a legend that identifies color ranges from the color function cf based on the set of contours contours.

Details and OptionsDetails and Options

  • BarLegend uses a list of colors associated with color function cf to identify the contours between min and max in the visualization or other legended item.
  • BarLegend is used automatically in functions such as ContourPlot and ListContourPlot.
  • Within visualization functions, Automatic in BarLegend[Automatic,] is automatically replaced by the actual color function, data range, and contours specification needed to determine the contour values and colors in between.
  • In BarLegend, contours can take the following forms:
  • ncontours at n equally spaced levels
    Automaticcontours chosen automatically
    Allall contours
    Noneno contours
    {Automatic,n}at most n contours chosen automatically
    {f1,f2,}contours at levels
    {{f1,gr1},}contours drawn with graphics directives
    funca function to be applied to , to get the list of contours
  • BarLegend[cf,contours] may use a list of colors or a continuous spectrum depending on the density of contour values.
  • Legended[expr,BarLegend[]] can be used to apply a legend to an arbitrary expression expr.
  • The following options can be given:
  • LabelStyleAutomaticstyle to use for labels
    LegendFunctionIdentitywrapper for the overall legend
    LegendLabelNoneoverall label for legend
    LegendLayoutAutomaticlegend layout to use
    LegendMarginsAutomaticspace between legend content and boundaries
    LegendMarkersNonemarkers to use to indicate each element
    LegendMarkerSizeAutomaticsize of the shape
  • BarLegend is displayed in StandardForm as a graphics object. In InputForm, it is displayed as an explicit list of color function, data range, and contour values.
  • In BarLegend, LegendLayout can have the following forms:
  • Automaticautomatically determine layout
    "Row"display legend in a horizontal row
    "Column"display legend in a vertical column
  • In LineLegend, LegendLayout can have the following forms:
  • Automaticautomatically determine layout
    "Row"display legend in a horizontal row
    "Column"display legend in a vertical column
    "ReversedRow"display reversed legend in a horizontal row
    "ReversedColumn"display reversed legend in a vertical column
  • LegendFunction is applied to the legend, including any overall label and margins.

ExamplesExamplesopen allclose all

Basic Examples  (4)Basic Examples  (4)

A continuous gradient bar:

In[1]:=
Click for copyable input
Out[1]=

Specify the data range:

In[1]:=
Click for copyable input
Out[1]=

Use five equally spaced contours:

In[1]:=
Click for copyable input
Out[1]=

Generate automatic legends for a plot:

In[1]:=
Click for copyable input
Out[1]=
Introduced in 2012
(9.0)