Developer Reference / @visdesignlab/upset2-react / UpsetProps
Interface: UpsetProps
Defined in: types.ts:98
Represents the props for the Upset component.
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
allowAttributeRemoval? | boolean | Whether or not to allow the user to remove attribute columns. This should be enabled only if there is an option within the parent application which allows for attributes to be added after removal. Default attribute removal behavior in UpSet 2.0 is done via context menu on attribute headers. Defaults to false. | types.ts:128 |
altTextSidebar? | SidebarProps | Sidebar options for the alt text sidebar component. This sidebar is used to display the generated text descriptions for an Upset 2.0 plot, given that the generateAltText function is provided. | types.ts:174 |
canEditPlotInformation? | boolean | Whether or not the user has plot information edit permissions. | types.ts:133 |
config? | any | Optional configuration for the Upset component. | types.ts:107 |
data | any | The data for the Upset component. | types.ts:102 |
elementSidebar? | SidebarProps | Sidebar options for the element sidebar component. This sidebar is used for element queries, element selection datatable, and supplimental plot generation. | types.ts:168 |
extProvenance? | object | External provenance actions and TrrackJS object for provenance history tracking and actions. This should only be used if your tool is using TrrackJS and has all the actions used by UpSet 2.0. Provenance is still tracked if nothing is provided. Note that initializeProvenanceTracking and getActions are used to ensure that the provided provenance object is compatible. | types.ts:154 |
extProvenance.actions | object | - | types.ts:156 |
extProvenance.actions.activateSelectionType | (selectionType: null | "vega" | "query") => 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. | provenance/index.ts:566 |
extProvenance.actions.addAttribute | (attr: string) => any | - | provenance/index.ts:484 |
extProvenance.actions.addBookmark | (b: Bookmark) => any | Adds a bookmark to the state | provenance/index.ts:507 |
extProvenance.actions.addCollapsed | (id: string) => any | - | provenance/index.ts:529 |
extProvenance.actions.addMultipleAttributes | (attrs: string[]) => any | - | provenance/index.ts:488 |
extProvenance.actions.addPlot | (plot: Plot) => any | Adds a plot to the state | provenance/index.ts:519 |
extProvenance.actions.addSetQuery | (query: SetQuery, queryString: string) => any | - | provenance/index.ts:616 |
extProvenance.actions.addVisibleSet | (set: string) => any | - | provenance/index.ts:480 |
extProvenance.actions.collapseAll | (ids: string[]) => any | - | provenance/index.ts:533 |
extProvenance.actions.expandAll | () => any | - | provenance/index.ts:535 |
extProvenance.actions.firstAggregateBy | (aggBy: AggregateBy) => any | - | provenance/index.ts:451 |
extProvenance.actions.firstOverlapBy | (overlap: number) => any | - | provenance/index.ts:453 |
extProvenance.actions.removeAttribute | (attr: string) => any | - | provenance/index.ts:486 |
extProvenance.actions.removeBookmark | (b: Bookmark) => any | Removes a bookmark from the state | provenance/index.ts:513 |
extProvenance.actions.removeCollapsed | (id: string) => any | - | provenance/index.ts:531 |
extProvenance.actions.removeMultipleVisibleAttributes | (attrs: string[]) => any | - | provenance/index.ts:493 |
extProvenance.actions.removePlot | (plot: Plot) => any | Removes a plot from the state | provenance/index.ts:525 |
extProvenance.actions.removeSetQuery | () => any | - | provenance/index.ts:618 |
extProvenance.actions.removeVisibleSet | (set: string) => any | - | provenance/index.ts:482 |
extProvenance.actions.replaceState | (state: UpsetConfig) => any | - | provenance/index.ts:527 |
extProvenance.actions.secondAggregateBy | (aggBy: AggregateBy) => any | - | provenance/index.ts:455 |
extProvenance.actions.secondOverlapBy | (overlap: number) => any | - | provenance/index.ts:457 |
extProvenance.actions.setHideEmpty | (val: boolean) => any | - | provenance/index.ts:470 |
extProvenance.actions.setHideNoSet | (val: boolean) => any | - | provenance/index.ts:475 |
extProvenance.actions.setIntersectionSizeLabels | (show: boolean) => any | Sets whether set intersection size labels should be shown | provenance/index.ts:593 |
extProvenance.actions.setMaxVisible | (val: number) => any | - | provenance/index.ts:466 |
extProvenance.actions.setMinVisible | (val: number) => any | - | provenance/index.ts:468 |
extProvenance.actions.setPlotInformation | (plotInformation: PlotInformation) => any | - | provenance/index.ts:536 |
extProvenance.actions.setQuerySelection | (selection: any) => any | Sets the element query and selection type to 'query', and clears the row selection | provenance/index.ts:577 |
extProvenance.actions.setRowSelection | (intersection: any) => any | - | provenance/index.ts:541 |
extProvenance.actions.setSetSizeLabels | (show: boolean) => any | Sets whether set size labels should be shown | provenance/index.ts:602 |
extProvenance.actions.setShowHiddenSets | (show: boolean) => any | Sets whether hidden sets should be shown | provenance/index.ts:611 |
extProvenance.actions.setUserAltText | (altText: any) => any | - | provenance/index.ts:584 |
extProvenance.actions.setVegaSelection | (selection: any) => any | Sets the vega selection and selection type to 'vega', and clears the row selection | provenance/index.ts:552 |
extProvenance.actions.sortBy | (sort: string, sortByOrder: SortByOrder) => any | - | provenance/index.ts:461 |
extProvenance.actions.sortVisibleBy | (sort: SortVisibleBy) => any | - | provenance/index.ts:459 |
extProvenance.actions.updateAttributePlotType | (attr: string, plotType: string) => any | - | provenance/index.ts:498 |
extProvenance.provenance | Trrack | - | types.ts:155 |
footerHeight? | number | Height of the footer overlayed on the upset plot, in px, if one exists. Used to prevent the bottom of the sidebars from overlapping with the footer. | types.ts:180 |
generateAltText? | () => Promise<AltText> | Async function which should return a generated AltText object. | types.ts:185 |
hideSettings? | boolean | Hide the aggregations/filter settings sidebar. | types.ts:138 |
parentHasHeight? | boolean | Indicates if the parent component has a fixed height. If this is set to false, the plot will occupy the full viewport height. When set to true, the plot will fit entirely within the parent component. Defaults to false. | types.ts:146 |
provVis? | SidebarProps | Sidebar options for the provVis component. | types.ts:162 |
visibleDatasetAttributes? | string[] | List of attribute names (strings) which should be visualized. Defaults to the first 3 if no value is provided. If an empty list is provided, displays no attributes. | types.ts:114 |
visualizeUpsetAttributes? | boolean | Whether or not to visualize UpSet generated attributes (degree and deviation). Defaults to false. | types.ts:120 |