Hierarchy

Index

Constructors

constructor

Properties

assetClassName

assetClassName: string

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

assetClassTitle

assetClassTitle: string

Display name (title) of the <a href="https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class\" target="_blank">Kelvin Asset Class linked to the <a href="https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target="_blank">Kelvin Asset.

assetTemplateName

assetTemplateName: string

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

If this <a href="https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target="_blank">Kelvin Asset was created from scratch, then this parameter will be null.

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.

assetTypeTitle

assetTypeTitle: string

Display name (title) 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.

created

created: Date

Time of creation of this <a href="https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target="_blank">Kelvin Asset in ISO 8601 UTC date/time format. Example; "2022-07-08T08:41:01.657916Z".

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.

entityTypeTitle

entityTypeTitle: string

Display 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.

failureDetection

failureDetection: FailureDetection

Failure detection settings for this <a href="https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target="_blank">Kelvin Asset. This will show all parameters and settings associated with this <a href="https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target="_blank">Kelvin Asset.

hierarchy

hierarchy: Array<Asset>

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.

location

metrics

name

name: string

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

properties

properties: Array<AssetProperty>

List of any custom properties for this <a href="https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target="_blank">Kelvin Asset.

status

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

title

title: string

Display name (title) of the <a href="https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target="_blank">Kelvin Asset.

updated

updated: Date

Time of modifying any variable of this <a href="https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target="_blank">Kelvin Asset in ISO 8601 UTC date/time format. Example; "2022-07-08T08:41:01.657916Z".

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