Hierarchy

  • Model
    • AssetTemplateHierarchy

Index

Constructors

constructor

Properties

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.

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

fromTemplateName

fromTemplateName: string

Name of the <a href="https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/#kelvin-templates\" target="_blank">Kelvin Template to copy its full hierarchy to this location.

If this parameter is used, no other parameter in this structure is required.

hierarchy

This is a recursive array that can reach unlimited levels of <a href="https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target="_blank">Kelvin Assets to be able to accurately describe all items in your <a href="https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target="_blank">Kelvin Asset.

hints

hints: any

Unused. This is reserved as a future feature.

metrics

Unused. This is reserved as a future feature.

properties

title

title: string

Default display name (title) for this property in the new Kelvin Template. This is a friendly name displayed in lists and in references.

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

This is shown as an example Display Name parameter field.

If you use from_template_name parameter this parameter is not required.

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