Kelvin SDK Client Library Reference

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

imageModel

imageModel: string

A http(s) URL link to an SVG image used to visually display your <a href="https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target="_blank">Kelvin Asset.

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

x

x: number

This is the x coordinate for the placement of the model on the page.

The default is 0.

This is important as it will affect the coordinates embedded in Kelvin Alarms to highlight alarm locations on the model.

y

y: number

This is the y coordinate for the placement of the model on the page.

The default is 0.

This is important as it will affect the coordinates embedded in Kelvin Alarms to highlight alarm locations on the model.

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