Type aliases
ADFSRequestParamsMapping
ADFSRequestParamsMapping: {}
AclActionSecurityCategories
AclActionTemplateInstances
AclScopeSecurityCategories
AclScopeTemplateInstances
Aggregate
Aggregate: "average" | "max" | "min" | "count" | "sum" | "interpolation" | "stepInterpolation" | "totalVariation" | "continuousVariance" | "discreteVariance"
Aggregates
Aggregates: "avg" | "count" | "max" | "min" | "stCentroid" | "stCollect" | "stConvexHull" | "stIntersection" | "stUnion" | "sum" | "variance"
AnnotatedResourceType
AnnotatedResourceType: "file"
AnnotationPayload
AnnotationPayload: object
AnnotationStatus
AnnotationStatus: "suggested" | "approved" | "rejected"
AnnotationType
AnnotationType: string
ApplicationDomains
ApplicationDomains: string[]
ArrayPatchLong
ArrayPatchLong: { set: number[] } | { add?: number[]; remove?: number[] }
ArrayPatchString
ArrayPatchString: { set: string[] } | { add?: string[]; remove?: string[] }
AssetAggregatedProperty
AssetAggregatedProperty: "childCount" | "path" | "depth"
AssetDescription
AssetDescription: string
AssetName
AssetName: string
AssetSource
AssetSource: string
AssetsSource
Type declaration
-
-
Optional mappings?: undefined | {}
-
type: "assets"
AutoPagingEach
Type parameters
Type declaration
-
-
Parameters
Returns Promise<void>
AutoPagingEachHandler
AutoPagingEachHandler<T>: (item: T) => (false | true | void) | Promise<void | boolean>
Type parameters
Type declaration
-
- (item: T): (false | true | void) | Promise<void | boolean>
-
Parameters
Returns (false | true | void) | Promise<void | boolean>
AutoPagingToArray
Type parameters
Type declaration
-
-
Parameters
Returns Promise<T[]>
CogniteExternalId
CogniteExternalId: string
CogniteInternalId
CogniteInternalId: number
ContextJobId
ContextJobId: number
ContextJobStatus
ContextJobStatus: "QUEUED" | "RUNNING" | "COMPLETED" | "FAILED"
CursorAndAsyncIterator
Type parameters
DataSetWriteProtected
DataSetWriteProtected: boolean
DefaultGroupId
DefaultGroupId: number
DocumentFilterProperty
DocumentFilterProperty: string[]
DocumentFilterRangeValue
DocumentFilterRangeValue: number
DocumentFilterValue
Document
FilterValue: string | number | boolean | Label
DocumentsAggregateAllUniqueValuesRequest
Documents
AggregateAllUniqueValuesRequest: { search?: undefined | { query: string } } & DocumentSearchFilter & { aggregate?: undefined | "allUniqueValues"; cursor?: undefined | string; limit?: undefined | number; properties?: { property: DocumentFilterProperty }[] }
DocumentsAggregateCountRequest
Documents
AggregateCountRequest: { search?: undefined | { query: string } } & DocumentSearchFilter & { aggregate?: undefined | "count" }
DocumentsAggregateRequest
DocumentsAggregateResponse
DocumentsAggregateUniqueValuesRequest
Documents
AggregateUniqueValuesRequest: { search?: undefined | { query: string } } & DocumentSearchFilter & { aggregate?: undefined | "uniqueValues"; limit?: undefined | number; properties?: { property: DocumentFilterProperty }[] }
EXECUTE
EXECUTE: "EXECUTE"
EntityMatchingClassifier
EntityMatchingClassifier: "randomforest" | "decisiontree" | "logisticregression" | "augmentedlogisticregression" | "augmentedrandomforest"
EntityMatchingFeatureType
EntityMatchingFeatureType: "simple" | "bigram" | "frequencyweightedbigram" | "bigramextratokenizers" | "bigramcombo"
EntityMatchingPredictRequest
EntityMatchingRefitRequest
EpochTimestamp
EpochTimestamp: number
EventsSource
Type declaration
-
-
Optional mappings?: undefined | {}
-
type: "events"
ExternalEntityTrueMatchSource
ExternalEntityTrueMatchTarget
ExternalIdPrefix
ExternalIdPrefix: string
ExternalView
External
View: { dataSetId?: undefined | number; externalId: string; source: Source }
Type declaration
-
Optional dataSetId?: undefined | number
-
externalId: string
-
FileContent
FileContent: ArrayBuffer | Buffer | any
FileGeoLocationGeometryType
FileGeoLocationGeometryType: "Point" | "MultiPolygon" | "MultiLineString" | "MultiPoint" | "Polygon" | "LineString"
FileGeoLocationRelation
FileGeoLocationRelation: "intersects" | "disjoint" | "within"
FileGeoLocationType
FileGeoLocationType: "Feature"
FileMimeType
FileMimeType: string
FileName
FileName: string
FilesSource
Type declaration
-
-
Optional mappings?: undefined | {}
-
type: "files"
GeometryPropertyType
GeometryPropertyType: "GEOMETRY" | "POINT" | "LINESTRING" | "POLYGON" | "MULTIPOINT" | "MULTILINESTRING" | "MULTIPOLYGON" | "GEOMETRYCOLLECTION" | "GEOMETRYZ" | "POINTZ" | "LINESTRINGZ" | "POLYGONZ" | "MULTIPOINTZ" | "MULTILINESTRINGZ" | "MULTIPOLYGONZ" | "GEOMETRYM" | "POINTM" | "LINESTRINGM" | "POLYGONM" | "MULTIPOINTM" | "MULTILINESTRINGM" | "MULTIPOLYGONM" | "GEOMETRYCOLLECTIONM" | "GEOMETRYZM" | "POINTZM" | "LINESTRINGZM" | "POLYGONZM" | "MULTIPOINTZM" | "MULTILINESTRINGZM" | "MULTIPOLYGONZM" | "GEOMETRYCOLLECTIONZM"
GeometryType
GeometryType: "WKT" | "GEOJSON"
GeospatialFeatureSearchStreamResponse
GeospatialFeatureSearchStreamResponse: string
GeospatialFeatureTypeProperty
Geospatial
FeatureTypeProperty: { description?: undefined | string; optional?: undefined | false | true; type: Exclude<GeospatialPropertyType, GeometryPropertyType | "STRING"> } | { description?: undefined | string; optional?: undefined | false | true; srid?: undefined | number; type: GeometryPropertyType } | { description?: undefined | string; optional?: undefined | false | true; size: number; type: "STRING" }
GeospatialIndexSpec
GeospatialIndexSpec: { properties: string[] }
GeospatialPropertyType
Geospatial
PropertyType: "STRING" | "LONG" | "DOUBLE" | "BOOLEAN" | "TIMESTAMP" | GeometryPropertyType
GraphQlError
GraphQlError: { locations: { column: number; line: number }[]; message: string; path: string[] }
Type declaration
-
locations: { column: number; line: number }[]
-
message: string
-
path: string[]
GroupName
GroupName: string
GroupSourceId
GroupSourceId: string
HttpCall
Type declaration
-
-
Type parameters
Parameters
Returns Promise<HttpResponse<ResponseType>>
HttpResponseType
HttpResponseType: "json" | "arraybuffer" | "text"
IntegerRange
Integer
Range: Range<number>
ItemsResponse
ItemsResponse<T>: ItemsWrapper<T[]>
Type parameters
KeysOfType
KeysOfType<T, U>: {}[keyof T]
Type parameters
ListEndpoint
Type parameters
ListReveal3DNodeAncestors
LogoutUrl
LogoutUrl: string
MEMBEROF
MEMBEROF: "MEMBEROF"
MultiLineStringCoordinates
NoInfer
NoInfer<T>: [T][T extends any ? 0 : never]
Type parameters
NullableProperty
NullableProperty<T>: T | { isNull: boolean }
Type parameters
NullableSinglePatchLong
NullableSinglePatchLong: { set: number } | { setNull: true }
NullableSinglePatchString
NullableSinglePatchString: { set: string } | { setNull: true }
ObjectOrString
ObjectOrString<T>: {}
Type parameters
ObjectPatch
ObjectPatch<T>: { set: {} } | { add: {}; remove: string[] }
Type parameters
OnTokens
OnTokens: (tokens: AuthTokens) => void
Type declaration
-
- (tokens: AuthTokens): void
Partition
Partition: string
PointCoordinates
Point
Coordinates: Tuple2<number>
ProjectName
ProjectName: string
RelationshipResourceType
RelationshipResourceType: "asset" | "timeSeries" | "file" | "event" | "sequence"
RelationshipsDeleteParams
Response401Handler
Response401
Handler: (err: HttpError, retry: () => void, reject: () => void) => void
Type declaration
-
- (err: HttpError, retry: () => void, reject: () => void): void
-
Parameters
-
-
retry: () => void
-
reject: () => void
Returns void
ResponseHandler
ResponseHandler<ResponseType>: (res: Response) => Promise<ResponseType>
Type parameters
Type declaration
-
- (res: Response): Promise<ResponseType>
-
Parameters
Returns Promise<ResponseType>
Revision3DStatus
Revision3DStatus: "Queued" | "Processing" | "Done" | "Failed"
RevisionMetadata
RevisionMetadata: {}
SequenceColumnDescription
SequenceColumnDescription: string
SequenceColumnName
SequenceColumnName: string
SequenceDescription
SequenceDescription: string
SequenceItem
SequenceItem: number | string | null
SequenceName
SequenceName: string
SequenceValueType
SequenceValueType: "STRING" | "DOUBLE" | "LONG"
SequencesSource
Type declaration
-
-
Optional mappings?: undefined | {}
-
type: "sequences"
ServiceAccountName
ServiceAccountName: string
SinglePatch
SinglePatch<T>: { set: T } | { setNull: boolean }
Type parameters
SinglePatchDate
Single
PatchDate: { set: Timestamp } | { setNull: boolean }
SortOrder
SortOrder: "asc" | "desc"
TimeSeriesSource
Type declaration
-
-
Optional mappings?: undefined | {}
-
type: "timeSeries"
TimeseriesIsStep
TimeseriesIsStep: boolean
TimeseriesIsString
TimeseriesIsString: boolean
TimeseriesName
TimeseriesName: string
TimeseriesUnit
TimeseriesUnit: string
Timestamp
Timestamp: number | Date
Tuple2
Tuple2<T>: [T, T]
Type parameters
Tuple3
Tuple3<T>: T[]
Type parameters
ValidDomains
ValidDomains: string[]
Variables
Const ACCESS_TOKEN
ACCESS_TOKEN: "access_token" = "access_token"
Const ACCESS_TOKEN_PARAM
ACCESS_TOKEN_PARAM: "access_token" = "access_token"
Const CREDENTIALS_REQUIRED_FIELDS
CREDENTIALS_
REQUIRED_FIELDS: CredentialsVerification[] = [{ method: 'api', field: 'apiKey' },{ method: 'client_credentials', field: 'authority' },{ method: 'client_credentials', field: 'client_id' },{ method: 'client_credentials', field: 'client_secret' },{ method: 'client_credentials', field: 'scope' },{ method: 'client_credentials', field: 'grant_type' },{ method: 'device', field: 'authority' },{ method: 'device', field: 'client_id' },{ method: 'device', field: 'scope' },{ method: 'implicit', field: 'authority' },{ method: 'implicit', field: 'client_id' },{ method: 'implicit', field: 'scope' },{ method: 'pkce', field: 'authority' },{ method: 'pkce', field: 'client_id' },{ method: 'pkce', field: 'scope' },]
Const DEFAULT_MAX_RETRY_ATTEMPTS
DEFAULT_MAX_RETRY_ATTEMPTS: 5 = 5
Const ERROR_DESCRIPTION_PARAM
ERROR_DESCRIPTION_PARAM: "error_description" = "error_description"
Const ERROR_PARAM
ERROR_PARAM: "error" = "error"
Const EXPIRES_IN
EXPIRES_IN: "expires_in" = "expires_in"
Const ID_TOKEN
ID_TOKEN: "id_token" = "id_token"
Const ID_TOKEN_PARAM
ID_TOKEN_PARAM: "id_token" = "id_token"
Const LOGIN_IFRAME_NAME
LOGIN_IFRAME_NAME: "adfsSilentLoginIframe" = "adfsSilentLoginIframe"
Const LOGIN_POPUP_NAME
LOGIN_POPUP_NAME: "cognite-js-sdk-auth-popup" = "cognite-js-sdk-auth-popup"
Const OPTIONS_REQUIRED_FIELDS
OPTIONS_REQUIRED_FIELDS: string[] = ['appId', 'project']
Const POPUP
POPUP: "POPUP" = "POPUP"
Const REDIRECT
REDIRECT: "REDIRECT" = "REDIRECT"
Const SCOPE
SCOPE: "scope" = "scope"
Const TOKEN_TYPE
TOKEN_TYPE: "token_type" = "token_type"
Const apiKey
apiKey: "TEST_KEY" = "TEST_KEY"
Const mockBaseUrl
mockBaseUrl: "https://example.com" = "https://example.com"
Const project
project: "TEST_PROJECT" = "TEST_PROJECT"
Const projectId
projectId: 123 = 123
Const retryValidator
retry
Validator: (request: HttpRequest, response: HttpResponse<any>, retryCount: number) => boolean = createRetryValidator(ENDPOINTS_TO_RETRY)
Type declaration
-
-
Parameters
Returns boolean
Const user
user: "user@example.com" = "user@example.com"
List of domains permitted for redirects. Redirects as part of a login flow may only target a domain (or subdomain) on this list. If this list is set to be empty, it will not be possible to use a login flow.