bind_svg_annotator_data: Bind svg annotator data

View source: R/bind_svg_annotator_data.R

bind_svg_annotator_dataR Documentation

Bind svg annotator data

Description

Bind svg annotator data

Usage

bind_svg_annotator_data(
  .,
  data = NULL,
  id = NULL,
  reveal_id = NULL,
  h1 = NULL,
  h2 = NULL,
  content = NULL,
  link = NULL,
  metadata = NULL
)

Arguments

.

The prior Flourish object. No need to specify name if piping graph as the graph will take the first argument (i.e. the prior existing graph).

data

Data.

id

ID. A column of IDs of elements in the uploaded SVG file. Flourish type hint: column

reveal_id

Reveal layer. A column to reveal when layer is clicked. Flourish type hint: column

h1

Heading 1. A column containing the main header. Flourish type hint: column

h2

Heading 2. A column containing a secondary header. Flourish type hint: column

content

Content. A column containing text or HTML to display. Flourish type hint: column

link

Link. A URL that can be opened when a layer is clicked. Any reveal layers or popups will be overridden. Flourish type hint: column

metadata

Info for popups. One or more columns to display in popups and panels. Flourish type hint: columns

Value

A Flourish chart

Examples

try(
  flourish(chart_type = "svg_annotator", api_key = Sys.getenv("FLOURISH_API_KEY")) |> 
  bind_svg_annotator_data(gapminder)
)

flourishcharts documentation built on Oct. 30, 2024, 9:07 a.m.