diff --git a/enums/_visdesignlab_upset2_core.AttributePlotType.html b/enums/_visdesignlab_upset2_core.AttributePlotType.html index 672f5e2f..74c566d8 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/enums/_visdesignlab_upset2_core.ElementQueryType.html b/enums/_visdesignlab_upset2_core.ElementQueryType.html index f66e70ab..4fe4beb8 100644 --- a/enums/_visdesignlab_upset2_core.ElementQueryType.html +++ b/enums/_visdesignlab_upset2_core.ElementQueryType.html @@ -1,8 +1,8 @@ ElementQueryType | UpSet 2.0

Possible string types for an element query

-

Enumeration Members

Enumeration Members

CONTAINS: "contains"
EQUALS: "equals"
GREATER_THAN: "greater than"
LENGTH: "length equals"
LESS_THAN: "less than"
REGEX: "regex"

Generated using TypeDoc

\ No newline at end of file +

Enumeration Members

CONTAINS: "contains"
EQUALS: "equals"
GREATER_THAN: "greater than"
LENGTH: "length equals"
LESS_THAN: "less than"
REGEX: "regex"

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/_visdesignlab_upset2_core.ElementQueryToBookmark.html b/functions/_visdesignlab_upset2_core.ElementQueryToBookmark.html index 2a3a7b8b..68ce38c6 100644 --- a/functions/_visdesignlab_upset2_core.ElementQueryToBookmark.html +++ b/functions/_visdesignlab_upset2_core.ElementQueryToBookmark.html @@ -2,4 +2,4 @@ Generates the ID by hashing the selection and labels the bookmark with the selection parameters.

Parameters

Returns ElementBookmark

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.areRowsAggregates.html b/functions/_visdesignlab_upset2_core.areRowsAggregates.html index ece37fa3..87cb4ace 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 12180bed..aab102aa 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 47f590c5..f2e08905 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.deepCopy.html b/functions/_visdesignlab_upset2_core.deepCopy.html index c309427a..5063c788 100644 --- a/functions/_visdesignlab_upset2_core.deepCopy.html +++ b/functions/_visdesignlab_upset2_core.deepCopy.html @@ -3,4 +3,4 @@ if structured cloning fails, falls back to JSON serialization.

Type Parameters

Parameters

Returns T

a deep copy of the 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.filterItems.html b/functions/_visdesignlab_upset2_core.filterItems.html index ea6eb7cf..6c9a44d0 100644 --- a/functions/_visdesignlab_upset2_core.filterItems.html +++ b/functions/_visdesignlab_upset2_core.filterItems.html @@ -2,4 +2,4 @@

Parameters

Returns Item[]

Filtered items

-

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 0efdee00..034cd8a8 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.firstAggregation.html b/functions/_visdesignlab_upset2_core.firstAggregation.html index 566cc296..59e1887c 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 911ce971..47b4fdf0 100644 --- a/functions/_visdesignlab_upset2_core.flattenedOnlyRows.html +++ b/functions/_visdesignlab_upset2_core.flattenedOnlyRows.html @@ -3,4 +3,4 @@

    Parameters

    Returns RowMap

    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 2e6e884f..67d4fdd2 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 683f3374..327d4f0b 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 793ec2e1..0439ea48 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 b28cc983..47aede1f 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 8527e92c..c0551078 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 9dddcd50..c51748ac 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 e448ec8e..e9441c6e 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 deda93ca..3ca8180e 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 2b5720f0..fd0fea04 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.hashString.html b/functions/_visdesignlab_upset2_core.hashString.html index cab55150..02be187a 100644 --- a/functions/_visdesignlab_upset2_core.hashString.html +++ b/functions/_visdesignlab_upset2_core.hashString.html @@ -1,4 +1,4 @@ hashString | UpSet 2.0
    • Hash a string to a number

      Parameters

      • str: string

        the string to hash

      Returns number

      the hash of the string

      -

    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 b47756dc..cdb3c8f3 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 8324cc3f..bc45624a 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 bb58f457..a27cb56d 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 57f7fcf1..4c3a5f7a 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 d07a8791..d6cf25f3 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 1ac55831..8e5d8453 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 6f0c47c6..476dbe3e 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 0e4f0bce..2d51f221 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.isColumn.html b/functions/_visdesignlab_upset2_core.isColumn.html index 8e1ee47c..a5298bfd 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.isElementBookmark.html b/functions/_visdesignlab_upset2_core.isElementBookmark.html index acc0f748..96c171b5 100644 --- a/functions/_visdesignlab_upset2_core.isElementBookmark.html +++ b/functions/_visdesignlab_upset2_core.isElementBookmark.html @@ -1,3 +1,3 @@ isElementBookmark | UpSet 2.0

    Generated using TypeDoc

    \ No newline at end of file +

    Returns b is ElementBookmark

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/_visdesignlab_upset2_core.isElementQuery.html b/functions/_visdesignlab_upset2_core.isElementQuery.html index 4e14af28..58eb3371 100644 --- a/functions/_visdesignlab_upset2_core.isElementQuery.html +++ b/functions/_visdesignlab_upset2_core.isElementQuery.html @@ -1,4 +1,4 @@ isElementQuery | UpSet 2.0
    • Type guard for ElementQuery

      Parameters

      • val: unknown

        The value to check.

      Returns val is ElementQuery

      whether the value is a ElementQuery

      -

    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.isElementSelection.html b/functions/_visdesignlab_upset2_core.isElementSelection.html index e8a7e7ac..2280ec2c 100644 --- a/functions/_visdesignlab_upset2_core.isElementSelection.html +++ b/functions/_visdesignlab_upset2_core.isElementSelection.html @@ -1,4 +1,4 @@ isElementSelection | UpSet 2.0
    • Determines if the given object is an ElementSelection.

      Parameters

      • e: unknown

        The object to check.

      Returns e is ElementSelection

      Whether the object 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 ee016e05..88c80349 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.isNumericalBookmark.html b/functions/_visdesignlab_upset2_core.isNumericalBookmark.html index f2104cb0..006660a1 100644 --- a/functions/_visdesignlab_upset2_core.isNumericalBookmark.html +++ b/functions/_visdesignlab_upset2_core.isNumericalBookmark.html @@ -1,3 +1,3 @@ isNumericalBookmark | UpSet 2.0

    Generated using TypeDoc

    \ No newline at end of file +

    Returns b is NumericalBookmark

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/_visdesignlab_upset2_core.isNumericalQuery.html b/functions/_visdesignlab_upset2_core.isNumericalQuery.html index f0ed9a87..48c29c96 100644 --- a/functions/_visdesignlab_upset2_core.isNumericalQuery.html +++ b/functions/_visdesignlab_upset2_core.isNumericalQuery.html @@ -1,4 +1,4 @@ isNumericalQuery | UpSet 2.0
    • Validates that the given value is a NumericalQuery.

      Parameters

      • value: unknown

        The value to check.

      Returns value is NumericalQuery

      whether the value is a NumericalQuery.

      -

    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.isObject.html b/functions/_visdesignlab_upset2_core.isObject.html index 80e405b0..a0419c5c 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 f59d5a9d..89ea840f 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 e4fdb4ad..1e44c583 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 a63ae10e..9a759e9a 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 3a4c6449..c04e79a9 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 39954e25..fbcce724 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 30e7b963..92e786b8 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 6fe71d18..cd01762b 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 1a6b41c6..c4b63923 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 6834aa6d..50b0057e 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.numericalQueriesEqual.html b/functions/_visdesignlab_upset2_core.numericalQueriesEqual.html index 3ea5a3fe..31dae5e0 100644 --- a/functions/_visdesignlab_upset2_core.numericalQueriesEqual.html +++ b/functions/_visdesignlab_upset2_core.numericalQueriesEqual.html @@ -4,4 +4,4 @@
  • b: undefined | NumericalQuery

    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.numericalQueryToBookmark.html b/functions/_visdesignlab_upset2_core.numericalQueryToBookmark.html index 790940de..a191cb14 100644 --- a/functions/_visdesignlab_upset2_core.numericalQueryToBookmark.html +++ b/functions/_visdesignlab_upset2_core.numericalQueryToBookmark.html @@ -3,4 +3,4 @@ Truncates keys to 16 characters and values to 2 sig figs.

    Parameters

    Returns NumericalBookmark

    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.process.html b/functions/_visdesignlab_upset2_core.process.html index 2b8134b7..b5763b67 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.secondAggregation.html b/functions/_visdesignlab_upset2_core.secondAggregation.html index 3f7205a0..df18e4eb 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.sortRows.html b/functions/_visdesignlab_upset2_core.sortRows.html index 2f7cc23e..619a546b 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 0eff5ab3..0deb4e74 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 8f2a6107..b681820e 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 52542511..26e51b5c 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 8168fa28..47c935f9 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 e0598aae..f9bbbc40 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 ee750877..06028c30 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 c4601e69..08216938 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 7129026f..5453c119 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 ac1ef6c2..cf4af447 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 c4358242..c54f3fbd 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 ada84789..289a9a9e 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 a770847c..0c02d2df 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 b8f56818..b7da4505 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 642e2048..ca08a5b3 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 459ddfb2..caf19121 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 520fba8e..5eff7aeb 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 c518c286..deaa1170 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 0c52123f..b79084d3 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 c01951eb..5f3db068 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 abe1bfb1..53f7890a 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 d9338904..87348d08 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 960f465c..b4192d3b 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 45648ff0..52ef6094 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 f0192b2c..e1cf3488 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 3a6b7fc2..a68a5f25 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 6a136981..d4140510 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 0030bb49..1865bb97 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 58600355..460c6dbb 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.Column.html b/types/_visdesignlab_upset2_core.Column.html index 23fd2fcf..962c1085 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 630fe5a3..292e6a18 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 3aa71feb..f02e3dab 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 c70ad152..0558a234 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 76331075..0d810e25 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.ElementBookmark.html b/types/_visdesignlab_upset2_core.ElementBookmark.html index c53b7c45..31424fd2 100644 --- a/types/_visdesignlab_upset2_core.ElementBookmark.html +++ b/types/_visdesignlab_upset2_core.ElementBookmark.html @@ -1,4 +1,4 @@ ElementBookmark | UpSet 2.0
    ElementBookmark: Bookmark & {
        selection: ElementQuery;
        type: "element";
    }

    Represents a bookmarked element selection based on attribute comparisons, created in the element view

    Type declaration

    • selection: ElementQuery

      Selection parameters

    • type: "element"

      Indicates type at runtim

      -

    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.ElementQuery.html b/types/_visdesignlab_upset2_core.ElementQuery.html index 633397a1..89aa1618 100644 --- a/types/_visdesignlab_upset2_core.ElementQuery.html +++ b/types/_visdesignlab_upset2_core.ElementQuery.html @@ -4,4 +4,4 @@ element must match this query string according to the rules set by the type.

  • type: ElementQueryType

    Type of the query; determines the mechanism used to evaluate whether the value of att on a given element matches this query

    -
  • 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.ElementSelection.html b/types/_visdesignlab_upset2_core.ElementSelection.html index 0378bd40..e9c2711b 100644 --- a/types/_visdesignlab_upset2_core.ElementSelection.html +++ b/types/_visdesignlab_upset2_core.ElementSelection.html @@ -1,2 +1,2 @@ ElementSelection | UpSet 2.0

    A bookmark which represents a selection of elements

    -

    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.Histogram.html b/types/_visdesignlab_upset2_core.Histogram.html index 25b6cd4c..0eb1699f 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 557c8d94..fcf7dedf 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 a53e7ee0..0a853c16 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 b54fdf58..19e39d7c 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 e9e3e382..1157f2d9 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.NumericalBookmark.html b/types/_visdesignlab_upset2_core.NumericalBookmark.html index ef0fb77b..c1e3c14f 100644 --- a/types/_visdesignlab_upset2_core.NumericalBookmark.html +++ b/types/_visdesignlab_upset2_core.NumericalBookmark.html @@ -1,4 +1,4 @@ NumericalBookmark | UpSet 2.0
    NumericalBookmark: Bookmark & {
        selection: NumericalQuery;
        type: "numerical";
    }

    Represents a bookmarked element selection based on numerical attributes, created in the Element View.

    Type declaration

    • selection: NumericalQuery

      The selection parameters

    • type: "numerical"

      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.NumericalQuery.html b/types/_visdesignlab_upset2_core.NumericalQuery.html index cc6ff7ef..3f5f2ca6 100644 --- a/types/_visdesignlab_upset2_core.NumericalQuery.html +++ b/types/_visdesignlab_upset2_core.NumericalQuery.html @@ -2,4 +2,4 @@ currently only from brushes in the element view. Maps attribute names to an array with the minimum and maximum values of the selection over each attribute.

    -

    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.Plot.html b/types/_visdesignlab_upset2_core.Plot.html index 58278015..f5ef09e9 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 0dfa1c3c..1f234cf1 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 f618860d..5c975a0e 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 7cf552cd..7b8fdbfd 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.RowMap.html b/types/_visdesignlab_upset2_core.RowMap.html index b8958b91..a199fdf6 100644 --- a/types/_visdesignlab_upset2_core.RowMap.html +++ b/types/_visdesignlab_upset2_core.RowMap.html @@ -1,2 +1,2 @@ RowMap | UpSet 2.0
    RowMap: Record<string, Row>

    Maps Row IDs to Row objects

    -

    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 0274736f..7c65f086 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 373b1874..4a867a98 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 7ab171f0..a22c85ff 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 fc7a42b5..9fb971ca 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 8e4fd1e1..1502b51a 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 904681f4..d3bb3c10 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 66cae53d..3a39e5a1 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 6ea454af..dfada1ac 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 ba9924c0..7d451e4c 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 827d72be..9e09f2e1 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 deb72059..472652f8 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 872310d7..d18fd902 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 eac59247..0e80900f 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 6c0eb44d..b9e49f20 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 3920b646..414bec60 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 609cf63f..03b4f3a8 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 f2935081..8e948b98 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 04596394..8050bbd9 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 174a09b8..0e85a42f 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 9fa5c6b6..7a3b2f46 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 27078ceb..77241b2c 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