@cognite/geospatial-sdk-js
The SDK is deprecated. Please go to Stable JS SDK
JavaScript (TypeScript) Cognite Geospatial SDK.
Building
To build and compile the typescript sources to javascript use:
yarn install
yarn build
Consuming
Navigate to the folder of your consuming project and run the following:
yarn install @cognite/geospatial-sdk-js
then initialize like:
import {
CogniteGeospatialClient
} from '@cognite/geospatial-sdk-js';
const getGeoSpatialSDKClient = (project: string, token: string) =>
CogniteGeospatialClient({
project, // eg: your tenant name
token, // eg: bearer token, (OR and api key)
api_key: process.env.REACT_APP_API_KEY,
api_url: 'api.cognitedata.com',
debug: true,
});
Methods available
createSpatial - Create a spatial item with its metadata.
...
getLayerItems - Get all spatial items belong to layer.
...
getCoverage -
...
findSpatial - Searches and returns the spatial items based on resource type content or coordinates.
Eg, to search for wells:
findSpatial({
limit: 100,
layer: 'point',
source: 'wellmodel',
attributes: ['geometry'],
geometry_rel: {
geometry: {
wkt: SOME_GEOMETRY,
crs: 'EPSG:4326',
},
relation: SpatialRel.Within, // exposed from this package
},
outputCRS: 'epsg:4326',
})
Arguments
limit - number - The max amount of results to return layer - string - source - string -