diff --git a/enums/_visdesignlab_upset2_core.AttributePlotType.html b/enums/_visdesignlab_upset2_core.AttributePlotType.html index 031c016f..a79b44e9 100644 --- a/enums/_visdesignlab_upset2_core.AttributePlotType.html +++ b/enums/_visdesignlab_upset2_core.AttributePlotType.html @@ -1,7 +1,7 @@ AttributePlotType | UpSet 2.0

Enumeration AttributePlotType

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

BoxPlot +

Enumeration Members

BoxPlot DensityPlot DotPlot StripPlot -

Enumeration Members

BoxPlot

BoxPlot: "Box Plot"

DensityPlot

DensityPlot: "Density Plot"

DotPlot

DotPlot: "Dot Plot"

StripPlot

StripPlot: "Strip Plot"

Settings

Member Visibility

Theme

On This Page

BoxPlotDensityPlotDotPlotStripPlot

Generated using TypeDoc

\ No newline at end of file +

Enumeration Members

BoxPlot

BoxPlot: "Box Plot"

DensityPlot

DensityPlot: "Density Plot"

DotPlot

DotPlot: "Dot Plot"

StripPlot

StripPlot: "Strip Plot"

Settings

Member Visibility

Theme

On This Page

BoxPlotDensityPlotDotPlotStripPlot

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 700d9ec5..6d0c0808 100644 --- a/enums/_visdesignlab_upset2_core.ElementQueryType.html +++ b/enums/_visdesignlab_upset2_core.ElementQueryType.html @@ -1,8 +1,8 @@ ElementQueryType | UpSet 2.0

Enumeration ElementQueryType

Possible string types for an element query

-

Enumeration Members

CONTAINS +

Enumeration Members

CONTAINS EQUALS GREATER_THAN LENGTH LESS_THAN REGEX -

Enumeration Members

CONTAINS

CONTAINS: "contains"

EQUALS

EQUALS: "equals"

GREATER_THAN

GREATER_THAN: "greater than"

LENGTH

LENGTH: "length equals"

LESS_THAN

LESS_THAN: "less than"

REGEX

REGEX: "regex"

Settings

Member Visibility

Theme

On This Page

CONTAINSEQUALSGREATER_THANLENGTHLESS_THANREGEX

Generated using TypeDoc

\ No newline at end of file +

Enumeration Members

CONTAINS

CONTAINS: "contains"

EQUALS

EQUALS: "equals"

GREATER_THAN

GREATER_THAN: "greater than"

LENGTH

LENGTH: "length equals"

LESS_THAN

LESS_THAN: "less than"

REGEX

REGEX: "regex"

Settings

Member Visibility

Theme

On This Page

CONTAINSEQUALSGREATER_THANLENGTHLESS_THANREGEX

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 02786b01..23cac5a6 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.

-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

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 dcf2f495..6da6151a 100644 --- a/functions/_visdesignlab_upset2_core.areRowsAggregates.html +++ b/functions/_visdesignlab_upset2_core.areRowsAggregates.html @@ -1,4 +1,4 @@ areRowsAggregates | UpSet 2.0

Function areRowsAggregates

  • areRowsAggregates(rr): rr is Aggregates

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

    -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

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 fdb304cc..7f893b9b 100644 --- a/functions/_visdesignlab_upset2_core.areRowsSubsets.html +++ b/functions/_visdesignlab_upset2_core.areRowsSubsets.html @@ -1,4 +1,4 @@ areRowsSubsets | UpSet 2.0

Function areRowsSubsets

  • areRowsSubsets(rr): rr is Subsets

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

    -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

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 285023f6..bdeb9c5b 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.

-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

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 ee74f230..bb445612 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

-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

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 4d9728f8..ebc8dd8c 100644 --- a/functions/_visdesignlab_upset2_core.filterItems.html +++ b/functions/_visdesignlab_upset2_core.filterItems.html @@ -2,4 +2,4 @@

Parameters

Returns Item[]

Filtered items

-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

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 18137cef..220eedac 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.

-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

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 dbf8577a..ee99a395 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.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    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 368e3268..38cc95ab 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.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    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 7c19324d..b510d764 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.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    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 58649d12..0bc8b0c6 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.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    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 a98734e2..80cb176d 100644 --- a/functions/_visdesignlab_upset2_core.getBelongingSetsFromSetMembership.html +++ b/functions/_visdesignlab_upset2_core.getBelongingSetsFromSetMembership.html @@ -1,4 +1,4 @@ getBelongingSetsFromSetMembership | UpSet 2.0

    Function getBelongingSetsFromSetMembership

    • getBelongingSetsFromSetMembership(membership): string[]

    • Retrieves the belonging sets from a set membership object.

      Parameters

      Returns string[]

      An array of strings representing the belonging sets.

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    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 c42f45e8..c56586d0 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.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    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 0e305d24..1763606c 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.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    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 df1c7ca5..cd8df03c 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.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    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 ce0eab55..b5b512ae 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.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    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 4240b6e7..49363c60 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.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    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 96aac72f..66f45047 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.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    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 8d9c7d70..ac577990 100644 --- a/functions/_visdesignlab_upset2_core.hashString.html +++ b/functions/_visdesignlab_upset2_core.hashString.html @@ -1,4 +1,4 @@ hashString | UpSet 2.0

    Function hashString

    • hashString(str): number

    • Hash a string to a number

      Parameters

      • str: string

        the string to hash

      Returns number

      the hash of the string

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    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 a4bdd4df..20530593 100644 --- a/functions/_visdesignlab_upset2_core.isAggregate.html +++ b/functions/_visdesignlab_upset2_core.isAggregate.html @@ -1,3 +1,3 @@ isAggregate | UpSet 2.0

    Function isAggregate

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns a is Aggregate

    Settings

    Member Visibility

    Theme

    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 6fa1fd11..57125817 100644 --- a/functions/_visdesignlab_upset2_core.isAggregateBy.html +++ b/functions/_visdesignlab_upset2_core.isAggregateBy.html @@ -1,3 +1,3 @@ isAggregateBy | UpSet 2.0

    Function isAggregateBy

    • isAggregateBy(a): a is "Degree" | "Sets" | "Deviations" | "Overlaps" | "None"

    • Type guard for aggregateBy

      Parameters

      • a: unknown

        variable to check

        -

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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

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

    Settings

    Member Visibility

    Theme

    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 ca2d5182..f4e3ba8e 100644 --- a/functions/_visdesignlab_upset2_core.isAltText.html +++ b/functions/_visdesignlab_upset2_core.isAltText.html @@ -1,4 +1,4 @@ isAltText | UpSet 2.0

    Function isAltText

    • isAltText(val): val is AltText

    • Type guard for AltText

      Parameters

      • val: unknown

        The value to check

      Returns val is AltText

      whether val is an AltText

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    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 40065d99..08508467 100644 --- a/functions/_visdesignlab_upset2_core.isAttributePlots.html +++ b/functions/_visdesignlab_upset2_core.isAttributePlots.html @@ -1,4 +1,4 @@ isAttributePlots | UpSet 2.0

    Function isAttributePlots

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    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 49db27bb..c86b75af 100644 --- a/functions/_visdesignlab_upset2_core.isBaseElement.html +++ b/functions/_visdesignlab_upset2_core.isBaseElement.html @@ -1,3 +1,3 @@ isBaseElement | UpSet 2.0

    Function isBaseElement

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns r is BaseElement

    Settings

    Member Visibility

    Theme

    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 8ffa7642..bde9f3c2 100644 --- a/functions/_visdesignlab_upset2_core.isBaseIntersection.html +++ b/functions/_visdesignlab_upset2_core.isBaseIntersection.html @@ -1,3 +1,3 @@ isBaseIntersection | UpSet 2.0

    Function isBaseIntersection

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns i is BaseIntersection

    Settings

    Member Visibility

    Theme

    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 9ca395fa..97c5b668 100644 --- a/functions/_visdesignlab_upset2_core.isBookmark.html +++ b/functions/_visdesignlab_upset2_core.isBookmark.html @@ -1,3 +1,3 @@ isBookmark | UpSet 2.0

    Function isBookmark

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns b is Bookmark

    Settings

    Member Visibility

    Theme

    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 391db934..5f388ba9 100644 --- a/functions/_visdesignlab_upset2_core.isBookmarkedIntersection.html +++ b/functions/_visdesignlab_upset2_core.isBookmarkedIntersection.html @@ -1,4 +1,4 @@ isBookmarkedIntersection | UpSet 2.0

    Function isBookmarkedIntersection

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    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 add3006c..54089251 100644 --- a/functions/_visdesignlab_upset2_core.isColumn.html +++ b/functions/_visdesignlab_upset2_core.isColumn.html @@ -1,3 +1,3 @@ isColumn | UpSet 2.0

    Function isColumn

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns c is Column

    Settings

    Member Visibility

    Theme

    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 9a58037f..98196529 100644 --- a/functions/_visdesignlab_upset2_core.isElementBookmark.html +++ b/functions/_visdesignlab_upset2_core.isElementBookmark.html @@ -1,3 +1,3 @@ isElementBookmark | UpSet 2.0

    Function isElementBookmark

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns b is ElementBookmark

    Settings

    Member Visibility

    Theme

    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 0d6006a8..a0f3deba 100644 --- a/functions/_visdesignlab_upset2_core.isElementQuery.html +++ b/functions/_visdesignlab_upset2_core.isElementQuery.html @@ -1,4 +1,4 @@ isElementQuery | UpSet 2.0

    Function isElementQuery

    • isElementQuery(val): val is ElementQuery

    • Type guard for ElementQuery

      Parameters

      • val: unknown

        The value to check.

      Returns val is ElementQuery

      whether the value is a ElementQuery

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    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 81c2d0c1..c07f7980 100644 --- a/functions/_visdesignlab_upset2_core.isElementSelection.html +++ b/functions/_visdesignlab_upset2_core.isElementSelection.html @@ -1,4 +1,4 @@ isElementSelection | UpSet 2.0

    Function isElementSelection

    • isElementSelection(e): e is ElementSelection

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

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    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 326db983..8dbcb836 100644 --- a/functions/_visdesignlab_upset2_core.isHistogram.html +++ b/functions/_visdesignlab_upset2_core.isHistogram.html @@ -1,3 +1,3 @@ isHistogram | UpSet 2.0

    Function isHistogram

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns h is Histogram

    Settings

    Member Visibility

    Theme

    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 1ec001f4..20daa91c 100644 --- a/functions/_visdesignlab_upset2_core.isNumericalBookmark.html +++ b/functions/_visdesignlab_upset2_core.isNumericalBookmark.html @@ -1,3 +1,3 @@ isNumericalBookmark | UpSet 2.0

    Function isNumericalBookmark

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns b is NumericalBookmark

    Settings

    Member Visibility

    Theme

    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 a0f1cabd..ce510c7b 100644 --- a/functions/_visdesignlab_upset2_core.isNumericalQuery.html +++ b/functions/_visdesignlab_upset2_core.isNumericalQuery.html @@ -1,4 +1,4 @@ isNumericalQuery | UpSet 2.0

    Function isNumericalQuery

    • isNumericalQuery(value): value is NumericalQuery

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

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    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 dcc67a26..b7e7c532 100644 --- a/functions/_visdesignlab_upset2_core.isObject.html +++ b/functions/_visdesignlab_upset2_core.isObject.html @@ -1,3 +1,3 @@ isObject | UpSet 2.0

    Function isObject

    • isObject(v): v is object

    • Checks that a value is not null/undefined and has type object

      Parameters

      • v: unknown

        The value

        -

      Returns v is object

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns v is object

    Settings

    Member Visibility

    Theme

    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 992473ad..9f226cc3 100644 --- a/functions/_visdesignlab_upset2_core.isPlotInformation.html +++ b/functions/_visdesignlab_upset2_core.isPlotInformation.html @@ -1,3 +1,3 @@ isPlotInformation | UpSet 2.0

    Function isPlotInformation

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns p is PlotInformation

    Settings

    Member Visibility

    Theme

    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 8758f4a8..b944f47a 100644 --- a/functions/_visdesignlab_upset2_core.isRow.html +++ b/functions/_visdesignlab_upset2_core.isRow.html @@ -1,3 +1,3 @@ isRow | UpSet 2.0

    Function isRow

    • isRow(r): r is Row

    • Type guard for Row

      Parameters

      • r: unknown

        variable to check

        -

      Returns r is Row

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns r is Row

    Settings

    Member Visibility

    Theme

    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 88f444c8..6dbdbf69 100644 --- a/functions/_visdesignlab_upset2_core.isRowAggregate.html +++ b/functions/_visdesignlab_upset2_core.isRowAggregate.html @@ -1,4 +1,4 @@ isRowAggregate | UpSet 2.0

    Function isRowAggregate

    • isRowAggregate(row): row is Aggregate

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

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    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 0de2569b..676b806e 100644 --- a/functions/_visdesignlab_upset2_core.isRowSubset.html +++ b/functions/_visdesignlab_upset2_core.isRowSubset.html @@ -1,4 +1,4 @@ isRowSubset | UpSet 2.0

    Function isRowSubset

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    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 655eefda..fc590a24 100644 --- a/functions/_visdesignlab_upset2_core.isRowType.html +++ b/functions/_visdesignlab_upset2_core.isRowType.html @@ -1,3 +1,3 @@ isRowType | UpSet 2.0

    Function isRowType

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns t is RowType

    Settings

    Member Visibility

    Theme

    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 84ac4c48..31c164c0 100644 --- a/functions/_visdesignlab_upset2_core.isScatterplot.html +++ b/functions/_visdesignlab_upset2_core.isScatterplot.html @@ -1,3 +1,3 @@ isScatterplot | UpSet 2.0

    Function isScatterplot

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns s is Scatterplot

    Settings

    Member Visibility

    Theme

    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 43789064..143e5604 100644 --- a/functions/_visdesignlab_upset2_core.isSubset.html +++ b/functions/_visdesignlab_upset2_core.isSubset.html @@ -1,3 +1,3 @@ isSubset | UpSet 2.0

    Function isSubset

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns s is BaseIntersection

    Settings

    Member Visibility

    Theme

    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 679d5d63..fe930c91 100644 --- a/functions/_visdesignlab_upset2_core.isSubsets.html +++ b/functions/_visdesignlab_upset2_core.isSubsets.html @@ -1,3 +1,3 @@ isSubsets | UpSet 2.0

    Function isSubsets

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns s is Subsets

    Settings

    Member Visibility

    Theme

    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 4db3af22..ca917f84 100644 --- a/functions/_visdesignlab_upset2_core.isUpsetConfig.html +++ b/functions/_visdesignlab_upset2_core.isUpsetConfig.html @@ -1,4 +1,4 @@ isUpsetConfig | UpSet 2.0

    Function isUpsetConfig

    • isUpsetConfig(config): config is UpsetConfig

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

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    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 148bcd2a..6241271c 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

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    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 5a75b154..f255ff75 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.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    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 684f8999..67baa4d8 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.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    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 73fdf454..eca4ca53 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.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    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 0a958ef7..e59656c8 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.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    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 dee8a120..62ce552a 100644 --- a/functions/_visdesignlab_upset2_react.Upset.html +++ b/functions/_visdesignlab_upset2_react.Upset.html @@ -1,3 +1,3 @@ Upset | UpSet 2.0

    Function Upset

    • Upset(props, context?): null | ReactElement<any, any>

    • Renders the Upset component.

      Parameters

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

      Returns null | ReactElement<any, any>

      The rendered Upset component.

      -

      Component

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Component

    Settings

    Member Visibility

    Theme

    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 174879b8..c4b2a6e0 100644 --- a/functions/_visdesignlab_upset2_react.downloadSVG.html +++ b/functions/_visdesignlab_upset2_react.downloadSVG.html @@ -1,3 +1,3 @@ downloadSVG | UpSet 2.0

    Function downloadSVG

    • downloadSVG(filename?): void

    • 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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    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 4c995782..5ad197af 100644 --- a/functions/_visdesignlab_upset2_react.exportProcessedData.html +++ b/functions/_visdesignlab_upset2_react.exportProcessedData.html @@ -1,4 +1,4 @@ exportProcessedData | UpSet 2.0

    Function exportProcessedData

    • exportProcessedData(rows, accessible?): void

    • 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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    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 7fc327dc..b8c97fdb 100644 --- a/functions/_visdesignlab_upset2_react.exportRawData.html +++ b/functions/_visdesignlab_upset2_react.exportRawData.html @@ -1,3 +1,3 @@ exportRawData | UpSet 2.0

    Function exportRawData

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    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 046c39ee..cf043321 100644 --- a/functions/_visdesignlab_upset2_react.exportState.html +++ b/functions/_visdesignlab_upset2_react.exportState.html @@ -2,4 +2,4 @@

    Parameters

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    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 97e9d659..f80cf733 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.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    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 ca2f6d09..77b4a33d 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)

    • Settings

    Member Visibility

    Theme

    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)

    • Settings

    Member Visibility

    Theme

    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 922971ba..37d90eed 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.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    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 c55f07c6..23bdb330 100644 --- a/functions/_visdesignlab_upset2_react.initializeProvenanceTracking.html +++ b/functions/_visdesignlab_upset2_react.initializeProvenanceTracking.html @@ -1 +1 @@ -initializeProvenanceTracking | UpSet 2.0

    Function initializeProvenanceTracking

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function initializeProvenanceTracking

    Settings

    Member Visibility

    Theme

    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 d0fca807..9b76fd09 100644 --- a/interfaces/_visdesignlab_upset2_react.AltText.html +++ b/interfaces/_visdesignlab_upset2_react.AltText.html @@ -1,11 +1,11 @@ AltText | UpSet 2.0

    Interface AltText

    Represents the alternative text for an Upset plot.

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

    Properties

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

    Properties

    longDescription shortDescription techniqueDescription warnings?

    Properties

    longDescription

    longDescription: string

    The long description for the Upset plot.

    -

    shortDescription

    shortDescription: string

    The short description for the Upset plot.

    -

    techniqueDescription

    techniqueDescription: string

    The technique description for the Upset plot.

    -

    Optional warnings

    warnings?: string

    Optional warnings for the Upset plot. +

    shortDescription

    shortDescription: string

    The short description for the Upset plot.

    +

    techniqueDescription

    techniqueDescription: string

    The technique description for the Upset plot.

    +

    Optional warnings

    warnings?: string

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

    -

    Settings

    Member Visibility

    Theme

    On This Page

    longDescriptionshortDescriptiontechniqueDescriptionwarnings

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    longDescriptionshortDescriptiontechniqueDescriptionwarnings

    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 e57d472c..53129133 100644 --- a/interfaces/_visdesignlab_upset2_react.SidebarProps.html +++ b/interfaces/_visdesignlab_upset2_react.SidebarProps.html @@ -1,6 +1,6 @@ SidebarProps | UpSet 2.0

    Interface SidebarProps

    Props for providing functions to open and close any sidebar.

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

    Properties

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

    Properties

    close open

    Properties

    close

    close: (() => void)

    Callback function to close the sidebar.

    -

    Type declaration

      • (): void

      • Returns void

    open

    open: boolean

    Indicates whether the sidebar is open or closed.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    closeopen

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    open

    open: boolean

    Indicates whether the sidebar is open or closed.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    closeopen

    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 856837f4..bb2ad2d2 100644 --- a/interfaces/_visdesignlab_upset2_react.UpsetItem.html +++ b/interfaces/_visdesignlab_upset2_react.UpsetItem.html @@ -1,3 +1,3 @@ UpsetItem | UpSet 2.0

    Interface UpsetItem

    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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Indexable

    [key: string]: string | number | boolean

    Settings

    Member Visibility

    Theme

    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 b4c770a0..28daa991 100644 --- a/interfaces/_visdesignlab_upset2_react.UpsetProps.html +++ b/interfaces/_visdesignlab_upset2_react.UpsetProps.html @@ -1,5 +1,5 @@ UpsetProps | UpSet 2.0

    Interface UpsetProps

    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);
                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? +
    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);
                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? canEditPlotInformation? config? @@ -16,14 +16,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.

    -

    Optional altTextSidebar

    altTextSidebar?: SidebarProps

    Sidebar options for the alt text sidebar component. +

    Optional altTextSidebar

    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.

    -

    Optional canEditPlotInformation

    canEditPlotInformation?: boolean

    Whether or not the user has plot information edit permissions.

    -

    Optional config

    config?: Partial<UpsetConfig>

    Optional configuration for the Upset component.

    -

    data

    data: CoreUpsetData | UpsetItem[]

    The data for the Upset component.

    -

    Optional elementSidebar

    elementSidebar?: SidebarProps

    Sidebar options for the element sidebar component. +

    Optional canEditPlotInformation

    canEditPlotInformation?: boolean

    Whether or not the user has plot information edit permissions.

    +

    Optional config

    config?: Partial<UpsetConfig>

    Optional configuration for the Upset component.

    +

    data

    data: CoreUpsetData | UpsetItem[]

    The data for the Upset component.

    +

    Optional elementSidebar

    elementSidebar?: SidebarProps

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

    -

    Optional extProvenance

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

    Optional extProvenance

    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.

    @@ -38,16 +38,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>

    • Optional generateAltText

    generateAltText?: (() => Promise<AltText>)

    Async function which should return a generated AltText object.

    -

    Type declaration

    Optional hideSettings

    hideSettings?: boolean

    Hide the aggregations/filter settings sidebar.

    -

    Optional parentHasHeight

    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>

    • Optional generateAltText

    generateAltText?: (() => Promise<AltText>)

    Async function which should return a generated AltText object.

    +

    Type declaration

    Optional hideSettings

    hideSettings?: boolean

    Hide the aggregations/filter settings sidebar.

    +

    Optional parentHasHeight

    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.

    -

    Optional provVis

    provVis?: SidebarProps

    Sidebar options for the provVis component.

    -

    Optional visualizeDatasetAttributes

    visualizeDatasetAttributes?: string[]

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

    Optional provVis

    provVis?: SidebarProps

    Sidebar options for the provVis component.

    +

    Optional visualizeDatasetAttributes

    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.

    -

    Optional visualizeUpsetAttributes

    visualizeUpsetAttributes?: boolean

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

    Optional visualizeUpsetAttributes

    visualizeUpsetAttributes?: boolean

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

    -

    Settings

    Member Visibility

    Theme

    On This Page

    allowAttributeRemovalaltTextSidebarcanEditPlotInformationconfigdataelementSidebarextProvenancegenerateAltTexthideSettingsparentHasHeightprovVisvisualizeDatasetAttributesvisualizeUpsetAttributes

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    allowAttributeRemovalaltTextSidebarcanEditPlotInformationconfigdataelementSidebarextProvenancegenerateAltTexthideSettingsparentHasHeightprovVisvisualizeDatasetAttributesvisualizeUpsetAttributes

    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 3936a404..1294f4e6 100644 --- a/types/_visdesignlab_upset2_core.AccessibleData.html +++ b/types/_visdesignlab_upset2_core.AccessibleData.html @@ -1 +1 @@ -AccessibleData | UpSet 2.0

    Type alias AccessibleData

    AccessibleData: {
        values: {
            [row: string]: AccessibleDataEntry;
        };
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type alias AccessibleData

    AccessibleData: {
        values: {
            [row: string]: AccessibleDataEntry;
        };
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    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 5ad07dba..348b8af8 100644 --- a/types/_visdesignlab_upset2_core.AccessibleDataEntry.html +++ b/types/_visdesignlab_upset2_core.AccessibleDataEntry.html @@ -1 +1 @@ -AccessibleDataEntry | UpSet 2.0

    Type alias AccessibleDataEntry

    AccessibleDataEntry: {
        attributes: Attributes;
        degree: number;
        elementName: string;
        id?: string;
        items?: {
            [row: string]: AccessibleDataEntry;
        };
        setMembership?: {
            [set: string]: SetMembershipStatus;
        };
        size: number;
        type: RowType;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type alias AccessibleDataEntry

    AccessibleDataEntry: {
        attributes: Attributes;
        degree: number;
        elementName: string;
        id?: string;
        items?: {
            [row: string]: AccessibleDataEntry;
        };
        setMembership?: {
            [set: string]: SetMembershipStatus;
        };
        size: number;
        type: RowType;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    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 3d580c49..07171f3e 100644 --- a/types/_visdesignlab_upset2_core.Aggregate.html +++ b/types/_visdesignlab_upset2_core.Aggregate.html @@ -1,2 +1,2 @@ Aggregate | UpSet 2.0

    Type alias Aggregate

    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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    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 87268fab..aa1bc001 100644 --- a/types/_visdesignlab_upset2_core.AggregateBy.html +++ b/types/_visdesignlab_upset2_core.AggregateBy.html @@ -1,2 +1,2 @@ AggregateBy | UpSet 2.0

    Type alias AggregateBy

    AggregateBy: typeof aggregateByList[number]

    Ways the upset plot can be aggregated

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    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 3a38e93e..27984c4c 100644 --- a/types/_visdesignlab_upset2_core.Aggregates.html +++ b/types/_visdesignlab_upset2_core.Aggregates.html @@ -1 +1 @@ -Aggregates | UpSet 2.0

    Type alias Aggregates

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

    Type declaration

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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type alias Aggregates

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

    Type declaration

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

    Settings

    Member Visibility

    Theme

    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 1c827202..13ca86bb 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

    -

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    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 07bdb360..2982c8d6 100644 --- a/types/_visdesignlab_upset2_core.AltTextConfig.html +++ b/types/_visdesignlab_upset2_core.AltTextConfig.html @@ -1 +1 @@ -AltTextConfig | UpSet 2.0

    Type alias AltTextConfig

    AltTextConfig: UpsetConfig & {
        accessibleProcessedData?: AccessibleData;
        processedData?: Rows;
        rawData?: CoreUpsetData;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type alias AltTextConfig

    AltTextConfig: UpsetConfig & {
        accessibleProcessedData?: AccessibleData;
        processedData?: Rows;
        rawData?: CoreUpsetData;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    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 81598338..f32f18b2 100644 --- a/types/_visdesignlab_upset2_core.AttributeList.html +++ b/types/_visdesignlab_upset2_core.AttributeList.html @@ -1,3 +1,3 @@ AttributeList | UpSet 2.0

    Type alias AttributeList

    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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    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 f75268c0..9f0cbc18 100644 --- a/types/_visdesignlab_upset2_core.AttributePlots.html +++ b/types/_visdesignlab_upset2_core.AttributePlots.html @@ -1,3 +1,3 @@ AttributePlots | UpSet 2.0

    Type alias AttributePlots

    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.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    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 1eb093c0..fe410343 100644 --- a/types/_visdesignlab_upset2_core.Attributes.html +++ b/types/_visdesignlab_upset2_core.Attributes.html @@ -1,4 +1,4 @@ Attributes | UpSet 2.0

    Type alias Attributes

    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.

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    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 6a9cc272..38b57b74 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.

    -

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    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 0c03933c..97814e0f 100644 --- a/types/_visdesignlab_upset2_core.BaseIntersection.html +++ b/types/_visdesignlab_upset2_core.BaseIntersection.html @@ -1,2 +1,2 @@ BaseIntersection | UpSet 2.0

    Type alias BaseIntersection

    BaseIntersection: BaseElement & {
        setMembership: {
            [key: string]: SetMembershipStatus;
        };
    }

    Base Intersection type for subsets and aggregates.

    -

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    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 f5edf821..4399fdac 100644 --- a/types/_visdesignlab_upset2_core.BasePlot.html +++ b/types/_visdesignlab_upset2_core.BasePlot.html @@ -1 +1 @@ -BasePlot | UpSet 2.0

    Type alias BasePlot

    BasePlot: {
        id: string;
    }

    Type declaration

    • id: string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type alias BasePlot

    BasePlot: {
        id: string;
    }

    Type declaration

    • id: string

    Settings

    Member Visibility

    Theme

    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 c02da309..a7c9c49e 100644 --- a/types/_visdesignlab_upset2_core.Bookmark.html +++ b/types/_visdesignlab_upset2_core.Bookmark.html @@ -2,4 +2,4 @@

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    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 d228e050..e1175817 100644 --- a/types/_visdesignlab_upset2_core.BookmarkedIntersection.html +++ b/types/_visdesignlab_upset2_core.BookmarkedIntersection.html @@ -1,4 +1,4 @@ BookmarkedIntersection | UpSet 2.0

    Type alias BookmarkedIntersection

    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

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    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 c5ce079c..103a63cb 100644 --- a/types/_visdesignlab_upset2_core.Column.html +++ b/types/_visdesignlab_upset2_core.Column.html @@ -1,2 +1,2 @@ Column | UpSet 2.0

    Type alias Column

    Column: {
        name: string;
        size: number;
    }

    Base type for a column in the plot

    -

    Type declaration

    • name: string
    • size: number

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    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 96e35c1c..1f130be1 100644 --- a/types/_visdesignlab_upset2_core.ColumnDefs.html +++ b/types/_visdesignlab_upset2_core.ColumnDefs.html @@ -1 +1 @@ -ColumnDefs | UpSet 2.0

    Type alias ColumnDefs

    ColumnDefs: {
        [columnName: string]: "number" | "boolean" | "string" | "label";
    }

    Type declaration

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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type alias ColumnDefs

    ColumnDefs: {
        [columnName: string]: "number" | "boolean" | "string" | "label";
    }

    Type declaration

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

    Settings

    Member Visibility

    Theme

    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 36d01de9..476f3b1a 100644 --- a/types/_visdesignlab_upset2_core.ColumnName.html +++ b/types/_visdesignlab_upset2_core.ColumnName.html @@ -1 +1 @@ -ColumnName | UpSet 2.0

    Type alias ColumnName

    ColumnName: string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type alias ColumnName

    ColumnName: string

    Settings

    Member Visibility

    Theme

    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 f8156d20..bb3b7540 100644 --- a/types/_visdesignlab_upset2_core.ColumnTypes.html +++ b/types/_visdesignlab_upset2_core.ColumnTypes.html @@ -1 +1 @@ -ColumnTypes | UpSet 2.0

    Type alias ColumnTypes

    ColumnTypes: {
        [key: string]: string;
    }

    Type declaration

    • [key: string]: string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type alias ColumnTypes

    ColumnTypes: {
        [key: string]: string;
    }

    Type declaration

    • [key: string]: string

    Settings

    Member Visibility

    Theme

    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 1092f969..dfbcf534 100644 --- a/types/_visdesignlab_upset2_core.CoreUpsetData.html +++ b/types/_visdesignlab_upset2_core.CoreUpsetData.html @@ -1 +1 @@ -CoreUpsetData | UpSet 2.0

    Type alias CoreUpsetData

    CoreUpsetData: {
        attributeColumns: ColumnName[];
        columnTypes: ColumnTypes;
        columns: ColumnName[];
        items: Items;
        label: ColumnName;
        setColumns: ColumnName[];
        sets: Sets;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type alias CoreUpsetData

    CoreUpsetData: {
        attributeColumns: ColumnName[];
        columnTypes: ColumnTypes;
        columns: ColumnName[];
        items: Items;
        label: ColumnName;
        setColumns: ColumnName[];
        sets: Sets;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    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 2f949508..1ef627d6 100644 --- a/types/_visdesignlab_upset2_core.ElementBookmark.html +++ b/types/_visdesignlab_upset2_core.ElementBookmark.html @@ -1,4 +1,4 @@ ElementBookmark | UpSet 2.0

    Type alias ElementBookmark

    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

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    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 ac095981..6f1a1887 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

    -

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    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 c884ef38..39d00490 100644 --- a/types/_visdesignlab_upset2_core.ElementSelection.html +++ b/types/_visdesignlab_upset2_core.ElementSelection.html @@ -1,2 +1,2 @@ ElementSelection | UpSet 2.0

    Type alias ElementSelection

    ElementSelection: NumericalBookmark | ElementBookmark

    A bookmark which represents a selection of elements

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    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 81f01946..001994c2 100644 --- a/types/_visdesignlab_upset2_core.Histogram.html +++ b/types/_visdesignlab_upset2_core.Histogram.html @@ -1,2 +1,2 @@ Histogram | UpSet 2.0

    Type alias Histogram

    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"

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    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 e973e685..8747f12a 100644 --- a/types/_visdesignlab_upset2_core.Intersections.html +++ b/types/_visdesignlab_upset2_core.Intersections.html @@ -1 +1 @@ -Intersections | UpSet 2.0

    Type alias Intersections

    Intersections: {
        order: string[];
        values: {
            [k: string]: BaseIntersection;
        };
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type alias Intersections

    Intersections: {
        order: string[];
        values: {
            [k: string]: BaseIntersection;
        };
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    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 470e12c2..1fd58261 100644 --- a/types/_visdesignlab_upset2_core.Item.html +++ b/types/_visdesignlab_upset2_core.Item.html @@ -1 +1 @@ -Item | UpSet 2.0

    Type alias Item

    Item: {
        _id: string;
        _label: string;
        [attr: string]: boolean | number | string;
    }

    Type declaration

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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type alias Item

    Item: {
        _id: string;
        _label: string;
        [attr: string]: boolean | number | string;
    }

    Type declaration

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

    Settings

    Member Visibility

    Theme

    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 9eb38216..4e9c65ef 100644 --- a/types/_visdesignlab_upset2_core.Items.html +++ b/types/_visdesignlab_upset2_core.Items.html @@ -1 +1 @@ -Items | UpSet 2.0

    Type alias Items

    Items: {
        [k: string]: Item;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type alias Items

    Items: {
        [k: string]: Item;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    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 769be3fc..91ba6c48 100644 --- a/types/_visdesignlab_upset2_core.Meta.html +++ b/types/_visdesignlab_upset2_core.Meta.html @@ -1 +1 @@ -Meta | UpSet 2.0

    Type alias Meta

    Meta: {
        columns: ColumnDefs;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type alias Meta

    Meta: {
        columns: ColumnDefs;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    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 7d7c75ee..ddeb6a2a 100644 --- a/types/_visdesignlab_upset2_core.NumericalBookmark.html +++ b/types/_visdesignlab_upset2_core.NumericalBookmark.html @@ -1,4 +1,4 @@ NumericalBookmark | UpSet 2.0

    Type alias NumericalBookmark

    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

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    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 bb91d1ff..c2a94ecd 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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    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 2ad62d60..8f37c31d 100644 --- a/types/_visdesignlab_upset2_core.Plot.html +++ b/types/_visdesignlab_upset2_core.Plot.html @@ -1 +1 @@ -Plot | UpSet 2.0

    Type alias Plot

    Plot: Scatterplot | Histogram

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type alias Plot

    Plot: Scatterplot | Histogram

    Settings

    Member Visibility

    Theme

    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 c5164564..c327a7c2 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

    -

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    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 371803db..1fd0503c 100644 --- a/types/_visdesignlab_upset2_core.RenderRow.html +++ b/types/_visdesignlab_upset2_core.RenderRow.html @@ -1 +1 @@ -RenderRow | UpSet 2.0

    Type alias RenderRow

    RenderRow: {
        id: string;
        row: Row;
    }

    Type declaration

    • id: string
    • row: Row

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type alias RenderRow

    RenderRow: {
        id: string;
        row: Row;
    }

    Type declaration

    • id: string
    • row: Row

    Settings

    Member Visibility

    Theme

    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 0aa3f290..e352fce7 100644 --- a/types/_visdesignlab_upset2_core.Row.html +++ b/types/_visdesignlab_upset2_core.Row.html @@ -1,2 +1,2 @@ Row | UpSet 2.0

    Type alias Row

    Row: Subset | Aggregate

    A row in the plot

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    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 26a8a8d2..3f8d9017 100644 --- a/types/_visdesignlab_upset2_core.RowMap.html +++ b/types/_visdesignlab_upset2_core.RowMap.html @@ -1,2 +1,2 @@ RowMap | UpSet 2.0

    Type alias RowMap

    RowMap: Record<string, Row>

    Maps Row IDs to Row objects

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    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 c2a20f95..067283cb 100644 --- a/types/_visdesignlab_upset2_core.RowType.html +++ b/types/_visdesignlab_upset2_core.RowType.html @@ -1,2 +1,2 @@ RowType | UpSet 2.0

    Type alias RowType

    RowType: "Set" | "Subset" | "Group" | "Aggregate" | "Query Group" | "Seperator" | "Undefined"

    Represents a row in the UpSet plot.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    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 ba620843..ba5f750b 100644 --- a/types/_visdesignlab_upset2_core.Rows.html +++ b/types/_visdesignlab_upset2_core.Rows.html @@ -1 +1 @@ -Rows | UpSet 2.0

    Type alias Rows

    Rows: Subsets | Aggregates

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type alias Rows

    Rows: Subsets | Aggregates

    Settings

    Member Visibility

    Theme

    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 900edeea..b69482a6 100644 --- a/types/_visdesignlab_upset2_core.Scatterplot.html +++ b/types/_visdesignlab_upset2_core.Scatterplot.html @@ -1,2 +1,2 @@ Scatterplot | UpSet 2.0

    Type alias Scatterplot

    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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    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 6d9449f8..26eafe21 100644 --- a/types/_visdesignlab_upset2_core.SetMembershipStatus.html +++ b/types/_visdesignlab_upset2_core.SetMembershipStatus.html @@ -1 +1 @@ -SetMembershipStatus | UpSet 2.0

    Type alias SetMembershipStatus

    SetMembershipStatus: "Yes" | "No" | "May"

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type alias SetMembershipStatus

    SetMembershipStatus: "Yes" | "No" | "May"

    Settings

    Member Visibility

    Theme

    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 ca1084c6..d82e8751 100644 --- a/types/_visdesignlab_upset2_core.Sets.html +++ b/types/_visdesignlab_upset2_core.Sets.html @@ -1 +1 @@ -Sets | UpSet 2.0

    Type alias Sets

    Sets: {
        [set_id: string]: BaseIntersection;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type alias Sets

    Sets: {
        [set_id: string]: BaseIntersection;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    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 921e98c4..d8d6f38d 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.

    -

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    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 7586072c..ff5ebdd4 100644 --- a/types/_visdesignlab_upset2_core.SortByOrder.html +++ b/types/_visdesignlab_upset2_core.SortByOrder.html @@ -1 +1 @@ -SortByOrder | UpSet 2.0

    Type alias SortByOrder

    SortByOrder: "Ascending" | "Descending"

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type alias SortByOrder

    SortByOrder: "Ascending" | "Descending"

    Settings

    Member Visibility

    Theme

    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 a63469f3..37758607 100644 --- a/types/_visdesignlab_upset2_core.SortVisibleBy.html +++ b/types/_visdesignlab_upset2_core.SortVisibleBy.html @@ -1 +1 @@ -SortVisibleBy | UpSet 2.0

    Type alias SortVisibleBy

    SortVisibleBy: typeof sortVisibleByList[number]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type alias SortVisibleBy

    SortVisibleBy: typeof sortVisibleByList[number]

    Settings

    Member Visibility

    Theme

    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 21044097..39959c1b 100644 --- a/types/_visdesignlab_upset2_core.Subset.html +++ b/types/_visdesignlab_upset2_core.Subset.html @@ -1,2 +1,2 @@ Subset | UpSet 2.0

    Type alias Subset

    Subset: BaseIntersection

    A single subset

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    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 07568667..d316c613 100644 --- a/types/_visdesignlab_upset2_core.Subsets.html +++ b/types/_visdesignlab_upset2_core.Subsets.html @@ -1,2 +1,2 @@ Subsets | UpSet 2.0

    Type alias Subsets

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

    A list of subsets & their order

    -

    Type declaration

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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    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 2de2600b..362b855d 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

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    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 1d190c12..0fada329 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.

    -

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    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 a5c4d19e..0b481bed 100644 --- a/types/_visdesignlab_upset2_react.ContextMenuItem.html +++ b/types/_visdesignlab_upset2_react.ContextMenuItem.html @@ -1,4 +1,4 @@ ContextMenuItem | UpSet 2.0

    Type alias ContextMenuItem

    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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    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 e6667036..d8f9b739 100644 --- a/types/_visdesignlab_upset2_react.Metadata.html +++ b/types/_visdesignlab_upset2_react.Metadata.html @@ -1 +1 @@ -Metadata | UpSet 2.0

    Type alias Metadata

    Metadata: {
        [key: string]: unknown;
    }

    Type declaration

    • [key: string]: unknown

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type alias Metadata

    Metadata: {
        [key: string]: unknown;
    }

    Type declaration

    • [key: string]: unknown

    Settings

    Member Visibility

    Theme

    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 65d7518e..8ca17cbb 100644 --- a/types/_visdesignlab_upset2_react.UpsetActions.html +++ b/types/_visdesignlab_upset2_react.UpsetActions.html @@ -1 +1 @@ -UpsetActions | UpSet 2.0

    Type alias UpsetActions

    UpsetActions: ReturnType<typeof getActions>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type alias UpsetActions

    UpsetActions: ReturnType<typeof getActions>

    Settings

    Member Visibility

    Theme

    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 d7e8c0d9..b2806399 100644 --- a/types/_visdesignlab_upset2_react.UpsetProvenance.html +++ b/types/_visdesignlab_upset2_react.UpsetProvenance.html @@ -1 +1 @@ -UpsetProvenance | UpSet 2.0

    Type alias UpsetProvenance

    UpsetProvenance: ReturnType<typeof initializeProvenanceTracking>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type alias UpsetProvenance

    UpsetProvenance: ReturnType<typeof initializeProvenanceTracking>

    Settings

    Member Visibility

    Theme

    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 0f985aad..128f97f1 100644 --- a/variables/_visdesignlab_upset2_core.DefaultConfig.html +++ b/variables/_visdesignlab_upset2_core.DefaultConfig.html @@ -1 +1 @@ -DefaultConfig | UpSet 2.0

    Variable DefaultConfigConst

    DefaultConfig: UpsetConfig = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Variable DefaultConfigConst

    DefaultConfig: UpsetConfig = ...

    Settings

    Member Visibility

    Theme

    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 a7d74b98..092c16ca 100644 --- a/variables/_visdesignlab_upset2_core.UNINCLUDED.html +++ b/variables/_visdesignlab_upset2_core.UNINCLUDED.html @@ -1 +1 @@ -UNINCLUDED | UpSet 2.0

    Variable UNINCLUDEDConst

    UNINCLUDED: "unincluded" = 'unincluded'

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Variable UNINCLUDEDConst

    UNINCLUDED: "unincluded" = 'unincluded'

    Settings

    Member Visibility

    Theme

    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 d8da0d8e..c30afb9d 100644 --- a/variables/_visdesignlab_upset2_core.aggregateByList.html +++ b/variables/_visdesignlab_upset2_core.aggregateByList.html @@ -1 +1 @@ -aggregateByList | UpSet 2.0

    Variable aggregateByListConst

    aggregateByList: readonly ["Degree", "Sets", "Deviations", "Overlaps", "None"] = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Variable aggregateByListConst

    aggregateByList: readonly ["Degree", "Sets", "Deviations", "Overlaps", "None"] = ...

    Settings

    Member Visibility

    Theme

    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 66566c5e..cf0627d4 100644 --- a/variables/_visdesignlab_upset2_core.sortVisibleByList.html +++ b/variables/_visdesignlab_upset2_core.sortVisibleByList.html @@ -1 +1 @@ -sortVisibleByList | UpSet 2.0

    Variable sortVisibleByListConst

    sortVisibleByList: readonly ["Alphabetical", "Ascending", "Descending"] = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Variable sortVisibleByListConst

    sortVisibleByList: readonly ["Alphabetical", "Ascending", "Descending"] = ...

    Settings

    Member Visibility

    Theme

    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 c5a939b1..17bceeac 100644 --- a/variables/_visdesignlab_upset2_react.upsetConfigAtom.html +++ b/variables/_visdesignlab_upset2_react.upsetConfigAtom.html @@ -1 +1 @@ -upsetConfigAtom | UpSet 2.0

    Variable upsetConfigAtomConst

    upsetConfigAtom: RecoilState<UpsetConfig> = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Variable upsetConfigAtomConst

    upsetConfigAtom: RecoilState<UpsetConfig> = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file