diff --git a/enums/_visdesignlab_upset2_core.AttributePlotType.html b/enums/_visdesignlab_upset2_core.AttributePlotType.html index ba839198..8ee259bb 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"
\ No newline at end of file +

Enumeration Members

BoxPlot: "Box Plot"
DensityPlot: "Density Plot"
DotPlot: "Dot Plot"
StripPlot: "Strip Plot"
\ No newline at end of file diff --git a/enums/_visdesignlab_upset2_core.ElementQueryType.html b/enums/_visdesignlab_upset2_core.ElementQueryType.html index df08bbdc..4a39f9bd 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"
\ 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"
\ No newline at end of file diff --git a/enums/_visdesignlab_upset2_core.NumericalQueryType.html b/enums/_visdesignlab_upset2_core.NumericalQueryType.html index 52d69b79..46017a31 100644 --- a/enums/_visdesignlab_upset2_core.NumericalQueryType.html +++ b/enums/_visdesignlab_upset2_core.NumericalQueryType.html @@ -1,5 +1,5 @@ NumericalQueryType | UpSet 2.0

Possible string types for an element query on a numerical attribute

-

Enumeration Members

Enumeration Members

Enumeration Members

EQUALS: "equals"
GREATER_THAN: "greater than"
LESS_THAN: "less than"
\ No newline at end of file +

Enumeration Members

EQUALS: "equals"
GREATER_THAN: "greater than"
LESS_THAN: "less than"
\ No newline at end of file diff --git a/functions/_visdesignlab_upset2_core.ElementQueryToBookmark.html b/functions/_visdesignlab_upset2_core.ElementQueryToBookmark.html index d8581d45..17aa59d3 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.

-
\ No newline at end of file +
\ No newline at end of file diff --git a/functions/_visdesignlab_upset2_core.areRowsAggregates.html b/functions/_visdesignlab_upset2_core.areRowsAggregates.html index 4d6a66d6..74cf6b59 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.

    -
\ No newline at end of file +
\ No newline at end of file diff --git a/functions/_visdesignlab_upset2_core.areRowsSubsets.html b/functions/_visdesignlab_upset2_core.areRowsSubsets.html index 80a16f21..425e186f 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.

    -
\ No newline at end of file +
\ No newline at end of file diff --git a/functions/_visdesignlab_upset2_core.convertConfig.html b/functions/_visdesignlab_upset2_core.convertConfig.html index 282abe23..b3d6f405 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.

-
\ No newline at end of file +
\ No newline at end of file diff --git a/functions/_visdesignlab_upset2_core.deepCopy.html b/functions/_visdesignlab_upset2_core.deepCopy.html index 7e3f15c1..8bf2d1d6 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

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

Parameters

Returns Item[]

Filtered items

-
\ No newline at end of file +
\ No newline at end of file diff --git a/functions/_visdesignlab_upset2_core.filterRows.html b/functions/_visdesignlab_upset2_core.filterRows.html index feb0c732..f05c0495 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.

-
\ No newline at end of file +
\ No newline at end of file diff --git a/functions/_visdesignlab_upset2_core.firstAggregation.html b/functions/_visdesignlab_upset2_core.firstAggregation.html index 8783b345..4dc73b16 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.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/functions/_visdesignlab_upset2_core.flattenedOnlyRows.html b/functions/_visdesignlab_upset2_core.flattenedOnlyRows.html index ba7e67ac..57961a4d 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.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/functions/_visdesignlab_upset2_core.flattenedRows.html b/functions/_visdesignlab_upset2_core.flattenedRows.html index 693f88c6..2fcef22e 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.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/functions/_visdesignlab_upset2_core.getAggSize.html b/functions/_visdesignlab_upset2_core.getAggSize.html index cb6a200d..1e0e26d3 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.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/functions/_visdesignlab_upset2_core.getBelongingSetsFromSetMembership.html b/functions/_visdesignlab_upset2_core.getBelongingSetsFromSetMembership.html index e8f90a6d..b3695b8b 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.

      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/functions/_visdesignlab_upset2_core.getDegreeFromSetMembership.html b/functions/_visdesignlab_upset2_core.getDegreeFromSetMembership.html index ed7ef6d0..a9b8517e 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.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/functions/_visdesignlab_upset2_core.getId.html b/functions/_visdesignlab_upset2_core.getId.html index 94afb679..ff4329fc 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.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/functions/_visdesignlab_upset2_core.getItems.html b/functions/_visdesignlab_upset2_core.getItems.html index 19975736..07d10ed6 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.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/functions/_visdesignlab_upset2_core.getRows.html b/functions/_visdesignlab_upset2_core.getRows.html index c8fcde08..aa7f60ef 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.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/functions/_visdesignlab_upset2_core.getSixNumberSummary.html b/functions/_visdesignlab_upset2_core.getSixNumberSummary.html index c20805b0..723415ad 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.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/functions/_visdesignlab_upset2_core.getSubsets.html b/functions/_visdesignlab_upset2_core.getSubsets.html index 07329be2..c1dcaf3b 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.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/functions/_visdesignlab_upset2_core.hashString.html b/functions/_visdesignlab_upset2_core.hashString.html index 7c0b20a7..7d26a6c0 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

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

    Returns a is Aggregate

    \ No newline at end of file diff --git a/functions/_visdesignlab_upset2_core.isAggregateBy.html b/functions/_visdesignlab_upset2_core.isAggregateBy.html index 04a0c404..fc99f68e 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"

    \ No newline at end of file +

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

    \ No newline at end of file diff --git a/functions/_visdesignlab_upset2_core.isAltText.html b/functions/_visdesignlab_upset2_core.isAltText.html index 4a060ce6..9b4604f0 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

      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/functions/_visdesignlab_upset2_core.isAttributePlots.html b/functions/_visdesignlab_upset2_core.isAttributePlots.html index 17f6e901..a9365bbe 100644 --- a/functions/_visdesignlab_upset2_core.isAttributePlots.html +++ b/functions/_visdesignlab_upset2_core.isAttributePlots.html @@ -1,4 +1,4 @@ isAttributePlots | UpSet 2.0
    \ No newline at end of file +
    \ No newline at end of file diff --git a/functions/_visdesignlab_upset2_core.isBaseElement.html b/functions/_visdesignlab_upset2_core.isBaseElement.html index 067a95a5..3d7998c7 100644 --- a/functions/_visdesignlab_upset2_core.isBaseElement.html +++ b/functions/_visdesignlab_upset2_core.isBaseElement.html @@ -1,3 +1,3 @@ isBaseElement | UpSet 2.0
    \ No newline at end of file +

    Returns r is BaseElement

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

    Returns i is BaseIntersection

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

    Returns b is Bookmark

    \ No newline at end of file diff --git a/functions/_visdesignlab_upset2_core.isBookmarkedIntersection.html b/functions/_visdesignlab_upset2_core.isBookmarkedIntersection.html index 23751eff..c023d09c 100644 --- a/functions/_visdesignlab_upset2_core.isBookmarkedIntersection.html +++ b/functions/_visdesignlab_upset2_core.isBookmarkedIntersection.html @@ -1,4 +1,4 @@ isBookmarkedIntersection | UpSet 2.0
    \ No newline at end of file +
    \ No newline at end of file diff --git a/functions/_visdesignlab_upset2_core.isColumn.html b/functions/_visdesignlab_upset2_core.isColumn.html index 94fcd534..9fcf65b7 100644 --- a/functions/_visdesignlab_upset2_core.isColumn.html +++ b/functions/_visdesignlab_upset2_core.isColumn.html @@ -1,3 +1,3 @@ isColumn | UpSet 2.0
    \ No newline at end of file +

    Returns c is Column

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

    Returns b is ElementBookmark

    \ No newline at end of file diff --git a/functions/_visdesignlab_upset2_core.isElementQuery.html b/functions/_visdesignlab_upset2_core.isElementQuery.html index 01c6b898..a0c137cd 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

      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/functions/_visdesignlab_upset2_core.isElementSelection.html b/functions/_visdesignlab_upset2_core.isElementSelection.html index 1bb998bb..87c04dba 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.

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

    Returns h is Histogram

    \ No newline at end of file diff --git a/functions/_visdesignlab_upset2_core.isNumericalBookmark.html b/functions/_visdesignlab_upset2_core.isNumericalBookmark.html index 93a9608f..6a71c75c 100644 --- a/functions/_visdesignlab_upset2_core.isNumericalBookmark.html +++ b/functions/_visdesignlab_upset2_core.isNumericalBookmark.html @@ -1,3 +1,3 @@ isNumericalBookmark | UpSet 2.0
    \ No newline at end of file +

    Returns b is NumericalBookmark

    \ No newline at end of file diff --git a/functions/_visdesignlab_upset2_core.isNumericalQuery.html b/functions/_visdesignlab_upset2_core.isNumericalQuery.html index 0693b3c8..4d2ac4d1 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.

      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/functions/_visdesignlab_upset2_core.isObject.html b/functions/_visdesignlab_upset2_core.isObject.html index 1d7bcd62..36c61a67 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

    \ No newline at end of file +

    Returns v is object

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

    Returns p is PlotInformation

    \ No newline at end of file diff --git a/functions/_visdesignlab_upset2_core.isRow.html b/functions/_visdesignlab_upset2_core.isRow.html index 725483eb..c0d98c8c 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

    \ No newline at end of file +

    Returns r is Row

    \ No newline at end of file diff --git a/functions/_visdesignlab_upset2_core.isRowAggregate.html b/functions/_visdesignlab_upset2_core.isRowAggregate.html index d4cde9ba..09a33135 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.

      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/functions/_visdesignlab_upset2_core.isRowSubset.html b/functions/_visdesignlab_upset2_core.isRowSubset.html index 3d1a688f..4c8d02c8 100644 --- a/functions/_visdesignlab_upset2_core.isRowSubset.html +++ b/functions/_visdesignlab_upset2_core.isRowSubset.html @@ -1,4 +1,4 @@ isRowSubset | UpSet 2.0
    \ No newline at end of file +
    \ No newline at end of file diff --git a/functions/_visdesignlab_upset2_core.isRowType.html b/functions/_visdesignlab_upset2_core.isRowType.html index 0a42d099..dff66bdc 100644 --- a/functions/_visdesignlab_upset2_core.isRowType.html +++ b/functions/_visdesignlab_upset2_core.isRowType.html @@ -1,3 +1,3 @@ isRowType | UpSet 2.0
    \ No newline at end of file +

    Returns t is RowType

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

    Returns s is Scatterplot

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

    Returns s is BaseIntersection

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

    Returns s is Subsets

    \ No newline at end of file diff --git a/functions/_visdesignlab_upset2_core.isUpsetConfig.html b/functions/_visdesignlab_upset2_core.isUpsetConfig.html index 6e56ccd7..0122fa30 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.

      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/functions/_visdesignlab_upset2_core.numericalQueriesEqual.html b/functions/_visdesignlab_upset2_core.numericalQueriesEqual.html index 67186ada..9b0fc1ba 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

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/functions/_visdesignlab_upset2_core.numericalQueryToBookmark.html b/functions/_visdesignlab_upset2_core.numericalQueryToBookmark.html index 3eccbe5e..327d2092 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.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/functions/_visdesignlab_upset2_core.plotToString.html b/functions/_visdesignlab_upset2_core.plotToString.html index 00ae5a33..c2107eb5 100644 --- a/functions/_visdesignlab_upset2_core.plotToString.html +++ b/functions/_visdesignlab_upset2_core.plotToString.html @@ -1,4 +1,4 @@ plotToString | UpSet 2.0
    • Converts a plot to a displable string

      Parameters

      • plot: Plot

        Plot to convert.

      Returns string

      Display string with type & axis of plot

      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/functions/_visdesignlab_upset2_core.process.html b/functions/_visdesignlab_upset2_core.process.html index 7af9fed2..40225a58 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.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/functions/_visdesignlab_upset2_core.secondAggregation.html b/functions/_visdesignlab_upset2_core.secondAggregation.html index b0fbc3dd..b4773eef 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.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/functions/_visdesignlab_upset2_core.sortRows.html b/functions/_visdesignlab_upset2_core.sortRows.html index 69f7d664..d8872ff1 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.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/functions/_visdesignlab_upset2_react.Upset.html b/functions/_visdesignlab_upset2_react.Upset.html index 10ccead7..4c62f368 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

    \ No newline at end of file +

    Component

    \ No newline at end of file diff --git a/functions/_visdesignlab_upset2_react.downloadSVG.html b/functions/_visdesignlab_upset2_react.downloadSVG.html index 2b6b7884..d771e6e0 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

    \ No newline at end of file +

    Returns void

    \ No newline at end of file diff --git a/functions/_visdesignlab_upset2_react.exportProcessedData.html b/functions/_visdesignlab_upset2_react.exportProcessedData.html index 02f1fb41..21b0da83 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

    \ No newline at end of file +

    Returns void

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

    Returns void

    \ No newline at end of file diff --git a/functions/_visdesignlab_upset2_react.exportState.html b/functions/_visdesignlab_upset2_react.exportState.html index 65b3df53..41e2953d 100644 --- a/functions/_visdesignlab_upset2_react.exportState.html +++ b/functions/_visdesignlab_upset2_react.exportState.html @@ -2,4 +2,4 @@

    Parameters

    Returns void

    \ No newline at end of file +

    Returns void

    \ No newline at end of file diff --git a/functions/_visdesignlab_upset2_react.getAccessibleData.html b/functions/_visdesignlab_upset2_react.getAccessibleData.html index adb6f33d..50573228 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.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/functions/_visdesignlab_upset2_react.getActions.html b/functions/_visdesignlab_upset2_react.getActions.html index d8efbf44..0fb112e6 100644 --- a/functions/_visdesignlab_upset2_react.getActions.html +++ b/functions/_visdesignlab_upset2_react.getActions.html @@ -15,4 +15,4 @@
  • setShowHiddenSets: ((show) => any)

    Sets whether hidden sets should be shown

  • setUseUserAltText: ((useUserAlt) => any)
  • setUserAltText: ((altText) => any)
  • sortBy: ((sort, sortByOrder) => any)
  • sortVisibleBy: ((sort) => any)
  • updateAttributePlotType: ((attr, plotType) => any)
  • \ No newline at end of file +

    Returns any

  • setUseUserAltText: ((useUserAlt) => any)
  • setUserAltText: ((altText) => any)
  • sortBy: ((sort, sortByOrder) => any)
  • sortVisibleBy: ((sort) => any)
  • updateAttributePlotType: ((attr, plotType) => any)
  • \ No newline at end of file diff --git a/functions/_visdesignlab_upset2_react.getAltTextConfig.html b/functions/_visdesignlab_upset2_react.getAltTextConfig.html index d3f92dd2..4cc60b7c 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.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/functions/_visdesignlab_upset2_react.initializeProvenanceTracking.html b/functions/_visdesignlab_upset2_react.initializeProvenanceTracking.html index 080d7ed6..8cdf2a55 100644 --- a/functions/_visdesignlab_upset2_react.initializeProvenanceTracking.html +++ b/functions/_visdesignlab_upset2_react.initializeProvenanceTracking.html @@ -1 +1 @@ -initializeProvenanceTracking | UpSet 2.0
    \ No newline at end of file +initializeProvenanceTracking | UpSet 2.0
    \ No newline at end of file diff --git a/interfaces/_visdesignlab_upset2_react.AltText.html b/interfaces/_visdesignlab_upset2_react.AltText.html index 5a07ef6c..eab720e4 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

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/interfaces/_visdesignlab_upset2_react.SidebarProps.html b/interfaces/_visdesignlab_upset2_react.SidebarProps.html index 6a4e2bcb..736c8f55 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.

    -
    \ No newline at end of file +

    Type declaration

    open: boolean

    Indicates whether the sidebar is open or closed.

    +
    \ No newline at end of file diff --git a/interfaces/_visdesignlab_upset2_react.UpsetItem.html b/interfaces/_visdesignlab_upset2_react.UpsetItem.html index 4dbf2213..47c73dda 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
    \ No newline at end of file +
    interface UpsetItem {
        [key: string]: string | number | boolean;
    }

    Indexable

    [key: string]: string | number | boolean
    \ No newline at end of file diff --git a/interfaces/_visdesignlab_upset2_react.UpsetProps.html b/interfaces/_visdesignlab_upset2_react.UpsetProps.html index 75cf1da8..9c1bafcb 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;
        canEditPlotInformation?: boolean;
        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);
                setIntersectionSizeLabels: ((show) => any);
                setMaxVisible: ((val) => any);
                setMinVisible: ((val) => any);
                setPlotInformation: ((plotInformation) => any);
                setSelected: ((intersection) => any);
                setSetSizeLabels: ((show) => any);
                setShowHiddenSets: ((show) => any);
                setUseUserAltText: ((useUserAlt) => any);
                setUserAltText: ((altText) => any);
                sortBy: ((sort, sortByOrder) => any);
                sortVisibleBy: ((sort) => any);
                updateAttributePlotType: ((attr, plotType) => any);
            };
            provenance: Trrack<UpsetConfig, string>;
        };
        footerHeight?: number;
        generateAltText?: (() => Promise<AltText>);
        hideSettings?: boolean;
        parentHasHeight?: boolean;
        provVis?: SidebarProps;
        visualizeDatasetAttributes?: string[];
        visualizeUpsetAttributes?: boolean;
    }

    Properties

    interface UpsetProps {
        allowAttributeRemoval?: boolean;
        altTextSidebar?: SidebarProps;
        canEditPlotInformation?: boolean;
        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);
                setIntersectionSizeLabels: ((show) => any);
                setMaxVisible: ((val) => any);
                setMinVisible: ((val) => any);
                setPlotInformation: ((plotInformation) => any);
                setSelected: ((intersection) => any);
                setSetSizeLabels: ((show) => any);
                setShowHiddenSets: ((show) => any);
                setUseUserAltText: ((useUserAlt) => any);
                setUserAltText: ((altText) => any);
                sortBy: ((sort, sortByOrder) => any);
                sortVisibleBy: ((sort) => any);
                updateAttributePlotType: ((attr, plotType) => any);
            };
            provenance: Trrack<UpsetConfig, string>;
        };
        footerHeight?: number;
        generateAltText?: (() => Promise<AltText>);
        hideSettings?: boolean;
        parentHasHeight?: boolean;
        provVis?: SidebarProps;
        visualizeDatasetAttributes?: string[];
        visualizeUpsetAttributes?: boolean;
    }

    Properties

    allowAttributeRemoval? altTextSidebar? canEditPlotInformation? config? @@ -17,14 +17,14 @@ 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.

    -
    canEditPlotInformation?: boolean

    Whether or not the user has plot information edit permissions.

    -
    config?: Partial<UpsetConfig>

    Optional configuration for the Upset component.

    -

    The data for the Upset component.

    -
    elementSidebar?: SidebarProps

    Sidebar options for the element sidebar component. +

    canEditPlotInformation?: boolean

    Whether or not the user has plot information edit permissions.

    +
    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);
            setIntersectionSizeLabels: ((show) => any);
            setMaxVisible: ((val) => any);
            setMinVisible: ((val) => any);
            setPlotInformation: ((plotInformation) => any);
            setSelected: ((intersection) => any);
            setSetSizeLabels: ((show) => any);
            setShowHiddenSets: ((show) => 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);
            setIntersectionSizeLabels: ((show) => any);
            setMaxVisible: ((val) => any);
            setMinVisible: ((val) => any);
            setPlotInformation: ((plotInformation) => any);
            setSelected: ((intersection) => any);
            setSetSizeLabels: ((show) => any);
            setShowHiddenSets: ((show) => 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.

    @@ -45,18 +45,18 @@
      • (show): any
      • Parameters

        • show: boolean

          Whether to show set size labels

        Returns any

  • setShowHiddenSets: ((show) => any)

    Sets whether hidden sets should be shown

      • (show): any
      • Parameters

        • show: boolean

          Whether to show hidden sets

          -

        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>
  • footerHeight?: number

    Height of the footer overlayed on the upset plot, in px, if one exists. +

    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>
  • footerHeight?: number

    Height of the footer overlayed on the upset plot, in px, if one exists. Used to prevent the bottom of the sidebars from overlapping with the footer.

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

    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.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_visdesignlab_upset2_core.AccessibleData.html b/types/_visdesignlab_upset2_core.AccessibleData.html index 1f8312ae..265a2cc2 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

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

    Type declaration

    \ No newline at end of file diff --git a/types/_visdesignlab_upset2_core.AccessibleDataEntry.html b/types/_visdesignlab_upset2_core.AccessibleDataEntry.html index 6519c7f4..81351fa3 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

    \ 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

    \ No newline at end of file diff --git a/types/_visdesignlab_upset2_core.Aggregate.html b/types/_visdesignlab_upset2_core.Aggregate.html index f5b0e8f2..5ce5e98c 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
    \ No newline at end of file +

    Type declaration

    \ No newline at end of file diff --git a/types/_visdesignlab_upset2_core.AggregateBy.html b/types/_visdesignlab_upset2_core.AggregateBy.html index 8197065b..9409a01f 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

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_visdesignlab_upset2_core.Aggregates.html b/types/_visdesignlab_upset2_core.Aggregates.html index 8781646e..5189b140 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;
      }
    \ 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;
      }
    \ No newline at end of file diff --git a/types/_visdesignlab_upset2_core.AltText.html b/types/_visdesignlab_upset2_core.AltText.html index 49c5df54..a7e8a7a8 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

    -
  • \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_visdesignlab_upset2_core.AltTextConfig.html b/types/_visdesignlab_upset2_core.AltTextConfig.html index 53428047..c4a88047 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

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

    Type declaration

    \ No newline at end of file diff --git a/types/_visdesignlab_upset2_core.AttributeList.html b/types/_visdesignlab_upset2_core.AttributeList.html index 20d2de77..16dc8da1 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

    \ No newline at end of file +

    Type declaration

    \ No newline at end of file diff --git a/types/_visdesignlab_upset2_core.AttributePlots.html b/types/_visdesignlab_upset2_core.AttributePlots.html index c1906369..0e785b17 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.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_visdesignlab_upset2_core.Attributes.html b/types/_visdesignlab_upset2_core.Attributes.html index f14850a2..c7655428 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.

      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_visdesignlab_upset2_core.BaseElement.html b/types/_visdesignlab_upset2_core.BaseElement.html index 4c5f2b7e..b6d243df 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.

    -
  • \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_visdesignlab_upset2_core.BaseIntersection.html b/types/_visdesignlab_upset2_core.BaseIntersection.html index 503724a5..25e7357c 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

    \ No newline at end of file +

    Type declaration

    \ No newline at end of file diff --git a/types/_visdesignlab_upset2_core.BasePlot.html b/types/_visdesignlab_upset2_core.BasePlot.html index 3e34c2c1..ec9d2ae0 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
    \ No newline at end of file +BasePlot | UpSet 2.0
    BasePlot: {
        id: string;
    }

    Type declaration

    • id: string
    \ No newline at end of file diff --git a/types/_visdesignlab_upset2_core.Bookmark.html b/types/_visdesignlab_upset2_core.Bookmark.html index fedf7353..bded09b7 100644 --- a/types/_visdesignlab_upset2_core.Bookmark.html +++ b/types/_visdesignlab_upset2_core.Bookmark.html @@ -2,4 +2,4 @@

    Type declaration

    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_visdesignlab_upset2_core.BookmarkedIntersection.html b/types/_visdesignlab_upset2_core.BookmarkedIntersection.html index 73819c5f..c02a0ead 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

      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_visdesignlab_upset2_core.Column.html b/types/_visdesignlab_upset2_core.Column.html index 35640a52..830f497a 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
    \ No newline at end of file +

    Type declaration

    \ No newline at end of file diff --git a/types/_visdesignlab_upset2_core.ColumnDefs.html b/types/_visdesignlab_upset2_core.ColumnDefs.html index 7914245c..1028a635 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"
    \ 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"
    \ No newline at end of file diff --git a/types/_visdesignlab_upset2_core.ColumnName.html b/types/_visdesignlab_upset2_core.ColumnName.html index 46d21f6b..cd41f56f 100644 --- a/types/_visdesignlab_upset2_core.ColumnName.html +++ b/types/_visdesignlab_upset2_core.ColumnName.html @@ -1 +1 @@ -ColumnName | UpSet 2.0
    ColumnName: string
    \ No newline at end of file +ColumnName | UpSet 2.0
    ColumnName: string
    \ No newline at end of file diff --git a/types/_visdesignlab_upset2_core.ColumnType.html b/types/_visdesignlab_upset2_core.ColumnType.html index c9d476a6..b714273b 100644 --- a/types/_visdesignlab_upset2_core.ColumnType.html +++ b/types/_visdesignlab_upset2_core.ColumnType.html @@ -1,3 +1,3 @@ ColumnType | UpSet 2.0
    ColumnType: "primary key" | "edge source" | "edge target" | "label" | "string" | "boolean" | "category" | "number" | "date" | "ignored"

    Possible column types. Taken from the TableTypeAnnotation in multinet-api

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

    Maps column names to their string type

    -

    Type declaration

    \ No newline at end of file +

    Type declaration

    \ No newline at end of file diff --git a/types/_visdesignlab_upset2_core.CoreUpsetData.html b/types/_visdesignlab_upset2_core.CoreUpsetData.html index a2ce7f13..a345257b 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

    \ 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

    \ No newline at end of file diff --git a/types/_visdesignlab_upset2_core.ElementBookmark.html b/types/_visdesignlab_upset2_core.ElementBookmark.html index 76dfea2a..79ae24e8 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

      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_visdesignlab_upset2_core.ElementQuery.html b/types/_visdesignlab_upset2_core.ElementQuery.html index 686e69de..8f6e9aa0 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

    -
  • \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_visdesignlab_upset2_core.ElementSelection.html b/types/_visdesignlab_upset2_core.ElementSelection.html index 936c23d6..7402f550 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

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_visdesignlab_upset2_core.Histogram.html b/types/_visdesignlab_upset2_core.Histogram.html index 771c631e..db2e6141 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"
    \ No newline at end of file +

    Type declaration

    \ No newline at end of file diff --git a/types/_visdesignlab_upset2_core.Intersections.html b/types/_visdesignlab_upset2_core.Intersections.html index e83a3fae..b4192dd9 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

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

    Type declaration

    \ No newline at end of file diff --git a/types/_visdesignlab_upset2_core.Item.html b/types/_visdesignlab_upset2_core.Item.html index 1534e026..93611ff1 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
    \ 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
    \ No newline at end of file diff --git a/types/_visdesignlab_upset2_core.Items.html b/types/_visdesignlab_upset2_core.Items.html index 37ad198f..4d98d0f0 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

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

    Type declaration

    \ No newline at end of file diff --git a/types/_visdesignlab_upset2_core.Meta.html b/types/_visdesignlab_upset2_core.Meta.html index 00cdc2e8..8f8fad33 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

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

    Type declaration

    \ No newline at end of file diff --git a/types/_visdesignlab_upset2_core.NumericalBookmark.html b/types/_visdesignlab_upset2_core.NumericalBookmark.html index cb9adb37..51ca68ed 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

      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_visdesignlab_upset2_core.NumericalQuery.html b/types/_visdesignlab_upset2_core.NumericalQuery.html index f7386329..e36c968e 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

    \ No newline at end of file +

    Type declaration

    \ No newline at end of file diff --git a/types/_visdesignlab_upset2_core.Plot.html b/types/_visdesignlab_upset2_core.Plot.html index b5e47677..bb8aec7d 100644 --- a/types/_visdesignlab_upset2_core.Plot.html +++ b/types/_visdesignlab_upset2_core.Plot.html @@ -1 +1 @@ -Plot | UpSet 2.0
    \ No newline at end of file +Plot | UpSet 2.0
    \ No newline at end of file diff --git a/types/_visdesignlab_upset2_core.PlotInformation.html b/types/_visdesignlab_upset2_core.PlotInformation.html index 68b6ca4b..1fe13ad3 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

    -
  • \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_visdesignlab_upset2_core.RenderRow.html b/types/_visdesignlab_upset2_core.RenderRow.html index a14a1f84..f65df9b8 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
    \ No newline at end of file +RenderRow | UpSet 2.0
    RenderRow: {
        id: string;
        row: Row;
    }

    Type declaration

    • id: string
    • row: Row
    \ No newline at end of file diff --git a/types/_visdesignlab_upset2_core.Row.html b/types/_visdesignlab_upset2_core.Row.html index 9690669a..86ec878f 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

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_visdesignlab_upset2_core.RowMap.html b/types/_visdesignlab_upset2_core.RowMap.html index 5378027e..29d4353c 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

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_visdesignlab_upset2_core.RowType.html b/types/_visdesignlab_upset2_core.RowType.html index 067c60e0..ebc6d12e 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.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_visdesignlab_upset2_core.Rows.html b/types/_visdesignlab_upset2_core.Rows.html index 73c45e83..0edc27e8 100644 --- a/types/_visdesignlab_upset2_core.Rows.html +++ b/types/_visdesignlab_upset2_core.Rows.html @@ -1 +1 @@ -Rows | UpSet 2.0
    \ No newline at end of file +Rows | UpSet 2.0
    \ No newline at end of file diff --git a/types/_visdesignlab_upset2_core.Scatterplot.html b/types/_visdesignlab_upset2_core.Scatterplot.html index 2d2dd299..9717fa4d 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
    \ No newline at end of file +

    Type declaration

    \ No newline at end of file diff --git a/types/_visdesignlab_upset2_core.SetMembershipStatus.html b/types/_visdesignlab_upset2_core.SetMembershipStatus.html index 160ec417..67ae6c60 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"
    \ No newline at end of file +SetMembershipStatus | UpSet 2.0
    SetMembershipStatus: "Yes" | "No" | "May"
    \ No newline at end of file diff --git a/types/_visdesignlab_upset2_core.Sets.html b/types/_visdesignlab_upset2_core.Sets.html index 8e2da5e4..80f1820a 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

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

    Type declaration

    \ No newline at end of file diff --git a/types/_visdesignlab_upset2_core.SixNumberSummary.html b/types/_visdesignlab_upset2_core.SixNumberSummary.html index be96fe7e..e6b8c74d 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.

    -
  • \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_visdesignlab_upset2_core.SortByOrder.html b/types/_visdesignlab_upset2_core.SortByOrder.html index 81f9b0b3..627aee07 100644 --- a/types/_visdesignlab_upset2_core.SortByOrder.html +++ b/types/_visdesignlab_upset2_core.SortByOrder.html @@ -1 +1 @@ -SortByOrder | UpSet 2.0
    SortByOrder: "Ascending" | "Descending"
    \ No newline at end of file +SortByOrder | UpSet 2.0
    SortByOrder: "Ascending" | "Descending"
    \ No newline at end of file diff --git a/types/_visdesignlab_upset2_core.SortVisibleBy.html b/types/_visdesignlab_upset2_core.SortVisibleBy.html index ed8f51e7..48ba3c18 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]
    \ No newline at end of file +SortVisibleBy | UpSet 2.0
    SortVisibleBy: typeof sortVisibleByList[number]
    \ No newline at end of file diff --git a/types/_visdesignlab_upset2_core.Subset.html b/types/_visdesignlab_upset2_core.Subset.html index e17f604c..507ea2e8 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

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_visdesignlab_upset2_core.Subsets.html b/types/_visdesignlab_upset2_core.Subsets.html index 5345396b..66fe64e4 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;
      }
    \ No newline at end of file +

    Type declaration

    \ No newline at end of file diff --git a/types/_visdesignlab_upset2_core.UpsetConfig.html b/types/_visdesignlab_upset2_core.UpsetConfig.html index a07b1fd9..a45e1b2d 100644 --- a/types/_visdesignlab_upset2_core.UpsetConfig.html +++ b/types/_visdesignlab_upset2_core.UpsetConfig.html @@ -5,4 +5,4 @@
  • plotInformation: PlotInformation
  • plots: {
        histograms: Histogram[];
        scatterplots: Scatterplot[];
    }
  • secondAggregateBy: AggregateBy
  • secondOverlapDegree: number
  • selected: Row | null
  • setSizeLabels: boolean

    Whether to display numerical size labels on the set size bars.

  • showHiddenSets: boolean

    Whether to display the hidden sets & their sizes above the plot

  • sortBy: string
  • sortByOrder: SortByOrder
  • sortVisibleBy: SortVisibleBy
  • useUserAlt: boolean
  • userAltText: AltText | null
  • version: "0.1.1"
  • visibleAttributes: ColumnName[]
  • visibleSets: ColumnName[]
  • Version

    0.1.0

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_visdesignlab_upset2_react.ContextMenuInfo.html b/types/_visdesignlab_upset2_react.ContextMenuInfo.html index bacd5760..2aa30eee 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.

    -
  • \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_visdesignlab_upset2_react.ContextMenuItem.html b/types/_visdesignlab_upset2_react.ContextMenuItem.html index 03b088d6..abd75908 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

    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_visdesignlab_upset2_react.Metadata.html b/types/_visdesignlab_upset2_react.Metadata.html index 5e938726..74332a5e 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
    \ No newline at end of file +Metadata | UpSet 2.0
    Metadata: {
        [key: string]: unknown;
    }

    Type declaration

    • [key: string]: unknown
    \ No newline at end of file diff --git a/types/_visdesignlab_upset2_react.UpsetActions.html b/types/_visdesignlab_upset2_react.UpsetActions.html index cf1d6bf2..4b3d8daa 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>
    \ No newline at end of file +UpsetActions | UpSet 2.0
    UpsetActions: ReturnType<typeof getActions>
    \ No newline at end of file diff --git a/types/_visdesignlab_upset2_react.UpsetProvenance.html b/types/_visdesignlab_upset2_react.UpsetProvenance.html index c1629361..2dce3c3c 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>
    \ No newline at end of file +UpsetProvenance | UpSet 2.0
    UpsetProvenance: ReturnType<typeof initializeProvenanceTracking>
    \ No newline at end of file diff --git a/variables/_visdesignlab_upset2_core.DefaultConfig.html b/variables/_visdesignlab_upset2_core.DefaultConfig.html index b313ec4b..98e5773f 100644 --- a/variables/_visdesignlab_upset2_core.DefaultConfig.html +++ b/variables/_visdesignlab_upset2_core.DefaultConfig.html @@ -1 +1 @@ -DefaultConfig | UpSet 2.0
    DefaultConfig: UpsetConfig = ...
    \ No newline at end of file +DefaultConfig | UpSet 2.0
    DefaultConfig: UpsetConfig = ...
    \ No newline at end of file diff --git a/variables/_visdesignlab_upset2_core.UNINCLUDED.html b/variables/_visdesignlab_upset2_core.UNINCLUDED.html index f0fc0fc4..07f3b502 100644 --- a/variables/_visdesignlab_upset2_core.UNINCLUDED.html +++ b/variables/_visdesignlab_upset2_core.UNINCLUDED.html @@ -1 +1 @@ -UNINCLUDED | UpSet 2.0
    UNINCLUDED: "unincluded" = 'unincluded'
    \ No newline at end of file +UNINCLUDED | UpSet 2.0
    UNINCLUDED: "unincluded" = 'unincluded'
    \ No newline at end of file diff --git a/variables/_visdesignlab_upset2_core.aggregateByList.html b/variables/_visdesignlab_upset2_core.aggregateByList.html index 2d9fc3ee..944cfc60 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"] = ...
    \ No newline at end of file +aggregateByList | UpSet 2.0
    aggregateByList: readonly ["Degree", "Sets", "Deviations", "Overlaps", "None"] = ...
    \ No newline at end of file diff --git a/variables/_visdesignlab_upset2_core.sortVisibleByList.html b/variables/_visdesignlab_upset2_core.sortVisibleByList.html index 4d326264..cd6b5063 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"] = ...
    \ No newline at end of file +sortVisibleByList | UpSet 2.0
    sortVisibleByList: readonly ["Alphabetical", "Ascending", "Descending"] = ...
    \ No newline at end of file diff --git a/variables/_visdesignlab_upset2_react.upsetConfigAtom.html b/variables/_visdesignlab_upset2_react.upsetConfigAtom.html index 579b2eba..bd3469d2 100644 --- a/variables/_visdesignlab_upset2_react.upsetConfigAtom.html +++ b/variables/_visdesignlab_upset2_react.upsetConfigAtom.html @@ -1 +1 @@ -upsetConfigAtom | UpSet 2.0
    upsetConfigAtom: RecoilState<UpsetConfig> = ...
    \ No newline at end of file +upsetConfigAtom | UpSet 2.0
    upsetConfigAtom: RecoilState<UpsetConfig> = ...
    \ No newline at end of file