The requested page is not available for the requested platform. You are viewing the content for Default platform.

VectorMapLegendBuilder Methods

Configures map legends.

Name Description
BackgroundColor(JS)

Colors the legend's background.

BackgroundColor(String)

Colors the legend's background.

Border(Action<VectorMapLegendsBorderBuilder>)

Configures the legend's border.

ColumnCount(Int32)

Arranges legend items into several columns.

ColumnCount(JS)

Arranges legend items into several columns.

ColumnItemSpacing(Double)

Specifies an empty space between item columns in pixels.

ColumnItemSpacing(JS)

Specifies an empty space between item columns in pixels.

CustomizeHint(RazorBlock)

Specifies text for a hint that appears when a user hovers the mouse pointer over the text of a legend item.

CustomizeHint(String)

Specifies text for a hint that appears when a user hovers the mouse pointer over the text of a legend item.

CustomizeItems(RazorBlock)

Allows you to change the order and visibility of legend items.

CustomizeItems(String)

Allows you to change the order and visibility of legend items.

CustomizeText(RazorBlock)

Specifies text for legend items.

CustomizeText(String)

Specifies text for legend items.

Equals(Object) Determines whether the specified object is equal to the current object.
(Inherited from Object)
Equals(Object, Object) Determines whether the specified object instances are considered equal.
(Inherited from Object)
Font(Action<VizFontBuilder>)

Specifies the legend items' font options.

GetHashCode() Serves as the default hash function.
(Inherited from Object)
GetType() Gets the Type of the current instance.
(Inherited from Object)
HorizontalAlignment(HorizontalAlignment)

Along with verticalAlignment, specifies the legend's position.

ItemTextPosition(Position)

Specifies the text's position relative to the marker in a legend item.

ItemsAlignment(HorizontalAlignment)

Aligns items in the last column or row (depending on the legend's orientation). Applies when legend items are not divided into columns or rows equally.

Margin(Action<VectorMapLegendsMarginBuilder>)

Generates an empty space, measured in pixels, around the legend.

Margin(Double)

Generates an empty space, measured in pixels, around the legend.

Margin(JS)

Generates an empty space, measured in pixels, around the legend.

MarkerColor(JS)

Specifies the color of item markers in the legend. The specified color applied only when the legend uses 'size' source.

MarkerColor(String)

Specifies the color of item markers in the legend. The specified color applied only when the legend uses 'size' source.

MarkerShape(VectorMapMarkerShape)

Specifies the shape of item markers.

MarkerSize(Double)

Specifies the marker's size in a legend item in pixels.

MarkerSize(JS)

Specifies the marker's size in a legend item in pixels.

MemberwiseClone() Creates a shallow copy of the current Object.
(Inherited from Object)
Option(String, Object)

Allows to specify an arbitrary option by its name.

Orientation(Orientation)

Arranges legend items vertically (in a column) or horizontally (in a row). The default value is "horizontal" if the legend.horizontalAlignment is "center". Otherwise, it is "vertical".

PaddingLeftRight(Double)

Generates an empty space, measured in pixels, between the legend's left/right border and its items.

PaddingLeftRight(JS)

Generates an empty space, measured in pixels, between the legend's left/right border and its items.

PaddingTopBottom(Double)

Generates an empty space, measured in pixels, between the legend's top/bottom border and its items.

PaddingTopBottom(JS)

Generates an empty space, measured in pixels, between the legend's top/bottom border and its items.

ReferenceEquals(Object, Object) Determines whether the specified Object instances are the same instance.
(Inherited from Object)
RowCount(Int32)

Arranges legend items in several rows.

RowCount(JS)

Arranges legend items in several rows.

RowItemSpacing(Double)

Specifies an empty space between item rows in pixels.

RowItemSpacing(JS)

Specifies an empty space between item rows in pixels.

Source(Action<VectorMapLegendsSourceBuilder>)

Specifies the source of data for the legend.

Title(Action<VectorMapLegendsTitleBuilder>)

Configures the legend title.

Title(JS)

Configures the legend title.

Title(String)

Configures the legend title.

ToString() Returns a string that represents the current object.
(Inherited from Object)
VerticalAlignment(VerticalEdge)

Along with horizontalAlignment, specifies the legend's position.

Visible(Boolean)

Specifies the legend's visibility.

Visible(JS)

Specifies the legend's visibility.

See Also