Options
All
  • Public
  • Public/Protected
  • All
Menu

Cognite JavaScript SDK

Index

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

Acl3D

AclAction3D

AclAction3D: READ | CREATE | UPDATE | DELETE

AclActionAnalytics

AclActionAnalytics: READ | EXECUTE | LIST

AclActionApiKeys

AclActionApiKeys: LIST | CREATE | DELETE

AclActionAssets

AclActionAssets: LIST | WRITE

AclActionEvents

AclActionEvents: READ | WRITE

AclActionFiles

AclActionFiles: READ | WRITE

AclActionGroups

AclActionGroups: LIST | READ | CREATE | UPDATE | DELETE

AclActionProjects

AclActionProjects: LIST | READ | CREATE | UPDATE

AclActionRaw

AclActionRaw: READ | WRITE | LIST

AclActionSecurityCategories

AclActionSecurityCategories: MEMBEROF | LIST | CREATE | DELETE

AclActionSequences

AclActionSequences: READ | WRITE

AclActionTimeseries

AclActionTimeseries: READ | WRITE

AclActionUsers

AclActionUsers: LIST | CREATE | DELETE

AclAnalytics

AclApiKeys

AclAssets

AclEvents

AclFiles

AclGroups

AclProjects

AclRaw

AclScope3D

AclScope3D: AclScopeAll

AclScopeAnalytics

AclScopeAnalytics: AclScopeAll

AclScopeApiKeys

AclScopeApiKeys: AclScopeAll | AclScopeCurrentUser

AclScopeAssets

AclScopeAssets: AclScopeAll

AclScopeEvents

AclScopeEvents: AclScopeAll

AclScopeFiles

AclScopeFiles: AclScopeAll

AclScopeGroups

AclScopeProjects

AclScopeProjects: AclScopeAll

AclScopeRaw

AclScopeRaw: AclScopeAll

AclScopeSecurityCategories

AclScopeSecurityCategories: AclScopeAll

AclScopeSequences

AclScopeSequences: AclScopeAll

AclScopeTimeseries

AclScopeTimeseries: AclScopeAll | AclScopeAssetsId

AclScopeUsers

AclScopeUsers: AclScopeAll

AclSecurityCategories

AclSequences

AclTimeseries

AclUsers

Aggregate

Aggregate: "average" | "max" | "min" | "count" | "sum" | "interpolation" | "stepInterpolation" | "totalVariation" | "continuousVariance" | "discreteVariance"

ArrayPatchLong

ArrayPatchLong: object | object

AssetAggregatedProperty

AssetAggregatedProperty: "childCount"

AssetChange

AssetDescription

AssetDescription: string

Description of asset.

AssetExternalId

AssetExternalId: ExternalId

AssetIdEither

AssetIdEither: IdEither

AssetInternalId

AssetInternalId: InternalId

AssetName

AssetName: string

Name of asset. Often referred to as tag.

AssetSource

AssetSource: string

The source of this asset

AutoPagingEach

AutoPagingEach: function

Type declaration

AutoPagingEachHandler

AutoPagingEachHandler: function

Type declaration

    • (item: T): false | true | void | Promise<void | boolean>
    • Parameters

      • item: T

      Returns false | true | void | Promise<void | boolean>

AutoPagingToArray

AutoPagingToArray: function

Type declaration

BaseRequestOptions

BaseRequestOptions: HttpRequestOptions

CREATE

CREATE: "CREATE"

CogniteCapability

CogniteCapability: SingleCogniteCapability[]

CogniteExternalId

CogniteExternalId: string

External Id provided by client. Should be unique within the project.

CogniteInternalId

CogniteInternalId: number

CreateAssetMapping3D

CreateAssetMapping3D: AssetMapping3DBase

CursorAndAsyncIterator

CursorAndAsyncIterator: CursorAndAsyncIterator<T>

DELETE

DELETE: "DELETE"

DatapointsDeleteRequest

DatapointsGetDatapoint

DatapointsPostDatapoint

DatapointsQuery

DateRange

DateRange: Range<Timestamp>

DefaultGroupId

DefaultGroupId: number

A default group for all project users. Can be used to establish default capabilities. WARNING: this group may be logically deleted

DeleteAssetMapping3D

DeleteAssetMapping3D: AssetMapping3DBase

EXECUTE

EXECUTE: "EXECUTE"

EventChange

FileChangeUpdate

FileContent

FileContent: ArrayBuffer | Buffer | any

FileMimeType

FileMimeType: string

File type. E.g. text/plain, application/pdf, ...

FileName

FileName: string

Name of the file.

GroupName

GroupName: string

Name of the group

example

Production Engineers

GroupSourceId

GroupSourceId: string

ID of the group in the source. If this is the same ID as a group in the IDP, a user in that group will implicitly be a part of this group as well.

example

b7c9a5a4-99c2-4785-bed3-5e6ad9a78603

Groups

IdEither

IntegerRange

IntegerRange: Range<number>

Range between two integers

ItemsResponse

ItemsResponse: ItemsWrapper<T[]>

LIST

LIST: "LIST"

LatestDataBeforeRequest

ListRawDatabases

ListRawDatabases: FilterQuery

ListRawTables

ListRawTables: FilterQuery

ListReveal3DNodeAncestors

ListReveal3DNodeAncestors: FilterQuery

LogoutUrl

LogoutUrl: string

The url to send the user to in order to log out

example

https://accounts.google.com/logout

MEMBEROF

MEMBEROF: "MEMBEROF"

NullableSinglePatchLong

NullableSinglePatchLong: object | object

NullableSinglePatchString

NullableSinglePatchString: object | object

ObjectPatch

ObjectPatch: object | object

OnAuthenticate

OnAuthenticate: function

Type declaration

OnTokens

OnTokens: function

Type declaration

    • (tokens: AuthTokens): void
    • Parameters

      • tokens: AuthTokens

      Returns void

ProjectName

ProjectName: string

The display name of the project.

example

Open Industrial Data

READ

READ: "READ"

Response

Response: HttpResponse<any>

SequenceChange

SequenceChange: SequencePatch & IdEither

SequenceColumnDescription

SequenceColumnDescription: string

Description of the column

SequenceColumnName

SequenceColumnName: string

Human readable name of the column

SequenceDescription

SequenceDescription: string

Description of the sequence

SequenceItem

SequenceItem: number | string | null

Element of type corresponding to the column type. May include NULL!

SequenceName

SequenceName: string

Name of the sequence

SequenceRowsDelete

SequenceRowsDelete: SequenceRowsDeleteData & IdEither

SequenceRowsInsert

SequenceRowsInsert: SequenceRowsInsertData & IdEither

SequenceRowsRetrieve

SequenceRowsRetrieve: SequenceRowsRetriveData & IdEither

A request for datapoints stored

ServiceAccountName

ServiceAccountName: string

Unique name of the service account

SingleCogniteCapability

SingleCogniteCapability: object | object | object | object | object | object | object | object | object | object | object | object | object

SinglePatchDate

SinglePatchDate: object | object

SinglePatchString

SinglePatchString: SetField<string> | RemoveField

TimeSeriesUpdate

TimeseriesIdEither

TimeseriesIdEither: InternalId | ExternalId

Timestamp

Timestamp: number | Date

Tuple3

Tuple3: T[]

UPDATE

UPDATE: "UPDATE"

UrlName

UrlName: string

The url name of the project. This is used as part of API calls. It should only contain letters, digits and hyphens, as long as the hyphens are not at the start or end.

example

publicdata

ValidDomains

ValidDomains: string[]

List of valid domains. If left empty, any user registered with the OAuth2 provider will get access.

WRITE

WRITE: "WRITE"

Variables

Const POPUP

POPUP: "POPUP" = "POPUP"

Const REDIRECT

REDIRECT: "REDIRECT" = "REDIRECT"

Functions

Const cdfRetryValidator

isLoginPopupWindow

  • isLoginPopupWindow(): boolean

loginPopupHandler

  • loginPopupHandler(): void

Object literals

Const HttpResponseType

HttpResponseType: object

ArrayBuffer

ArrayBuffer: "json" | "arraybuffer" | "text" = 'arraybuffer' as HttpResponseType

Json

Json: "json" | "arraybuffer" | "text" = 'json' as HttpResponseType

Text

Text: "json" | "arraybuffer" | "text" = 'text' as HttpResponseType

Const SequenceValueType

SequenceValueType: object

What type the datapoints in a column will have. DOUBLE is restricted to the range [-1E100, 1E100]

default

STRING

DOUBLE

DOUBLE: "STRING" | "DOUBLE" | "LONG" = 'DOUBLE' as SequenceValueType

LONG

LONG: "STRING" | "DOUBLE" | "LONG" = 'LONG' as SequenceValueType

STRING

STRING: "STRING" | "DOUBLE" | "LONG" = 'STRING' as SequenceValueType