Cognite JavaScript SDK > TimeSeries

Class: TimeSeries

Hierarchy

TimeSeries

Index

Methods


Methods

<Static> create

create(timeSeries: Partial<Timeseries>[]): Promise<void>

Defined in TimeSeries.ts:80

Parameters:

Name Type
timeSeries Partial<Timeseries>[]

Returns: Promise<void>


<Static> delete

delete(name: string): Promise<void>

Defined in TimeSeries.ts:146

Parameters:

Name Type
name string

Returns: Promise<void>


<Static> list

list(params?: TimeseriesListParams): Promise<TimeseriesWithCursor>

Defined in TimeSeries.ts:151

Parameters:

Name Type
Optional params TimeseriesListParams

Returns: Promise<TimeseriesWithCursor>


<Static> overwriteMultiple

overwriteMultiple(timeseries: Timeseries[]): Promise<void>

Defined in TimeSeries.ts:136

Parameters:

Name Type
timeseries Timeseries[]

Returns: Promise<void>


<Static> retrieve

retrieve(timeseriesId: number, includeMetadata?: * undefined | false | true*): Promise<Timeseries>

Defined in TimeSeries.ts:89

Parameters:

Name Type
timeseriesId number
Optional includeMetadata undefined | false | true

Returns: Promise<Timeseries>


<Static> retrieveMultiple

retrieveMultiple(timeseriesIds: number[]): Promise<Timeseries[]>

Defined in TimeSeries.ts:101

Parameters:

Name Type
timeseriesIds number[]

Returns: Promise<Timeseries[]>


search(params: TimeseriesSearchParams): Promise<TimeseriesWithCursor>

Defined in TimeSeries.ts:161

Parameters:

Name Type
params TimeseriesSearchParams

Returns: Promise<TimeseriesWithCursor>


<Static> update

update(timeseriesId: number, changes: object): Promise<Timeseries>

Defined in TimeSeries.ts:114

Parameters:

Name Type
timeseriesId number
changes object

Returns: Promise<Timeseries>


<Static> updateMultiple

updateMultiple(changes: any[]): Promise<Timeseries[]>

Defined in TimeSeries.ts:125

Parameters:

Name Type
changes any[]

Returns: Promise<Timeseries[]>