Search results

LegendSettingsModel API in JavaScript (ES5) Maps API control

Interface for a class LegendSettings

Properties

alignment

Alignment

Gets or sets the alignment of the legend in maps.

background

string

Gets or sets the background color for the legend in maps.

border

BorderModel

Gets or sets the options for customizing the style properties of the legend border.

fill

string

Gets or sets the color of the legend in maps.

height

string

Gets or sets the height of the legend in maps.

invertedPointer

boolean

Enables or disables the visibility of the inverted pointer in interactive legend in maps.

labelDisplayMode

LabelIntersectAction

Gets or sets the action to perform when the legend item text intersects with others.

labelPosition

LabelPosition

Gets or sets the position of the label in legend.

location

Point

Gets or sets the location of the legend in pixels when the legend position is set as Float.

mode

LegendMode

Gets or sets the mode of the legend in maps. The modes available are default and interactive modes.

opacity

number

Gets or sets the opacity for the legend in maps.

orientation

LegendArrangement

Gets or sets the orientation of the legend in maps.

position

LegendPosition

Gets or sets the position of the legend in maps.

removeDuplicateLegend

boolean

Enables or disables the ability to remove the duplicate legend item.

shape

LegendShape

Gets or sets the shape of the legend in maps.

shapeBorder

BorderModel

Gets or sets the options for customizing the style properties of the border of the shapes of the legend items.

shapeHeight

number

Gets or sets the height of the shapes in legend.

shapePadding

number

Gets or sets the padding for the shapes in legend.

shapeWidth

number

Gets or sets the width of the shapes in legend.

showLegendPath

string

Gets or sets the field name from the data source which is used to provide visibility state for each legend item.

textStyle

FontModel

Gets or sets the options for customizing the text styles of the legend item text in maps.

title

CommonTitleSettingsModel

Gets or sets the title for the legend in maps.

titleStyle

FontModel

Gets or sets the options for customizing the style of the title of the legend in maps.

toggleLegendSettings

ToggleLegendSettingsModel

Gets or sets the options for customizing the color and border width of the shape related to the legend when selecting the legend.

toggleVisibility

boolean

Enables or disables the toggle visibility of the legend in maps.

type

LegendType

Gets or sets the type of the legend in maps.

useMarkerShape

boolean

Enables or disables to render the legend item based on the shapes from the data source of markers.

valuePath

string

Set and gets the field name from the data source to display the legend item text.

visible

boolean

Enables or disables the visibility of the legend in maps.

width

string

Gets or sets the width of the legend in maps.