echartsUtils

The goal of echartsUtils is to consolidate helpful utility functions for modifying Echarts rendered via echarty & echarts4r.

Installation

You can install the development version of echartsUtils from GitHub with:

# install.packages("devtools")
devtools::install_github("yogat3ch/echartsUtils")

Functions

Name	Concept	Title	Description
dirs		directory path generation convenience functions	directory path generation convenience functions
e_is_parallel		Is the chart a parallelAxis chart?	Is the chart a parallelAxis chart?
e_js_axisPointer		A callback function with associated dependencies for formatting Echarts axisPointers	A callback function with associated dependencies for formatting Echarts axisPointers
e_opts_axisPointer		Default formatter for axisPointer	Default formatter for axisPointer
e_opts_init		Initialize the options if they don't exist	Initialize the options if they don't exist
e_saveAsImage_filename		saveAsImage_filename	A utils function used in echarts module building chains. The function takes an echarts object in, as well as a name and adds the name to the saveImageAs toolbox feature.
e_tooltip_legend_dot		Create an echarts style legend dot	Create an echarts style legend dot
ec_toolbox		Add default toolbox options to echart Add ability to save as image, restore, zoom and reset zoom to an echart	Add default toolbox options to echart Add ability to save as image, restore, zoom and reset zoom to an echart
echartsUtils-package		echartsUtils: Tools for working with echarts	Utility functions for working with echarts objects created by echarts4r & echarty
js_num2str		An JS callback formatting function	An JS callback formatting function
Re-imports		Re-imports	Useful functions from other packages
reexports		Objects exported from other packages	These objects are imported from other packages. Follow the links below to see their documentation. rlang%\|%, %\|\|% UU%\|0\|%, %\|legit\|%, %\|try\|%, %\|zchar\|%, %nin%
use_js_deps		Use dependencies for echartsUtils	Use dependencies for echartsUtils
e_series_axis_data	data	Extract data for a particular axis from an `axis_data`` tbl	Extract data for a particular axis from an `axis_data`` tbl
e_series_data	data	Extract the series data	Extract the series data
e_year_on_x	data	Is the X axis in years?	Is the X axis in years?
e_opts_line_default	line	A list of default options for an echart line	A list of default options for an echart line
e_opts_make_stacked_area_series	line	Makes an appropriately styled data list for stacked area charts for a single serie	Makes an appropriately styled data list for stacked area charts for a single serie
e_default_opts	options	Use the default options applied to each echart.	Use the default options applied to each echart.
e_get_opts	options	Get the options from an echart	Get the options from an echart Get the options from an echart
e_has_base_opts	options	Is the echart using baseOptions	Is the echart using baseOptions Is the echart using baseOptions
e_has_group	options	Does the echart have a group	Does the echart have a group Does the echart have a group
e_has_timeline	options	Does the echart have a timeline	Does the echart have a timeline Does the echart have a timeline
e_opts_is_xAxis_series	options	Does the echart have xAxis options for each series (multiple unnamed lists with options)	Does the echart have xAxis options for each series (multiple unnamed lists with options) Does the echart have xAxis options for each series (multiple unnamed lists with options)
e_opts_modify	options	Modify echarts options	Modify echarts options
e_opts_parallel	options	Modify parallel options	Modify parallel options
e_opts_parallelAxisDefault	options	Add default options for Parallel Axis	Add default options for Parallel Axis
e_opts_update	options	Update echarts options	Update echarts options
e_opts_xAxis_type	options	Get the xAxis type	Get the xAxis type Get the xAxis type
e_opts_xAxis	options	Get x-axis options	Get x-axis options
e_opts_yAxis	options	Get y-axis options	Get y-axis options
e_parallel_default_opts	options	Use the default options for parallelAxis ECharts	Use the default options for parallelAxis ECharts
e_series	options	Get the series option from an echarts object	Get the series option from an echarts object
e_x_axis_formatting	options	e_x_axis_year_formatting	generates a list that configures the min/max and correct axis formatting for echarts figs
e_y_axis_formatting	options	e_y_axis_year_formatting	generates a list that configures the correct y axis formatting for echarts figs
e_yAxis_width	options	Calculate a best guess nameGap value for spacing the ECharts axis titles beyond the axis labels	Calculate a best guess nameGap value for spacing the ECharts axis titles beyond the axis labels
e_series_object	series	Retrieve a specific object from each series item	Retrieve a specific object from each series item