MapLegends Item

The MapLegends item contains the list of the MapLegend items.

MapLegend Items

The MapLegend item contains the description of the map legend object. Map legend is an instance of the MapLegend class.

Example of Legend Setup

MapLegend Item Attributes

Attribute name Type Description
Id String Legend object identifier
Background Brush

Identifier of a brush described in the item dictionary or full description of the brush. It can be used as an item for full description of a brush. The identifier must be placed in curved brackets:

Background: ”{identifier}”.
BorderColor String Border color in HTML format.
BorderThickness Double

Border width.
Height Double

Legend height.
Left Double

Left coordinate of the legend. If HorizontalAlignment is set to Relative, values of this attribute are within the range from 0 to 1.
Margin Thickness

Legend margins. Format: Margin: ”2 2 2 2”.
Padding Thickness

Legend content indent. Format: Padding: ”2 2 2 2”.
Top Double

Top coordinate of the legend. If VerticalAlignment is set to Relative, values of this attribute lie within the range from 0 to 1.
Width Double

Legend width.
BetweenFormat String

String format for the values "between".
EqualFormat String

String format for the values "equal to".
Font Font

Identifier of a font described in the item dictionary or full description of the font. It can be used as an item for full description of a font. The identifier must be placed in curved brackets:

Font: ”{identifier}”.
Footer MapLabel

Identifier of a label described in the item dictionary or full description of label object. It can be used as an item for full description of a label object. The identifier must be placed in curved brackets:

Footer: ”{identifier}”.
GreaterFormat String

String format for the values "greater than".
Header MapLabel

Identifier of a label described in the item dictionary or full description of label object. It can be used as an item for full description of a label object. The identifier must be placed in curved brackets:

Header: ”{identifier}”.
LessFormat String

String format for the values "less than".
MapScale MapScale

Identifier of a scale described in the items dictionary or full description of scale object. It can be used as an item for full description of a scale object. The identifier must be placed in curved brackets:

MapScale: ”{identifier}”.
Marker MarkerShape

Marker shape. Available values:

  • Circle: Circle.

  • Rectangle: Rectangle.

  • Rhombus: Diamond.

  • TriangleDown: Downward triangle.

  • TriangleUp: Upward triangle.
IsOuter Boolean

The flag indicates whether the legend is internal. Available values:

  • True: External.

  • False: Internal.

Default value is False.
ColumnCount Number

Number of columns in the legend.
TextWrapping TextWrapping

Text wrapping. Available values:

  • Wrap;

  • NoWrap.
NoDataText String

Text displayed for No Data marker.
HorizontalAlignment HorizontalAlignment

Horizontal alignment of the legend. Available values:

  • Left: To the left edge.

  • Center: To the center.

  • Right: To the right edge.

  • Absolute: Absolute value.

  • Relative: Relative value.
VerticalAlignment VerticalAlignment

Vertical alignment of the legend. Available values:

  • Top: To the top edge.

  • Center: To the center.

  • Bottom: To the bottom edge.

  • Absolute: Absolute value.

  • Relative: Relative value.
NoDataVisible Boolean

Flag that indicates whether to display the No Data item in the legend. Available values:

  • True: Show.

  • False: Do not show.
NoDataPosition NoDataPosition

Position of the No Data item. Available values:

  • Before - In the beginning.

  • After: At the end.
IncludeEquals Boolean

Flag that indicates whether to display equality values in the legend. Available values:

  • True: Show.

  • False: Do not show.
Visibility Visibility

Object visibility. Available values:

  • Visible;

  • Collapsed.
HoverMode HoverMode

Legend item selection mode:

  • MouseOver - On mouse over.

  • Click - On left click.
InactiveBrush Brush

Brush to highlight territories not selected in the legend.
HighlightBrush Brush

Brush to highlight legend items. It is relevant if DoHighlight is set to True.
DoHighlight Boolean

Enables and disables legend items highlighting:

  • True - enabled.

  • False - disabled.

See also:

MapChart Item