Web SDK documentation
  1. Injectables
  2. AssetSearchService

File

search/search.service.ts

Extends

SubAssetsService

Index

Properties
Methods

Methods

buildCombinedRootQueryFilter
buildCombinedRootQueryFilter(columns, pagination)
Parameters :
Name Optional
columns No
pagination No
Returns : any
Async getData
getData(columns: DeviceGridColumn[], pagination: Pagination)
Parameters :
Name Type Optional
columns DeviceGridColumn[] No
pagination Pagination No
Returns : unknown
Async canAssignDevice
canAssignDevice(group: IManagedObject)
Parameters :
Name Type Optional
group IManagedObject No
Returns : Promise<boolean>
canCreateGroup
canCreateGroup()
Returns : boolean
canDeleteSmartGroup
canDeleteSmartGroup()
Returns : boolean
Async canEditGroup
canEditGroup(group: IManagedObject)
Parameters :
Name Type Optional
group IManagedObject No
Returns : Promise<boolean>
canEditSmartGroup
canEditSmartGroup()
Returns : boolean
Async deleteAsset
deleteAsset(asset: IManagedObject, parentRef: IManagedObject, params: object)
Parameters :
Name Type Optional Default value
asset IManagedObject No
parentRef IManagedObject No
params object No {}
Returns : any
Protected Async getAssetsStatistics
getAssetsStatistics(parentReference: IManagedObject, filters: object)
Parameters :
Name Type Optional
parentReference IManagedObject No
filters object No
Returns : Promise<number>
Async getCount
getCount(columns: DeviceGridColumn[], pagination: Pagination, parentReference: IManagedObject, baseQuery: any)
Parameters :
Name Type Optional Default value
columns DeviceGridColumn[] No
pagination Pagination No
parentReference IManagedObject No
baseQuery any No {}
Returns : Promise<number>
Async getCustomProperties
getCustomProperties(group: IManagedObject)
Parameters :
Name Type Optional
group IManagedObject No
Returns : Promise<IManagedObject[]>
getDefaultActionControls
getDefaultActionControls()
Returns : ActionControl[]
getDefaultBulkActionControls
getDefaultBulkActionControls()
Returns : BulkActionControl[]
getDefaultColumns
getDefaultColumns(filterable: boolean, sortable: boolean)
Parameters :
Name Type Optional Default value
filterable boolean No true
sortable boolean No true
Returns : DeviceGridColumn[]
getDefaultPagination
getDefaultPagination()
Returns : Pagination
getTotal
getTotal(parentReference: IManagedObject, baseQuery: any)
Parameters :
Name Type Optional Default value
parentReference IManagedObject No
baseQuery any No {}
Returns : Promise<number>
isDevice
isDevice(asset: IManagedObject)
Parameters :
Name Type Optional
asset IManagedObject No
Returns : boolean
isSmartGroup
isSmartGroup(group: IManagedObject)
Parameters :
Name Type Optional
group IManagedObject No
Returns : boolean
isUsingInventoryRoles
isUsingInventoryRoles()
Returns : boolean
shouldShowWithDeviceUserCheckbox
shouldShowWithDeviceUserCheckbox(asset: IManagedObject)
Parameters :
Name Type Optional
asset IManagedObject No
Returns : boolean
Async unassignAsset
unassignAsset(asset: IManagedObject, parentRef: IManagedObject)
Parameters :
Name Type Optional
asset IManagedObject No
parentRef IManagedObject No
Returns : any
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 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
getDefaultHeaderActionControls
getDefaultHeaderActionControls()
Returns : HeaderActionControl[]
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 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 : 50
Protected GRID_CONFIG_STORAGE_KEY
Type : string
Default value : 'search-grid-config'
Protected GRID_CONFIG_DEFAULT_STORAGE_KEY
Type : string
Default value : 'sub-assets-grid-config'
queriesUtil
Type : QueriesUtil
uiOnlyCountersUpdate
Default value : new BehaviorSubject(null)

results matching ""

    No results matching ""