Data SDK

Installation

To get started with the Data SDK, visit the appropriate setup guide for your environment:

API Overview

The sections below contain an overview of Unfolded Data SDK organized by function.

Map Functions

API Function

Description

create-map

Create a map record, specifying the map state and list of associated datasets.

copy-map

Copy an existing map, copying the map and layer configuration.

get-map

Get a map record, including the full map state and list of associated datasets.

update-map

Update a map record, including the map state and list of associated datasets.

replace-dataset

Replace a dataset on a map.

delete-map

Delete a map record.

list-maps

Get all map records for the user.

Data Functions

API Function

Description

upload-file

Create a dataset from a data upload.

get-dataset

Get a data record.

download-dataset

Download a dataset.

update-dataset

Update a data record with an upload.

delete-dataset

Delete a dataset. Deletes all data associated with the dataset.

list-datasets

Get all dataset records for the user.

Hex Tile Functions

API Function

Description

create_hextile

Process a dataset into Hex Tiles.

enrich

Enrich a dataset with Hex Tiles. Enriching refers to the process of combining a non-Hex Tile dataset with a Hex Tile dataset.

API Reference

Visit the Data SDK's API Reference to view all functions, methods, and parameter specifications.


Did this page help you?