Legend configuration for selecting/filtering series.
Usage
Legend(
show = NULL,
orient = NULL,
align = NULL,
left = NULL,
right = NULL,
top = NULL,
bottom = NULL,
width = NULL,
height = NULL,
padding = NULL,
item_gap = NULL,
item_width = NULL,
item_height = NULL,
icon = NULL,
selected_mode = NULL,
selected = NULL,
formatter = NULL,
inactive_color = NULL,
inactive_border_color = NULL,
text_style = NULL,
item_style = NULL,
background_color = NULL,
border_color = NULL,
border_width = NULL,
border_radius = NULL,
trigger_event = NULL,
data = NULL
)Arguments
- show
Optional Logical: Whether to show the legend.
- orient
Optional Character {"horizontal", "vertical"}: Layout orientation.
- align
Optional Character {"auto", "left", "right"}: Marker and text alignment.
- left
Optional Numeric or Character: Left position.
- right
Optional Numeric or Character: Right position.
- top
Optional Numeric or Character: Top position.
- bottom
Optional Numeric or Character: Bottom position.
- width
Optional Numeric or Character: Legend box width.
- height
Optional Numeric or Character: Legend box height.
- padding
Optional Numeric: Padding inside the legend box.
- item_gap
Optional Numeric
[0, Inf): Gap between legend items.- item_width
Optional Numeric
[0, Inf): Legend symbol width.- item_height
Optional Numeric
[0, Inf): Legend symbol height.- icon
Optional Character: Default legend icon.
- selected_mode
Optional Logical or Character {"single", "multiple"}: Selection mode.
- selected
Optional Named logical vector: Pre-selected items.
- formatter
Optional Character or function: Label formatter.
- inactive_color
Optional Character: Color for unselected items.
- inactive_border_color
Optional Character: Border color for unselected items.
- text_style
Optional TextStyle: Legend label text style.
- item_style
Optional ItemStyle: Legend icon style.
- background_color
Optional Character: Background color.
- border_color
Optional Character: Border color.
- border_width
Optional Numeric
[0, Inf): Border width.- border_radius
Optional Numeric: Border radius.
- trigger_event
Optional Logical: Whether the legend emits events.
- data
Optional Character vector or list: Legend data items.
Details
Corresponds to LegendOption in src/component/legend/LegendModel.ts (line 162).
ECharts docs: https://echarts.apache.org/en/option.html#legend
Examples
Legend(show = TRUE, orient = "vertical", left = "left")#> <rtemis.draw::Legend>
#> @ show : logi TRUE
#> @ orient : chr "vertical"
#> @ align : NULL
#> @ left : chr "left"
#> @ right : NULL
#> @ top : NULL
#> @ bottom : NULL
#> @ width : NULL
#> @ height : NULL
#> @ padding : NULL
#> @ item_gap : NULL
#> @ item_width : NULL
#> @ item_height : NULL
#> @ icon : NULL
#> @ selected_mode : NULL
#> @ selected : NULL
#> @ formatter : NULL
#> @ inactive_color : NULL
#> @ inactive_border_color: NULL
#> @ text_style : NULL
#> @ item_style : NULL
#> @ background_color : NULL
#> @ border_color : NULL
#> @ border_width : NULL
#> @ border_radius : NULL
#> @ trigger_event : NULL
#> @ data : NULL