Class Dataset

See

API.getDataset

Example

//Don't use this constructor directly, use:
API.v1.createDataset(caseId, datasetId, widgetId);

Methods

aggregate excludeColumnFromXssSanitization exec groupBy limit preFilter reset select setPassError skip sort useCaseIdOnly useExternalReference where And Condition Or

Methods

aggregate

  • aggregate(
        column: string,
        operator: string,
        alias: string,
        dataType?: string,
    ): this

    Adds an aggregated column to the dataset

    Parameters

    • column: string
    • operator: string
    • alias: string
    • dataType: string = 'double'

    Returns this

excludeColumnFromXssSanitization

  • excludeColumnFromXssSanitization(alias: string): void

    Parameters

    • alias: string

      the alias of the column to be excluded from xss sanitation

    Returns void

exec

  • exec(): Promise<
        { columns: any; info: any; paging: any; rows: Record<string, any>[] },
    >

    Execute the constructed dataset query and return the result

    Returns Promise<{ columns: any; info: any; paging: any; rows: Record<string, any>[] }>

groupBy

  • groupBy(column: string, alias: string, allowHtml?: boolean): Dataset

    Groups the dataset by a column

    Parameters

    • column: string
    • alias: string
    • allowHtml: boolean = false

    Returns Dataset

limit

  • limit(limit: number): this

    Limit the number of rows to retrieve

    Parameters

    • limit: number

      maximum number of rows to retrieve

    Returns this

preFilter

  • preFilter(list: Or | And | ConditionList): Dataset

    Pre-filter the dataset with a condition list

    Parameters

    • list: Or | And | ConditionList

    Returns Dataset

reset

  • reset(): Dataset

    Remove all sorts / conditions and additional columns

    Returns Dataset

select

  • select(...columns: string[]): Dataset

    Select only a subset of all the available columns

    Parameters

    • ...columns: string[]

      one or multiple columns

    Returns Dataset

setPassError

  • setPassError(enabled?: boolean): this

    Enable or disable error passing to the caller instead of showing error messages When enabled, errors will be passed to the catch() handler instead of being shown in the UI

    Parameters

    • enabled: boolean = true

      whether to pass errors to the caller

    Returns this

skip

  • skip(skip: number): Dataset

    Skip the first n rows of the resulting dataset

    Parameters

    • skip: number

      number of rows to skip

    Returns Dataset

sort

  • sort(column: string, direction?: "asc" | "desc"): Dataset

    Sort the dataset on a column in a given direction. If no direction is given, it will default to 'asc'.

    Parameters

    • column: string
    • direction: "asc" | "desc" = 'asc'

    Returns Dataset

useCaseIdOnly

  • useCaseIdOnly(): Dataset

    Use column ids when sorting, searching and returning data (no aliases, references, etc.) There is only a very small chance you'll ever want to use this other than for debugging.

    Returns Dataset

useExternalReference

  • useExternalReference(): Dataset

    Use column external references when sorting, searching and returning data

    Returns Dataset

where

  • where(list: Or | And | ConditionList): this

    Filter the dataset with a condition list

    Parameters

    • list: Or | And | ConditionList

    Returns this

StaticAnd

  • And(...conditions: (Condition | Or | And)[]): And

    Parameters

    • ...conditions: (Condition | Or | And)[]

      one or more conditions (Condition, Or or And)

    Returns And

    Static

StaticCondition

  • Condition(
        column: string,
        operator: OperatorString,
        value: string,
        valueType: string,
    ): Condition

    Returns a new condition object

    Parameters

    • column: string
    • operator: OperatorString
    • value: string
    • valueType: string

    Returns Condition

    Static

StaticOr

  • Or(...conditions: (Condition | Or | And)[]): Or

    Parameters

    • ...conditions: (Condition | Or | And)[]

      one or more conditions (Condition, Or or And)

    Returns Or

    Static

Settings

Member Visibility

On This Page

Methods