Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface VennDiagramPropsG<T, C, N, L>

Type parameters

  • T

  • C

  • N

  • L

Hierarchy

Index

Properties

Optional children

children?: N

Optional className

className?: string

optional class name for the SVG element

Optional classNames

classNames?: VennDiagramMultiStyle<string>

object of classnames for certain sub elements

Optional color

color?: string

main color to render bars and dark dots

default

black

Optional combinations

combinations?: { mergeColors?: any } | ISetCombinations<T>

the set combinations to visualize or the generation options to generate the distinct set combinations by default all set distinct intersections are computed

Optional description

description?: L

optional description text for the plot

Optional exportButtons

exportButtons?: boolean | UpSetExportOptions

show export buttons

default

true

Optional filled

filled?: boolean

whether to fill the circles

default

false

Optional fontFamily

fontFamily?: string | false

specify the overall font family, set to false to use the default font family

default

sans-serif

Optional fontSizes

specify font sizes for different sub elements

Optional hasSelectionColor

hasSelectionColor?: string

main color used when a selection is present

default

undefined

Optional hasSelectionOpacity

hasSelectionOpacity?: number

main opacity used when a selection is present

default

undefined

height

height: number

height of the chart

Optional id

id?: string

optional unique id of the set element. Note: if set, it is will also be used as a CSS class suffix

Optional layout

function used to perform the venn diagram layout

Optional opacity

opacity?: number

main opacity

default

undefined

Optional padding

padding?: number

padding within the svg

default

5

Optional queries

queries?: UpSetQueries<T>

list of queries as an alternative to provide a single selection

Optional queryLegend

queryLegend?: boolean

show a legend of queries enabled by default when queries are set

Optional selection

selection?: UpSetSelection<T>

the selection of the plot. Can be a set like (set or set combination), an array of elements, or a function to compute the overlap to a given set

Optional selectionColor

selectionColor?: string

color used to highlight the selection

default

orange

Optional setLabelOffsets

setLabelOffsets?: readonly { x: number; y: number }[]

optional offsets for the x and y positions of each set label

sets

sets: ISets<T>

the sets to visualize

Optional strokeColor

strokeColor?: string

stroke color to render around sets or cells

default

black

Optional style

style?: C

style object applied to the SVG element

Optional styles

object for applying styles to certain sub elements

Optional textColor

textColor?: string

main color to render text

default

black

Optional theme

theme?: UpSetThemes

basic theme of the plot either 'light' or 'dark'

default

light

Optional title

title?: L

optional title text for the plot

Optional tooltips

tooltips?: boolean

whether to render tooltips aka title attributes

default

true

Optional valueTextColor

valueTextColor?: string

main color to render text

default

black

width

width: number

width of the chart

Methods

Optional onClick

Optional onContextMenu

Optional onHover

Optional onMouseMove

Optional styleFactory

  • styleFactory(rules: string): N

Optional toElemKey

  • toElemKey(elem: T): string

Optional toKey

Optional valueFormat

  • valueFormat(cardinality: number): string