@sqlrooms/mosaic / DashboardAiAdapter

Type Alias: DashboardAiAdapter<TState>

DashboardAiAdapter<TState> = object

Type Parameters

Type Parameter
TState

Properties

getTables

getTables: (state) => DashboardAiTable[]

Parameters

Parameter	Type
state	TState

Returns

DashboardAiTable[]

---

hasRunContext?

optional hasRunContext?: (state, context?) => boolean

Parameters

Parameter	Type
state	TState
context?	ChartToolExecutionContext

Returns

boolean

---

resolveContextDashboardArtifactId?

optional resolveContextDashboardArtifactId?: (state, context?) => string | undefined

Parameters

Parameter	Type
state	TState
context?	ChartToolExecutionContext

Returns

string | undefined

---

makeDashboardPrimaryForRun?

optional makeDashboardPrimaryForRun?: (state, dashboardId, context?) => void

Parameters

Parameter	Type
state	TState
dashboardId	string
context?	ChartToolExecutionContext

Returns

void

---

getCurrentDashboardArtifactId

getCurrentDashboardArtifactId: (state) => string | undefined

Parameters

Parameter	Type
state	TState

Returns

string | undefined

---

createDashboardArtifact

createDashboardArtifact: (state, title?, layoutType?) => string

Parameters

Parameter	Type
state	TState
title?	string
layoutType?	MosaicDashboardLayoutType

Returns

string

---

isDashboardArtifact

isDashboardArtifact: (state, artifactId) => boolean

Parameters

Parameter	Type
state	TState
artifactId	string

Returns

boolean

---

setCurrentArtifact

setCurrentArtifact: (state, artifactId) => void

Parameters

Parameter	Type
state	TState
artifactId	string

Returns

void

---

ensureDashboard

ensureDashboard: (state, dashboardId, title?, layoutType?) => void

Parameters

Parameter	Type
state	TState
dashboardId	string
title?	string
layoutType?	MosaicDashboardLayoutType

Returns

void

---

getDashboard

getDashboard: (state, dashboardId) => MosaicDashboardEntry | undefined

Parameters

Parameter	Type
state	TState
dashboardId	string

Returns

MosaicDashboardEntry | undefined

---

getPanelIssue?

optional getPanelIssue?: (state, dashboardId, panelId) => ChartRuntimeIssue | undefined

Parameters

Parameter	Type
state	TState
dashboardId	string
panelId	string

Returns

ChartRuntimeIssue | undefined

---

setSelectedTable

setSelectedTable: (state, dashboardId, tableName) => void

Parameters

Parameter	Type
state	TState
dashboardId	string
tableName	string

Returns

void

---

addPanel

addPanel: (state, dashboardId, panel) => string

Parameters

Parameter	Type
state	TState
dashboardId	string
panel	MosaicDashboardPanelConfig

Returns

string

---

updatePanel

updatePanel: (state, dashboardId, panelId, patch) => void

Parameters

Parameter	Type
state	TState
dashboardId	string
panelId	string
patch	Partial<PanelPatch>

Returns

void

---

removePanel

removePanel: (state, dashboardId, panelId) => void

Parameters

Parameter	Type
state	TState
dashboardId	string
panelId	string

Returns

void