Docs

File

core/common/group.service.ts

Index

Properties

dataBrokerSourceFragmentInactive
Readonly icons

Methods

Async getIcon
isAnyGroup
isAsset
isDataBroker
isDataBrokerActive
isDevice
isDynamicGroup
isGroup

Constructor

constructor(assetTypesService: AssetTypesService)

Parameters :

Name	Type	Optional
assetTypesService	`AssetTypesService`	No

Methods

Async getIcon

getIcon(mo: IManagedObject, open)

Finds an icon based on the contents of a managed object. It takes into account factors such as type, and specific fragments.

Parameters :

Name	Type	Optional	Default value	Description
mo	`IManagedObject`	No		Managed object to be checked.
open		No	`false`	Determines whether the method should return an alternative icon showing the open state.

Returns : Promise<string>

Returns an icon.

isAnyGroup

isAnyGroup(mo: IManagedObject)

Checks whether the object belongs to any type of group. Types of groups: group, dynamic group, data broker, data broker active.

Parameters :

Name	Type	Optional	Description
mo	`IManagedObject`	No	Managed object to be checked.

Returns : boolean

Returns true if the managed object belongs to the group category.

isAsset

isAsset(mo: IManagedObject)

Checks whether a given managed object is an asset.

Parameters :

Name	Type	Optional	Description
mo	`IManagedObject`	No	Managed object to be checked.

Returns : boolean

Returns true if the managed object is an asset.

isDataBroker

isDataBroker(mo: IManagedObject)

Checks whether a given managed object is a data broker.

Parameters :

Name	Type	Optional	Description
mo	`IManagedObject`	No	Managed object to be checked.

Returns : boolean

Returns true if the managed object is a data broker.

isDataBrokerActive

isDataBrokerActive(mo: IManagedObject)

Checks whether a given managed object is a data broker active.

Parameters :

Name	Type	Optional	Description
mo	`IManagedObject`	No	Managed object to be checked.

Returns : boolean

Returns true if the managed object is a data broker active.

isDevice

isDevice(mo: IManagedObject)

Checks whether a given managed object is a device.

Parameters :

Name	Type	Optional	Description
mo	`IManagedObject`	No	Managed object to be checked.

Returns : boolean

Returns true if the managed object is a device.

isDynamicGroup

isDynamicGroup(mo: IManagedObject)

Checks whether a given managed object is a dynamic group.

Parameters :

Name	Type	Optional	Description
mo	`IManagedObject`	No	Managed object to be checked.

Returns : boolean

Returns true if the managed object is a dynamic group.

isGroup

isGroup(mo: IManagedObject)

Checks whether a given managed object is a group.

Parameters :

Name	Type	Optional	Description
mo	`IManagedObject`	No	Managed object to be checked.

Returns : boolean

Returns true if the managed object is a group.

Properties

dataBrokerSourceFragmentInactive

Default value : `_${GroupFragment.dataBrokerSourceFragment}`

Readonly icons

Type : Icons

Default value :

{
    brokerSourceInactive: {
      icon: 'c8y-group-remote-inactive',
      iconOpen: 'c8y-group-remote-inactive'
    },
    brokerSource: {
      icon: 'c8y-group-remote',
      iconOpen: 'c8y-group-remote-open'
    },
    group: {
      icon: 'c8y-group',
      iconOpen: 'c8y-group-open'
    },
    dynamicGroup: {
      icon: 'c8y-group-smart',
      iconOpen: 'c8y-group-smart-open'
    },
    other: {
      icon: 'exchange',
      iconClass: 'statusUnknown'
    }
  }

File

Index

Properties

Methods

Constructor

Methods

Properties

results matching ""

No results matching ""