Web SDK documentation
  1. Injectables
  2. DeviceGridService

File

device-grid/device-grid.service.ts

Index

Properties
Methods

Constructor

constructor(inventoryService: InventoryService, userService: UserService, translateService: TranslateService, alertService: AlertService, modal: ModalService, columnUtilService: ColumnUtilService, userPreferencesService: UserPreferencesService, gainsightService?: GainsightService)
Parameters :
Name Type Optional
inventoryService InventoryService No
userService UserService No
translateService TranslateService No
alertService AlertService No
modal ModalService No
columnUtilService ColumnUtilService No
userPreferencesService UserPreferencesService No
gainsightService GainsightService Yes

Methods

Protected 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 Default value
key string No this.GRID_CONFIG_DEFAULT_STORAGE_KEY
Returns : void
Async delete
delete(device: IManagedObject)
Parameters :
Name Type Optional
device IManagedObject No
Returns : Promise<void>
getAlarmsHref
getAlarmsHref(device: IManagedObject)
Parameters :
Name Type Optional
device IManagedObject No
Returns : string
Async getChildDeviceData
getChildDeviceData(columns: DeviceGridColumn[], pagination: Pagination, query: any, withChildren: boolean, id: string)
Parameters :
Name Type Optional Default value
columns DeviceGridColumn[] No
pagination Pagination No
query any No {}
withChildren boolean No false
id string No
Returns : unknown
getChildDeviceGridColumns
getChildDeviceGridColumns()
Returns : DeviceGridColumn[]
getConfig
Use getConfig$(key: string): Observable instead.
getConfig(key: string)
Parameters :
Name Type Optional Default value
key string No this.GRID_CONFIG_DEFAULT_STORAGE_KEY
Returns : GridConfig
getConfig$
getConfig$(key: string)
Decorators :
@mapLegacyGridConfiguration()
Parameters :
Name Type Optional Default value
key string No this.GRID_CONFIG_DEFAULT_STORAGE_KEY
Returns : Observable<GridConfig>
Async getCount
getCount(columns: DeviceGridColumn[], pagination: Pagination, query: any)
Parameters :
Name Type Optional Default value
columns DeviceGridColumn[] No
pagination Pagination No
query any No {}
Returns : unknown
Async getCountChildDevices
getCountChildDevices(columns: DeviceGridColumn[], pagination: Pagination, query: any, id: string)
Parameters :
Name Type Optional Default value
columns DeviceGridColumn[] No
pagination Pagination No
query any No {}
id string No
Returns : unknown
Async getData
getData(columns: DeviceGridColumn[], pagination: Pagination, query: any, withChildren: boolean)
Parameters :
Name Type Optional Default value
columns DeviceGridColumn[] No
pagination Pagination No
query any No {}
withChildren boolean No false
Returns : unknown
getDefaultActionControls
getDefaultActionControls()
Returns : ActionControl[]
getDefaultBulkActionControls
getDefaultBulkActionControls()
Returns : BulkActionControl[]
getDefaultColumns
getDefaultColumns()
Returns : DeviceGridColumn[]
getDefaultHeaderActionControls
getDefaultHeaderActionControls()
Returns : HeaderActionControl[]
getDefaultPagination
getDefaultPagination()
Returns : Pagination
getDeviceQueryString
getDeviceQueryString(columns: DeviceGridColumn[], query: any)
Parameters :
Name Type Optional
columns DeviceGridColumn[] No
query any No
Returns : string
getHref
getHref(groupOrDevice: IManagedObject, prefix: string)
Parameters :
Name Type Optional Default value
groupOrDevice IManagedObject No
prefix string No '#/'
Returns : string
getInfiniteScrollPagination
getInfiniteScrollPagination()
Returns : Pagination
getModel
getModel(device: IManagedObject)
Parameters :
Name Type Optional
device IManagedObject No
Returns : string
getParentsNames
getParentsNames(device: IManagedObject, featuredParentId?: string | number)
Parameters :
Name Type Optional
device IManagedObject No
featuredParentId string | number Yes
Returns : string
getProperName
getProperName(device: IManagedObject)
Parameters :
Name Type Optional
device IManagedObject No
Returns : string
getQueryObj
getQueryObj(columns: DeviceGridColumn[], defaultFilter: object)
Parameters :
Name Type Optional Default value
columns DeviceGridColumn[] No
defaultFilter object No {}
Returns : any
getSerialNumber
getSerialNumber(device: IManagedObject)
Parameters :
Name Type Optional
device IManagedObject No
Returns : string
Async getTotal
getTotal(query: any)
Parameters :
Name Type Optional Default value
query any No {}
Returns : Promise<number>
Async getTotalChildDevices
getTotalChildDevices(query: any, id: string)
Parameters :
Name Type Optional Default value
query any No {}
id string No
Returns : Promise<number>
getUserConfiguredColumns
Use getUserConfiguredColumns$(Column[] | Observable, string) instead.
getUserConfiguredColumns(columns: Column[], storageKey?: string)
Parameters :
Name Type Optional
columns Column[] No
storageKey string Yes
Returns : {}
getUserConfiguredColumns$
getUserConfiguredColumns$(columns: Column[] | Observable<Column[]>, storageKey?: string)
Parameters :
Name Type Optional
columns Column[] | Observable<Column[]> No
storageKey string Yes
Returns : any
saveConfig
Use saveConfig$(config: GridConfig, key: string): Promise instead.
saveConfig(config: GridConfig, key: string)
Parameters :
Name Type Optional Default value
config GridConfig No
key string No this.GRID_CONFIG_DEFAULT_STORAGE_KEY
Returns : void
saveConfig$
saveConfig$(config: GridConfig, key: string)
Parameters :
Name Type Optional Default value
config GridConfig No
key string No this.GRID_CONFIG_DEFAULT_STORAGE_KEY
Returns : Observable<GridConfig>

Properties

Protected DEFAULT_PAGE_SIZE
Type : number
Default value : 20
Protected GRID_CONFIG_DEFAULT_STORAGE_KEY
Type : string
Default value : 'device-grid-config'
Protected queriesUtil
Type : QueriesUtil

results matching ""

    No results matching ""