hc_venn: Highcharter Venn/Euler Geom Function

View source: R/geom-venn.R

hc_vennR Documentation

Highcharter Venn/Euler Geom Function

Description

Adds a "venn" type series to a Highcharts chart. Supports any number of sets and any number of intersection entries.

Usage

hc_venn(chart, spec, opts, geom_params, use_js = TRUE, ...)

Arguments

chart

A highchart object (from base_fig() bypass path).

spec

An hd_spec() object. ⁠$data⁠ is unused.

opts

An hd_opts() object.

geom_params

Named list. Must contain sets; optionally series_name and label_font_size.

use_js

Logical. Unused for venn; present for engine consistency.

...

Unused.

Value

The updated highchart object.

Highcharts venn series contract

Each entry in sets becomes one element of the Highcharts data array:

  • Single set: list(sets = list("A"), name = "Animals", value = 5)

  • Intersection: list(sets = list("A", "B"), value = 2)

name is optional for intersections but required for single sets if you want a label in the diagram.


highdir documentation built on July 31, 2026, 5:06 p.m.