Search results

LegendSettings API in Vue Maps API component

Gets or sets the options to customize the legend of the maps.

Properties

alignment

Alignment

Gets or sets the alignment of the legend in maps.

Defaults to Center

background

string

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

Defaults to ‘transparent’

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.

Defaults to null

height

string

Gets or sets the height of the legend in maps.

Defaults to

invertedPointer

boolean

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

Defaults to false

labelDisplayMode

LabelIntersectAction

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

Defaults to None

labelPosition

LabelPosition

Gets or sets the position of the label in legend.

Defaults to After

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.

Defaults to Default

opacity

number

Gets or sets the opacity for the legend in maps.

Defaults to 1

orientation

LegendArrangement

Gets or sets the orientation of the legend in maps.

Defaults to None

position

LegendPosition

Gets or sets the position of the legend in maps.

Defaults to Bottom

removeDuplicateLegend

boolean

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

Defaults to false

shape

LegendShape

Gets or sets the shape of the legend in maps.

Defaults to Circle

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.

Defaults to 15

shapePadding

number

Gets or sets the padding for the shapes in legend.

Defaults to 10

shapeWidth

number

Gets or sets the width of the shapes in legend.

Defaults to 15

showLegendPath

string

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

Defaults to null

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.

Defaults to false

type

LegendType

Gets or sets the type of the legend in maps.

Defaults to Layers

useMarkerShape

boolean

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

Defaults to false

valuePath

string

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

Defaults to null

visible

boolean

Enables or disables the visibility of the legend in maps.

Defaults to false

width

string

Gets or sets the width of the legend in maps.

Defaults to