Web SDK documentation
  1. Injectables
  2. DashboardManagerService

File

dashboard-manager/dashboard-manager.service.ts

Extends

DataGridService

Index

Properties
Methods

Constructor

constructor(inventory: InventoryService, userPreferencesService: UserPreferencesService, modal: ModalService, translateService: TranslateService, contextDashboardService: ContextDashboardService)
Parameters :
Name Type Optional
inventory InventoryService No
userPreferencesService UserPreferencesService No
modal ModalService No
translateService TranslateService No
contextDashboardService ContextDashboardService No

Methods

Async delete
delete(dashboard: ContextDashboardManagedObject, onSuccess: () => void)
Parameters :
Name Type Optional
dashboard ContextDashboardManagedObject No
onSuccess function No
Returns : Promise<void>
getColumns
getColumns()
Returns : Column[]
Async getData
getData(columns: Column[], pagination: Pagination, text?: string)
Parameters :
Name Type Optional
columns Column[] No
pagination Pagination No
text string Yes
Returns : Promise<IResultList<IManagedObject>>
getDefaultPagination
getDefaultPagination()
Returns : Pagination
Async getTotal
getTotal()
Returns : Promise<number>
applyConfigToColumns
applyConfigToColumns(config: GridConfig, columns: Column[], storageKey?: string)
Parameters :
Name Type Optional
config GridConfig No
columns Column[] No
storageKey string Yes
Returns : Column[]
clearConfig
clearConfig(key: string)
Parameters :
Name Type Optional
key string No
Returns : void
getConfig$
getConfig$(key: string)
Parameters :
Name Type Optional
key string No
Returns : Observable<GridConfig>
getQueryObj
getQueryObj(columns: Column[], defaultFilter: object)
Parameters :
Name Type Optional Default value
columns Column[] No
defaultFilter object No {}
Returns : any
getUserConfiguredColumns$
getUserConfiguredColumns$(columns: Column[] | Observable<Column[]>, storageKey?: string)
Parameters :
Name Type Optional
columns Column[] | Observable<Column[]> No
storageKey string Yes
Returns : any
saveConfig$
saveConfig$(config: GridConfig, key: string)
Parameters :
Name Type Optional
config GridConfig No
key string No
Returns : Observable<GridConfig>

Properties

baseQuery
Type : object
Default value : { __filter: { __and: [ { 'c8y_Dashboard.deviceType': { __eq: true } }, { __has: 'c8y_Dashboard.deviceTypeValue' } ] } }
queriesUtil
Type : QueriesUtil
Protected DEFAULT_PAGE_SIZE
Type : number
Default value : 20

results matching ""

    No results matching ""