valueBoxSpark: Create a value box with a sparkline

In mbacou/WADashboard: IWMI Water Accounting+ Visualization Dashboard

Create a value box with a sparkline

Description

Modified version of bs4Dash::valueBox()

Usage

valueBoxSpark(
  value,
  unit = "",
  selected = NA,
  title = "",
  subtitle = "",
  info = NULL,
  sparkobj = NULL,
  type = NA,
  icon = NULL,
  color = "light",
  width = 4,
  href = NULL
)

Arguments

value	The value to display in the box. Usually a number or short text.
unit	display unit
selected	selected x value to highlight
subtitle	Subtitle text.
info	tooltip information text
sparkobj	(optional) highcharts object
type	(optional) type of spark chart (line, column, etc.) default to NA (no sparkline) if not passed
icon	An icon tag, created by icon.
color	The color of the item. This determines the item's background color. Valid colors are defined as follows: primary: \Sexpr[results=rd, stage=render]{bs4Dash:::rd_color_tag("#007bff")}. secondary: \Sexpr[results=rd, stage=render]{bs4Dash:::rd_color_tag("#6c757d")}. info: \Sexpr[results=rd, stage=render]{bs4Dash:::rd_color_tag("#17a2b8")}. success: \Sexpr[results=rd, stage=render]{bs4Dash:::rd_color_tag("#28a745")}. warning: \Sexpr[results=rd, stage=render]{bs4Dash:::rd_color_tag("#ffc107")}. danger: \Sexpr[results=rd, stage=render]{bs4Dash:::rd_color_tag("#dc3545")}. gray-dark: \Sexpr[results=rd, stage=render]{bs4Dash:::rd_color_tag("#343a40")}. gray: \Sexpr[results=rd, stage=render]{bs4Dash:::rd_color_tag("#adb5bd")}. white: \Sexpr[results=rd, stage=render]{bs4Dash:::rd_color_tag("#fff")}. indigo: \Sexpr[results=rd, stage=render]{bs4Dash:::rd_color_tag("#6610f2")}. lightblue: \Sexpr[results=rd, stage=render]{bs4Dash:::rd_color_tag("#3c8dbc")}. navy: \Sexpr[results=rd, stage=render]{bs4Dash:::rd_color_tag("#001f3f")}. purple: \Sexpr[results=rd, stage=render]{bs4Dash:::rd_color_tag("#605ca8")}. fuchsia: \Sexpr[results=rd, stage=render]{bs4Dash:::rd_color_tag("#f012be")}. pink: \Sexpr[results=rd, stage=render]{bs4Dash:::rd_color_tag("#e83e8c")}. maroon: \Sexpr[results=rd, stage=render]{bs4Dash:::rd_color_tag("#d81b60")}. orange: \Sexpr[results=rd, stage=render]{bs4Dash:::rd_color_tag("#ff851b")}. lime: \Sexpr[results=rd, stage=render]{bs4Dash:::rd_color_tag("#01ff70")}. teal: \Sexpr[results=rd, stage=render]{bs4Dash:::rd_color_tag("#39cccc")}. olive: \Sexpr[results=rd, stage=render]{bs4Dash:::rd_color_tag("#3d9970")}.
width	The width of the box, using the Bootstrap grid system. This is used for row-based layouts. The overall width of a region is 12, so the default width of 4 occupies 1/3 of that width. For column-based layouts, use NULL for the width; the width is set by the column that contains the box.
href	An optional URL to link to in the footer. Should both 'footer' and this parameter be set, 'footer' will take precedence.
data	(optional) data.table to summarize with at least columns x and y

Examples

data <- data.table(
  x = Sys.Date() + 0:9,
  y = rnorm(10)
)
valueBoxSpark(data, title="Title", subtitle="Subtitle", color="success", type="line")

data <- DATA[iso3=="ken" & id=="net_inflow" & period=="year", .(year, value)]
valueBoxSpark(data,
  title="Title", subtitle="Subtitle",
  color="success", type="bar", unit="km3")

valueBoxSpark(33,
  title="Title", subtitle="Subtitle",
  color="success", unit="km3", footer="Footer")

mbacou/WADashboard documentation built on Jan. 3, 2023, 6:21 p.m.