propValidators | UpSet.js Bundle

Functions

Const axisOffset

axisOffset(value?: number | "auto"): boolean

- Defined in .yarn/__virtual__/@upsetjs-react-virtual-06be4ef03d/1/packages/react/dist/index.d.ts:965
Parameters
- Optional value: number | "auto"
Returns boolean

Const bandScale

bandScale(value?: BandScaleFactory | "band"): boolean

- Defined in .yarn/__virtual__/@upsetjs-react-virtual-06be4ef03d/1/packages/react/dist/index.d.ts:964
Parameters
- Optional value: BandScaleFactory | "band"
Returns boolean

Const classNames

classNames(value?: UpSetStyleClassNames | VennDiagramMultiStyle<string> | KarnaughMapMultiStyle<string>): boolean

- Defined in .yarn/__virtual__/@upsetjs-react-virtual-06be4ef03d/1/packages/react/dist/index.d.ts:961
Parameters
- Optional value: UpSetStyleClassNames | VennDiagramMultiStyle<string> | KarnaughMapMultiStyle<string>
Returns boolean

Const combinations

combinations(value?: ISetCombinations<any> | GenerateSetCombinationsOptions<any>): boolean

- Defined in .yarn/__virtual__/@upsetjs-react-virtual-06be4ef03d/1/packages/react/dist/index.d.ts:951
Parameters
- Optional value: ISetCombinations<any> | GenerateSetCombinationsOptions<any>
Returns boolean

Const exportButtons

exportButtons(value?: boolean | UpSetExportOptions): boolean

- Defined in .yarn/__virtual__/@upsetjs-react-virtual-06be4ef03d/1/packages/react/dist/index.d.ts:968
Parameters
- Optional value: boolean | UpSetExportOptions
Returns boolean

Const fontSizes

fontSizes(value?: UpSetFontSizes | VennDiagramFontSizes | KarnaughMapFontSizes): boolean

- Defined in .yarn/__virtual__/@upsetjs-react-virtual-06be4ef03d/1/packages/react/dist/index.d.ts:962
Parameters
- Optional value: UpSetFontSizes | VennDiagramFontSizes | KarnaughMapFontSizes
Returns boolean

Const heightRatios

heightRatios(value?: [number]): boolean

- Defined in .yarn/__virtual__/@upsetjs-react-virtual-06be4ef03d/1/packages/react/dist/index.d.ts:948
Parameters
- Optional value: [number]
Returns boolean

Const numericScale

numericScale(value?: NumericScaleFactory | "linear" | "log"): boolean

- Defined in .yarn/__virtual__/@upsetjs-react-virtual-06be4ef03d/1/packages/react/dist/index.d.ts:963
Parameters
- Optional value: NumericScaleFactory | "linear" | "log"
Returns boolean

Const onClick

onClick(value?: (selection: null | ISetLike<any>, evt: MouseEvent, addonInfos: UpSetAddonHandlerInfos) => void): boolean

- Defined in .yarn/__virtual__/@upsetjs-react-virtual-06be4ef03d/1/packages/react/dist/index.d.ts:954
Parameters
- Optional value: (selection: null | ISetLike<any>, evt: MouseEvent, addonInfos: UpSetAddonHandlerInfos) => void
  - - (selection: null | ISetLike<any>, evt: MouseEvent, addonInfos: UpSetAddonHandlerInfos): void
    - mouse click listener, triggered when the user is clicking on a set (combination)
      
      Parameters
      - selection: null | ISetLike<any>
      - evt: MouseEvent
      - addonInfos: UpSetAddonHandlerInfos
      Returns void
Returns boolean

Const onContextMenu

onContextMenu(value?: (selection: null | ISetLike<any>, evt: MouseEvent, addonInfos: UpSetAddonHandlerInfos) => void): boolean

- Defined in .yarn/__virtual__/@upsetjs-react-virtual-06be4ef03d/1/packages/react/dist/index.d.ts:955
Parameters
- Optional value: (selection: null | ISetLike<any>, evt: MouseEvent, addonInfos: UpSetAddonHandlerInfos) => void
  - - (selection: null | ISetLike<any>, evt: MouseEvent, addonInfos: UpSetAddonHandlerInfos): void
    - mouse context menu listener, triggered when the user right clicks on a set (combination)
      
      Parameters
      - selection: null | ISetLike<any>
      - evt: MouseEvent
      - addonInfos: UpSetAddonHandlerInfos
      Returns void
Returns boolean

Const onHover

onHover(value?: (selection: null | ISetLike<any>, evt: MouseEvent, addonInfos: UpSetAddonHandlerInfos) => void): boolean

- Defined in .yarn/__virtual__/@upsetjs-react-virtual-06be4ef03d/1/packages/react/dist/index.d.ts:953
Parameters
- Optional value: (selection: null | ISetLike<any>, evt: MouseEvent, addonInfos: UpSetAddonHandlerInfos) => void
  - - (selection: null | ISetLike<any>, evt: MouseEvent, addonInfos: UpSetAddonHandlerInfos): void
    - mouse hover listener, triggered when the user is over a set (combination) a combination of mouseEnter and mouseLeave
      
      Parameters
      - selection: null | ISetLike<any>
      - evt: MouseEvent
      - addonInfos: UpSetAddonHandlerInfos
      Returns void
Returns boolean

Const onMouseMove

onMouseMove(value?: (selection: ISetLike<any>, evt: MouseEvent, addonInfos: UpSetAddonHandlerInfos) => void): boolean

- Defined in .yarn/__virtual__/@upsetjs-react-virtual-06be4ef03d/1/packages/react/dist/index.d.ts:956
Parameters
- Optional value: (selection: ISetLike<any>, evt: MouseEvent, addonInfos: UpSetAddonHandlerInfos) => void
  - - (selection: ISetLike<any>, evt: MouseEvent, addonInfos: UpSetAddonHandlerInfos): void
    - mouse move over set listener, triggered when the user is over a set (combination)
      
      Parameters
      - selection: ISetLike<any>
      - evt: MouseEvent
      - addonInfos: UpSetAddonHandlerInfos
      Returns void
Returns boolean

Const queries

queries(value?: UpSetQueries<any>): boolean

- Defined in .yarn/__virtual__/@upsetjs-react-virtual-06be4ef03d/1/packages/react/dist/index.d.ts:957
Parameters
- Optional value: UpSetQueries<any>
Returns boolean

Const selection

selection(value?: UpSetSelection<any>): boolean

- Defined in .yarn/__virtual__/@upsetjs-react-virtual-06be4ef03d/1/packages/react/dist/index.d.ts:952
Parameters
- Optional value: UpSetSelection<any>
Returns boolean

Const setLabelAlignment

setLabelAlignment(value?: "left" | "center" | "right"): boolean

- Defined in .yarn/__virtual__/@upsetjs-react-virtual-06be4ef03d/1/packages/react/dist/index.d.ts:949
Parameters
- Optional value: "left" | "center" | "right"
Returns boolean

Const setLabelOffsets

setLabelOffsets(value?: readonly { x: number; y: number }[]): boolean

- Defined in .yarn/__virtual__/@upsetjs-react-virtual-06be4ef03d/1/packages/react/dist/index.d.ts:959
Parameters
- Optional value: readonly { x: number; y: number }[]
Returns boolean

Const sets

sets(value: ISets<any>): boolean

- Defined in .yarn/__virtual__/@upsetjs-react-virtual-06be4ef03d/1/packages/react/dist/index.d.ts:950
Parameters
- value: ISets<any>
Returns boolean

Const stringOrFalse

stringOrFalse(value?: string | false): boolean

- Defined in .yarn/__virtual__/@upsetjs-react-virtual-06be4ef03d/1/packages/react/dist/index.d.ts:958
Parameters
- Optional value: string | false
Returns boolean

Const style

style(value?: any): boolean

- Defined in .yarn/__virtual__/@upsetjs-react-virtual-06be4ef03d/1/packages/react/dist/index.d.ts:966
Parameters
- Optional value: any
Returns boolean

Const styles

styles(value?: UpSetMultiStyle<any> | VennDiagramMultiStyle<any> | KarnaughMapMultiStyle<any>): boolean

- Defined in .yarn/__virtual__/@upsetjs-react-virtual-06be4ef03d/1/packages/react/dist/index.d.ts:967
Parameters
- Optional value: UpSetMultiStyle<any> | VennDiagramMultiStyle<any> | KarnaughMapMultiStyle<any>
Returns boolean

Const theme

theme(value?: UpSetThemes): boolean

- Defined in .yarn/__virtual__/@upsetjs-react-virtual-06be4ef03d/1/packages/react/dist/index.d.ts:960
Parameters
- Optional value: UpSetThemes
Returns boolean

Const widthRatios

widthRatios(value?: [number, number]): boolean

- Defined in .yarn/__virtual__/@upsetjs-react-virtual-06be4ef03d/1/packages/react/dist/index.d.ts:947
Parameters
- Optional value: [number, number]
Returns boolean

Index

Functions

Functions

Const axisOffset

Parameters

Optional value: number | "auto"

Returns boolean

Const bandScale

Parameters

Optional value: BandScaleFactory | "band"

Returns boolean

Const classNames

Parameters

Optional value: UpSetStyleClassNames | VennDiagramMultiStyle<string> | KarnaughMapMultiStyle<string>

Returns boolean

Const combinations

Parameters

Optional value: ISetCombinations<any> | GenerateSetCombinationsOptions<any>

Returns boolean

Const exportButtons

Parameters

Optional value: boolean | UpSetExportOptions

Returns boolean

Const fontSizes

Parameters

Optional value: UpSetFontSizes | VennDiagramFontSizes | KarnaughMapFontSizes

Returns boolean

Const heightRatios

Parameters

Optional value: [number]

Returns boolean

Const numericScale

Parameters

Optional value: NumericScaleFactory | "linear" | "log"

Returns boolean

Const onClick

Parameters

Optional value: (selection: null | ISetLike<any>, evt: MouseEvent, addonInfos: UpSetAddonHandlerInfos) => void

Parameters

selection: null | ISetLike<any>

evt: MouseEvent

addonInfos: UpSetAddonHandlerInfos

Returns void

Returns boolean

Const onContextMenu

Parameters

Optional value: (selection: null | ISetLike<any>, evt: MouseEvent, addonInfos: UpSetAddonHandlerInfos) => void

Parameters

selection: null | ISetLike<any>

evt: MouseEvent

addonInfos: UpSetAddonHandlerInfos

Returns void

Returns boolean

Const onHover

Parameters

Optional value: (selection: null | ISetLike<any>, evt: MouseEvent, addonInfos: UpSetAddonHandlerInfos) => void

Parameters

selection: null | ISetLike<any>

evt: MouseEvent

addonInfos: UpSetAddonHandlerInfos

Returns void

Returns boolean

Const onMouseMove

Parameters

Optional value: (selection: ISetLike<any>, evt: MouseEvent, addonInfos: UpSetAddonHandlerInfos) => void

Parameters

selection: ISetLike<any>

evt: MouseEvent

addonInfos: UpSetAddonHandlerInfos

Returns void

Returns boolean

Const queries

Parameters

Optional value: UpSetQueries<any>

Returns boolean

Const selection

Parameters

Optional value: UpSetSelection<any>

Returns boolean

Const setLabelAlignment