@deephaven/jsapi-types
    Preparing search index...

    Interface OneClick

    A one-click configuration for a chart series.

    A OneClick can be used to select values for one or more columns, and uses those values to select one or more constituent tables from a PartitionedTable.

    interface OneClick {
        get columns(): Column[];
        get requireAllFiltersToDisplay(): boolean;
        getValueForColumn(columnName: string): any;
        setValueForColumn(columnName: string, value: any): void;
    }
    Index
    • get columns(): Column[]

      The columns that can be used to select a constituent table.

      Returns Column[]

    • get requireAllFiltersToDisplay(): boolean

      Whether all column values must be set before a table is selected.

      Returns boolean

    • Gets the currently selected value for columnName.

      Parameters

      • columnName: string

        the column name

      Returns any

      the selected value, or null if no value has been set

    • Sets the selected value for columnName.

      Passing null clears the selected value for the column.

      Parameters

      • columnName: string

        the column name to set a value for

      • value: any

        the selected value, or null to clear

      Returns void