ECharts Option

The top-level configuration object passed to echarts.setOption(). Holds all chart components, series, and global settings.

Usage

EChartsOption(
  title = NULL,
  legend = NULL,
  x_axis_3d = NULL,
  y_axis_3d = NULL,
  z_axis_3d = NULL,
  grid_3d = NULL,
  grid = NULL,
  x_axis = NULL,
  y_axis = NULL,
  tooltip = NULL,
  visual_map = NULL,
  graphic = NULL,
  toolbox = NULL,
  data_zoom = NULL,
  series = NULL,
  color = NULL,
  background_color = NULL,
  text_style = NULL,
  animation = NULL,
  animation_threshold = NULL,
  animation_duration = NULL,
  animation_easing = NULL,
  animation_delay = NULL,
  dark_mode = NULL,
  use_utc = NULL
)

Arguments

title

Optional Title or list: Title configuration.

legend

Optional Legend or list: Legend configuration.

x_axis_3d, y_axis_3d, z_axis_3d, grid_3d

Optional List: ECharts-GL cartesian axes and grid, as defined by its Axis3D and Grid3DModel sources.

grid

Optional Grid or list: Grid configuration.

x_axis

Optional Axis or list: X-axis configuration (xAxis).

y_axis

Optional Axis or list: Y-axis configuration (yAxis).

tooltip

Optional Tooltip: Tooltip configuration.

visual_map

Optional VisualMap or list: Visual map configuration (visualMap). Required for heatmaps to map data values to colors.

graphic

Optional list: Native graphic annotations, corresponding to GraphicComponentOption in src/component/graphic/GraphicModel.ts.

toolbox

Optional list: Toolbox configuration (toolbox), e.g. the dataZoom and restore features used by draw_gantt().

data_zoom

Optional DataZoom or list of DataZoom: Axis zoom component(s) (dataZoom). Pass a list to combine, e.g., a "slider" with an "inside" zoom.

series

Optional series object or list: Series configuration (LineSeries, BarSeries, ScatterSeries, PieSeries, BoxplotSeries, HeatmapSeries).

color

Optional Character: Color palette.

background_color

Optional Character: Chart background color.

text_style

Optional TextStyle: Global default text style.

animation

Optional Logical: Whether to enable animation.

animation_threshold

Optional Numeric [0, Inf): Data-count threshold that disables animation.

animation_duration

Optional Numeric [0, Inf): Initial animation duration in milliseconds.

animation_easing

Optional Character: Animation easing function name.

animation_delay

Optional Numeric [0, Inf): Initial animation delay in milliseconds.

dark_mode

Optional Logical or Character {"auto"}: Dark-mode setting.

use_utc

Optional Logical: Whether to use UTC for time axes.

Value

EChartsOption object.

Details

Corresponds to EChartsOption in src/export/option.ts (line 258) and ECUnitOption in src/util/types.ts (line 697).

Examples

EChartsOption(
  title = Title(text = "Weekly sessions"),
  x_axis = Axis(type = "category", data = c("Mon", "Tue", "Wed")),
  y_axis = Axis(type = "value"),
  series = LineSeries(data = c(150, 230, 224), smooth = TRUE)
)

#> <rtemis.draw::EChartsOption>
#>  @ title              : <rtemis.draw::Title>
#>  .. @ show               : NULL
#>  .. @ text               : chr "Weekly sessions"
#>  .. @ link               : NULL
#>  .. @ target             : NULL
#>  .. @ subtext            : NULL
#>  .. @ sublink            : NULL
#>  .. @ subtarget          : NULL
#>  .. @ text_align         : NULL
#>  .. @ text_vertical_align: NULL
#>  .. @ padding            : NULL
#>  .. @ item_gap           : NULL
#>  .. @ text_style         : NULL
#>  .. @ subtext_style      : NULL
#>  .. @ trigger_event      : NULL
#>  .. @ background_color   : NULL
#>  .. @ border_color       : NULL
#>  .. @ border_width       : NULL
#>  .. @ border_radius      : NULL
#>  .. @ left               : NULL
#>  .. @ right              : NULL
#>  .. @ top                : NULL
#>  .. @ bottom             : NULL
#>  @ legend             : NULL
#>  @ x_axis_3d          : NULL
#>  @ y_axis_3d          : NULL
#>  @ z_axis_3d          : NULL
#>  @ grid_3d            : NULL
#>  @ grid               : NULL
#>  @ x_axis             : <rtemis.draw::Axis>
#>  .. @ type            : chr "category"
#>  .. @ show            : NULL
#>  .. @ inverse         : NULL
#>  .. @ name            : NULL
#>  .. @ name_location   : NULL
#>  .. @ name_rotate     : NULL
#>  .. @ name_gap        : NULL
#>  .. @ name_text_style : NULL
#>  .. @ silent          : NULL
#>  .. @ trigger_event   : NULL
#>  .. @ min             : NULL
#>  .. @ max             : NULL
#>  .. @ scale           : NULL
#>  .. @ split_number    : NULL
#>  .. @ interval        : NULL
#>  .. @ min_interval    : NULL
#>  .. @ max_interval    : NULL
#>  .. @ align_ticks     : NULL
#>  .. @ log_base        : NULL
#>  .. @ boundary_gap    : NULL
#>  .. @ data            : chr [1:3] "Mon" "Tue" "Wed"
#>  .. @ axis_line       : NULL
#>  .. @ axis_tick       : NULL
#>  .. @ minor_tick      : NULL
#>  .. @ axis_label      : NULL
#>  .. @ split_line      : NULL
#>  .. @ minor_split_line: NULL
#>  .. @ split_area      : NULL
#>  .. @ axis_pointer    : NULL
#>  .. @ position        : NULL
#>  .. @ grid_index      : NULL
#>  @ y_axis             : <rtemis.draw::Axis>
#>  .. @ type            : chr "value"
#>  .. @ show            : NULL
#>  .. @ inverse         : NULL
#>  .. @ name            : NULL
#>  .. @ name_location   : NULL
#>  .. @ name_rotate     : NULL
#>  .. @ name_gap        : NULL
#>  .. @ name_text_style : NULL
#>  .. @ silent          : NULL
#>  .. @ trigger_event   : NULL
#>  .. @ min             : NULL
#>  .. @ max             : NULL
#>  .. @ scale           : NULL
#>  .. @ split_number    : NULL
#>  .. @ interval        : NULL
#>  .. @ min_interval    : NULL
#>  .. @ max_interval    : NULL
#>  .. @ align_ticks     : NULL
#>  .. @ log_base        : NULL
#>  .. @ boundary_gap    : NULL
#>  .. @ data            : NULL
#>  .. @ axis_line       : NULL
#>  .. @ axis_tick       : NULL
#>  .. @ minor_tick      : NULL
#>  .. @ axis_label      : NULL
#>  .. @ split_line      : NULL
#>  .. @ minor_split_line: NULL
#>  .. @ split_area      : NULL
#>  .. @ axis_pointer    : NULL
#>  .. @ position        : NULL
#>  .. @ grid_index      : NULL
#>  @ tooltip            : NULL
#>  @ visual_map         : NULL
#>  @ graphic            : NULL
#>  @ toolbox            : NULL
#>  @ data_zoom          : NULL
#>  @ series             : <rtemis.draw::LineSeries>
#>  .. @ name             : NULL
#>  .. @ data             : num [1:3] 150 230 224
#>  .. @ x_axis_index     : NULL
#>  .. @ y_axis_index     : NULL
#>  .. @ stack            : NULL
#>  .. @ silent           : NULL
#>  .. @ legend_hover_link: NULL
#>  .. @ color            : NULL
#>  .. @ z_level          : NULL
#>  .. @ z                : NULL
#>  .. @ smooth           : logi TRUE
#>  .. @ step             : NULL
#>  .. @ connect_nulls    : NULL
#>  .. @ clip             : NULL
#>  .. @ show_symbol      : NULL
#>  .. @ symbol           : NULL
#>  .. @ symbol_size      : NULL
#>  .. @ symbol_rotate    : NULL
#>  .. @ symbol_offset    : NULL
#>  .. @ line_style       : NULL
#>  .. @ area_style       : NULL
#>  .. @ item_style       : NULL
#>  .. @ label            : NULL
#>  .. @ mark_area        : NULL
#>  @ color              : NULL
#>  @ background_color   : NULL
#>  @ text_style         : NULL
#>  @ animation          : NULL
#>  @ animation_threshold: NULL
#>  @ animation_duration : NULL
#>  @ animation_easing   : NULL
#>  @ animation_delay    : NULL
#>  @ dark_mode          : NULL
#>  @ use_utc            : NULL