propValidators | UpSet.js React

Functions

axisOffset

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

- Defined in react/src/validators.ts:114
Parameters
- Optional value: number | "auto"
Returns boolean

bandScale

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

- Defined in react/src/validators.ts:110
Parameters
- Optional value: BandScaleFactory | "band"
Returns boolean

classNames

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

- Defined in react/src/validators.ts:86
Parameters
- Optional value: UpSetStyleClassNames | VennDiagramMultiStyle<string> | KarnaughMapMultiStyle<string>
Returns boolean

combinations

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

- Defined in react/src/validators.ts:43
Parameters
- Optional value: ISetCombinations<any> | GenerateSetCombinationsOptions<any>
Returns boolean

exportButtons

exportButtons(value?: boolean | UpSetExportOptions): boolean

- Defined in react/src/validators.ts:131
Parameters
- Optional value: boolean | UpSetExportOptions
Returns boolean

fontSizes

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

- Defined in react/src/validators.ts:97
Parameters
- Optional value: UpSetFontSizes | VennDiagramFontSizes | KarnaughMapFontSizes
Returns boolean

heightRatios

heightRatios(value?: [number]): boolean

- Defined in react/src/validators.ts:32
Parameters
- Optional value: [number]
Returns boolean

numericScale

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

- Defined in react/src/validators.ts:106
Parameters
- Optional value: NumericScaleFactory | "linear" | "log"
Returns boolean

onClick

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

- Defined in react/src/validators.ts:57
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

onContextMenu

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

- Defined in react/src/validators.ts:60
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

onHover

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

- Defined in react/src/validators.ts:53
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

onMouseMove

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

- Defined in react/src/validators.ts:63
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

queries

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

- Defined in react/src/validators.ts:67
Parameters
- Optional value: UpSetQueries<any>
Returns boolean

selection

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

- Defined in react/src/validators.ts:49
Parameters
- Optional value: UpSetSelection<any>
Returns boolean

setLabelAlignment

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

- Defined in react/src/validators.ts:35
Parameters
- Optional value: "left" | "center" | "right"
Returns boolean

setLabelOffsets

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

- Defined in react/src/validators.ts:75
Parameters
- Optional value: readonly { x: number; y: number }[]
Returns boolean

sets

sets(value: ISets<any>): boolean

- Defined in react/src/validators.ts:39
Parameters
- value: ISets<any>
Returns boolean

stringOrFalse

stringOrFalse(value?: string | false): boolean

- Defined in react/src/validators.ts:71
Parameters
- Optional value: string | false
Returns boolean

style

style(value?: any): boolean

- Defined in react/src/validators.ts:118
Parameters
- Optional value: any
Returns boolean

styles

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

- Defined in react/src/validators.ts:122
Parameters
- Optional value: UpSetMultiStyle<any> | VennDiagramMultiStyle<any> | KarnaughMapMultiStyle<any>
Returns boolean

theme

theme(value?: UpSetThemes): boolean

- Defined in react/src/validators.ts:82
Parameters
- Optional value: UpSetThemes
Returns boolean

widthRatios

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

- Defined in react/src/validators.ts:29
Parameters
- Optional value: [number, number]
Returns boolean

Index

Functions

Functions

axisOffset

Parameters

Optional value: number | "auto"

Returns boolean

bandScale

Parameters

Optional value: BandScaleFactory | "band"

Returns boolean

classNames

Parameters

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

Returns boolean

combinations

Parameters

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

Returns boolean

exportButtons

Parameters

Optional value: boolean | UpSetExportOptions

Returns boolean

fontSizes

Parameters

Optional value: UpSetFontSizes | VennDiagramFontSizes | KarnaughMapFontSizes

Returns boolean

heightRatios

Parameters

Optional value: [number]

Returns boolean

numericScale

Parameters

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

Returns boolean

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

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

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

onMouseMove

Parameters

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

Parameters

selection: ISetLike<any>

evt: MouseEvent

addonInfos: UpSetAddonHandlerInfos

Returns void

Returns boolean

queries

Parameters

Optional value: UpSetQueries<any>

Returns boolean

selection

Parameters

Optional value: UpSetSelection<any>

Returns boolean

setLabelAlignment