Skip to main content

Function: useDashboard()

useDashboard(): object

Defined in: DashboardProvider.tsx:283

Returns​

object

addCard​

addCard: (item) => void

Parameters​

ParameterType
itemCardCatalogItem

Returns​

void

cancelEdit​

cancelEdit: () => void

Returns​

void

cancelSaveAsNew​

cancelSaveAsNew: () => void

Returns​

void

cardCatalog​

cardCatalog: CardCatalogItem[]

confirmSaveAsNew​

confirmSaveAsNew: (title) => void

Parameters​

ParameterType
titlestring

Returns​

void

editable​

editable: boolean

editingGrid​

editingGrid: DashboardGridItem[] | null

filters​

filters: DashboardFilter[]

isEditMode​

isEditMode: boolean

onLayoutChange​

onLayoutChange: (currentLayout) => void

Parameters​

ParameterType
currentLayoutLayout[]

Returns​

void

removeCard​

removeCard: (id) => void

Parameters​

ParameterType
idstring

Returns​

void

saveAsNew​

saveAsNew: () => void

Returns​

void

saveAsNewModalOpen​

saveAsNewModalOpen: boolean

saveEdit​

saveEdit: () => void

Returns​

void

selectedTemplate​

selectedTemplate: DashboardTemplate | undefined

startEdit​

startEdit: () => void

Returns​

void

templates​

templates: DashboardTemplate[]

updateCard​

updateCard: (id, cardPatch) => void

Parameters​

ParameterType
idstring
cardPatchRecord<string, unknown>

Returns​

void

updateFilter​

updateFilter: (key, value) => void

Parameters​

ParameterType
keystring
valueDashboardFilterValue

Returns​

void