From a30f09d3fcd2028c729a3c9e28595a0f00268d17 Mon Sep 17 00:00:00 2001 From: mkranjcev Date: Mon, 28 Aug 2023 09:14:00 +0200 Subject: [PATCH 1/4] Doc: Fix typo in `reorder` description --- R/echarts4r.R | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/R/echarts4r.R b/R/echarts4r.R index 44d4bfe7..d6d7a91a 100644 --- a/R/echarts4r.R +++ b/R/echarts4r.R @@ -27,7 +27,7 @@ echarts_build <- function(e) { #' @param renderer Renderer, takes \code{canvas} (default) or \code{svg}. #' @param timeline Set to \code{TRUE} to build a timeline, see timeline section. #' @param ... Any other argument. -#' @param reorder Set the \code{FALSE} to not reorder numeric x axis values. +#' @param reorder Set to \code{FALSE} to not reorder numeric x axis values. #' #' @section Timeline: #' The timeline feature currently supports the following chart types. From 8abbc540295165da61781ebc4dff6e3214d55615 Mon Sep 17 00:00:00 2001 From: mkranjcev Date: Mon, 28 Aug 2023 09:26:37 +0200 Subject: [PATCH 2/4] Doc: Details creating a static grid in e_charts --- R/echarts4r.R | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/R/echarts4r.R b/R/echarts4r.R index d6d7a91a..279dc953 100644 --- a/R/echarts4r.R +++ b/R/echarts4r.R @@ -29,8 +29,17 @@ echarts_build <- function(e) { #' @param ... Any other argument. #' @param reorder Set to \code{FALSE} to not reorder numeric x axis values. #' -#' @section Timeline: -#' The timeline feature currently supports the following chart types. +#' @section Details: The chart is created inside a parent *
* element, the +#' dimensions of which are controlled by the \code{'width'} and +#' \code{'height'} arguments. When these dimensions are small, it is possible +#' that the chart \code{'grid'} resizes to a size larger than the parent, +#' which might result in unexpected size given the input arguments. To disable +#' this automatic readjustment, define a static \code{\link{e_grid}} like the +#' following: \code{'e_grid(e = current_chart, top = 0, left = 20, right = 0, +#' bottom = 20)'}. +#' +#' @section Timeline: The timeline feature currently supports the following +#' chart types. #' \itemize{ #' \item{\code{\link{e_bar}}} #' \item{\code{\link{e_line}}} From 623497fb8621d0af94f115e11b2156f58ca53a4f Mon Sep 17 00:00:00 2001 From: mkranjcev Date: Mon, 28 Aug 2023 09:28:50 +0200 Subject: [PATCH 3/4] Doc: Details creating static grid Shiny bindings --- R/echarts4r.R | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/R/echarts4r.R b/R/echarts4r.R index 279dc953..712f1a25 100644 --- a/R/echarts4r.R +++ b/R/echarts4r.R @@ -472,6 +472,15 @@ e_data <- function(e, data, x) { #' @param id Target chart id. #' @param session Shiny session. #' +#' @section Details: The chart is created inside a parent *
* element, the +#' dimensions of which are controlled by the \code{'width'} and +#' \code{'height'} arguments. When these dimensions are small, it is possible +#' that the chart \code{'grid'} resizes to a size larger than the parent, +#' which might result in unexpected size given the input arguments. To disable +#' this automatic readjustment, define a static \code{\link{e_grid}} like the +#' following: \code{'e_grid(e = current_chart, top = 0, left = 20, right = 0, +#' bottom = 20)'}. +#' #' @section Callbacks: #' \itemize{ #' \item{\code{id_brush}: returns data on brushed data points.} From 98b1e688a8e52fcccfb942d982e7e9494691f2d9 Mon Sep 17 00:00:00 2001 From: mkranjcev Date: Mon, 28 Aug 2023 09:40:50 +0200 Subject: [PATCH 4/4] Doc: fix
formatting --- R/echarts4r.R | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/R/echarts4r.R b/R/echarts4r.R index 712f1a25..414cc393 100644 --- a/R/echarts4r.R +++ b/R/echarts4r.R @@ -29,8 +29,8 @@ echarts_build <- function(e) { #' @param ... Any other argument. #' @param reorder Set to \code{FALSE} to not reorder numeric x axis values. #' -#' @section Details: The chart is created inside a parent *
* element, the -#' dimensions of which are controlled by the \code{'width'} and +#' @section Details: The chart is created inside a parent \code{'
'} +#' element, the dimensions of which are controlled by the \code{'width'} and #' \code{'height'} arguments. When these dimensions are small, it is possible #' that the chart \code{'grid'} resizes to a size larger than the parent, #' which might result in unexpected size given the input arguments. To disable @@ -472,8 +472,8 @@ e_data <- function(e, data, x) { #' @param id Target chart id. #' @param session Shiny session. #' -#' @section Details: The chart is created inside a parent *
* element, the -#' dimensions of which are controlled by the \code{'width'} and +#' @section Details: The chart is created inside a parent \code{'
'} +#' element, the dimensions of which are controlled by the \code{'width'} and #' \code{'height'} arguments. When these dimensions are small, it is possible #' that the chart \code{'grid'} resizes to a size larger than the parent, #' which might result in unexpected size given the input arguments. To disable