shoebox

Available for:Map PanelBI Map PanelRecipe PanelCustom Panel

The Shoebox interface allows to mange your shoeboxes.

Methods

Name Summary
addEntry

Add new entry to the existing shoebox

getList

Get list of shoeboxes

getShoeboxById

Find shoebox using its ID

remove

Remove give shoebox (shoeboxes)

removeEntry

Remvoe entry from the existing shoebox

Methods • Details

addEntry(dataset, shoeboxId, callback, errback) → {void}(async)

async
Available for:Map PanelBI Map PanelRecipe PanelCustom Panel

Add new entry to the existing shoebox

Parameters

Name Type Description
dataset Object
{
 "id": string,
 "name": string
}

Daset which will be added to the existing shoebox

id

Id of dataset

name

New shoebox entry name

shoeboxId string

Id of existing shoebox

callback optional

Callback executed on success

errback optional

Callback executed on failure

Returns

TypeDescription
void

getList(callback, errback) → {void}(async)

async
Available for:Map PanelBI Map PanelRecipe PanelCustom Panel

Get list of shoeboxes

Parameters

Name Type Description
callback optional

Callback executed on success

errback optional

Callback executed on failure

Returns

TypeDescription
void

getShoeboxById(shoeboxId, callback, errback) → {void}(async)

async
Available for:Map PanelBI Map PanelRecipe PanelCustom Panel

Find shoebox using its ID

Parameters

Name Type Description
shoeboxId string

Id of looking shoebox

callback optional

Callback executed on success

errback optional

Callback executed on failure

Returns

TypeDescription
void

remove(shoeboxIds, callback, errback) → {void}(async)

async
Available for:Map PanelBI Map PanelRecipe PanelCustom Panel

Remove give shoebox (shoeboxes)

Parameters

Name Type Description
shoeboxIds string|Arrat.<string>

Id (ids) of shoebox which should be removed

callback optional

Callback executed on success

errback optional

Callback executed on failure

Returns

TypeDescription
void

removeEntry(datasetIds, shoeboxId, callback, errback) → {void}(async)

async
Available for:Map PanelBI Map PanelRecipe PanelCustom Panel

Remvoe entry from the existing shoebox

Parameters

Name Type Description
datasetIds string|Arrat.<string>

Id (ids) of datasets which should be removed

shoeboxId string

Id of existing shoebox

callback optional

Callback executed on success

errback optional

Callback executed on failure

Returns

TypeDescription
void