UpSet.js Plots - v1.11.0

Type aliases

UpSetThemes

UpSetThemes: "light" | "dark" | "vega"

Functions

BarChart

BarChart<T>(props: BarChartProps<T>): React.ReactElement<any, any> | null

- Defined in packages/plots/src/components/BarChart.tsx:34
Type parameters
- T
Parameters
- props: BarChartProps<T>
Returns React.ReactElement<any, any> | null

Histogram

Histogram<T>(props: HistogramProps<T>): React.ReactElement<any, any> | null

- Defined in packages/plots/src/components/Histogram.tsx:108
Type parameters
- T
Parameters
- props: HistogramProps<T>
Returns React.ReactElement<any, any> | null

PieChart

PieChart<T>(props: PieChartProps<T>): React.ReactElement<any, any> | null

- Defined in packages/plots/src/components/PieChart.tsx:80
Type parameters
- T
Parameters
- props: PieChartProps<T>
Returns React.ReactElement<any, any> | null

Scatterplot

Scatterplot<T>(props: ScatterplotProps<T>): React.ReactElement<any, any> | null

- Defined in packages/plots/src/components/Scatterplot.tsx:28
Type parameters
- T
Parameters
- props: ScatterplotProps<T>
Returns React.ReactElement<any, any> | null

createAggregatedGroupSetComposite

createAggregatedGroupSetComposite<T>(attr: string, elems: readonly T[], groups: readonly (string | number)[], name?: string): IAggregatedGroupSetComposite<T>

- Defined in packages/plots/src/selections/singleAggregate.ts:34
Type parameters
- T
Parameters
- attr: string
- elems: readonly T[]
- groups: readonly (string | number)[]
- Optional name: string
Returns IAggregatedGroupSetComposite<T>

createIntervalSetComposite

createIntervalSetComposite<T>(xAttr: string, yAttr: string, elems: readonly T[], x: [number, number], y: [number, number]): IIntervalSetComposite<T>

- Defined in packages/plots/src/selections/interval.ts:42
Type parameters
- T
Parameters
- xAttr: string
- yAttr: string
- elems: readonly T[]
- x: [number, number]
- y: [number, number]
Returns IIntervalSetComposite<T>

createSetComposite

createSetComposite<T>(elems: readonly T[]): ISetComposite<T>

- Defined in packages/plots/src/selections/single.ts:14
Type parameters
- T
Parameters
- elems: readonly T[]
Returns ISetComposite<T>

fillDefaults

fillDefaults<T>(props: UpSetPlotProps<T>): UpSetPlotFullProps<T>

- Defined in packages/plots/src/interfaces.ts:53
Type parameters
- T
Parameters
- props: UpSetPlotProps<T>
Returns UpSetPlotFullProps<T>

isAggregatedGroupSetComposite

isAggregatedGroupSetComposite<T>(s: undefined | UpSetSelection<T>, attr: string): s is IAggregatedGroupSetComposite<T>

- Defined in packages/plots/src/selections/singleAggregate.ts:21
Type parameters
- T
Parameters
- s: undefined | UpSetSelection<T>
- attr: string
Returns s is IAggregatedGroupSetComposite<T>

isIntervalSetComposite

isIntervalSetComposite<T>(s: undefined | UpSetSelection<T>, xAttr: string, yAttr: string): s is IIntervalSetComposite<T>

- Defined in packages/plots/src/selections/interval.ts:23
Type parameters
- T
Parameters
- s: undefined | UpSetSelection<T>
- xAttr: string
- yAttr: string
Returns s is IIntervalSetComposite<T>

useVegaAggregatedGroupSelection

useVegaAggregatedGroupSelection<T>(viewRef: RefObject<View>, selection: undefined | UpSetSelection<T>, name: string, onClick?: (v: null | ISetLike<T> | readonly T[]) => void, onHover?: (v: null | ISetLike<T> | readonly T[]) => void, __namedParameters?: { aggregateField?: string; aggregatedData?: string; elemField?: string; paramName?: string; unitData?: string; valuesField?: string; nameGen?: any }): { hoverParamName: null | string; paramName: null | string; params: TopLevelSelectionParameter[]; signalListeners: undefined | {} }

- Defined in packages/plots/src/selections/singleAggregate.ts:80
Type parameters
- T
Parameters
- viewRef: RefObject<View>
- selection: undefined | UpSetSelection<T>
- name: string
- Optional onClick: (v: null | ISetLike<T> | readonly T[]) => void
  - - (v: null | ISetLike<T> | readonly T[]): void
    - Parameters
      - v: null | ISetLike<T> | readonly T[]
      Returns void
- Optional onHover: (v: null | ISetLike<T> | readonly T[]) => void
  - - (v: null | ISetLike<T> | readonly T[]): void
    - Parameters
      - v: null | ISetLike<T> | readonly T[]
      Returns void
- __namedParameters: { aggregateField?: string; aggregatedData?: string; elemField?: string; paramName?: string; unitData?: string; valuesField?: string; nameGen?: any } = {}
  - Optional aggregateField?: string
  - Optional aggregatedData?: string
  - Optional elemField?: string
  - Optional paramName?: string
  - Optional unitData?: string
  - Optional valuesField?: string
  - nameGen?:function
    - nameGen(groups: any[]): string
    - Defined in packages/plots/src/selections/singleAggregate.ts:101
      Parameters
      - groups: any[]
      Returns string
Returns { hoverParamName: null | string; paramName: null | string; params: TopLevelSelectionParameter[]; signalListeners: undefined | {} }
- hoverParamName: null | string
- paramName: null | string
- params: TopLevelSelectionParameter[]
- signalListeners: undefined | {}

useVegaBinSelection

useVegaBinSelection<T>(viewRef: RefObject<View>, selection: undefined | UpSetSelection<T>, name: string, onClick?: (v: null | ISetLike<T> | readonly T[]) => void, onHover?: (v: null | ISetLike<T> | readonly T[]) => void, __namedParameters?: { aggregatedData: undefined | string; elemField: undefined | string; paramName: undefined | string; unitData: undefined | string; valueField: undefined | string; valuesField: undefined | string }): { hoverParamName: null | string; paramName: null | string; params: TopLevelSelectionParameter[]; signalListeners: undefined | {} }

- Defined in packages/plots/src/selections/singleBin.ts:13
Type parameters
- T
Parameters
- viewRef: RefObject<View>
- selection: undefined | UpSetSelection<T>
- name: string
- Optional onClick: (v: null | ISetLike<T> | readonly T[]) => void
  - - (v: null | ISetLike<T> | readonly T[]): void
    - Parameters
      - v: null | ISetLike<T> | readonly T[]
      Returns void
- Optional onHover: (v: null | ISetLike<T> | readonly T[]) => void
  - - (v: null | ISetLike<T> | readonly T[]): void
    - Parameters
      - v: null | ISetLike<T> | readonly T[]
      Returns void
- __namedParameters: { aggregatedData: undefined | string; elemField: undefined | string; paramName: undefined | string; unitData: undefined | string; valueField: undefined | string; valuesField: undefined | string } = {}
  - aggregatedData: undefined | string
  - elemField: undefined | string
  - paramName: undefined | string
  - unitData: undefined | string
  - valueField: undefined | string
  - valuesField: undefined | string
Returns { hoverParamName: null | string; paramName: null | string; params: TopLevelSelectionParameter[]; signalListeners: undefined | {} }
- hoverParamName: null | string
- paramName: null | string
- params: TopLevelSelectionParameter[]
- signalListeners: undefined | {}

useVegaIntervalSelection

useVegaIntervalSelection<T>(viewRef: RefObject<View>, selection: undefined | UpSetSelection<T>, xName: string, yName: string, toElemKey?: (v: any) => string, onClick?: (v: null | ISetLike<T> | readonly T[]) => void, onHover?: (v: null | ISetLike<T> | readonly T[]) => void, __namedParameters?: { elemField: undefined | string; paramName: undefined | string; transformedData: undefined | string; xField: undefined | string; yField: undefined | string }): { hoverParamName: null | string; paramName: null | string; params: TopLevelSelectionParameter[]; signalListeners: undefined | {} }

- Defined in packages/plots/src/selections/interval.ts:101
Type parameters
- T
Parameters
- viewRef: RefObject<View>
- selection: undefined | UpSetSelection<T>
- xName: string
- yName: string
- Optional toElemKey: (v: any) => string
  - - (v: any): string
    - Parameters
      - v: any
      Returns string
- Optional onClick: (v: null | ISetLike<T> | readonly T[]) => void
  - - (v: null | ISetLike<T> | readonly T[]): void
    - Parameters
      - v: null | ISetLike<T> | readonly T[]
      Returns void
- Optional onHover: (v: null | ISetLike<T> | readonly T[]) => void
  - - (v: null | ISetLike<T> | readonly T[]): void
    - Parameters
      - v: null | ISetLike<T> | readonly T[]
      Returns void
- __namedParameters: { elemField: undefined | string; paramName: undefined | string; transformedData: undefined | string; xField: undefined | string; yField: undefined | string } = {}
  - elemField: undefined | string
  - paramName: undefined | string
  - transformedData: undefined | string
  - xField: undefined | string
  - yField: undefined | string
Returns { hoverParamName: null | string; paramName: null | string; params: TopLevelSelectionParameter[]; signalListeners: undefined | {} }
- hoverParamName: null | string
- paramName: null | string
- params: TopLevelSelectionParameter[]
- signalListeners: undefined | {}

useVegaMultiSelection

useVegaMultiSelection<T>(mode: "single" | "multi", viewRef: RefObject<View>, toElemKey: undefined | ((v: any) => string), selection: undefined | UpSetSelection<T>, onClick?: (v: null | ISetLike<T> | readonly T[]) => void, onHover?: (v: null | ISetLike<T> | readonly T[]) => void, __namedParameters?: { elemField: undefined | string; paramName: undefined | string; transformedData: undefined | string; unitData: undefined | string }): { hoverParamName: null | string; paramName: null | string; params: TopLevelSelectionParameter[]; signalListeners: undefined | {} }

- Defined in packages/plots/src/selections/single.ts:95
Type parameters
- T
Parameters
- mode: "single" | "multi"
- viewRef: RefObject<View>
- toElemKey: undefined | ((v: any) => string)
- selection: undefined | UpSetSelection<T>
- Optional onClick: (v: null | ISetLike<T> | readonly T[]) => void
  - - (v: null | ISetLike<T> | readonly T[]): void
    - Parameters
      - v: null | ISetLike<T> | readonly T[]
      Returns void
- Optional onHover: (v: null | ISetLike<T> | readonly T[]) => void
  - - (v: null | ISetLike<T> | readonly T[]): void
    - Parameters
      - v: null | ISetLike<T> | readonly T[]
      Returns void
- __namedParameters: { elemField: undefined | string; paramName: undefined | string; transformedData: undefined | string; unitData: undefined | string } = {}
  - elemField: undefined | string
  - paramName: undefined | string
  - transformedData: undefined | string
  - unitData: undefined | string
Returns { hoverParamName: null | string; paramName: null | string; params: TopLevelSelectionParameter[]; signalListeners: undefined | {} }
- hoverParamName: null | string
- paramName: null | string
- params: TopLevelSelectionParameter[]
- signalListeners: undefined | {}

Index

Interfaces

Type aliases

Functions

Type aliases

UpSetThemes

Functions

BarChart

Type parameters

T

Parameters

props: BarChartProps<T>

Returns React.ReactElement<any, any> | null

Histogram

Type parameters

T

Parameters

props: HistogramProps<T>

Returns React.ReactElement<any, any> | null

PieChart

Type parameters

T

Parameters

props: PieChartProps<T>

Returns React.ReactElement<any, any> | null

Scatterplot

Type parameters

T

Parameters

props: ScatterplotProps<T>

Returns React.ReactElement<any, any> | null

createAggregatedGroupSetComposite

Type parameters

T

Parameters

attr: string

elems: readonly T[]

groups: readonly (string | number)[]

Optional name: string

Returns IAggregatedGroupSetComposite<T>

createIntervalSetComposite

Type parameters

T

Parameters

xAttr: string

yAttr: string

elems: readonly T[]

x: [number, number]

y: [number, number]

Returns IIntervalSetComposite<T>

createSetComposite

Type parameters

T

Parameters

elems: readonly T[]

Returns ISetComposite<T>

fillDefaults

Type parameters

T

Parameters

props: UpSetPlotProps<T>

Returns UpSetPlotFullProps<T>

isAggregatedGroupSetComposite

Type parameters

T

Parameters

s: undefined | UpSetSelection<T>

attr: string

Returns s is IAggregatedGroupSetComposite<T>

isIntervalSetComposite

Type parameters

T

Parameters

s: undefined | UpSetSelection<T>

xAttr: string

yAttr: string

Returns s is IIntervalSetComposite<T>

useVegaAggregatedGroupSelection

Type parameters

T