Legend Options

Options available for the legend.

Referenced by: ClassBreaks Renderer, ColorInfo Visual Variable, Dot Density Renderer, Flow Renderer, Heatmap Renderer, Pie Chart Renderer, RotationInfo Visual Variable, SizeInfo Visual Variable, TransparencyInfo Visual Variable, UniqueValue Renderer

Properties

Property Details
dotLabel The text that should be displayed in the legend for each dot. This will display next to the number 1. If not present, it will be a localized string for the word 'Dot'. Only applicable to dot density renderers.
maxLabel Text in the legend that describes the hottest (most dense) part of the heatmap. Only applicable to Heatmap renderers. If not specified, then a localized label, for 'High' will display on the legend.
minLabel Text in the legend that describes the coldest (least dense) part of the heatmap. Only applicable to Heatmap renderers. If not specified, then a localized label, for 'Low' will display on the legend.
order Indicates the order in which the legend is displayed.
Valid values:
  • ascendingValues
  • descendingValues
showLegend Indicates whether to show the color/size/opacity ramp in the legend. This property is not available directly under uniqueValueRenderer and/or classBreaksRenderer.
title The title of the legend.
unit Indicates the unit of the data being visualized in a dotDensity renderer. This will display next to the dot value in the title of the legend.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.