legend

Method of Figure.

Overloads

Name	Description
legend(const Map options) -> Figure	Sets the legend option map.
legend() -> Figure	Ensures legend exists with default options.

legend(const Map options) -> Figure

Sets the legend option map.

Parameters

• options: Map of legend options.
  • id (string): Component ID.
  • show (boolean): Whether the legend is displayed.
  • type (string): Legend type: plain or scroll.
  • left (string|number): Left offset.
  • top (string|number): Top offset.
  • right (string|number): Right offset.
  • bottom (string|number): Bottom offset.
  • width (string|number): Legend width.
  • height (string|number): Legend height.
  • orient (string): Orientation: horizontal or vertical.
  • align (string): Alignment: auto/left/right.
  • padding (number|List): Legend padding.
  • item_gap (number): Gap between legend items.
  • item_width (number): Legend item width.
  • item_height (number): Legend item height.
  • item_style (Map): Legend item style.
  • item_style.color (Color): Item color.
  • item_style.border_color (Color): Item border color.
  • item_style.border_width (number): Item border width.
  • item_style.border_type (string|number|List): Item border type.
  • item_style.border_dash_offset (number): Item border dash offset.
  • item_style.border_cap (string): Item border cap.
  • item_style.border_join (string): Item border join.
  • item_style.border_miter_limit (number): Item border miter limit.
  • item_style.shadow_blur (number): Item shadow blur.
  • item_style.shadow_color (Color): Item shadow color.
  • item_style.shadow_offset_x (number): Item shadow offset X.
  • item_style.shadow_offset_y (number): Item shadow offset Y.
  • item_style.opacity (number): Item opacity.
  • item_style.decal (Map): Decal style options.
  • item_style.decal.symbol (string|List): Decal symbol.
  • item_style.decal.symbol_size (number): Decal symbol size.
  • item_style.decal.symbol_keep_aspect (boolean): Keep decal symbol aspect.
  • item_style.decal.color (Color): Decal color.
  • item_style.decal.background_color (Color): Decal background color.
  • item_style.decal.dash_array_x (number|List): Decal dash array X.
  • item_style.decal.dash_array_y (number|List): Decal dash array Y.
  • item_style.decal.rotation (number): Decal rotation.
  • item_style.decal.max_tile_width (number): Decal max tile width.
  • item_style.decal.max_tile_height (number): Decal max tile height.
  • item_style.decal.max_tile_x (number): Decal max tile X.
  • item_style.decal.max_tile_y (number): Decal max tile Y.
  • item_style.decal.symbol_offset (List): Decal symbol offset.
  • item_style.decal.symbol_width (number): Decal symbol width.
  • item_style.decal.symbol_height (number): Decal symbol height.
  • item_style.decal.color_alpha (number): Decal color alpha.
  • item_style.decal.opacity (number): Decal opacity.
  • item_style.decal.background_color_alpha (number): Decal background color alpha.
  • item_style.decal.background_opacity (number): Decal background opacity.
  • item_style.decal.cull (boolean): Cull decaled elements.
  • formatter (string): Legend item formatter.
  • selected_mode (boolean|string): Selection mode: true/false/'single'/'multiple'.
  • inactive_color (Color): Inactive legend item color.
  • inactive_border_color (Color): Inactive legend border color.
  • inactive_border_width (number): Inactive legend border width.
  • inactive_border_type (string|number|List): Inactive legend border type.
  • inactive_border_dash_offset (number): Inactive legend border dash offset.
  • inactive_border_radius (number|List): Inactive legend border radius.
  • text_style (Map): Legend text style.
  • text_style.color (Color): Text color.
  • text_style.font_style (string): Font style.
  • text_style.font_weight (string|number): Font weight.
  • text_style.font_family (string): Font family.
  • text_style.font_size (number): Font size.
  • text_style.line_height (number): Line height.
  • text_style.background_color (string|Map): Background color or image.
  • text_style.border_color (Color): Border color.
  • text_style.border_width (number): Border width.
  • text_style.border_type (string|number|List): Border type or dash array.
  • text_style.border_dash_offset (number): Border dash offset.
  • text_style.border_radius (number): Border radius.
  • text_style.padding (number|List): Padding for the text block.
  • text_style.shadow_color (Color): Shadow color.
  • text_style.shadow_blur (number): Shadow blur.
  • text_style.shadow_offset_x (number): Shadow offset X.
  • text_style.shadow_offset_y (number): Shadow offset Y.
  • text_style.width (number): Text block width.
  • text_style.height (number): Text block height.
  • text_style.text_border_color (Color): Text stroke color.
  • text_style.text_border_width (number): Text stroke width.
  • text_style.text_border_type (string|number|List): Text stroke type or dash array.
  • text_style.text_border_dash_offset (number): Text stroke dash offset.
  • text_style.text_shadow_color (Color): Text shadow color.
  • text_style.text_shadow_blur (number): Text shadow blur.
  • text_style.text_shadow_offset_x (number): Text shadow offset X.
  • text_style.text_shadow_offset_y (number): Text shadow offset Y.
  • text_style.overflow (string): Overflow handling: truncate/break/breakAll.
  • text_style.ellipsis (string): Ellipsis when truncated.
  • text_style.rich (Map): Rich text styles.
  • text_style.rich_inherit_plain_label (boolean): Whether rich text inherits plain styles.
  • data (List): Legend data.
  • selected (Map): Selected state map.
  • inactive_color_alpha (number): Inactive color alpha.
  • page_button_item_gap (number): Gap between scroll buttons.
  • page_button_gap (number): Gap between scroll buttons and legend.
  • page_button_position (string): Scroll button position: start/end.
  • page_formatter (string): Page formatter.
  • page_icons (Map): Scroll button icons.
  • page_icons.horizontal (List): Horizontal icons.
  • page_icons.vertical (List): Vertical icons.
  • page_icon_color (Color): Scroll icon color.
  • page_icon_inactive_color (Color): Inactive icon color.
  • page_icon_size (number|List): Icon size.
  • page_text_style (Map): Page text style.
  • page_text_style.color (Color): Text color.
  • page_text_style.font_style (string): Font style.
  • page_text_style.font_weight (string|number): Font weight.
  • page_text_style.font_family (string): Font family.
  • page_text_style.font_size (number): Font size.
  • page_text_style.line_height (number): Line height.
  • page_text_style.width (number): Text block width.
  • page_text_style.height (number): Text block height.
  • page_text_style.text_border_color (Color): Text stroke color.
  • page_text_style.text_border_width (number): Text stroke width.
  • page_text_style.text_border_type (string|number|List): Text stroke type.
  • page_text_style.text_border_dash_offset (number): Text stroke dash offset.
  • page_text_style.text_shadow_color (Color): Text shadow color.
  • page_text_style.text_shadow_blur (number): Text shadow blur.
  • page_text_style.text_shadow_offset_x (number): Text shadow offset X.
  • page_text_style.text_shadow_offset_y (number): Text shadow offset Y.
  • page_text_style.overflow (string): Overflow handling.
  • page_text_style.ellipsis (string): Ellipsis when truncated.
  • page_text_style.rich (Map): Rich text styles.
  • page_text_style.rich_inherit_plain_label (boolean): Rich text inherits plain styles.
  • animation (boolean): Enable animation.
  • animation_duration_update (number): Animation duration on update.
  • animation_easing_update (string): Animation easing on update.
  • animation_delay_update (number): Animation delay on update.
  • selector (List): Selector buttons.
  • selector_label (Map): Selector label options.
  • selector_position (string): Selector position: start/end.
  • selector_item_gap (number): Selector item gap.
  • selector_button_gap (number): Selector button gap.
  • selector_label_gap (number): Selector label gap.
  • selector_label_align (string): Selector label alignment.
  • selector_label_color (Color): Selector label color.
  • selector_label_font_style (string): Selector label font style.
  • selector_label_font_weight (string|number): Selector label font weight.
  • selector_label_font_family (string): Selector label font family.
  • selector_label_font_size (number): Selector label font size.
  • selector_label_border_radius (number): Selector label border radius.
  • selector_label_padding (number|List): Selector label padding.
  • selector_label_shadow_blur (number): Selector label shadow blur.
  • selector_label_shadow_color (Color): Selector label shadow color.
  • selector_label_shadow_offset_x (number): Selector label shadow offset X.
  • selector_label_shadow_offset_y (number): Selector label shadow offset Y.
  • selector_label_line_height (number): Selector label line height.
  • selector_label_width (number): Selector label width.
  • selector_label_height (number): Selector label height.
  • selector_label_text_border_color (Color): Selector label text stroke color.
  • selector_label_text_border_width (number): Selector label text stroke width.
  • selector_label_text_border_type (string|number|List): Selector label text stroke type.
  • selector_label_text_border_dash_offset (number): Selector label text stroke dash offset.
  • selector_label_text_shadow_color (Color): Selector label text shadow color.
  • selector_label_text_shadow_blur (number): Selector label text shadow blur.
  • selector_label_text_shadow_offset_x (number): Selector label text shadow offset X.
  • selector_label_text_shadow_offset_y (number): Selector label text shadow offset Y.
  • selector_label_overflow (string): Selector label overflow handling.
  • selector_label_ellipsis (string): Selector label ellipsis.
  • selector_label_rich (Map): Selector label rich text styles.
  • selector_label_rich_inherit_plain_label (boolean): Selector label rich text inherits plain styles.
  • selector_label_background_color (string|Map): Selector label background color.
  • selector_label_border_color (Color): Selector label border color.
  • selector_label_border_width (number): Selector label border width.
  • selector_label_border_type (string|number|List): Selector label border type.
  • selector_label_border_dash_offset (number): Selector label border dash offset.

legend() -> Figure

Ensures legend exists with default options.