Skip to main content

Developer Reference / @visdesignlab/upset2-react / getActions

Function: getActions()

getActions(provenance): object

Defined in: provenance/index.ts:449

Parameters​

provenance​

Trrack

Returns​

object

activateSelectionType()​

activateSelectionType: (selectionType) => any

Activates a saved selection. This should ONLY be used when the selection of the given type has already been set. If null, clears the selection type. DON'T use this concurrently with setVegaSelection or setQuerySelection; these handle selection type themselves.

Parameters​

selectionType​

The selection type to activate

null | "vega" | "query"

Returns​

any

addAttribute()​

addAttribute: (attr) => any

Parameters​

attr​

string

Returns​

any

addBookmark()​

addBookmark: (b) => any

Adds a bookmark to the state

Parameters​

b​

Bookmark

bookmark to add

Returns​

any

addCollapsed()​

addCollapsed: (id) => any

Parameters​

id​

string

Returns​

any

addMultipleAttributes()​

addMultipleAttributes: (attrs) => any

Parameters​

attrs​

string[]

Returns​

any

addPlot()​

addPlot: (plot) => any

Adds a plot to the state

Parameters​

plot​

Plot

plot to add

Returns​

any

addSetQuery()​

addSetQuery: (query, queryString) => any

Parameters​

query​

SetQuery

queryString​

string

Returns​

any

addVisibleSet()​

addVisibleSet: (set) => any

Parameters​

set​

string

Returns​

any

collapseAll()​

collapseAll: (ids) => any

Parameters​

ids​

string[]

Returns​

any

expandAll()​

expandAll: () => any

Returns​

any

firstAggregateBy()​

firstAggregateBy: (aggBy) => any

Parameters​

aggBy​

AggregateBy

Returns​

any

firstOverlapBy()​

firstOverlapBy: (overlap) => any

Parameters​

overlap​

number

Returns​

any

removeAttribute()​

removeAttribute: (attr) => any

Parameters​

attr​

string

Returns​

any

removeBookmark()​

removeBookmark: (b) => any

Removes a bookmark from the state

Parameters​

b​

Bookmark

bookmark to remove

Returns​

any

removeCollapsed()​

removeCollapsed: (id) => any

Parameters​

id​

string

Returns​

any

removeMultipleVisibleAttributes()​

removeMultipleVisibleAttributes: (attrs) => any

Parameters​

attrs​

string[]

Returns​

any

removePlot()​

removePlot: (plot) => any

Removes a plot from the state

Parameters​

plot​

Plot

plot to remove

Returns​

any

removeSetQuery()​

removeSetQuery: () => any

Returns​

any

removeVisibleSet()​

removeVisibleSet: (set) => any

Parameters​

set​

string

Returns​

any

replaceState()​

replaceState: (state) => any

Parameters​

state​

UpsetConfig

Returns​

any

secondAggregateBy()​

secondAggregateBy: (aggBy) => any

Parameters​

aggBy​

AggregateBy

Returns​

any

secondOverlapBy()​

secondOverlapBy: (overlap) => any

Parameters​

overlap​

number

Returns​

any

setHideEmpty()​

setHideEmpty: (val) => any

Parameters​

val​

boolean

Returns​

any

setHideNoSet()​

setHideNoSet: (val) => any

Parameters​

val​

boolean

Returns​

any

setIntersectionSizeLabels()​

setIntersectionSizeLabels: (show) => any

Sets whether set intersection size labels should be shown

Parameters​

show​

boolean

Whether to show intersection size labels

Returns​

any

setMaxVisible()​

setMaxVisible: (val) => any

Parameters​

val​

number

Returns​

any

setMinVisible()​

setMinVisible: (val) => any

Parameters​

val​

number

Returns​

any

setPlotInformation()​

setPlotInformation: (plotInformation) => any

Parameters​

plotInformation​

PlotInformation

Returns​

any

setQuerySelection()​

setQuerySelection: (selection) => any

Sets the element query and selection type to 'query', and clears the row selection

Parameters​

selection​

any

The query selection to set

Returns​

any

setRowSelection()​

setRowSelection: (intersection) => any

Parameters​

intersection​

any

Returns​

any

setSetSizeLabels()​

setSetSizeLabels: (show) => any

Sets whether set size labels should be shown

Parameters​

show​

boolean

Whether to show set size labels

Returns​

any

setShowHiddenSets()​

setShowHiddenSets: (show) => any

Sets whether hidden sets should be shown

Parameters​

show​

boolean

Whether to show hidden sets

Returns​

any

setUserAltText()​

setUserAltText: (altText) => any

Parameters​

altText​

any

Returns​

any

setVegaSelection()​

setVegaSelection: (selection) => any

Sets the vega selection and selection type to 'vega', and clears the row selection

Parameters​

selection​

any

The selection to set

Returns​

any

sortBy()​

sortBy: (sort, sortByOrder) => any

Parameters​

sort​

string

sortByOrder​

SortByOrder

Returns​

any

sortVisibleBy()​

sortVisibleBy: (sort) => any

Parameters​

sort​

SortVisibleBy

Returns​

any

updateAttributePlotType()​

updateAttributePlotType: (attr, plotType) => any

Parameters​

attr​

string

plotType​

string

Returns​

any