Add some edit features

Author: Shaunson26

.Rbuildignore

@@ -9,3 +9,4 @@
 ^tooltip_tmp.R$
 ^R/cjs_plot_gallery.R$
 _\.new\.png$
+^dev$

.gitignore

@@ -9,3 +9,4 @@ inst/doc
 tooltip_tmp.R
 # {shinytest2}: Ignore new debug snapshots for `$expect_values()`
 *_.new.png
+^dev$

DESCRIPTION

@@ -1,13 +1,13 @@
 Package: chartjs4r
 Title: Chartjs For R
-Version: 0.0.6
+Version: 0.0.7
 Authors@R: 
     person("Shaun", "Nielsen", , "[email protected]", role = c("aut", "cre"))
 Description: Chartjs htmlwidgeet for R.
 License: MIT + file LICENSE
 Encoding: UTF-8
 Roxygen: list(markdown = TRUE)
-RoxygenNote: 7.2.3
+RoxygenNote: 7.3.1
 Imports: 
     base,
     crosstalk,
@@ -16,6 +16,7 @@ Imports:
     grDevices,
     htmltools,
     htmlwidgets,
+    jsonlite,
     magrittr,
     rlang,
     rmarkdown,

NAMESPACE

@@ -7,9 +7,12 @@ export(chartjsOutput)
 export(chartjsProxy)
 export(cjs_add_bars)
 export(cjs_add_doughnut_pie)
+export(cjs_add_options)
 export(cjs_add_points)
 export(cjs_bar_orientation)
 export(cjs_border)
+export(cjs_config_line)
+export(cjs_defaults)
 export(cjs_events)
 export(cjs_example_data)
 export(cjs_flexdashboard_example)

NEWS.md

@@ -1,3 +1,8 @@
+# Version 0.0.7
+
+* Add some customiser functions
+* `cjs_defaults()`, `cjs_add_options()`, `cjs_config_line()`
+
 # Version 0.0.6
 
 * tool tips customisation with text literals `cjs_tooltip()`

R/cjs_add_options.R

@@ -0,0 +1,33 @@
+#' Add/edit options of a chartjs object
+#'
+#' A short cut to add options to the chart object. The options object is deeply
+#' nested and has many options. Rather than write a function capturing all the
+#' options (and their children), this function allows you to specify them using
+#' a . (dot) notation e.g. elements.line.tension = 0.25 expands to
+#' \{elements: \{line: \{tension: 0.25\}\}\}. Thus you must determine the options you
+#' desire from the [chartjs documention](https://www.chartjs.org/docs/latest/configuration/).
+#' Any previously set options should be preserved ...
+#'
+#' @param p chartjs object
+#' @param ... any chartjs option, using . notation
+#'
+#' @return An object of class `htmlwidget`
+#'
+#' @export
+cjs_add_options <- function(p, ...){
+
+  #chartjs_output$x$options$elements$line$tension = 0.25
+  #chartjs_output$x$options$elements$line$borderJoinStyle = 'round'
+
+  # Capture arguments
+  parameters <- list(...)
+  parameters <- get_non_null_parameters(parameters)
+  parameters <- relist_parameter_vector(parameters)
+
+  # Update data
+  p$x$options <-
+    modify_list(p$x$options, parameters)
+
+  # Return plot
+  p
+}

R/cjs_config_line.R

@@ -0,0 +1,39 @@
+#' Line Configuration
+#'
+#' Line elements are used to represent the line in a line chart.
+
+#' @param tension number 0	Bézier curve tension (0 for no Bézier curves).
+#' @param backgroundColor Color Chart.defaults.backgroundColor	Line fill color.
+#' @param borderWidth	number	3	Line stroke width.
+#' @param borderColor	Color Chart.defaults.borderColor	Line stroke color.
+#' @param borderCapStyle	string	'butt'	Line cap style. See MDN
+#' @param borderDash	number[]	[]	Line dash. See MDN
+#' @param borderDashOffset	number	0.0	Line dash offset. See MDN
+#' @param borderJoinStyle	'round'|'bevel'|'miter'	'miter'	Line join style. See MDN
+#' @param capBezierPoints	boolean	true	true to keep Bézier control inside the chart, false for no restriction.
+#' @param cubicInterpolationMode	string	'default'	Interpolation mode to apply. See more...
+#' @param fill	boolean|string	false	How to fill the area under the line. See area charts.
+#' @param stepped	boolean	false	true to show the line as a stepped line (tension will be ignored).
+#'
+#' @return a list
+#'
+#' @export
+cjs_config_line <- function(
+  tension = 0,
+  backgroundColor = NULL,
+  borderWidth = 3,
+  borderColor = NULL,
+  borderCapStyle = 'butt',
+  borderDash = NULL,
+  borderDashOffset = NULL,
+  borderJoinStyle = 'miter',
+  capBezierPoints = TRUE,
+  cubicInterpolationMode = 'default',
+  fill = FALSE,
+  stepped = FALSE) {
+
+  parameters <- as.list(environment())
+  parameters <- get_non_null_parameters(parameters)
+  parameters
+
+}

R/cjs_defaults.R

@@ -0,0 +1,32 @@
+#' Set chartjs defaults
+#'
+#' Set global defaults for subsequent chartjs objects in a document. To check
+#' available options, create a chartjs plot, examine in the browser, go to the
+#' javascript console and print the object "Chart.defaults".
+#'
+#' @param ... default options.
+#'
+#' @export
+cjs_defaults <- function(...){
+
+  # Capture arguments
+  parameters <- list(...)
+  parameters <- get_non_null_parameters(parameters)
+  parameters <- relist_parameter_vector(parameters)
+
+  update_obj = jsonlite::toJSON(parameters, auto_unbox = T)
+
+
+  htmltools::singleton(
+    htmltools::tags$script(
+      htmltools::HTML(
+        "updateObjectInPlace(Chart.defaults,", update_obj, ");"
+      )
+    )
+  )
+
+}
+
+
+
+

R/cjs_tooltip.R

@@ -1,7 +1,7 @@
 #' Modify tooltips
 #'
 #' Uses a callback function within chartjs. Reference elements using template literal
-#' notation e.g. 'x value: ${x}, y value: ${y}'.
+#' notation e.g. 'x value: $\{x\}, y value: $\{y\}'.
 #' See `vignette('tooltips-and-interaction-modes', package = 'chartjs4r')`
 #'
 #' @param p chartjs object