Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UpSetPropsG<T, C, N, L>

the UpSetJS component properties, separated in multiple semantic sub interfaces

Type parameters

  • T

  • C

  • N

  • L

Hierarchy

Index

Properties

Optional alternatingBackgroundColor

alternatingBackgroundColor?: string | false

color used to highlight alternating background in the sets for easier comparison set to false to disable alternating pattern

Optional bandScale

bandScale?: BandScaleFactory | "band"

band scale to use, either constant 'band' or a custom factory function

default

band

Optional barLabelOffset

barLabelOffset?: number

offset of the label on top or left of a bar

default

2

Optional barPadding

barPadding?: number

padding argument for scaleBand

default

0.1

Optional children

children?: N

Optional className

className?: string

optional class name for the SVG element

Optional classNames

object of classnames for certain sub elements

Optional color

color?: string

main color to render bars and dark dots

default

black

Optional combinationAddonPadding

combinationAddonPadding?: number

padding between combination addons

default

1

Optional combinationAddons

combinationAddons?: UpSetAddons<ISetCombination<T>, T, N>

list of addons that should be rendered along the vertical set combinations

Optional combinationMaxScale

combinationMaxScale?: number

maximum combination scale value

default

derived from the combinations

Optional combinationName

combinationName?: L

combination axis label

default

Intersection Size

Optional combinationNameAxisOffset

combinationNameAxisOffset?: number | "auto"

offset of the combination name from the combination y axis. 'auto' means that it will be guessed according to the current values

default

auto

Optional combinations

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

Optional description

description?: L

optional description text for the plot

Optional dotPadding

dotPadding?: number

padding factor the for dots

default

0.7

Optional emptySelection

emptySelection?: boolean

render empty selection for better performance

default

true

Optional exportButtons

exportButtons?: boolean | UpSetExportOptions

show export buttons

default

true

Optional fontFamily

fontFamily?: string | false

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

default

sans-serif

Optional fontSizes

fontSizes?: UpSetFontSizes

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 heightRatios

heightRatios?: [number]

height ratios for different plots, if a number larger than 1 is given, it is interpreted as pixel values [intersection chart, set chart = derived]

default

[0.6]

Optional hoverHintColor

hoverHintColor?: string

color for the hover hint rects for set combinations

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 notMemberColor

notMemberColor?: string

color for dots that indicate it is not a member

Optional numericScale

numericScale?: NumericScaleFactory | "linear" | "log"

numeric scale to use, either constants 'linear' or 'log' or a custom factory function

default

linear

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 setAddonPadding

setAddonPadding?: number

padding between combination addons

default

1

Optional setAddons

setAddons?: UpSetAddons<ISet<T>, T, N>

list of addons that should be rendered along the horizontal sets

Optional setLabelAlignment

setLabelAlignment?: "left" | "center" | "right"

alignment for the set labels

default

'center'

Optional setMaxScale

setMaxScale?: number

maximum set scale value

default

derived from the sets

Optional setName

setName?: L

set axis label

default

Set Size

Optional setNameAxisOffset

setNameAxisOffset?: number | "auto"

offset of the set name from the set x axis. 'auto' means that it will be guessed according to the current values

default

auto

sets

sets: ISets<T>

the sets to visualize

Optional style

style?: C

style object applied to the SVG element

Optional styles

styles?: UpSetMultiStyle<C>

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

width

width: number

width of the chart

Optional widthRatios

widthRatios?: [number, number]

width ratios for different plots, if a number larger than 1 is given, it is interpreted as pixel values [set chart, set labels, intersection chart = derived]

default

[0.21, 0.19]

Methods

Optional combinationChildrenFactory

Optional onClick

Optional onContextMenu

Optional onHover

Optional onMouseMove

Optional setChildrenFactory

  • setChildrenFactory(set: ISet<T>): N

Optional styleFactory

  • styleFactory(rules: string): N

Optional toElemKey

  • toElemKey(elem: T): string

Optional toKey