Skip to main content

Function: useDashboard()

useDashboard(): object

Defined in: DashboardProvider.tsx:261

Returns​

object

addCard()​

addCard: (item) => void

Parameters​

item​

CardCatalogItem

Returns​

void

cancelEdit()​

cancelEdit: () => void

Returns​

void

cancelSaveAsNew()​

cancelSaveAsNew: () => void

Returns​

void

cardCatalog​

cardCatalog: CardCatalogItem[]

confirmSaveAsNew()​

confirmSaveAsNew: (title) => void

Parameters​

title​

string

Returns​

void

editable​

editable: boolean

editingGrid​

editingGrid: DashboardGridItem[] | null

filters​

filters: DashboardFilter[]

isEditMode​

isEditMode: boolean

onLayoutChange()​

onLayoutChange: (currentLayout) => void

Parameters​

currentLayout​

Layout[]

Returns​

void

removeCard()​

removeCard: (id) => void

Parameters​

id​

string

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​

id​

string

cardPatch​

Record<string, unknown>

Returns​

void

updateFilter()​

updateFilter: (key, value) => void

Parameters​

key​

string

value​

DashboardFilterValue

Returns​

void