Hierarchy

  • Model
    • AssetHierarchyItem

Index

Constructors

constructor

Properties

_new

_new: boolean

assetTypeName

assetTypeName: string

Unique identifier name of the <a href="https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type\" target="_blank">Kelvin Asset Type linked to this <a href="https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target="_blank">Kelvin Asset.

entityTypeName

entityTypeName: string

Unique identifier name of the entity type linked to this <a href="https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class\" target="_blank">Kelvin Asset Class.

hierarchy

A list of all <a href="https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target="_blank">Kelvin Assets which will include any Kelvin Asset, Kelvin Components, Kelvin Parts or Kelvin Sensors that are in the hierarchy below this <a href="https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target="_blank">Kelvin Assets.

metrics

name

name: string

Unique identifier name for this property in the <a href="https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset\" target="_blank">Kelvin Asset.

This must contain only lowercase alphanumeric characters. The ., _ and - characters are also allowed to separate words instead of a space BUT can not be at the beginning or end of the name.

status

status: string

Current status (state) of the Kelvin Asset. There are four status options; online, offline, partially_online and unknown.

title

title: string

Display name (title) for this property in the <a href="https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset\" target="_blank">Kelvin Asset. This is a friendly name displayed in lists and in references within asset details.

You can use any character, numeric, space and special character in this parameter.

visualization

visualization: Visualization

2D and 3D information and links to the models for displaying in <a href="https://docs.kelvininc.com/latest/kelvin-overview/kelvin-maps/\" target="_blank">Kelvin Maps. More details about the use of these models can be found in the <a href="https://docs.kelvininc.com/latest/documentation/kelvin-maps/kelvin-maps-asset-details/#2d-3d-option\" target="_blank">Kelvin Maps Documentation.

Methods

clone

getClass

  • getClass(): Function

mapping

  • mapping(): {}

serializeArray

  • serializeArray(obj: any[]): Object

serializeObject

  • serializeObject(obj: any): any

serializeObjectInstance

  • serializeObjectInstance(obj: Object): Object

stringify

  • stringify(): string

toJSONObject

  • toJSONObject(): Object