netlify[bot]
commented
2 months ago Deploy Preview for upset2 ready!
| Name | Link |
|---|---|
| Latest commit | 0d822f4e06f0582d86042cc7afd2e35b7d98b0ef |
| Latest deploy log | https://app.netlify.com/sites/upset2/deploys/6669c5279a12df00087810e3 |
| Deploy Preview | https://deploy-preview-361--upset2.netlify.app |
| Preview on mobile | Toggle QR Code...Use your smartphone camera to open QR code link. |
To edit notification comments on pull requests, go to your Netlify site configuration.
Does this PR close any open issues?
Closes #25
Give a longer description of what this PR addresses and why it's needed
This PR adds/improves upon the ability for UpSet 2.0 to be used as a react component. With this, there are many additions or changes to the UpSet props, documentation, etc.
All UpSet component props: (from the readme updates)
data: The data for the Upset component. See UpSet 2.0 Data for more information.config(optional): The configuration options for the Upset component. This can be partial. See Configuration Options for more details.visualizeAttributes(optional)(string[]): List of attribute names (strings) which should be loaded. Defaults to the first 3 if no value is provided. If an empty list is provided, displays no attributes.visualizeUpsetAttributes(optional)(boolean): Whether or not to visualize UpSet generated attributes (degree, anddeviation). Defaults tofalse.allowAttributeRemoval(optional)(boolean): Whether or not to allow the user to remove attribute columns. This should be enabled only if there is an option for users to re-add attributes which have been removed. Defaults tofalse.hideSettings(optional)(boolean): Hide the aggregations/filter settings sidebar.parentHasHeight(optional)(boolean): Indicates if the parent component has a fixed height. Defaults tofalse.yOffset(optional)(number): Offset from the top of the viewport. Defaults to 0.extProvenance(optional): 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 a provenance structure that can use the UpSet actions. Provenance is still tracked if nothing is provided.provVis(optional): Sidebar options for the provenance visualization sidebar. See Trrack-Vis for more information about Trrack provenance visualization.elementSidebar(optional): Sidebar options for the element visualization sidebar. This sidebar is used for element queries, element selection datatable, and supplimental plot generation.altTextSidebar(optional): Sidebar options for the text description sidebar. This sidebar is used to display the generated text descriptions for an Upset 2.0 plot, given that thegeneratedAltTextfunction is provided.generateAltText(optional)(() => Promise<AltText>): Async function which should return a generated AltText object. See Alt Text Generation for more information about Alt Text generation.Provide pictures/videos of the behavior before and after these changes (optional)
No behavior changes for UpSet app.
Have you added or updated relevant tests?
Have you added or updated relevant documentation?
Are there any additional TODOs before this PR is ready to go?
TODOs: