UI Component Reference - v2.63.4
    Preparing search index...

    Interface LoggingDataQuery

    interface LoggingDataQuery {
        decimals?: number;
        extendedBoundary?: boolean;
        factor?: number;
        from?: string;
        limit?: number;
        offset?: number;
        order?: "asc" | "desc";
        postAggr?: Aggregator;
        postTransform?: "difference" | null;
        preAggr?: Aggregator;
        ref?: string;
        selector?: string;
        step?: number | "day" | "week" | "month";
        tag?: { publicId: string } | null;
        to?: string;
        unit?: string;
        variable?: { publicId: string } | null;
    }
    Index

    Properties

    decimals? extendedBoundary? factor? from? limit? offset? order? postAggr? postTransform? preAggr? ref? selector? step? tag? to? unit? variable?

    Properties

    decimals?: number

    Number of decimals to be returned

    extendedBoundary?: boolean

    Whether or not you want to query for extra data-points, one before the start date and one beyond the end date (if they exist).

    factor?: number

    The factor to multiply the value by

    from?: string

    Used to override the global time-range for this specific query

    For example 2019-01-01T00:00:00Z

    limit?: number

    How many values should be fetched. The postAggr is applied to reduce the set of points to the limit.

    offset?: number

    Starting point for returned values

    Must be null if postAggr is set

    order?: "asc" | "desc"

    The order to order datapoints by

    postAggr?: Aggregator

    Aggregrator for aggregation after data storage

    Must be null if offset is set

    postTransform?: "difference" | null

    Apply a transform. Only applies when postAggr is 'last'.

    'difference' takes the difference between the last value in a bucket and the bucket before it.

    preAggr?: Aggregator

    When omitted, the pre-aggregator is determined automatically based on a couple of factors, but in most cases it defaults to "raw".

    ref?: string

    Reference used to identify the value. If not set, a unique reference is generated.

    When the output is formatted as CSV, this reference will be used as the column header. In this case, the variable $TH_UNIT can be used to dynamically render a unit suffix, if applicable. If no unit is configured, it will fallback to an empty string.

    For example: a reference value of "Weight$TH_UNIT" would in CSV format output as "Weight (kg)".

    selector?: string

    The selector for getting data from a specific tag or variable. Can be used instead of tag or variable field

    Formatted as .. where is the name of the datas source, is 'tag' or 'variable' and is the slug of the tag or variable.

    step?: number | "day" | "week" | "month"

    Number of seconds between subsequent data-points

    tag?: { publicId: string } | null

    The tag to fetch the data from. Must be null if variable is set

    to?: string

    Used to override the global time-range for this specific query

    For example 2019-01-01T23:59:59Z

    unit?: string

    The unit of the value

    variable?: { publicId: string } | null

    The variable to fetch the data from. Must be null if tag is set

    Settings

    Member Visibility

    On This Page

    Properties