LegendSettings API in Vue Maps API component

Sets and gets the options to customize the legend of the maps.

Properties

alignment

string

Sets and gets the alignment for the legend in maps.

Defaults to Center

background

string

Sets and gets the background color for the legend in maps.

Defaults to ‘transparent’

border

BorderModel

Sets and gets the options for customizing the color and width of the legend border.

fill

string

Sets and gets the color of the legend in maps.

height

string

Sets and gets 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.

labelDisplayMode

string

Sets and gets the display mode for the label in legend.

Defaults to None

labelPosition

string

Sets and gets the position of the label in legend.

Defaults to After

location

Point

Sets and gets the location of the legend, given by x and y values.

mode

string

Sets and gets the mode of the legend in maps. The modes available are default and interactive modes.

Defaults to Default

opacity

number

Sets and gets the opacity for the legend in maps.

Defaults to 1

orientation

string

Sets and gets the orientation of the legend in maps.

Defaults to None

position

string

Sets and gets the position of the legend in maps.

Defaults to Bottom

removeDuplicateLegend

boolean

Enables or disables to remove the duplicate legend item.

Defaults to false

shape

string

Sets and gets the shape of the legend in maps.

Defaults to Circle

shapeBorder

BorderModel

Sets and gets the options for customizing the color and width of the border for the shape in legend.

shapeHeight

number

Sets and gets the width of the shapes in legend.

Defaults to 15

shapePadding

number

Sets and gets the padding for the shapes in legend.

Defaults to 10

shapeWidth

number

Sets and gets the width of the shapes in legend.

Defaults to 15

showLegendPath

string

Sets and gets the path for the legend from the data source to be shown.

Defaults to null

textStyle

FontModel

Sets and gets the options for customizing the text styles for the legend in maps.

title

CommonTitleSettingsModel

Sets and gets the title for the legend in maps.

titleStyle

FontModel

Sets and gets the options for customizing the style of the title for the legend in maps.

toggleLegendSettings

ToggleLegendSettingsModel

Sets and gets the options for customizing the color and width of the shape related to the legend on selecting the legend.

toggleVisibility

boolean

Enables or disables the toggle visibility for legend in maps.

Defaults to false

type

string

Sets and gets 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 value from the data source for legend.

Defaults to null

visible

boolean

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

Defaults to false

width

string

Sets and gets the width of the legend in maps.

Defaults to ”