API / geotoolkit / gauges / Alarm / Alarm
An Alarm is attached to a gauge and contains a collection of Alerts
Constructors
Methods
Css Properties
| Name | Type | Description |
|---|---|---|
handlername | string | Name of the handler function as defined in Alarm Factory |
high | number | Upper boundary of range that the alarm is effective on |
low | number | Lower boundary of range that the alarm is effective on |
name | string | Name of the alarm for indexing |
range | Range | Range that the alarm is effective on |
range-high | number | Upper range boundary |
range-low | number | Lower range boundary |
range-max | number | |
range-min | number |
Methods
▸ getAdditionalProperties(): Record<string, any>
Returns extra properties which will be passed into the handler function as fourth parameter
Record<string, any>
▸ getClassName(): string
string
▸ getHandlerName(): string
Gets the name of the function in Alarm Factory that is associated with this alarm
string
Name of the function
▸ getName(): string
Gets the name of the function in Alarm Factory that is associated with this alarm
string
Name of the function
▸ getProperties(): OptionsOut
Returns properties of alarm
properties or an alarm to extract properties from
▸ setAdditionalProperties(props): Alarm
Sets extra properties which will be passed into the handler function as fourth parameter
| Name | Type | Description |
|---|---|---|
props | Record<string, any> | Properties |
▸ setProperties(props?): Alarm
Sets properties pertaining to alarm class
| Name | Type | Description |
|---|---|---|
Optional props | Options | properties or an alarm to extract properties from |
▸ testValue(val): boolean
Takes a value and tests if it lies within this alarm range
| Name | Type | Description |
|---|---|---|
val | number | Value to test |
boolean
▸ Static fromObject(props): Alarm
Returns an instance of alarm created using provided properties
alarm
▸ Static getClassName(): string
string