Developer Reference / @visdesignlab/upset2-react / Upset
Variable: Upset
constUpset:FC<UpsetProps>
Defined in: components/Upset.tsx:32
Renders the Upset component.
Component
Param
The data for the Upset component.
Param
The configuration options for the Upset component. This can be partial. Note that if extProvenance is also passed, the most recent state from extProvenance is used instead of this
Param
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.
Param
Whether or not to visualize UpSet generated attributes (degree and deviation). Defaults to false.
Param
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.
Param
Hide the aggregations/filter settings sidebar.
Param
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.
Param
Whether or not the user has plot information edit permissions.
Param
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. See App.tsx to see how UpSet 2.0 and Multinet use an external Trrack object. Note that initializeProvenanceTracking and getActions are used to ensure that the provided provenance object is compatible.
Param
The provenance visualization sidebar options.
Param
The element sidebar options. This sidebar is used for element queries, element selection datatable, and supplimental plot generation.
Param
The alternative text sidebar options. This sidebar is used to display the generated text descriptions for an Upset 2.0 plot, given that the generateAltText function is provided.
Param
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.
Param
The function to generate alternative text.
Returns
The rendered Upset component.