diff --git a/enums/_visdesignlab_upset2_core.AttributePlotType.html b/enums/_visdesignlab_upset2_core.AttributePlotType.html index 5c128c0ca..f388474cd 100644 --- a/enums/_visdesignlab_upset2_core.AttributePlotType.html +++ b/enums/_visdesignlab_upset2_core.AttributePlotType.html @@ -1,7 +1,7 @@ AttributePlotType | UpSet 2.0

Represents the different types of attribute plots. Enum value is used here so that the values can be used as keys in upset package.

-

Enumeration Members

Enumeration Members

Enumeration Members

BoxPlot: "Box Plot"
DensityPlot: "Density Plot"
DotPlot: "Dot Plot"
StripPlot: "Strip Plot"

Generated using TypeDoc

\ No newline at end of file +

Enumeration Members

BoxPlot: "Box Plot"
DensityPlot: "Density Plot"
DotPlot: "Dot Plot"
StripPlot: "Strip Plot"

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/_visdesignlab_upset2_core.areRowsAggregates.html b/functions/_visdesignlab_upset2_core.areRowsAggregates.html index fc0eb4df9..dded75a6f 100644 --- a/functions/_visdesignlab_upset2_core.areRowsAggregates.html +++ b/functions/_visdesignlab_upset2_core.areRowsAggregates.html @@ -1,4 +1,4 @@ areRowsAggregates | UpSet 2.0
  • Checks if the given rows are aggregates.

    Parameters

    • rr: Rows

      The rows to check.

    Returns rr is Aggregates

    true if the rows are aggregates, false otherwise.

    -

Generated using TypeDoc

\ No newline at end of file +

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/_visdesignlab_upset2_core.areRowsSubsets.html b/functions/_visdesignlab_upset2_core.areRowsSubsets.html index 74603615d..8898ce466 100644 --- a/functions/_visdesignlab_upset2_core.areRowsSubsets.html +++ b/functions/_visdesignlab_upset2_core.areRowsSubsets.html @@ -1,4 +1,4 @@ areRowsSubsets | UpSet 2.0
  • Checks if the given rows are subsets.

    Parameters

    • rr: Rows

      The rows to check.

    Returns rr is Subsets

    True if the rows are subsets, false otherwise.

    -

Generated using TypeDoc

\ No newline at end of file +

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/_visdesignlab_upset2_core.convertConfig.html b/functions/_visdesignlab_upset2_core.convertConfig.html index d9e349036..17299c288 100644 --- a/functions/_visdesignlab_upset2_core.convertConfig.html +++ b/functions/_visdesignlab_upset2_core.convertConfig.html @@ -4,4 +4,4 @@ this should not happen in practice but if it does, there will likely be other errors downstream.

Parameters

Returns UpsetConfig

The converted config; the same object as the input config.

-

Generated using TypeDoc

\ No newline at end of file +

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/_visdesignlab_upset2_core.elementSelectionToBookmark.html b/functions/_visdesignlab_upset2_core.elementSelectionToBookmark.html index c60c02bce..84a0c6138 100644 --- a/functions/_visdesignlab_upset2_core.elementSelectionToBookmark.html +++ b/functions/_visdesignlab_upset2_core.elementSelectionToBookmark.html @@ -3,4 +3,4 @@ Truncates keys to 16 characters and values to 2 sig figs.

Parameters

Returns BookmarkedSelection

The element selection.

-

Generated using TypeDoc

\ No newline at end of file +

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/_visdesignlab_upset2_core.elementSelectionsEqual.html b/functions/_visdesignlab_upset2_core.elementSelectionsEqual.html index 527d0af45..1930f18b8 100644 --- a/functions/_visdesignlab_upset2_core.elementSelectionsEqual.html +++ b/functions/_visdesignlab_upset2_core.elementSelectionsEqual.html @@ -4,4 +4,4 @@
  • b: undefined | ElementSelection

    The second element selection

  • decimalPlaces: number = 4

    The number of decimal places to use when comparing equality of numbers, default 4

  • Returns boolean

    Whether a and b are equal

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/_visdesignlab_upset2_core.filterRR.html b/functions/_visdesignlab_upset2_core.filterRR.html index 95bfd9a7a..9947f2e02 100644 --- a/functions/_visdesignlab_upset2_core.filterRR.html +++ b/functions/_visdesignlab_upset2_core.filterRR.html @@ -2,4 +2,4 @@

    Parameters

    Returns Rows

    The filtered rows based on the RR algorithm and the provided filters.

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/_visdesignlab_upset2_core.filterRows.html b/functions/_visdesignlab_upset2_core.filterRows.html index 2c54e864d..50d7bd710 100644 --- a/functions/_visdesignlab_upset2_core.filterRows.html +++ b/functions/_visdesignlab_upset2_core.filterRows.html @@ -2,4 +2,4 @@

    Parameters

    Returns Rows

    The filtered rows.

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/_visdesignlab_upset2_core.firstAggRR.html b/functions/_visdesignlab_upset2_core.firstAggRR.html index aa4c91043..1a8a4aaa2 100644 --- a/functions/_visdesignlab_upset2_core.firstAggRR.html +++ b/functions/_visdesignlab_upset2_core.firstAggRR.html @@ -2,4 +2,4 @@

    Parameters

    Returns Rows

    The result of the first aggregation.

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/_visdesignlab_upset2_core.firstAggregation.html b/functions/_visdesignlab_upset2_core.firstAggregation.html index 3a4a368d5..555ed0e6c 100644 --- a/functions/_visdesignlab_upset2_core.firstAggregation.html +++ b/functions/_visdesignlab_upset2_core.firstAggregation.html @@ -6,4 +6,4 @@
  • items: Items

    The items associated with the subsets.

  • attributeColumns: string[]

    The attribute columns to be considered during aggregation.

  • Returns Rows

    The aggregated rows.

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/_visdesignlab_upset2_core.flattenedOnlyRows.html b/functions/_visdesignlab_upset2_core.flattenedOnlyRows.html index 288c79aa2..84469e785 100644 --- a/functions/_visdesignlab_upset2_core.flattenedOnlyRows.html +++ b/functions/_visdesignlab_upset2_core.flattenedOnlyRows.html @@ -3,4 +3,4 @@

    Parameters

    Returns {
        [key: string]: Row;
    }

    An object containing only the rows.

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/_visdesignlab_upset2_core.flattenedRows.html b/functions/_visdesignlab_upset2_core.flattenedRows.html index 2bc4a4ece..f7f7776b7 100644 --- a/functions/_visdesignlab_upset2_core.flattenedRows.html +++ b/functions/_visdesignlab_upset2_core.flattenedRows.html @@ -2,4 +2,4 @@

    Parameters

    Returns RenderRow[]

    The flattened rows of data.

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/_visdesignlab_upset2_core.getAggSize.html b/functions/_visdesignlab_upset2_core.getAggSize.html index 6686e9525..7d4290e4f 100644 --- a/functions/_visdesignlab_upset2_core.getAggSize.html +++ b/functions/_visdesignlab_upset2_core.getAggSize.html @@ -3,4 +3,4 @@ If the row contains items, recursively calculates the aggregate size of each item.

    Parameters

    Returns number

    The aggregate size of the row.

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/_visdesignlab_upset2_core.getBelongingSetsFromSetMembership.html b/functions/_visdesignlab_upset2_core.getBelongingSetsFromSetMembership.html index d99a7c36b..5560d0807 100644 --- a/functions/_visdesignlab_upset2_core.getBelongingSetsFromSetMembership.html +++ b/functions/_visdesignlab_upset2_core.getBelongingSetsFromSetMembership.html @@ -1,4 +1,4 @@ getBelongingSetsFromSetMembership | UpSet 2.0
    • Retrieves the belonging sets from a set membership object.

      Parameters

      Returns string[]

      An array of strings representing the belonging sets.

      -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/_visdesignlab_upset2_core.getDegreeFromSetMembership.html b/functions/_visdesignlab_upset2_core.getDegreeFromSetMembership.html index 5916dd411..9eed9a710 100644 --- a/functions/_visdesignlab_upset2_core.getDegreeFromSetMembership.html +++ b/functions/_visdesignlab_upset2_core.getDegreeFromSetMembership.html @@ -2,4 +2,4 @@ The degree of set membership is the number of sets in which the subset is comprised of.

    Parameters

    Returns number

    The degree of set membership.

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/_visdesignlab_upset2_core.getId.html b/functions/_visdesignlab_upset2_core.getId.html index 67f599a8d..4b7c817a5 100644 --- a/functions/_visdesignlab_upset2_core.getId.html +++ b/functions/_visdesignlab_upset2_core.getId.html @@ -3,4 +3,4 @@

    Parameters

    Returns string

    The generated ID.

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/_visdesignlab_upset2_core.getItems.html b/functions/_visdesignlab_upset2_core.getItems.html index 2a797e96d..b29c50af9 100644 --- a/functions/_visdesignlab_upset2_core.getItems.html +++ b/functions/_visdesignlab_upset2_core.getItems.html @@ -4,4 +4,4 @@ The returned items are unique (no duplicates).

    Parameters

    Returns string[]

    An array of unique items from the row.

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/_visdesignlab_upset2_core.getRows.html b/functions/_visdesignlab_upset2_core.getRows.html index 04a84be23..b66c994a6 100644 --- a/functions/_visdesignlab_upset2_core.getRows.html +++ b/functions/_visdesignlab_upset2_core.getRows.html @@ -2,4 +2,4 @@

    Parameters

    Returns Rows

    The filtered rows of data.

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/_visdesignlab_upset2_core.getSixNumberSummary.html b/functions/_visdesignlab_upset2_core.getSixNumberSummary.html index 68e225954..208d0ab5a 100644 --- a/functions/_visdesignlab_upset2_core.getSixNumberSummary.html +++ b/functions/_visdesignlab_upset2_core.getSixNumberSummary.html @@ -3,4 +3,4 @@
  • memberItems: string[]

    The member items to consider.

  • attributeColumns: string[]

    The attribute columns to calculate the summary for.

  • Returns AttributeList

    An object containing the five-number summary for each attribute.

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/_visdesignlab_upset2_core.getSubsets.html b/functions/_visdesignlab_upset2_core.getSubsets.html index 95332e487..f33b6a6d0 100644 --- a/functions/_visdesignlab_upset2_core.getSubsets.html +++ b/functions/_visdesignlab_upset2_core.getSubsets.html @@ -4,4 +4,4 @@
  • vSets: string[]

    The vSets used to calculate subsets.

  • attributeColumns: string[]

    The attribute columns used to calculate subsets.

  • Returns Subsets

    The calculated subsets.

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/_visdesignlab_upset2_core.isAggregate.html b/functions/_visdesignlab_upset2_core.isAggregate.html index f93b76ea6..a507b8de4 100644 --- a/functions/_visdesignlab_upset2_core.isAggregate.html +++ b/functions/_visdesignlab_upset2_core.isAggregate.html @@ -1,3 +1,3 @@ isAggregate | UpSet 2.0

    Generated using TypeDoc

    \ No newline at end of file +

    Returns a is Aggregate

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/_visdesignlab_upset2_core.isAggregateBy.html b/functions/_visdesignlab_upset2_core.isAggregateBy.html index 3db00edc4..5292210c8 100644 --- a/functions/_visdesignlab_upset2_core.isAggregateBy.html +++ b/functions/_visdesignlab_upset2_core.isAggregateBy.html @@ -1,3 +1,3 @@ isAggregateBy | UpSet 2.0
    • Type guard for aggregateBy

      Parameters

      • a: unknown

        variable to check

        -

      Returns a is "Degree" | "Sets" | "Deviations" | "Overlaps" | "None"

    Generated using TypeDoc

    \ No newline at end of file +

    Returns a is "Degree" | "Sets" | "Deviations" | "Overlaps" | "None"

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/_visdesignlab_upset2_core.isAltText.html b/functions/_visdesignlab_upset2_core.isAltText.html index 863337e87..7ce32d27b 100644 --- a/functions/_visdesignlab_upset2_core.isAltText.html +++ b/functions/_visdesignlab_upset2_core.isAltText.html @@ -1,4 +1,4 @@ isAltText | UpSet 2.0
    • Type guard for AltText

      Parameters

      • val: unknown

        The value to check

      Returns val is AltText

      whether val is an AltText

      -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/_visdesignlab_upset2_core.isAttributePlots.html b/functions/_visdesignlab_upset2_core.isAttributePlots.html index ca519dc9b..e9ad4e22b 100644 --- a/functions/_visdesignlab_upset2_core.isAttributePlots.html +++ b/functions/_visdesignlab_upset2_core.isAttributePlots.html @@ -1,4 +1,4 @@ isAttributePlots | UpSet 2.0

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/_visdesignlab_upset2_core.isBaseElement.html b/functions/_visdesignlab_upset2_core.isBaseElement.html index f9f1d65be..714e7e8af 100644 --- a/functions/_visdesignlab_upset2_core.isBaseElement.html +++ b/functions/_visdesignlab_upset2_core.isBaseElement.html @@ -1,3 +1,3 @@ isBaseElement | UpSet 2.0

    Generated using TypeDoc

    \ No newline at end of file +

    Returns r is BaseElement

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/_visdesignlab_upset2_core.isBaseIntersection.html b/functions/_visdesignlab_upset2_core.isBaseIntersection.html index 120453796..8eed4c79d 100644 --- a/functions/_visdesignlab_upset2_core.isBaseIntersection.html +++ b/functions/_visdesignlab_upset2_core.isBaseIntersection.html @@ -1,3 +1,3 @@ isBaseIntersection | UpSet 2.0

    Generated using TypeDoc

    \ No newline at end of file +

    Returns i is BaseIntersection

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/_visdesignlab_upset2_core.isBookmark.html b/functions/_visdesignlab_upset2_core.isBookmark.html index 72b6b1518..dbc608bf2 100644 --- a/functions/_visdesignlab_upset2_core.isBookmark.html +++ b/functions/_visdesignlab_upset2_core.isBookmark.html @@ -1,3 +1,3 @@ isBookmark | UpSet 2.0

    Generated using TypeDoc

    \ No newline at end of file +

    Returns b is Bookmark

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/_visdesignlab_upset2_core.isBookmarkedIntersection.html b/functions/_visdesignlab_upset2_core.isBookmarkedIntersection.html index fca09617e..cc3803d5b 100644 --- a/functions/_visdesignlab_upset2_core.isBookmarkedIntersection.html +++ b/functions/_visdesignlab_upset2_core.isBookmarkedIntersection.html @@ -1,4 +1,4 @@ isBookmarkedIntersection | UpSet 2.0

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/_visdesignlab_upset2_core.isBookmarkedSelection.html b/functions/_visdesignlab_upset2_core.isBookmarkedSelection.html index a6b9ca815..c0d7b4419 100644 --- a/functions/_visdesignlab_upset2_core.isBookmarkedSelection.html +++ b/functions/_visdesignlab_upset2_core.isBookmarkedSelection.html @@ -1,3 +1,3 @@ isBookmarkedSelection | UpSet 2.0

    Generated using TypeDoc

    \ No newline at end of file +

    Returns b is BookmarkedSelection

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/_visdesignlab_upset2_core.isColumn.html b/functions/_visdesignlab_upset2_core.isColumn.html index 912084fc4..e4f0316cf 100644 --- a/functions/_visdesignlab_upset2_core.isColumn.html +++ b/functions/_visdesignlab_upset2_core.isColumn.html @@ -1,3 +1,3 @@ isColumn | UpSet 2.0

    Generated using TypeDoc

    \ No newline at end of file +

    Returns c is Column

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/_visdesignlab_upset2_core.isElementSelection.html b/functions/_visdesignlab_upset2_core.isElementSelection.html index 5b8307c0d..218f19680 100644 --- a/functions/_visdesignlab_upset2_core.isElementSelection.html +++ b/functions/_visdesignlab_upset2_core.isElementSelection.html @@ -1,4 +1,4 @@ isElementSelection | UpSet 2.0
    • Validates that the given value is an ElementSelection.

      Parameters

      • value: unknown

        The value to check.

      Returns value is ElementSelection

      whether the value is an ElementSelection.

      -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/_visdesignlab_upset2_core.isHistogram.html b/functions/_visdesignlab_upset2_core.isHistogram.html index da95a1293..48d99788b 100644 --- a/functions/_visdesignlab_upset2_core.isHistogram.html +++ b/functions/_visdesignlab_upset2_core.isHistogram.html @@ -1,3 +1,3 @@ isHistogram | UpSet 2.0

    Generated using TypeDoc

    \ No newline at end of file +

    Returns h is Histogram

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/_visdesignlab_upset2_core.isObject.html b/functions/_visdesignlab_upset2_core.isObject.html index b26e1aa3e..c6e70ad9b 100644 --- a/functions/_visdesignlab_upset2_core.isObject.html +++ b/functions/_visdesignlab_upset2_core.isObject.html @@ -1,3 +1,3 @@ isObject | UpSet 2.0
    • Checks that a value is not null/undefined and has type object

      Parameters

      • v: unknown

        The value

        -

      Returns v is object

    Generated using TypeDoc

    \ No newline at end of file +

    Returns v is object

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/_visdesignlab_upset2_core.isPlotInformation.html b/functions/_visdesignlab_upset2_core.isPlotInformation.html index d2f4563e7..acaae643e 100644 --- a/functions/_visdesignlab_upset2_core.isPlotInformation.html +++ b/functions/_visdesignlab_upset2_core.isPlotInformation.html @@ -1,3 +1,3 @@ isPlotInformation | UpSet 2.0

    Generated using TypeDoc

    \ No newline at end of file +

    Returns p is PlotInformation

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/_visdesignlab_upset2_core.isRow.html b/functions/_visdesignlab_upset2_core.isRow.html index 80cb8e932..340dc7aa2 100644 --- a/functions/_visdesignlab_upset2_core.isRow.html +++ b/functions/_visdesignlab_upset2_core.isRow.html @@ -1,3 +1,3 @@ isRow | UpSet 2.0
    • Type guard for Row

      Parameters

      • r: unknown

        variable to check

        -

      Returns r is Row

    Generated using TypeDoc

    \ No newline at end of file +

    Returns r is Row

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/_visdesignlab_upset2_core.isRowAggregate.html b/functions/_visdesignlab_upset2_core.isRowAggregate.html index 36ca4fa56..ff5110532 100644 --- a/functions/_visdesignlab_upset2_core.isRowAggregate.html +++ b/functions/_visdesignlab_upset2_core.isRowAggregate.html @@ -1,4 +1,4 @@ isRowAggregate | UpSet 2.0
    • Checks if a given row is an aggregate.

      Parameters

      • row: Row

        The row to check.

      Returns row is Aggregate

      True if the row is an aggregate, false otherwise.

      -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/_visdesignlab_upset2_core.isRowSubset.html b/functions/_visdesignlab_upset2_core.isRowSubset.html index e4656687d..574c47652 100644 --- a/functions/_visdesignlab_upset2_core.isRowSubset.html +++ b/functions/_visdesignlab_upset2_core.isRowSubset.html @@ -1,4 +1,4 @@ isRowSubset | UpSet 2.0

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/_visdesignlab_upset2_core.isRowType.html b/functions/_visdesignlab_upset2_core.isRowType.html index 549d33e29..45695b515 100644 --- a/functions/_visdesignlab_upset2_core.isRowType.html +++ b/functions/_visdesignlab_upset2_core.isRowType.html @@ -1,3 +1,3 @@ isRowType | UpSet 2.0

    Generated using TypeDoc

    \ No newline at end of file +

    Returns t is RowType

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/_visdesignlab_upset2_core.isScatterplot.html b/functions/_visdesignlab_upset2_core.isScatterplot.html index b5ff4ac96..7343b05bd 100644 --- a/functions/_visdesignlab_upset2_core.isScatterplot.html +++ b/functions/_visdesignlab_upset2_core.isScatterplot.html @@ -1,3 +1,3 @@ isScatterplot | UpSet 2.0

    Generated using TypeDoc

    \ No newline at end of file +

    Returns s is Scatterplot

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/_visdesignlab_upset2_core.isSubset.html b/functions/_visdesignlab_upset2_core.isSubset.html index 23871c2d1..2389c7960 100644 --- a/functions/_visdesignlab_upset2_core.isSubset.html +++ b/functions/_visdesignlab_upset2_core.isSubset.html @@ -1,3 +1,3 @@ isSubset | UpSet 2.0

    Generated using TypeDoc

    \ No newline at end of file +

    Returns s is BaseIntersection

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/_visdesignlab_upset2_core.isSubsets.html b/functions/_visdesignlab_upset2_core.isSubsets.html index f71c7ea5e..42bf927a8 100644 --- a/functions/_visdesignlab_upset2_core.isSubsets.html +++ b/functions/_visdesignlab_upset2_core.isSubsets.html @@ -1,3 +1,3 @@ isSubsets | UpSet 2.0

    Generated using TypeDoc

    \ No newline at end of file +

    Returns s is Subsets

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/_visdesignlab_upset2_core.isUpsetConfig.html b/functions/_visdesignlab_upset2_core.isUpsetConfig.html index 10819138a..581a5c2ce 100644 --- a/functions/_visdesignlab_upset2_core.isUpsetConfig.html +++ b/functions/_visdesignlab_upset2_core.isUpsetConfig.html @@ -1,4 +1,4 @@ isUpsetConfig | UpSet 2.0
    • Determines if the given object is a valid UpsetConfig using the CURRENT version.

      Parameters

      • config: unknown

        The object to check.

      Returns config is UpsetConfig

      Whether the object is a valid UpsetConfig.

      -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/_visdesignlab_upset2_core.process.html b/functions/_visdesignlab_upset2_core.process.html index 2f865f20c..751008307 100644 --- a/functions/_visdesignlab_upset2_core.process.html +++ b/functions/_visdesignlab_upset2_core.process.html @@ -2,4 +2,4 @@

    Parameters

    Returns CoreUpsetData

    The core upset data object.

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/_visdesignlab_upset2_core.rowsCount.html b/functions/_visdesignlab_upset2_core.rowsCount.html index 985bc354d..19336a4df 100644 --- a/functions/_visdesignlab_upset2_core.rowsCount.html +++ b/functions/_visdesignlab_upset2_core.rowsCount.html @@ -2,4 +2,4 @@

    Parameters

    Returns number

    The number of rows in the data.

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/_visdesignlab_upset2_core.secondAggRR.html b/functions/_visdesignlab_upset2_core.secondAggRR.html index b9231023c..d4c56e0be 100644 --- a/functions/_visdesignlab_upset2_core.secondAggRR.html +++ b/functions/_visdesignlab_upset2_core.secondAggRR.html @@ -4,4 +4,4 @@

    Parameters

    Returns Subsets | Aggregates

    The second-level aggregation result.

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/_visdesignlab_upset2_core.secondAggregation.html b/functions/_visdesignlab_upset2_core.secondAggregation.html index be757b82f..5b2820f9b 100644 --- a/functions/_visdesignlab_upset2_core.secondAggregation.html +++ b/functions/_visdesignlab_upset2_core.secondAggregation.html @@ -6,4 +6,4 @@
  • items: Items

    The items data.

  • attributeColumns: string[]

    The attribute columns to consider.

  • Returns Aggregates

    The aggregated result.

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/_visdesignlab_upset2_core.sortByRR.html b/functions/_visdesignlab_upset2_core.sortByRR.html index 399118484..169836572 100644 --- a/functions/_visdesignlab_upset2_core.sortByRR.html +++ b/functions/_visdesignlab_upset2_core.sortByRR.html @@ -2,4 +2,4 @@

    Parameters

    Returns Rows

    The sorted rows based on the RR and the provided sorting options.

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/_visdesignlab_upset2_core.sortRows.html b/functions/_visdesignlab_upset2_core.sortRows.html index 2c2eadfad..b56672642 100644 --- a/functions/_visdesignlab_upset2_core.sortRows.html +++ b/functions/_visdesignlab_upset2_core.sortRows.html @@ -5,4 +5,4 @@
  • visibleSets: Sets

    The visible sets.

  • Optional sortByOrder: SortByOrder

    The sort order.

  • Returns Rows

    The sorted rows.

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/_visdesignlab_upset2_react.Upset.html b/functions/_visdesignlab_upset2_react.Upset.html index 0f990fa6b..8e1983c16 100644 --- a/functions/_visdesignlab_upset2_react.Upset.html +++ b/functions/_visdesignlab_upset2_react.Upset.html @@ -1,3 +1,3 @@ Upset | UpSet 2.0
    • Renders the Upset component.

      Parameters

      • props: PropsWithChildren<UpsetProps>
      • Optional context: any

      Returns null | ReactElement<any, any>

      The rendered Upset component.

      -

      Component

    Generated using TypeDoc

    \ No newline at end of file +

    Component

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/_visdesignlab_upset2_react.downloadSVG.html b/functions/_visdesignlab_upset2_react.downloadSVG.html index 6a060b82a..c16b3a436 100644 --- a/functions/_visdesignlab_upset2_react.downloadSVG.html +++ b/functions/_visdesignlab_upset2_react.downloadSVG.html @@ -1,3 +1,3 @@ downloadSVG | UpSet 2.0
    • Downloads an SVG file of the current UpSet plot.

      Parameters

      • filename: string = ...

        The name of the downloaded file. Defaults to "upset-plot-{current date}".

        -

      Returns void

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/_visdesignlab_upset2_react.exportProcessedData.html b/functions/_visdesignlab_upset2_react.exportProcessedData.html index 09c45217b..40c34b740 100644 --- a/functions/_visdesignlab_upset2_react.exportProcessedData.html +++ b/functions/_visdesignlab_upset2_react.exportProcessedData.html @@ -1,4 +1,4 @@ exportProcessedData | UpSet 2.0
    • Exports processed data as a JSON file.

      Parameters

      • rows: Rows

        The data to be exported.

      • Optional accessible: boolean

        Optional parameter indicating whether the exported data should fit the accessible datatype.

        -

      Returns void

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/_visdesignlab_upset2_react.exportRawData.html b/functions/_visdesignlab_upset2_react.exportRawData.html index 77b6b8709..5809cf0b0 100644 --- a/functions/_visdesignlab_upset2_react.exportRawData.html +++ b/functions/_visdesignlab_upset2_react.exportRawData.html @@ -1,3 +1,3 @@ exportRawData | UpSet 2.0

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/_visdesignlab_upset2_react.exportState.html b/functions/_visdesignlab_upset2_react.exportState.html index d2df4caa5..7d57b144c 100644 --- a/functions/_visdesignlab_upset2_react.exportState.html +++ b/functions/_visdesignlab_upset2_react.exportState.html @@ -2,4 +2,4 @@

    Parameters

    Returns void

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/_visdesignlab_upset2_react.getAccessibleData.html b/functions/_visdesignlab_upset2_react.getAccessibleData.html index 7fa641520..007f03fca 100644 --- a/functions/_visdesignlab_upset2_react.getAccessibleData.html +++ b/functions/_visdesignlab_upset2_react.getAccessibleData.html @@ -2,4 +2,4 @@

    Parameters

    Returns AccessibleData

    The accessible data.

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/_visdesignlab_upset2_react.getActions.html b/functions/_visdesignlab_upset2_react.getActions.html index 34711a152..353e7f0bb 100644 --- a/functions/_visdesignlab_upset2_react.getActions.html +++ b/functions/_visdesignlab_upset2_react.getActions.html @@ -9,4 +9,4 @@

    Returns any

  • removeVisibleSet: ((set) => any)
  • replaceState: ((state) => any)
  • secondAggregateBy: ((aggBy) => any)
  • secondOverlapBy: ((overlap) => any)
  • setElementSelection: ((selection) => any)

    Sets a global element selection for the plot, which is a filter on items based on their attributes.

  • setHideEmpty: ((val) => any)
  • setHideNoSet: ((val) => any)
  • setMaxVisible: ((val) => any)
  • setMinVisible: ((val) => any)
  • setPlotInformation: ((plotInformation) => any)
  • setSelected: ((intersection) => any)
  • setUseUserAltText: ((useUserAlt) => any)
  • setUserAltText: ((altText) => any)
  • sortBy: ((sort, sortByOrder) => any)
  • sortVisibleBy: ((sort) => any)
  • updateAttributePlotType: ((attr, plotType) => any)
  • Generated using TypeDoc

    \ No newline at end of file +

    Returns any

  • setHideEmpty: ((val) => any)
  • setHideNoSet: ((val) => any)
  • setMaxVisible: ((val) => any)
  • setMinVisible: ((val) => any)
  • setPlotInformation: ((plotInformation) => any)
  • setSelected: ((intersection) => any)
  • setUseUserAltText: ((useUserAlt) => any)
  • setUserAltText: ((altText) => any)
  • sortBy: ((sort, sortByOrder) => any)
  • sortVisibleBy: ((sort) => any)
  • updateAttributePlotType: ((attr, plotType) => any)
  • Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/_visdesignlab_upset2_react.getAltTextConfig.html b/functions/_visdesignlab_upset2_react.getAltTextConfig.html index 50f1de104..388101bed 100644 --- a/functions/_visdesignlab_upset2_react.getAltTextConfig.html +++ b/functions/_visdesignlab_upset2_react.getAltTextConfig.html @@ -3,4 +3,4 @@
  • data: CoreUpsetData

    The CoreUpsetData object.

  • rows: Rows

    The Rows object.

  • Returns AltTextConfig

    The AltTextConfig object.

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/_visdesignlab_upset2_react.initializeProvenanceTracking.html b/functions/_visdesignlab_upset2_react.initializeProvenanceTracking.html index f80603e79..e280811ab 100644 --- a/functions/_visdesignlab_upset2_react.initializeProvenanceTracking.html +++ b/functions/_visdesignlab_upset2_react.initializeProvenanceTracking.html @@ -1 +1 @@ -initializeProvenanceTracking | UpSet 2.0

    Generated using TypeDoc

    \ No newline at end of file +initializeProvenanceTracking | UpSet 2.0

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_visdesignlab_upset2_react.AltText.html b/interfaces/_visdesignlab_upset2_react.AltText.html index 62cc8d1a6..cb0cc0153 100644 --- a/interfaces/_visdesignlab_upset2_react.AltText.html +++ b/interfaces/_visdesignlab_upset2_react.AltText.html @@ -1,11 +1,11 @@ AltText | UpSet 2.0

    Represents the alternative text for an Upset plot.

    -
    interface AltText {
        longDescription: string;
        shortDescription: string;
        techniqueDescription: string;
        warnings?: string;
    }

    Properties

    interface AltText {
        longDescription: string;
        shortDescription: string;
        techniqueDescription: string;
        warnings?: string;
    }

    Properties

    longDescription: string

    The long description for the Upset plot.

    -
    shortDescription: string

    The short description for the Upset plot.

    -
    techniqueDescription: string

    The technique description for the Upset plot.

    -
    warnings?: string

    Optional warnings for the Upset plot. +

    shortDescription: string

    The short description for the Upset plot.

    +
    techniqueDescription: string

    The technique description for the Upset plot.

    +
    warnings?: string

    Optional warnings for the Upset plot. Not yet implemented by the API as of 4/22/24

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_visdesignlab_upset2_react.SidebarProps.html b/interfaces/_visdesignlab_upset2_react.SidebarProps.html index f600b4a9c..f31ea2179 100644 --- a/interfaces/_visdesignlab_upset2_react.SidebarProps.html +++ b/interfaces/_visdesignlab_upset2_react.SidebarProps.html @@ -1,6 +1,6 @@ SidebarProps | UpSet 2.0

    Props for providing functions to open and close any sidebar.

    -
    interface SidebarProps {
        close: (() => void);
        open: boolean;
    }

    Properties

    interface SidebarProps {
        close: (() => void);
        open: boolean;
    }

    Properties

    Properties

    close: (() => void)

    Callback function to close the sidebar.

    -

    Type declaration

      • (): void
      • Returns void

    open: boolean

    Indicates whether the sidebar is open or closed.

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    open: boolean

    Indicates whether the sidebar is open or closed.

    +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_visdesignlab_upset2_react.UpsetItem.html b/interfaces/_visdesignlab_upset2_react.UpsetItem.html index 2373fb5ce..cdba13af9 100644 --- a/interfaces/_visdesignlab_upset2_react.UpsetItem.html +++ b/interfaces/_visdesignlab_upset2_react.UpsetItem.html @@ -1,3 +1,3 @@ UpsetItem | UpSet 2.0

    Raw data object for an UpSet plot. This is used to generate the processed data. Column annotations are inferred from the data types.

    -
    interface UpsetItem {
        [key: string]: string | number | boolean;
    }

    Indexable

    [key: string]: string | number | boolean

    Generated using TypeDoc

    \ No newline at end of file +
    interface UpsetItem {
        [key: string]: string | number | boolean;
    }

    Indexable

    [key: string]: string | number | boolean

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_visdesignlab_upset2_react.UpsetProps.html b/interfaces/_visdesignlab_upset2_react.UpsetProps.html index ba7cdc544..13efb7338 100644 --- a/interfaces/_visdesignlab_upset2_react.UpsetProps.html +++ b/interfaces/_visdesignlab_upset2_react.UpsetProps.html @@ -1,5 +1,5 @@ UpsetProps | UpSet 2.0

    Represents the props for the Upset component.

    -
    interface UpsetProps {
        allowAttributeRemoval?: boolean;
        altTextSidebar?: SidebarProps;
        config?: Partial<UpsetConfig>;
        data: CoreUpsetData | UpsetItem[];
        elementSidebar?: SidebarProps;
        extProvenance?: {
            actions: {
                addAttribute: ((attr) => any);
                addBookmark: (<T>(b) => any);
                addCollapsed: ((id) => any);
                addMultipleAttributes: ((attrs) => any);
                addPlot: ((plot) => any);
                addVisibleSet: ((set) => any);
                collapseAll: ((ids) => any);
                expandAll: (() => any);
                firstAggregateBy: ((aggBy) => any);
                firstOverlapBy: ((overlap) => any);
                removeAttribute: ((attr) => any);
                removeBookmark: ((b) => any);
                removeCollapsed: ((id) => any);
                removeMultipleVisibleAttributes: ((attrs) => any);
                removePlot: ((plot) => any);
                removeVisibleSet: ((set) => any);
                replaceState: ((state) => any);
                secondAggregateBy: ((aggBy) => any);
                secondOverlapBy: ((overlap) => any);
                setElementSelection: ((selection) => any);
                setHideEmpty: ((val) => any);
                setHideNoSet: ((val) => any);
                setMaxVisible: ((val) => any);
                setMinVisible: ((val) => any);
                setPlotInformation: ((plotInformation) => any);
                setSelected: ((intersection) => any);
                setUseUserAltText: ((useUserAlt) => any);
                setUserAltText: ((altText) => any);
                sortBy: ((sort, sortByOrder) => any);
                sortVisibleBy: ((sort) => any);
                updateAttributePlotType: ((attr, plotType) => any);
            };
            provenance: Trrack<UpsetConfig, string>;
        };
        generateAltText?: (() => Promise<AltText>);
        hideSettings?: boolean;
        parentHasHeight?: boolean;
        provVis?: SidebarProps;
        visualizeDatasetAttributes?: string[];
        visualizeUpsetAttributes?: boolean;
    }

    Properties

    interface UpsetProps {
        allowAttributeRemoval?: boolean;
        altTextSidebar?: SidebarProps;
        config?: Partial<UpsetConfig>;
        data: CoreUpsetData | UpsetItem[];
        elementSidebar?: SidebarProps;
        extProvenance?: {
            actions: {
                addAttribute: ((attr) => any);
                addBookmark: (<T>(b) => any);
                addCollapsed: ((id) => any);
                addMultipleAttributes: ((attrs) => any);
                addPlot: ((plot) => any);
                addVisibleSet: ((set) => any);
                collapseAll: ((ids) => any);
                expandAll: (() => any);
                firstAggregateBy: ((aggBy) => any);
                firstOverlapBy: ((overlap) => any);
                removeAttribute: ((attr) => any);
                removeBookmark: ((b) => any);
                removeCollapsed: ((id) => any);
                removeMultipleVisibleAttributes: ((attrs) => any);
                removePlot: ((plot) => any);
                removeVisibleSet: ((set) => any);
                replaceState: ((state) => any);
                secondAggregateBy: ((aggBy) => any);
                secondOverlapBy: ((overlap) => any);
                setElementSelection: ((selection) => any);
                setHideEmpty: ((val) => any);
                setHideNoSet: ((val) => any);
                setMaxVisible: ((val) => any);
                setMinVisible: ((val) => any);
                setPlotInformation: ((plotInformation) => any);
                setSelected: ((intersection) => any);
                setUseUserAltText: ((useUserAlt) => any);
                setUserAltText: ((altText) => any);
                sortBy: ((sort, sortByOrder) => any);
                sortVisibleBy: ((sort) => any);
                updateAttributePlotType: ((attr, plotType) => any);
            };
            provenance: Trrack<UpsetConfig, string>;
        };
        generateAltText?: (() => Promise<AltText>);
        hideSettings?: boolean;
        parentHasHeight?: boolean;
        provVis?: SidebarProps;
        visualizeDatasetAttributes?: string[];
        visualizeUpsetAttributes?: boolean;
    }

    Properties

    allowAttributeRemoval? altTextSidebar? config? data @@ -15,13 +15,13 @@ 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.

    -
    altTextSidebar?: SidebarProps

    Sidebar options for the alt text sidebar component. +

    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.

    -
    config?: Partial<UpsetConfig>

    Optional configuration for the Upset component.

    -

    The data for the Upset component.

    -
    elementSidebar?: SidebarProps

    Sidebar options for the element sidebar component. +

    config?: Partial<UpsetConfig>

    Optional configuration for the Upset component.

    +

    The data for the Upset component.

    +
    elementSidebar?: SidebarProps

    Sidebar options for the element sidebar component. This sidebar is used for element queries, element selection datatable, and supplimental plot generation.

    -
    extProvenance?: {
        actions: {
            addAttribute: ((attr) => any);
            addBookmark: (<T>(b) => any);
            addCollapsed: ((id) => any);
            addMultipleAttributes: ((attrs) => any);
            addPlot: ((plot) => any);
            addVisibleSet: ((set) => any);
            collapseAll: ((ids) => any);
            expandAll: (() => any);
            firstAggregateBy: ((aggBy) => any);
            firstOverlapBy: ((overlap) => any);
            removeAttribute: ((attr) => any);
            removeBookmark: ((b) => any);
            removeCollapsed: ((id) => any);
            removeMultipleVisibleAttributes: ((attrs) => any);
            removePlot: ((plot) => any);
            removeVisibleSet: ((set) => any);
            replaceState: ((state) => any);
            secondAggregateBy: ((aggBy) => any);
            secondOverlapBy: ((overlap) => any);
            setElementSelection: ((selection) => any);
            setHideEmpty: ((val) => any);
            setHideNoSet: ((val) => any);
            setMaxVisible: ((val) => any);
            setMinVisible: ((val) => any);
            setPlotInformation: ((plotInformation) => any);
            setSelected: ((intersection) => any);
            setUseUserAltText: ((useUserAlt) => any);
            setUserAltText: ((altText) => any);
            sortBy: ((sort, sortByOrder) => any);
            sortVisibleBy: ((sort) => any);
            updateAttributePlotType: ((attr, plotType) => any);
        };
        provenance: Trrack<UpsetConfig, string>;
    }

    External provenance actions and TrrackJS object for provenance history tracking and actions. +

    extProvenance?: {
        actions: {
            addAttribute: ((attr) => any);
            addBookmark: (<T>(b) => any);
            addCollapsed: ((id) => any);
            addMultipleAttributes: ((attrs) => any);
            addPlot: ((plot) => any);
            addVisibleSet: ((set) => any);
            collapseAll: ((ids) => any);
            expandAll: (() => any);
            firstAggregateBy: ((aggBy) => any);
            firstOverlapBy: ((overlap) => any);
            removeAttribute: ((attr) => any);
            removeBookmark: ((b) => any);
            removeCollapsed: ((id) => any);
            removeMultipleVisibleAttributes: ((attrs) => any);
            removePlot: ((plot) => any);
            removeVisibleSet: ((set) => any);
            replaceState: ((state) => any);
            secondAggregateBy: ((aggBy) => any);
            secondOverlapBy: ((overlap) => any);
            setElementSelection: ((selection) => any);
            setHideEmpty: ((val) => any);
            setHideNoSet: ((val) => any);
            setMaxVisible: ((val) => any);
            setMinVisible: ((val) => any);
            setPlotInformation: ((plotInformation) => any);
            setSelected: ((intersection) => any);
            setUseUserAltText: ((useUserAlt) => any);
            setUserAltText: ((altText) => any);
            sortBy: ((sort, sortByOrder) => any);
            sortVisibleBy: ((sort) => any);
            updateAttributePlotType: ((attr, plotType) => any);
        };
        provenance: Trrack<UpsetConfig, string>;
    }

    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.

    @@ -36,16 +36,16 @@

    Returns any

  • removeVisibleSet: ((set) => any)
      • (set): any
      • Parameters

        • set: string

        Returns any

  • replaceState: ((state) => any)
  • secondAggregateBy: ((aggBy) => any)
      • (aggBy): any
      • Parameters

        • aggBy: "Degree" | "Sets" | "Deviations" | "Overlaps" | "None"

        Returns any

  • secondOverlapBy: ((overlap) => any)
      • (overlap): any
      • Parameters

        • overlap: number

        Returns any

  • setElementSelection: ((selection) => any)

    Sets a global element selection for the plot, which is a filter on items based on their attributes.

      • (selection): any
      • Parameters

        Returns any

  • setHideEmpty: ((val) => any)
      • (val): any
      • Parameters

        • val: boolean

        Returns any

  • setHideNoSet: ((val) => any)
      • (val): any
      • Parameters

        • val: boolean

        Returns any

  • setMaxVisible: ((val) => any)
      • (val): any
      • Parameters

        • val: number

        Returns any

  • setMinVisible: ((val) => any)
      • (val): any
      • Parameters

        • val: number

        Returns any

  • setPlotInformation: ((plotInformation) => any)
      • (plotInformation): any
      • Parameters

        Returns any

  • setSelected: ((intersection) => any)
      • (intersection): any
      • Parameters

        • intersection: null | Row

        Returns any

  • setUseUserAltText: ((useUserAlt) => any)
      • (useUserAlt): any
      • Parameters

        • useUserAlt: boolean

        Returns any

  • setUserAltText: ((altText) => any)
      • (altText): any
      • Parameters

        Returns any

  • sortBy: ((sort, sortByOrder) => any)
      • (sort, sortByOrder): any
      • Parameters

        Returns any

  • sortVisibleBy: ((sort) => any)
      • (sort): any
      • Parameters

        • sort: "Alphabetical" | "Ascending" | "Descending"

        Returns any

  • updateAttributePlotType: ((attr, plotType) => any)
      • (attr, plotType): any
      • Parameters

        • attr: string
        • plotType: string

        Returns any

  • provenance: Trrack<UpsetConfig, string>
  • generateAltText?: (() => Promise<AltText>)

    Async function which should return a generated AltText object.

    -

    Type declaration

    hideSettings?: boolean

    Hide the aggregations/filter settings sidebar.

    -
    parentHasHeight?: boolean

    Indicates if the parent component has a fixed height. +

    Returns any

  • setHideEmpty: ((val) => any)
  • setHideNoSet: ((val) => any)
  • setMaxVisible: ((val) => any)
  • setMinVisible: ((val) => any)
  • setPlotInformation: ((plotInformation) => any)
  • setSelected: ((intersection) => any)
  • setUseUserAltText: ((useUserAlt) => any)
  • setUserAltText: ((altText) => any)
  • sortBy: ((sort, sortByOrder) => any)
  • sortVisibleBy: ((sort) => any)
  • updateAttributePlotType: ((attr, plotType) => any)
  • provenance: Trrack<UpsetConfig, string>
  • generateAltText?: (() => Promise<AltText>)

    Async function which should return a generated AltText object.

    +

    Type declaration

    hideSettings?: boolean

    Hide the aggregations/filter settings sidebar.

    +
    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.

    -
    provVis?: SidebarProps

    Sidebar options for the provVis component.

    -
    visualizeDatasetAttributes?: string[]

    List of attribute names (strings) which should be visualized. +

    provVis?: SidebarProps

    Sidebar options for the provVis component.

    +
    visualizeDatasetAttributes?: 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.

    -
    visualizeUpsetAttributes?: boolean

    Whether or not to visualize UpSet generated attributes (degree and deviation). +

    visualizeUpsetAttributes?: boolean

    Whether or not to visualize UpSet generated attributes (degree and deviation). Defaults to false.

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_visdesignlab_upset2_core.AccessibleData.html b/types/_visdesignlab_upset2_core.AccessibleData.html index 71f9005bd..449ecf770 100644 --- a/types/_visdesignlab_upset2_core.AccessibleData.html +++ b/types/_visdesignlab_upset2_core.AccessibleData.html @@ -1 +1 @@ -AccessibleData | UpSet 2.0
    AccessibleData: {
        values: {
            [row: string]: AccessibleDataEntry;
        };
    }

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file +AccessibleData | UpSet 2.0
    AccessibleData: {
        values: {
            [row: string]: AccessibleDataEntry;
        };
    }

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_visdesignlab_upset2_core.AccessibleDataEntry.html b/types/_visdesignlab_upset2_core.AccessibleDataEntry.html index 988387a9a..7cf2b1723 100644 --- a/types/_visdesignlab_upset2_core.AccessibleDataEntry.html +++ b/types/_visdesignlab_upset2_core.AccessibleDataEntry.html @@ -1 +1 @@ -AccessibleDataEntry | UpSet 2.0
    AccessibleDataEntry: {
        attributes: Attributes;
        degree: number;
        elementName: string;
        id?: string;
        items?: {
            [row: string]: AccessibleDataEntry;
        };
        setMembership?: {
            [set: string]: SetMembershipStatus;
        };
        size: number;
        type: RowType;
    }

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file +AccessibleDataEntry | UpSet 2.0
    AccessibleDataEntry: {
        attributes: Attributes;
        degree: number;
        elementName: string;
        id?: string;
        items?: {
            [row: string]: AccessibleDataEntry;
        };
        setMembership?: {
            [set: string]: SetMembershipStatus;
        };
        size: number;
        type: RowType;
    }

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_visdesignlab_upset2_core.Aggregate.html b/types/_visdesignlab_upset2_core.Aggregate.html index 4e78874ae..4de7a74c2 100644 --- a/types/_visdesignlab_upset2_core.Aggregate.html +++ b/types/_visdesignlab_upset2_core.Aggregate.html @@ -1,2 +1,2 @@ Aggregate | UpSet 2.0
    Aggregate: Omit<Subset, "items"> & {
        aggregateBy: AggregateBy;
        description: string;
        items: Subsets | {
            order: string[];
            values: {
                [agg_id: string]: Aggregate;
            };
        };
        level: number;
    }

    An aggregate row in the plot

    -

    Type declaration

    • aggregateBy: AggregateBy
    • description: string
    • items: Subsets | {
          order: string[];
          values: {
              [agg_id: string]: Aggregate;
          };
      }
    • level: number

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_visdesignlab_upset2_core.AggregateBy.html b/types/_visdesignlab_upset2_core.AggregateBy.html index 116e5b0f4..8c8cbd690 100644 --- a/types/_visdesignlab_upset2_core.AggregateBy.html +++ b/types/_visdesignlab_upset2_core.AggregateBy.html @@ -1,2 +1,2 @@ AggregateBy | UpSet 2.0
    AggregateBy: typeof aggregateByList[number]

    Ways the upset plot can be aggregated

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_visdesignlab_upset2_core.Aggregates.html b/types/_visdesignlab_upset2_core.Aggregates.html index 21e9faf82..a94667e30 100644 --- a/types/_visdesignlab_upset2_core.Aggregates.html +++ b/types/_visdesignlab_upset2_core.Aggregates.html @@ -1 +1 @@ -Aggregates | UpSet 2.0
    Aggregates: {
        order: string[];
        values: {
            [agg_id: string]: Aggregate;
        };
    }

    Type declaration

    • order: string[]
    • values: {
          [agg_id: string]: Aggregate;
      }

    Generated using TypeDoc

    \ No newline at end of file +Aggregates | UpSet 2.0
    Aggregates: {
        order: string[];
        values: {
            [agg_id: string]: Aggregate;
        };
    }

    Type declaration

    • order: string[]
    • values: {
          [agg_id: string]: Aggregate;
      }

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_visdesignlab_upset2_core.AltText.html b/types/_visdesignlab_upset2_core.AltText.html index 2d5a57c44..8ea1b8ae5 100644 --- a/types/_visdesignlab_upset2_core.AltText.html +++ b/types/_visdesignlab_upset2_core.AltText.html @@ -4,4 +4,4 @@
  • Optional techniqueDescription?: string

    The technique description for the Upset plot.

  • Optional warnings?: string

    Optional warnings for the Upset plot. Not yet implemented by the API as of 4/22/24

    -
  • Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_visdesignlab_upset2_core.AltTextConfig.html b/types/_visdesignlab_upset2_core.AltTextConfig.html index 82b746f31..796941295 100644 --- a/types/_visdesignlab_upset2_core.AltTextConfig.html +++ b/types/_visdesignlab_upset2_core.AltTextConfig.html @@ -1 +1 @@ -AltTextConfig | UpSet 2.0
    AltTextConfig: UpsetConfig & {
        accessibleProcessedData?: AccessibleData;
        processedData?: Rows;
        rawData?: CoreUpsetData;
    }

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file +AltTextConfig | UpSet 2.0
    AltTextConfig: UpsetConfig & {
        accessibleProcessedData?: AccessibleData;
        processedData?: Rows;
        rawData?: CoreUpsetData;
    }

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_visdesignlab_upset2_core.AttributeList.html b/types/_visdesignlab_upset2_core.AttributeList.html index 61b686a85..569e65224 100644 --- a/types/_visdesignlab_upset2_core.AttributeList.html +++ b/types/_visdesignlab_upset2_core.AttributeList.html @@ -1,3 +1,3 @@ AttributeList | UpSet 2.0
    AttributeList: {
        [attribute: string]: SixNumberSummary | number;
    }

    Represents a list of attributes and their corresponding values. The keys are attribute names and the values can be either a SixNumberSummary object or a number (deviation).

    -

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_visdesignlab_upset2_core.AttributePlots.html b/types/_visdesignlab_upset2_core.AttributePlots.html index 207ece998..e32bf7d70 100644 --- a/types/_visdesignlab_upset2_core.AttributePlots.html +++ b/types/_visdesignlab_upset2_core.AttributePlots.html @@ -1,3 +1,3 @@ AttributePlots | UpSet 2.0
    AttributePlots: Record<string, `${AttributePlotType}`>

    Represents the different types of attribute plots. Enum values (AttributePlotType) behave better in a Record object than in traditional dict types.

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_visdesignlab_upset2_core.Attributes.html b/types/_visdesignlab_upset2_core.Attributes.html index ce8001df1..177d09b61 100644 --- a/types/_visdesignlab_upset2_core.Attributes.html +++ b/types/_visdesignlab_upset2_core.Attributes.html @@ -1,4 +1,4 @@ Attributes | UpSet 2.0
    Attributes: AttributeList & {
        degree?: number;
        deviation: number;
    }

    List of attributes for a subset ({attr1, attr2, deviation, degree, etc})

    Type declaration

    • Optional degree?: number

      The degree of the subset.

    • deviation: number

      The deviation of the subset.

      -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_visdesignlab_upset2_core.BaseElement.html b/types/_visdesignlab_upset2_core.BaseElement.html index 49148c835..9724a9982 100644 --- a/types/_visdesignlab_upset2_core.BaseElement.html +++ b/types/_visdesignlab_upset2_core.BaseElement.html @@ -6,4 +6,4 @@
  • Optional parent?: string

    The parent element ID, if any.

  • size: number

    The size of the element.

  • type: RowType

    The type of the element.

    -
  • Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_visdesignlab_upset2_core.BaseIntersection.html b/types/_visdesignlab_upset2_core.BaseIntersection.html index 388557ff2..4c6b284aa 100644 --- a/types/_visdesignlab_upset2_core.BaseIntersection.html +++ b/types/_visdesignlab_upset2_core.BaseIntersection.html @@ -1,2 +1,2 @@ BaseIntersection | UpSet 2.0
    BaseIntersection: BaseElement & {
        setMembership: {
            [key: string]: SetMembershipStatus;
        };
    }

    Base Intersection type for subsets and aggregates.

    -

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_visdesignlab_upset2_core.BasePlot.html b/types/_visdesignlab_upset2_core.BasePlot.html index f0abe29cb..5b13bcc01 100644 --- a/types/_visdesignlab_upset2_core.BasePlot.html +++ b/types/_visdesignlab_upset2_core.BasePlot.html @@ -1 +1 @@ -BasePlot | UpSet 2.0
    BasePlot: {
        id: string;
    }

    Type declaration

    • id: string

    Generated using TypeDoc

    \ No newline at end of file +BasePlot | UpSet 2.0
    BasePlot: {
        id: string;
    }

    Type declaration

    • id: string

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_visdesignlab_upset2_core.Bookmark.html b/types/_visdesignlab_upset2_core.Bookmark.html index b6b45eccc..fb90eb8dc 100644 --- a/types/_visdesignlab_upset2_core.Bookmark.html +++ b/types/_visdesignlab_upset2_core.Bookmark.html @@ -2,4 +2,4 @@

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_visdesignlab_upset2_core.BookmarkedIntersection.html b/types/_visdesignlab_upset2_core.BookmarkedIntersection.html index d04035bb0..173b1c6b6 100644 --- a/types/_visdesignlab_upset2_core.BookmarkedIntersection.html +++ b/types/_visdesignlab_upset2_core.BookmarkedIntersection.html @@ -1,4 +1,4 @@ BookmarkedIntersection | UpSet 2.0
    BookmarkedIntersection: Bookmark & {
        size: number;
        type: "intersection";
    }

    A bookmarked intersection.

    Type declaration

    • size: number

      The size of the bookmarked intersection.

    • type: "intersection"

      Indicates type at runtime

      -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_visdesignlab_upset2_core.BookmarkedSelection.html b/types/_visdesignlab_upset2_core.BookmarkedSelection.html index cc9d20127..e0a4292a1 100644 --- a/types/_visdesignlab_upset2_core.BookmarkedSelection.html +++ b/types/_visdesignlab_upset2_core.BookmarkedSelection.html @@ -1,4 +1,4 @@ BookmarkedSelection | UpSet 2.0
    BookmarkedSelection: Bookmark & {
        selection: ElementSelection;
        type: "elements";
    }

    Represents a bookmarked element selection, created in the Element View.

    Type declaration

    • selection: ElementSelection

      The selection parameters

    • type: "elements"

      Indicates type at runtime

      -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_visdesignlab_upset2_core.Column.html b/types/_visdesignlab_upset2_core.Column.html index e415fc8af..02e269675 100644 --- a/types/_visdesignlab_upset2_core.Column.html +++ b/types/_visdesignlab_upset2_core.Column.html @@ -1,2 +1,2 @@ Column | UpSet 2.0
    Column: {
        name: string;
        size: number;
    }

    Base type for a column in the plot

    -

    Type declaration

    • name: string
    • size: number

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_visdesignlab_upset2_core.ColumnDefs.html b/types/_visdesignlab_upset2_core.ColumnDefs.html index bf27a4f93..936218970 100644 --- a/types/_visdesignlab_upset2_core.ColumnDefs.html +++ b/types/_visdesignlab_upset2_core.ColumnDefs.html @@ -1 +1 @@ -ColumnDefs | UpSet 2.0
    ColumnDefs: {
        [columnName: string]: "number" | "boolean" | "string" | "label";
    }

    Type declaration

    • [columnName: string]: "number" | "boolean" | "string" | "label"

    Generated using TypeDoc

    \ No newline at end of file +ColumnDefs | UpSet 2.0
    ColumnDefs: {
        [columnName: string]: "number" | "boolean" | "string" | "label";
    }

    Type declaration

    • [columnName: string]: "number" | "boolean" | "string" | "label"

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_visdesignlab_upset2_core.ColumnName.html b/types/_visdesignlab_upset2_core.ColumnName.html index 59e67fa9e..76cba59b6 100644 --- a/types/_visdesignlab_upset2_core.ColumnName.html +++ b/types/_visdesignlab_upset2_core.ColumnName.html @@ -1 +1 @@ -ColumnName | UpSet 2.0
    ColumnName: string

    Generated using TypeDoc

    \ No newline at end of file +ColumnName | UpSet 2.0
    ColumnName: string

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_visdesignlab_upset2_core.ColumnTypes.html b/types/_visdesignlab_upset2_core.ColumnTypes.html index 642c66369..ac37deb44 100644 --- a/types/_visdesignlab_upset2_core.ColumnTypes.html +++ b/types/_visdesignlab_upset2_core.ColumnTypes.html @@ -1 +1 @@ -ColumnTypes | UpSet 2.0
    ColumnTypes: {
        [key: string]: string;
    }

    Type declaration

    • [key: string]: string

    Generated using TypeDoc

    \ No newline at end of file +ColumnTypes | UpSet 2.0
    ColumnTypes: {
        [key: string]: string;
    }

    Type declaration

    • [key: string]: string

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_visdesignlab_upset2_core.CoreUpsetData.html b/types/_visdesignlab_upset2_core.CoreUpsetData.html index c63e30ddb..3a0c14bc7 100644 --- a/types/_visdesignlab_upset2_core.CoreUpsetData.html +++ b/types/_visdesignlab_upset2_core.CoreUpsetData.html @@ -1 +1 @@ -CoreUpsetData | UpSet 2.0
    CoreUpsetData: {
        attributeColumns: ColumnName[];
        columnTypes: ColumnTypes;
        columns: ColumnName[];
        items: Items;
        label: ColumnName;
        setColumns: ColumnName[];
        sets: Sets;
    }

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file +CoreUpsetData | UpSet 2.0
    CoreUpsetData: {
        attributeColumns: ColumnName[];
        columnTypes: ColumnTypes;
        columns: ColumnName[];
        items: Items;
        label: ColumnName;
        setColumns: ColumnName[];
        sets: Sets;
    }

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_visdesignlab_upset2_core.ElementSelection.html b/types/_visdesignlab_upset2_core.ElementSelection.html index f727cb289..3784b8e88 100644 --- a/types/_visdesignlab_upset2_core.ElementSelection.html +++ b/types/_visdesignlab_upset2_core.ElementSelection.html @@ -1,4 +1,4 @@ ElementSelection | UpSet 2.0
    ElementSelection: {
        [attName: string]: [number, number];
    }

    Represents a selection of elements in the Element View. Maps attribute names to an array with the minimum and maximum values of the selection over each attribute.

    -

    Type declaration

    • [attName: string]: [number, number]

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_visdesignlab_upset2_core.Histogram.html b/types/_visdesignlab_upset2_core.Histogram.html index a93c1e061..8ac9c8ea2 100644 --- a/types/_visdesignlab_upset2_core.Histogram.html +++ b/types/_visdesignlab_upset2_core.Histogram.html @@ -1,2 +1,2 @@ Histogram | UpSet 2.0
    Histogram: BasePlot & {
        attribute: string;
        bins: number;
        frequency: boolean;
        type: "Histogram";
    }

    Information defining an element view histogram.

    -

    Type declaration

    • attribute: string
    • bins: number
    • frequency: boolean
    • type: "Histogram"

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_visdesignlab_upset2_core.Intersections.html b/types/_visdesignlab_upset2_core.Intersections.html index b387d1cef..c0fa77613 100644 --- a/types/_visdesignlab_upset2_core.Intersections.html +++ b/types/_visdesignlab_upset2_core.Intersections.html @@ -1 +1 @@ -Intersections | UpSet 2.0
    Intersections: {
        order: string[];
        values: {
            [k: string]: BaseIntersection;
        };
    }

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file +Intersections | UpSet 2.0
    Intersections: {
        order: string[];
        values: {
            [k: string]: BaseIntersection;
        };
    }

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_visdesignlab_upset2_core.Item.html b/types/_visdesignlab_upset2_core.Item.html index 4b4498c4e..c175eca0b 100644 --- a/types/_visdesignlab_upset2_core.Item.html +++ b/types/_visdesignlab_upset2_core.Item.html @@ -1 +1 @@ -Item | UpSet 2.0
    Item: {
        _id: string;
        _label: string;
        [attr: string]: boolean | number | string;
    }

    Type declaration

    • [attr: string]: boolean | number | string
    • _id: string
    • _label: string

    Generated using TypeDoc

    \ No newline at end of file +Item | UpSet 2.0
    Item: {
        _id: string;
        _label: string;
        [attr: string]: boolean | number | string;
    }

    Type declaration

    • [attr: string]: boolean | number | string
    • _id: string
    • _label: string

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_visdesignlab_upset2_core.Items.html b/types/_visdesignlab_upset2_core.Items.html index 795a442b1..92c4640b9 100644 --- a/types/_visdesignlab_upset2_core.Items.html +++ b/types/_visdesignlab_upset2_core.Items.html @@ -1 +1 @@ -Items | UpSet 2.0
    Items: {
        [k: string]: Item;
    }

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file +Items | UpSet 2.0
    Items: {
        [k: string]: Item;
    }

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_visdesignlab_upset2_core.Meta.html b/types/_visdesignlab_upset2_core.Meta.html index 2c8719806..ff1721d25 100644 --- a/types/_visdesignlab_upset2_core.Meta.html +++ b/types/_visdesignlab_upset2_core.Meta.html @@ -1 +1 @@ -Meta | UpSet 2.0
    Meta: {
        columns: ColumnDefs;
    }

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file +Meta | UpSet 2.0
    Meta: {
        columns: ColumnDefs;
    }

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_visdesignlab_upset2_core.Plot.html b/types/_visdesignlab_upset2_core.Plot.html index 970127d03..b38d76850 100644 --- a/types/_visdesignlab_upset2_core.Plot.html +++ b/types/_visdesignlab_upset2_core.Plot.html @@ -1 +1 @@ -Plot | UpSet 2.0

    Generated using TypeDoc

    \ No newline at end of file +Plot | UpSet 2.0

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_visdesignlab_upset2_core.PlotInformation.html b/types/_visdesignlab_upset2_core.PlotInformation.html index 32fbbe068..7c8c0fef8 100644 --- a/types/_visdesignlab_upset2_core.PlotInformation.html +++ b/types/_visdesignlab_upset2_core.PlotInformation.html @@ -4,4 +4,4 @@
  • items: string | null

    User-generated name for items in the dataset (ie "movies")

  • sets: string | null

    User-generated name to use for sets in the plot (ie "genres")

  • title: string | null

    User-defined plot title

    -
  • Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_visdesignlab_upset2_core.RenderRow.html b/types/_visdesignlab_upset2_core.RenderRow.html index 36b3cba9c..7e892fba6 100644 --- a/types/_visdesignlab_upset2_core.RenderRow.html +++ b/types/_visdesignlab_upset2_core.RenderRow.html @@ -1 +1 @@ -RenderRow | UpSet 2.0
    RenderRow: {
        id: string;
        row: Row;
    }

    Type declaration

    • id: string
    • row: Row

    Generated using TypeDoc

    \ No newline at end of file +RenderRow | UpSet 2.0
    RenderRow: {
        id: string;
        row: Row;
    }

    Type declaration

    • id: string
    • row: Row

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_visdesignlab_upset2_core.Row.html b/types/_visdesignlab_upset2_core.Row.html index 5a6bba679..a466b95c4 100644 --- a/types/_visdesignlab_upset2_core.Row.html +++ b/types/_visdesignlab_upset2_core.Row.html @@ -1,2 +1,2 @@ Row | UpSet 2.0

    A row in the plot

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_visdesignlab_upset2_core.RowType.html b/types/_visdesignlab_upset2_core.RowType.html index 4e6c41846..0d0f83284 100644 --- a/types/_visdesignlab_upset2_core.RowType.html +++ b/types/_visdesignlab_upset2_core.RowType.html @@ -1,2 +1,2 @@ RowType | UpSet 2.0
    RowType: "Set" | "Subset" | "Group" | "Aggregate" | "Query Group" | "Seperator" | "Undefined"

    Represents a row in the UpSet plot.

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_visdesignlab_upset2_core.Rows.html b/types/_visdesignlab_upset2_core.Rows.html index e76a43d66..dde7fdfa2 100644 --- a/types/_visdesignlab_upset2_core.Rows.html +++ b/types/_visdesignlab_upset2_core.Rows.html @@ -1 +1 @@ -Rows | UpSet 2.0

    Generated using TypeDoc

    \ No newline at end of file +Rows | UpSet 2.0

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_visdesignlab_upset2_core.Scatterplot.html b/types/_visdesignlab_upset2_core.Scatterplot.html index bf85627c0..cd004ea09 100644 --- a/types/_visdesignlab_upset2_core.Scatterplot.html +++ b/types/_visdesignlab_upset2_core.Scatterplot.html @@ -1,2 +1,2 @@ Scatterplot | UpSet 2.0
    Scatterplot: BasePlot & {
        type: "Scatterplot";
        x: string;
        xScaleLog?: boolean;
        y: string;
        yScaleLog?: boolean;
    }

    Information defining an element view scatterplot

    -

    Type declaration

    • type: "Scatterplot"
    • x: string
    • Optional xScaleLog?: boolean
    • y: string
    • Optional yScaleLog?: boolean

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_visdesignlab_upset2_core.SetMembershipStatus.html b/types/_visdesignlab_upset2_core.SetMembershipStatus.html index 189c76ce6..20c6d3a13 100644 --- a/types/_visdesignlab_upset2_core.SetMembershipStatus.html +++ b/types/_visdesignlab_upset2_core.SetMembershipStatus.html @@ -1 +1 @@ -SetMembershipStatus | UpSet 2.0
    SetMembershipStatus: "Yes" | "No" | "May"

    Generated using TypeDoc

    \ No newline at end of file +SetMembershipStatus | UpSet 2.0
    SetMembershipStatus: "Yes" | "No" | "May"

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_visdesignlab_upset2_core.Sets.html b/types/_visdesignlab_upset2_core.Sets.html index adda34fd6..7fa4764e1 100644 --- a/types/_visdesignlab_upset2_core.Sets.html +++ b/types/_visdesignlab_upset2_core.Sets.html @@ -1 +1 @@ -Sets | UpSet 2.0
    Sets: {
        [set_id: string]: BaseIntersection;
    }

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file +Sets | UpSet 2.0
    Sets: {
        [set_id: string]: BaseIntersection;
    }

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_visdesignlab_upset2_core.SixNumberSummary.html b/types/_visdesignlab_upset2_core.SixNumberSummary.html index d15331a80..3aacc33c8 100644 --- a/types/_visdesignlab_upset2_core.SixNumberSummary.html +++ b/types/_visdesignlab_upset2_core.SixNumberSummary.html @@ -5,4 +5,4 @@
  • Optional median?: number

    The median value.

  • Optional min?: number

    The minimum value.

  • Optional third?: number

    The third quartile value.

    -
  • Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_visdesignlab_upset2_core.SortByOrder.html b/types/_visdesignlab_upset2_core.SortByOrder.html index c6c3dce23..272636014 100644 --- a/types/_visdesignlab_upset2_core.SortByOrder.html +++ b/types/_visdesignlab_upset2_core.SortByOrder.html @@ -1 +1 @@ -SortByOrder | UpSet 2.0
    SortByOrder: "Ascending" | "Descending"

    Generated using TypeDoc

    \ No newline at end of file +SortByOrder | UpSet 2.0
    SortByOrder: "Ascending" | "Descending"

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_visdesignlab_upset2_core.SortVisibleBy.html b/types/_visdesignlab_upset2_core.SortVisibleBy.html index a0e87770d..5be572a25 100644 --- a/types/_visdesignlab_upset2_core.SortVisibleBy.html +++ b/types/_visdesignlab_upset2_core.SortVisibleBy.html @@ -1 +1 @@ -SortVisibleBy | UpSet 2.0
    SortVisibleBy: typeof sortVisibleByList[number]

    Generated using TypeDoc

    \ No newline at end of file +SortVisibleBy | UpSet 2.0
    SortVisibleBy: typeof sortVisibleByList[number]

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_visdesignlab_upset2_core.Subset.html b/types/_visdesignlab_upset2_core.Subset.html index b42416f5a..f410ea3e4 100644 --- a/types/_visdesignlab_upset2_core.Subset.html +++ b/types/_visdesignlab_upset2_core.Subset.html @@ -1,2 +1,2 @@ Subset | UpSet 2.0

    A single subset

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_visdesignlab_upset2_core.Subsets.html b/types/_visdesignlab_upset2_core.Subsets.html index 74fb62b72..e0f2d2344 100644 --- a/types/_visdesignlab_upset2_core.Subsets.html +++ b/types/_visdesignlab_upset2_core.Subsets.html @@ -1,2 +1,2 @@ Subsets | UpSet 2.0
    Subsets: {
        order: string[];
        values: {
            [subset_id: string]: Subset;
        };
    }

    A list of subsets & their order

    -

    Type declaration

    • order: string[]
    • values: {
          [subset_id: string]: Subset;
      }

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_visdesignlab_upset2_core.UpsetConfig.html b/types/_visdesignlab_upset2_core.UpsetConfig.html index e76d5f082..aff14ecac 100644 --- a/types/_visdesignlab_upset2_core.UpsetConfig.html +++ b/types/_visdesignlab_upset2_core.UpsetConfig.html @@ -2,4 +2,4 @@

    Type declaration

    Version

    0.1.0

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_visdesignlab_upset2_react.ContextMenuInfo.html b/types/_visdesignlab_upset2_react.ContextMenuInfo.html index 67fe03207..8d28efae7 100644 --- a/types/_visdesignlab_upset2_react.ContextMenuInfo.html +++ b/types/_visdesignlab_upset2_react.ContextMenuInfo.html @@ -3,4 +3,4 @@
  • items: ContextMenuItem[]

    The items to display in the context menu.

  • mouseX: number

    The x-coordinate of the mouse.

  • mouseY: number

    The y-coordinate of the mouse.

    -
  • Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_visdesignlab_upset2_react.ContextMenuItem.html b/types/_visdesignlab_upset2_react.ContextMenuItem.html index bfd01de4c..6b6ba0a26 100644 --- a/types/_visdesignlab_upset2_react.ContextMenuItem.html +++ b/types/_visdesignlab_upset2_react.ContextMenuItem.html @@ -1,4 +1,4 @@ ContextMenuItem | UpSet 2.0
    ContextMenuItem: {
        disabled?: boolean;
        label: string;
        onClick: (() => void);
    }

    Type declaration

    • Optional disabled?: boolean

      Specifies whether the context menu item is disabled.

    • label: string

      The label for the context menu item.

    • onClick: (() => void)

      The function to call when the context menu item is clicked.

      -
        • (): void
        • Returns void

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_visdesignlab_upset2_react.Metadata.html b/types/_visdesignlab_upset2_react.Metadata.html index 13bd20cf5..cdeaecee3 100644 --- a/types/_visdesignlab_upset2_react.Metadata.html +++ b/types/_visdesignlab_upset2_react.Metadata.html @@ -1 +1 @@ -Metadata | UpSet 2.0
    Metadata: {
        [key: string]: unknown;
    }

    Type declaration

    • [key: string]: unknown

    Generated using TypeDoc

    \ No newline at end of file +Metadata | UpSet 2.0
    Metadata: {
        [key: string]: unknown;
    }

    Type declaration

    • [key: string]: unknown

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_visdesignlab_upset2_react.UpsetActions.html b/types/_visdesignlab_upset2_react.UpsetActions.html index c53167d90..ebd81c907 100644 --- a/types/_visdesignlab_upset2_react.UpsetActions.html +++ b/types/_visdesignlab_upset2_react.UpsetActions.html @@ -1 +1 @@ -UpsetActions | UpSet 2.0
    UpsetActions: ReturnType<typeof getActions>

    Generated using TypeDoc

    \ No newline at end of file +UpsetActions | UpSet 2.0
    UpsetActions: ReturnType<typeof getActions>

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_visdesignlab_upset2_react.UpsetProvenance.html b/types/_visdesignlab_upset2_react.UpsetProvenance.html index e3051de5c..7b620797e 100644 --- a/types/_visdesignlab_upset2_react.UpsetProvenance.html +++ b/types/_visdesignlab_upset2_react.UpsetProvenance.html @@ -1 +1 @@ -UpsetProvenance | UpSet 2.0
    UpsetProvenance: ReturnType<typeof initializeProvenanceTracking>

    Generated using TypeDoc

    \ No newline at end of file +UpsetProvenance | UpSet 2.0
    UpsetProvenance: ReturnType<typeof initializeProvenanceTracking>

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/_visdesignlab_upset2_core.DefaultConfig.html b/variables/_visdesignlab_upset2_core.DefaultConfig.html index 32ed772ff..01f943482 100644 --- a/variables/_visdesignlab_upset2_core.DefaultConfig.html +++ b/variables/_visdesignlab_upset2_core.DefaultConfig.html @@ -1 +1 @@ -DefaultConfig | UpSet 2.0
    DefaultConfig: UpsetConfig = ...

    Generated using TypeDoc

    \ No newline at end of file +DefaultConfig | UpSet 2.0
    DefaultConfig: UpsetConfig = ...

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/_visdesignlab_upset2_core.UNINCLUDED.html b/variables/_visdesignlab_upset2_core.UNINCLUDED.html index 190e1992b..626aa3eb9 100644 --- a/variables/_visdesignlab_upset2_core.UNINCLUDED.html +++ b/variables/_visdesignlab_upset2_core.UNINCLUDED.html @@ -1 +1 @@ -UNINCLUDED | UpSet 2.0
    UNINCLUDED: "unincluded" = 'unincluded'

    Generated using TypeDoc

    \ No newline at end of file +UNINCLUDED | UpSet 2.0
    UNINCLUDED: "unincluded" = 'unincluded'

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/_visdesignlab_upset2_core.aggregateByList.html b/variables/_visdesignlab_upset2_core.aggregateByList.html index 2071f1cb3..d83e9c7d1 100644 --- a/variables/_visdesignlab_upset2_core.aggregateByList.html +++ b/variables/_visdesignlab_upset2_core.aggregateByList.html @@ -1 +1 @@ -aggregateByList | UpSet 2.0
    aggregateByList: readonly ["Degree", "Sets", "Deviations", "Overlaps", "None"] = ...

    Generated using TypeDoc

    \ No newline at end of file +aggregateByList | UpSet 2.0
    aggregateByList: readonly ["Degree", "Sets", "Deviations", "Overlaps", "None"] = ...

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/_visdesignlab_upset2_core.sortVisibleByList.html b/variables/_visdesignlab_upset2_core.sortVisibleByList.html index 5a909776a..b5edb68a4 100644 --- a/variables/_visdesignlab_upset2_core.sortVisibleByList.html +++ b/variables/_visdesignlab_upset2_core.sortVisibleByList.html @@ -1 +1 @@ -sortVisibleByList | UpSet 2.0
    sortVisibleByList: readonly ["Alphabetical", "Ascending", "Descending"] = ...

    Generated using TypeDoc

    \ No newline at end of file +sortVisibleByList | UpSet 2.0
    sortVisibleByList: readonly ["Alphabetical", "Ascending", "Descending"] = ...

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/_visdesignlab_upset2_react.upsetConfigAtom.html b/variables/_visdesignlab_upset2_react.upsetConfigAtom.html index d4b140fb6..0d921d7e0 100644 --- a/variables/_visdesignlab_upset2_react.upsetConfigAtom.html +++ b/variables/_visdesignlab_upset2_react.upsetConfigAtom.html @@ -1 +1 @@ -upsetConfigAtom | UpSet 2.0
    upsetConfigAtom: RecoilState<UpsetConfig> = ...

    Generated using TypeDoc

    \ No newline at end of file +upsetConfigAtom | UpSet 2.0
    upsetConfigAtom: RecoilState<UpsetConfig> = ...

    Generated using TypeDoc

    \ No newline at end of file