Search
Preparing search index...
The search index is not available
UpSet.js Plots - v1.11.0
Options
All
Public
Public/Protected
All
Inherited
Menu
UpSet.js Plots - v1.11.0
Index
Interfaces
Bar
Chart
Props
Histogram
Props
IAggregated
Group
Set
Composite
IInterval
Set
Composite
Pie
Chart
Props
Scatterplot
Props
Up
Set
Plot
Full
Props
Up
Set
Plot
Props
Up
Set
Plot
Selection
Props
Up
Set
Plot
Style
Props
Up
Set
Plot
Theme
Props
Type aliases
Up
Set
Themes
Functions
Bar
Chart
Histogram
Pie
Chart
Scatterplot
create
Aggregated
Group
Set
Composite
create
Interval
Set
Composite
create
Set
Composite
fill
Defaults
is
Aggregated
Group
Set
Composite
is
Interval
Set
Composite
use
Vega
Aggregated
Group
Selection
use
Vega
Bin
Selection
use
Vega
Interval
Selection
use
Vega
Multi
Selection
Type aliases
Up
Set
Themes
Up
Set
Themes
:
"light"
|
"dark"
|
"vega"
Functions
Bar
Chart
Bar
Chart
<
T
>
(
props
:
BarChartProps
<
T
>
)
:
React.ReactElement
<
any
,
any
>
|
null
Type parameters
T
Parameters
props:
BarChartProps
<
T
>
Returns
React.ReactElement
<
any
,
any
>
|
null
Histogram
Histogram
<
T
>
(
props
:
HistogramProps
<
T
>
)
:
React.ReactElement
<
any
,
any
>
|
null
Type parameters
T
Parameters
props:
HistogramProps
<
T
>
Returns
React.ReactElement
<
any
,
any
>
|
null
Pie
Chart
Pie
Chart
<
T
>
(
props
:
PieChartProps
<
T
>
)
:
React.ReactElement
<
any
,
any
>
|
null
Type parameters
T
Parameters
props:
PieChartProps
<
T
>
Returns
React.ReactElement
<
any
,
any
>
|
null
Scatterplot
Scatterplot
<
T
>
(
props
:
ScatterplotProps
<
T
>
)
:
React.ReactElement
<
any
,
any
>
|
null
Type parameters
T
Parameters
props:
ScatterplotProps
<
T
>
Returns
React.ReactElement
<
any
,
any
>
|
null
create
Aggregated
Group
Set
Composite
create
Aggregated
Group
Set
Composite
<
T
>
(
attr
:
string
, elems
:
readonly
T
[]
, groups
:
readonly
(
string
|
number
)
[]
, name
?:
string
)
:
IAggregatedGroupSetComposite
<
T
>
Type parameters
T
Parameters
attr:
string
elems:
readonly
T
[]
groups:
readonly
(
string
|
number
)
[]
Optional
name:
string
Returns
IAggregatedGroupSetComposite
<
T
>
create
Interval
Set
Composite
create
Interval
Set
Composite
<
T
>
(
xAttr
:
string
, yAttr
:
string
, elems
:
readonly
T
[]
, x
:
[
number
,
number
]
, y
:
[
number
,
number
]
)
:
IIntervalSetComposite
<
T
>
Type parameters
T
Parameters
xAttr:
string
yAttr:
string
elems:
readonly
T
[]
x:
[
number
,
number
]
y:
[
number
,
number
]
Returns
IIntervalSetComposite
<
T
>
create
Set
Composite
create
Set
Composite
<
T
>
(
elems
:
readonly
T
[]
)
:
ISetComposite
<
T
>
Type parameters
T
Parameters
elems:
readonly
T
[]
Returns
ISetComposite
<
T
>
fill
Defaults
fill
Defaults
<
T
>
(
props
:
UpSetPlotProps
<
T
>
)
:
UpSetPlotFullProps
<
T
>
Type parameters
T
Parameters
props:
UpSetPlotProps
<
T
>
Returns
UpSetPlotFullProps
<
T
>
is
Aggregated
Group
Set
Composite
is
Aggregated
Group
Set
Composite
<
T
>
(
s
:
undefined
|
UpSetSelection
<
T
>
, attr
:
string
)
:
s
is
IAggregatedGroupSetComposite
<
T
>
Type parameters
T
Parameters
s:
undefined
|
UpSetSelection
<
T
>
attr:
string
Returns
s
is
IAggregatedGroupSetComposite
<
T
>
is
Interval
Set
Composite
is
Interval
Set
Composite
<
T
>
(
s
:
undefined
|
UpSetSelection
<
T
>
, xAttr
:
string
, yAttr
:
string
)
:
s
is
IIntervalSetComposite
<
T
>
Type parameters
T
Parameters
s:
undefined
|
UpSetSelection
<
T
>
xAttr:
string
yAttr:
string
Returns
s
is
IIntervalSetComposite
<
T
>
use
Vega
Aggregated
Group
Selection
use
Vega
Aggregated
Group
Selection
<
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
|
{}
}
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
aggregate
Field
?:
string
Optional
aggregated
Data
?:
string
Optional
elem
Field
?:
string
Optional
param
Name
?:
string
Optional
unit
Data
?:
string
Optional
values
Field
?:
string
name
Gen
?:
function
name
Gen
(
groups
:
any
[]
)
:
string
Parameters
groups:
any
[]
Returns
string
Returns
{
hoverParamName
:
null
|
string
;
paramName
:
null
|
string
;
params
:
TopLevelSelectionParameter
[]
;
signalListeners
:
undefined
|
{}
}
hover
Param
Name
:
null
|
string
param
Name
:
null
|
string
params
:
TopLevelSelectionParameter
[]
signal
Listeners
:
undefined
|
{}
use
Vega
Bin
Selection
use
Vega
Bin
Selection
<
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
|
{}
}
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
}
= {}
aggregated
Data
:
undefined
|
string
elem
Field
:
undefined
|
string
param
Name
:
undefined
|
string
unit
Data
:
undefined
|
string
value
Field
:
undefined
|
string
values
Field
:
undefined
|
string
Returns
{
hoverParamName
:
null
|
string
;
paramName
:
null
|
string
;
params
:
TopLevelSelectionParameter
[]
;
signalListeners
:
undefined
|
{}
}
hover
Param
Name
:
null
|
string
param
Name
:
null
|
string
params
:
TopLevelSelectionParameter
[]
signal
Listeners
:
undefined
|
{}
use
Vega
Interval
Selection
use
Vega
Interval
Selection
<
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
|
{}
}
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
}
= {}
elem
Field
:
undefined
|
string
param
Name
:
undefined
|
string
transformed
Data
:
undefined
|
string
x
Field
:
undefined
|
string
y
Field
:
undefined
|
string
Returns
{
hoverParamName
:
null
|
string
;
paramName
:
null
|
string
;
params
:
TopLevelSelectionParameter
[]
;
signalListeners
:
undefined
|
{}
}
hover
Param
Name
:
null
|
string
param
Name
:
null
|
string
params
:
TopLevelSelectionParameter
[]
signal
Listeners
:
undefined
|
{}
use
Vega
Multi
Selection
use
Vega
Multi
Selection
<
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
|
{}
}
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
}
= {}
elem
Field
:
undefined
|
string
param
Name
:
undefined
|
string
transformed
Data
:
undefined
|
string
unit
Data
:
undefined
|
string
Returns
{
hoverParamName
:
null
|
string
;
paramName
:
null
|
string
;
params
:
TopLevelSelectionParameter
[]
;
signalListeners
:
undefined
|
{}
}
hover
Param
Name
:
null
|
string
param
Name
:
null
|
string
params
:
TopLevelSelectionParameter
[]
signal
Listeners
:
undefined
|
{}
Exports
Bar
Chart
Props
Histogram
Props
IAggregated
Group
Set
Composite
IInterval
Set
Composite
Pie
Chart
Props
Scatterplot
Props
Up
Set
Plot
Full
Props
Up
Set
Plot
Props
Up
Set
Plot
Selection
Props
Up
Set
Plot
Style
Props
Up
Set
Plot
Theme
Props
Up
Set
Themes
Bar
Chart
Histogram
Pie
Chart
Scatterplot
create
Aggregated
Group
Set
Composite
create
Interval
Set
Composite
create
Set
Composite
fill
Defaults
is
Aggregated
Group
Set
Composite
is
Interval
Set
Composite
use
Vega
Aggregated
Group
Selection
use
Vega
Bin
Selection
use
Vega
Interval
Selection
use
Vega
Multi
Selection