Hierarchy

Index

Constructors

constructor

Properties

assetClassName

assetClassName: string

The name (not the Display Name / Title) of the default <a href="https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class\" target="_blank">Kelvin Asset Class that will be selected.

This can be changed by the user when adding the Kelvin Template as a new <a href="https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target="_blank">Kelvin Asset.

assetClassTitle

assetClassTitle: string

The Display Name (Title) of the default <a href="https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-class\" target="_blank">Kelvin Asset Class that will be selected.

This can be changed by the user when adding the Kelvin Template as a new <a href="https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target="_blank">Kelvin Asset.

assetTypeName

assetTypeName: string

The name (not the Display Name / Title) of the default <a href="https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type\" target="_blank">Kelvin Asset Type that will be selected.

This can be changed by the user when adding the Kelvin Template as a new <a href="https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target="_blank">Kelvin Asset.

assetTypeTitle

assetTypeTitle: string

The Display Name (Title) of the default <a href="https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#asset-type\" target="_blank">Kelvin Asset Type that will be selected.

This can be changed by the user when adding the Kelvin Template as a new <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/#asset-class\" target="_blank">Kelvin Asset Class in ISO 8601 UTC date/time format. Example; "2022-07-08T08:41:01.657916Z".

description

description: string

Detailed description of the <a href="https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#kelvin-templates\" target="_blank">Kelvin Template

entityTypeName

entityTypeName: string

Entity type name that is linked to this new Kelvin Template.

There are 5 entity type options available to choose from; group, asset, component, part and sensor.

Detailed information about the asset hierarchy and function of each entity type can be found at <a href="https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target="_blank">https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/.

entityTypeTitle

entityTypeTitle: string

Entity type display name (title) that is linked to this new Kelvin Template.

There are 5 entity type options available to choose from; Group, Asset, Component, Part and Sensor.

Detailed information about the asset hierarchy and function of each entity type can be found at <a href="https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target="_blank">https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/.

failureDetection

failureDetection: FailureDetection

hierarchy

Full details of all Kelvin Assets, Kelvin Components, Kelvin Parts and Kelvin Sensors in the Kelvin Template hierarchy.

hints

hints: any

Unused. This is reserved as a future feature.

imageUrl

imageUrl: string

A http(s) URL link to an image to visually display your template picture next to the description.

The file can be in any web-compatible format including jpg, png, gif, animated gif and apng. Even though any size is allowed as it will be automatically resized, it is advised to keep it below 400 x 400 px.

If the link is behind a secure login, all login or token details must be incorporated into the URL here.

metrics

Unused. This is reserved as a future feature.

name

name: 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.

owner

owner: string

Who created the <a href="https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#kelvin-templates\" target="_blank">Kelvin Template. There are two types of owners; custom (any user) or kelvin (core <a href="https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#kelvin-templates\" target="_blank">Kelvin Template).

properties

title

title: string

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

updated

updated: Date

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

visualization

visualization: Visualization

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