Interface TimeSeries

Export

TimeSeries

interface TimeSeries {
    begin?: Date;
    dateVersionType?: TimeSeriesDateVersionTypeEnum;
    end?: Date;
    interval?: TimeSeriesInterval;
    intervalOffset?: number;
    name?: string;
    nextPage?: string;
    officeId?: string;
    page?: string;
    pageSize?: number;
    timeZone?: string;
    total?: number;
    units: string;
    valueColumns?: TimeSeriesColumn[];
    values?: object[][];
    versionDate?: Date;
    verticalDatumInfo?: VerticalDatumInfo;
}

Properties

begin? dateVersionType? end? interval? intervalOffset? name? nextPage? officeId? page? pageSize? timeZone? total? units valueColumns? values? versionDate? verticalDatumInfo?

Properties

Optional Readonly begin

begin?: Date

The requested start time of the data, in ISO-8601 format with offset and timezone ('yyyy-MM-dd'T'HH:mm:ssZ'['VV']'')

Memberof

TimeSeries

Optional dateVersionType

dateVersionType?: TimeSeriesDateVersionTypeEnum

Version type specifies the type of timeseries response to be received. Can be max aggregate or single version. Max aggregate cannot be run if version date field is specified.

Memberof

TimeSeries

Optional Readonly end

end?: Date

The requested end time of the data, in ISO-8601 format with offset and timezone ('yyyy-MM-dd'T'HH:mm:ssZ'['VV']'')

Memberof

TimeSeries

Optional interval

interval?: TimeSeriesInterval

Memberof

TimeSeries

Optional Readonly intervalOffset

intervalOffset?: number

Offset from top of interval

Memberof

TimeSeries

Optional name

name?: string

Time-series name

Memberof

TimeSeries

Optional Readonly nextPage

nextPage?: string

The cursor to the next page of data; null if there is no more data

Memberof

TimeSeries

Optional officeId

officeId?: string

Office ID that owns the time-series

Memberof

TimeSeries

Optional Readonly page

page?: string

The cursor to the current page of data

Memberof

TimeSeries

Optional Readonly pageSize

pageSize?: number

The number of records fetched per-page; this may be larger than the number of records actually retrieved

Memberof

TimeSeries

Optional Readonly timeZone

timeZone?: string

Only on 21.1.1 Database. The timezone the Interval Offset is from.

Memberof

TimeSeries

Optional Readonly total

total?: number

The total number of records retrieved; null or not present if not supported or unknown

Memberof

TimeSeries

units

units: string

The units of the time series data

Memberof

TimeSeries

Optional Readonly valueColumns

valueColumns?: TimeSeriesColumn[]

The columns of the time-series data array returned, this property is used to describe the data structure of the records array. Contains [name, ordinal, datatype]. Name corresponds to the variable described by the data, ordinal is the order of the column in the data value array returned (starts at index 1), and datatype is the class name of the data type for the variable. Since the records array can be of variable length, the column index value is used to identify the position of the data in the array.

Memberof

TimeSeries

Optional values

values?: object[][]

Memberof

TimeSeries

Optional versionDate

versionDate?: Date

The version date of the time series trace

Memberof

TimeSeries

Optional verticalDatumInfo

verticalDatumInfo?: VerticalDatumInfo

Memberof

TimeSeries

Settings

Member Visibility

Theme

On This Page

begindateVersionTypeendintervalintervalOffsetnamenextPageofficeIdpagepageSizetimeZonetotalunitsvalueColumnsvaluesversionDateverticalDatumInfo