JavaScript & React libraryAPIFunctionsdownloadCosmographData

Function: downloadCosmographData()

downloadCosmographData(config, pointsData, linksData?): Promise<undefined | CosmographDataPrepResult<CosmographData>>

Downloads the prepared Cosmograph data in the specified format and Cosmograph configuration object for this data.

Parameters

ParameterTypeDescription
configCosmographDataPrepConfigThe configuration for preparing the Cosmograph data.
pointsDataDataThe data for the Cosmograph points.
linksData?DataThe data for the Cosmograph links (optional).

Returns

Promise<undefined | CosmographDataPrepResult<CosmographData>>

The configuration of the downloaded Cosmograph data, or undefined if the download failed.