Merge pull request #564 from Mkranj/doc_static_grid

Documentation: implementing a static grid for small charts

R/echarts4r.R

@@ -27,10 +27,19 @@ 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.
+#' @section Details: The chart is created inside a parent \code{'<div>'}
+#'   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}}}
@@ -463,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 \code{'<div>'}
+#'   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.}