@sqlrooms/deck / CreateOrUpdateDeckMapResourceHost

Type Alias: CreateOrUpdateDeckMapResourceHost

CreateOrUpdateDeckMapResourceHost = object

Host callbacks used to coordinate a durable Deck map resource with its block document container, table registry, and optional config preparation.

Properties

ensureBlockDocument

ensureBlockDocument: (blockDocumentId) => void

Parameters

Parameter	Type
blockDocumentId	string

Returns

void

---

findMapBlock

findMapBlock: (blockDocumentId, mapId) => { blockId: string; mapId: string; caption?: string; } | undefined

Parameters

Parameter	Type
blockDocumentId	string
mapId	string

Returns

{ blockId: string; mapId: string; caption?: string; } | undefined

---

findMap

findMap: (mapId) => DeckMapResource | undefined

Parameters

Parameter	Type
mapId	string

Returns

DeckMapResource | undefined

---

createMapBlock

createMapBlock: (options) => Promise<{ blockId: string; mapId: string; }>

Parameters

Parameter	Type
options	{ blockDocumentId: string; mapId: string; title: string; caption?: string; intent?: string; height?: number; }
options.blockDocumentId	string
options.mapId	string
options.title	string
options.caption?	string
options.intent?	string
options.height?	number

Returns

Promise<{ blockId: string; mapId: string; }>

---

updateBlockMetadata

updateBlockMetadata: (options) => void | Promise<void>

Parameters

Parameter	Type
options	{ blockDocumentId: string; blockId: string; caption?: string; intent?: string; height?: number; }
options.blockDocumentId	string
options.blockId	string
options.caption?	string
options.intent?	string
options.height?	number

Returns

void | Promise<void>

---

ensureMap

ensureMap: (mapId, title) => void

Parameters

Parameter	Type
mapId	string
title	string

Returns

void

---

writeMap

writeMap: (options) => void | Promise<void>

Parameters

Parameter	Type
options	{ mapId: string; title: string; config: DeckMapConfig; selectedTable?: string; }
options.mapId	string
options.title	string
options.config	DeckMapConfig
options.selectedTable?	string

Returns

void | Promise<void>

---

findTable

findTable: (tableName) => { tableIdentity: string; } | undefined

Parameters

Parameter	Type
tableName	string

Returns

{ tableIdentity: string; } | undefined

---

prepareConfig?

optional prepareConfig?: (options) => DeckMapConfig | Promise<DeckMapConfig>

Parameters

Parameter	Type
options	{ config: DeckMapConfig; existingMapConfig?: DeckMapConfig; tableName?: string; replaceLayers?: boolean; replaceDatasets?: boolean; }
options.config	DeckMapConfig
options.existingMapConfig?	DeckMapConfig
options.tableName?	string
options.replaceLayers?	boolean
options.replaceDatasets?	boolean

Returns

DeckMapConfig | Promise<DeckMapConfig>