Last updated

API / geotoolkit / widgets / legends / LegendOptions

Module: LegendOptions

Table of contents

Type Aliases

Contents

Type Aliases

LegendOptions

Ƭ LegendOptions: Object

Define legend options

Type declaration

NameTypeDescription
alignment?AnchorTypedefault legend alignment (can be moved by user)
data?OptionsBase["data"]legend data
fillstyle?Typelegend background fillstyle
layoutstyle?Optionslegend layout style
linestyle?Typelegend border linestyle
location?AnnotationLocationlegend annotation location
margins?TypeIt has properties for specifying the margins for each side
offset?Point | Options | numberdefault legend offset (in px) in specifiet device space
orientation?Orientationlegend content orientation
size?true | Dimension | Optionsif true then auto size to calculate device size of the legend, or size corresponds to dimension
type?stringType of the items to be displayed
visible?booleanlegend visibility flag

LegendOptionsOut

Ƭ LegendOptionsOut: Object

Define legend out options

Type declaration

NameTypeDescription
alignmentAnchorTypedefault legend alignment (can be moved by user)
data?OptionsOut["data"]legend data
fillstyleFillStylelegend background fillstyle
linestyleLineStylelegend border linestyle
locationAnnotationLocationlegend annotation location
marginsSpaceStyleIt has properties for specifying the margins for each side
offsetPointdefault legend offset (in px) from the chart center limits
orientationOrientationlegend content orientation
sizetrue | Dimensionif true then auto size to calculate device size of the legend, or size corresponds to dimension
type?stringType of the items to be displayed
visiblebooleanlegend visibility flag