Alarms and status

Multi-State Indicator <smart-multi-state-indicator>

MultiStateIndicator is a read-only lamp that shows one of several named states, such as running, stopped, manual, fault or unknown.

<smart-multi-state-indicator> · 6 properties, 1 methods, 0 events · source/modules/smart.multistateindicator.js

Usage in React

The React wrapper is the MultiStateIndicator component: every property is a prop, every event a prop named on<Event> that receives the CustomEvent, and the methods are called on the element through a ref.

import { MultiStateIndicator } from 'smart-industrial/react/multistateindicator';

const ref = useRef<MultiStateIndicator>(null);

<MultiStateIndicator ref={ref} shape={'round'} />

// methods are called on the wrapper the ref holds, which calls the element
ref.current?.stateFor({});

Properties

Prop	Type, default	Description
shape	MultiStateIndicatorShape round	Sets or retrieves the shape of the lamp.
showLabel	boolean false	Sets or retrieves whether the label of the resolved state is rendered next to the lamp.
states	array	Sets or retrieves the state definitions. Each entry is an object with: value - the value this state matches; label - the text shown when showLabel is enabled, also used as the accessible name; severity - one of ok, advisory, warning, critical, manual, maintenance, off, unknown, which selects a colour from the active theme (an off lamp is an empty ring with a border that keeps 3:1 contrast); color - an explicit CSS colour that overrides the severity; blink - whether the lamp blinks, as ISA-18.2 uses for a state awaiting acknowledgement.
unknownLabel	string	Sets or retrieves the label used when the current value matches none of the declared states. It is empty by default, so the label comes from the unknown message ("Unknown" in English) and follows the locale, including after applyLocale. A value set here takes precedence over the message.
value	string | null	Sets or retrieves the current value. A value that arrives as text from an attribute or a JSON payload matches a state declared with a number when it is that number written in decimal ("3" matches 3; "0x1" does not), and a text value matches a text state ignoring case and surrounding spaces. Missing data matches no state: null, an empty or blank string, false, NaN, an array or an object show the unknown state (a hatched lamp, the unknown label, and the unmatched attribute) instead of the first declared state.
quality	MultiStateIndicatorQuality good	Sets or retrieves the quality of the value, as the Tank family takes it: good, uncertain (the lamp is dimmed), bad (hatched and outlined) or stale (faded). The lamp keeps the state it resolved but does not look live, and the quality word is added to the label and the accessible name, for example 'Running (quality bad)'.

Methods

Method	Description
stateFor(value?: any): any	Returns the state definition matching a value, or null when none matches. Called without arguments it resolves the component's current value. Matching is as described for value: missing data matches nothing. value any The value to resolve. Defaults to the current value.

Types

type MultiStateIndicatorShape

'round' | 'square' | 'bar'

type MultiStateIndicatorQuality

'good' | 'uncertain' | 'bad' | 'stale'

CSS variables

The component declares 3 CSS variables; the CSS page shows how to set them.

--smart-multi-state-indicator-default-size --smart-multi-state-indicator-bar-width --smart-multi-state-indicator-blink-duration