LegendSettings
23 Sep 20252 minutes to read
Sets and gets the options for customizing the legend of the treemap.
Properties
alignment Alignment
Sets and gets the alignment of legend in the treemap.
Defaults to ‘Center’
background string
Sets and gets the background color of legend in the treemap.
Defaults to ‘transparent’
border BorderModel
Sets and gets the options for customizing the color and width of the border of the legend in the treemap.
fill string
Sets and gets the shape color of legend in the treemap.
Defaults to null
height string
Sets and gets the height of legend in the treemap.
Defaults to ’’
imageUrl string
Sets and gets the URL path of the legend shapes that is set as image.
Defaults to null
invertedPointer boolean
Enables or disables the pointer for interactive legend in the treemap.
Defaults to false
labelDisplayMode LabelIntersectAction
Sets and gets the action of legend item text when they intersect with each other.
Defaults to ‘None’
labelPosition LabelPlacement
Sets and gets the label position for interactive legend in the treemap.
Defaults to ‘After’
location Location
Sets and gets the location to place the legend in a custom location in the treemap.
mode LegendMode
Sets and gets the mode of legend in the treemap. The modes available are default and interactive modes.
Defaults to ‘Default’
opacity number
Sets and gets the opacity of the legend in the treemap.
Defaults to 1
orientation LegendOrientation
Sets and gets the orientation of legend in the treemap.
Defaults to ‘None’
position LegendPosition
Sets and gets the position of legend in the treemap.
Defaults to ‘Bottom’
removeDuplicateLegend boolean
Enables or disables to remove the duplicate legend item.
Defaults to false
shape LegendShape
Sets and gets the shape of legend in the treemap.
Defaults to ‘Circle’
shapeBorder BorderModel
Sets and gets the options for customizing the color and width of the border of the legend shape in the treemap.
shapeHeight number
Sets and gets the height of the shapes of legend in the treemap.
Defaults to 15
shapePadding number
Sets and gets the shape padding of legend in the treemap.
Defaults to 10
shapeWidth number
Sets and gets the width of the shapes in legend in the treemap.
Defaults to 15
showLegendPath string
Sets and gets the value path from the data source for the visibility state of the legend item in the treemap.
Defaults to null
textStyle FontModel
Sets and gets the options to customize the text style of legend in the treemap.
title CommonTitleSettingsModel
Sets and gets the options to customize the title of the legend in the treemap.
titleStyle FontModel
Sets and gets the options to customize the text style of the legend item text in the treemap.
valuePath string
Sets and gets the value path from the data source to render legend in the treemap.
Defaults to null
visible boolean
Enables or disables the visibility of legend in the treemap.
Defaults to false
width string
Sets and gets the width of legend in the treemap.
Defaults to ’’