Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface VennDiagramFullPropsG<T, C, N, L>

Type parameters

  • T

  • C

  • N

  • L

Hierarchy

Index

Properties

Optional children

children?: N

className

className: string

optional class name for the SVG element

classNames

classNames: VennDiagramMultiStyle<string>

object of classnames for certain sub elements

color

color: string

main color to render bars and dark dots

default

black

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

description

description: L

optional description text for the plot

exportButtons

exportButtons: boolean | UpSetExportOptions

show export buttons

default

true

filled

filled: boolean

whether to fill the circles

default

false

fontFamily

fontFamily: string | false

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

default

sans-serif

fontSizes

specify font sizes for different sub elements

hasSelectionColor

hasSelectionColor: string

main color used when a selection is present

default

undefined

hasSelectionOpacity

hasSelectionOpacity: number

main opacity used when a selection is present

default

undefined

height

height: number

height of the chart

id

id: string

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

layout

function used to perform the venn diagram layout

opacity

opacity: number

main opacity

default

undefined

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

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

selectionColor

selectionColor: string

color used to highlight the selection

default

orange

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

strokeColor

strokeColor: string

stroke color to render around sets or cells

default

black

style

style: C

style object applied to the SVG element

styles

object for applying styles to certain sub elements

textColor

textColor: string

main color to render text

default

black

theme

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

default

light

title

title: L

optional title text for the plot

tooltips

tooltips: boolean

whether to render tooltips aka title attributes

default

true

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

styleFactory

  • styleFactory(rules: string): N
  • factory to create the style tag

    Parameters

    • rules: string

    Returns N

Optional toElemKey

  • toElemKey(elem: T): string

toKey

  • optional function to identify the same sets

    Parameters

    • set: ISetLike<T>

      the set to generate a key for

    Returns string

valueFormat

  • valueFormat(cardinality: number): string