added more examples

R/scales.R

@@ -986,7 +986,7 @@ v_scale_gradient <- function(vc,
 #' @return A [vchart()] `htmlwidget` object.
 #' @export
 #'
-# @examples
+#' @example examples/scale_size.R
 v_scale_size <- function(vc,
                          name = NULL,
                          range = c(5, 30),

R/specs.R

@@ -411,7 +411,8 @@ v_specs_custom_mark <- function(vc, ...) {
 #'
 #' @return A [vchart()] `htmlwidget` object.
 #' @export
-#'
+#' 
+#' @example examples/crosshair.R
 v_specs_crosshair <- function(vc, ...) {
   vc <- .vchart_specs2(
     vc,
@@ -431,7 +432,8 @@ v_specs_crosshair <- function(vc, ...) {
 #'
 #' @return A [vchart()] `htmlwidget` object.
 #' @export
-#'
+#' 
+#' @example examples/indicator.R
 v_specs_indicator <- function(vc, ...) {
   vc <- .vchart_specs2(
     vc,

examples/crosshair.R

@@ -0,0 +1,34 @@
+
+library(vchartr)
+
+data.frame(month = month.abb, value = sample(1:50, 12)) %>% 
+  vchart() %>% 
+  v_line(aes(month, value)) %>% 
+  v_specs_crosshair(
+    xField = list(
+      visible = TRUE,
+      line = list(type = "rect"), 
+      defaultSelect = list(
+        axisIndex = 0, 
+        datum = "May"
+      ), 
+      label = list(visible = TRUE)
+    ), 
+    yField = list(
+      visible = TRUE, 
+      defaultSelect = list(
+        axisIndex = 1,
+        datum = 30
+      ), 
+      line = list(
+        style = list(
+          lineWidth = 1, 
+          opacity = 1, 
+          stroke = "#000", 
+          lineDash = c(2, 2)
+        )
+      ),
+      label = list(visible = TRUE)
+    )
+  )
+

examples/indicator.R

@@ -0,0 +1,40 @@
+
+library(vchartr)
+
+electricity_mix %>% 
+  subset(country == "France") %>%
+  vchart() %>% 
+  v_pie(
+    aes(x = source, y = generation),
+    outerRadius = 0.8,
+    innerRadius = 0.5,
+    padAngle = 0.6
+  ) %>%
+  v_specs_tooltip(visible = FALSE) %>% 
+  v_specs_indicator(
+    visible = TRUE,
+    trigger = "hover",
+    limitRatio = 0.5,
+    title = list(
+      visible = TRUE,
+      autoFit = TRUE,
+      fitStrategy = "inscribed",
+      style = list(
+        fontWeight = "bolder",
+        fill = "#888",
+        text = JS("datum => datum !== null ? datum.x : ''")
+      )
+    ),
+    content = list(
+      list(
+        visible = TRUE,
+        autoFit = TRUE,
+        fitStrategy = "inscribed",
+        style = list(
+          fontWeight = "bolder",
+          fill = "#000",
+          text = JS("datum => datum !== null ? Math.round(datum.y) + 'TWh' : ''")
+        )
+      )
+    )
+  )

examples/scale_size.R

@@ -0,0 +1,13 @@
+library(vchartr)
+data("penguins", package = "palmerpenguins")
+
+vchart(penguins) %>%
+  v_scatter(aes(
+    x = bill_length_mm, 
+    y = bill_depth_mm,
+    size = body_mass_g
+  )) %>% 
+  v_scale_size(
+    name = "Body mass",
+    range = c(1, 20)
+  )