Module: shared-definitions

Provides definitions that are shared throughout the application.

Members

(inner, constant) WicaChannelPropertyDefaults :module:shared-definitions.WicaChannelProperties

JS Object that defines the default values for the properties of a Wica Channel.
Type:
Properties:
Name Type Attributes Default Description
daqmode string | null <optional>
 null The data acquisition mode. When null, the stream default is used.
pollint number | null <optional>
 null The interval between successive polls of the channel value. When null, the stream default is used.
fields string | null <optional>
 null A semicolon delimited list defining the data fields that should be included when sending the value information for this channel. When null, the stream default is used.
prec number | null <optional>
 null The precision (= number of digits after the decimal point) to be used when sending the numeric information for this channel. When null, the stream default is used.
filter string <optional>
 "last-n" The type of filtering to be used on the channel. One of: "all-value", "last-n", "one-in-m", "rate-limiter", "changes".
n number <optional>
 1 The filter number of samples.
m number <optional>
 1 The filter cycle length.
interval number <optional>
 1 The filter sampling interval.
deadband number <optional>
 1.0 The filter deadband.

(inner, constant) WicaElementConnectionAttributeDefaults :module:shared-definitions.WicaElementConnectionAttributes

JS Object that defines the HTML element attributes used by the module:document-stream-connector.DocumentStreamConnector when communicating with the Wica server.
Type:
Properties:
Name Type Attributes Default Description
streamName string <optional>
 "data-wica-stream-name" The name of the element attribute which specifies the wica stream name. Format: JS string literal.
assignedStreamName string <optional>
 "data-wica-assigned-stream-name" The name of the element attribute which will reflect the stream name assigned by wica following document scanning. Format: JS string literal.
streamProperties string <optional>
 "data-wica-stream-props" The name of the element attribute which specifies the wica stream properties. Format: JSON string literal, representing JS module:shared-definitions.WicaStreamProperties object.
streamState string <optional>
 "data-wica-stream-state" The name of the element attribute which reflects the state of the connection to the wica server's data stream. Format: JS string literal with possible values: [ "connect-CCC", "opened-XXX", "closed-XXX" ], where CCC represents the incrementing connection request counter and XXX the id of the last stream that was opened.
channelName string <optional>
 "data-wica-channel-name" The name of the element attribute which specifies the wica channel name. This is the minimum information that must be present for an element to be considered "wica-aware". Format: JS string literal.
channelProperties string <optional>
 "data-wica-channel-props" The name of the element attribute which specifies the wica channel properties. Format: JSON string literal, representing JS module:shared-definitions.WicaChannelProperties object.
channelConnectionState string <optional>
 "data-wica-channel-connection-state" The name of the element attribute which reflects the state of the connection between the wica server and the wica channel's data source. Format: JS string literal with possible values: ["connecting-N", "opened-X", "closed-X"], where N represents the incrementing count of connection attempts and X represents the stream ID assigned by the server.
channelMetadata string <optional>
 "data-wica-channel-metadata" The name of the element attribute which reflects the metadata obtained most recently from the wica channel. Format: JSON string literal, representing JS module:shared-definitions.WicaChannelMetadata object.
channelValueArray string <optional>
 "data-wica-channel-value-array" The name of the attribute which reflects the most recently obtained values from the wica channel. Format: JSON string literal, representing JS Array of module:shared-definitions.WicaChannelValue objects.
channelValueLatest string <optional>
 "data-wica-channel-value-latest" The name of the attribute which is set to reflect the last value obtained from the channel. Format: JSON string literal, representing JS module:shared-definitions.WicaChannelValue object.
channelAlarmState string <optional>
 "data-wica-channel-alarm-state" The name of the attribute which reflects the alarm status most recently obtained from the channel. Format: JS number literal with possible values: [ 0 (= "NO_ALARM"), 1 (= "MINOR_ALARM"), 2 (= "MAJOR_ALARM"), 3 (= "INVALID_ALARM") ].

(inner, constant) WicaElementEventAttributeDefaults :module:shared-definitions.WicaElementEventAttributes

JS Object that defines the HTML element attributes used by the module:document-event-manager.DocumentEventManager in its mission to fire events on wica-aware elements.
Type:
Properties:
Name Type Attributes Default Description
eventHandler string <optional>
 "onchange" The name of the attribute which will be examined to look for a wica custom event handler.

(inner, constant) WicaElementTextRenderingAttributeDefaults :module:shared-definitions.WicaElementTextRenderingAttributes

JS Object that defines the HTML element attributes used by the module:document-text-renderer.DocumentTextRenderer when rendering the element's visual state.
Type:
Properties:
Name Type Attributes Default Description
tooltip string <optional>
 "data-wica-tooltip" The name of the attribute which specifies the tooltip to be displayed when the browser's cursor hovers over the element. When not explicitly set by the developer the wica channel name will be assigned to this attribute instead. Format: JS string literal.
renderingProperties string <optional>
 "data-wica-rendering-props" The name of the attribute which provides other miscellaneous properties which affect the way the element is rendered. Format: JSON string literal representing JS module:shared-definitions.WicaTextRenderingProperties object.

(inner, constant) WicaStreamPropertyDefaults :module:shared-definitions.WicaStreamProperties

JS Object that defines the default values for the properties of a Wica Stream.
Type:
Properties:
Name Type Attributes Default Description
hbflux number <optional>
 15000 The interval in milliseconds between heartbeat messages.
metaflux number <optional>
 100 The interval in milliseconds between transmitting successive Server-Sent-Event (SSE) messages with the latest wica channel metadata.
monflux number <optional>
 200 The interval in milliseconds between transmitting successive Server-Sent-Event (SSE) messages with the latest wica channel monitored values.
pollflux number <optional>
 1000 The interval in milliseconds between transmitting successive Server-Sent-Event (SSE) messages with the latest wica channel polled values.
daqmode string <optional>
 "monitor" The default data acquisition mode.
pollint number <optional>
 1000 The default polling interval in milliseconds.
prec number <optional>
 3 The precision (= number of digits after the decimal point) to be used when sending numeric information.
fields string <optional>
 "val;sevr" A semicolon delimited list defining the data fields that should be included by default in the stream of WicaChannelValues.

(inner, constant) WicaTextRenderingPropertyDefaults :module:shared-definitions.WicaTextRenderingProperties

JS Object that defines the default values for the properties of the Wica Text Renderer.
Type:
Properties:
Name Type Attributes Default Description
disable boolean <optional>
 false Disables rendering for this channel.
units string <optional>
 "" The units to be displayed when rendering numeric information. When this property is specified it will be used. When not specified an attempt will be made to obtain the units from the metadata.
exp boolean <optional>
 false Sets the rendering format for channels which return numeric data. Possible values: [true (use exponential format, eg 1.27E-1), false (use fixed decimal point format, eg 0.127)].
prec number <optional>
 8 The precision (= number of digits after the decimal point) to be used for channels which return numeric data.

Type Definitions

WicaChannelMetadata

Provides a type definition for a union type which describes the metadata information associated with a wica channel. See module:shared-definitions.WicaChannelMetadataOther, and module:shared-definitions.WicaChannelMetadataEpics.
Type:

WicaChannelMetadataEpics

Provides a type definition to describe the metadata associated with a channel based on an EPICS data source. The published properties may vary according to the EPICS record that publishes the EPICS channel. A combination of any or all of the following properties is possible.
Type:
  • Object
Properties:
Name Type Description
type string One of: "REAL", "INTEGER", "STRING", "REAL_ARRAY", "INTEGER_ARRAY", "STRING_ARRAY".
egu string Engineering Units in which the channel's value will be expressed.
prec number The precision in which the channel's value will be expressed. Applies only to numeric types.
hopr number High Operating Range.
lopr number Low Operating Range.
drvh number Drive High Control Limit.
drvl number Drive Low Control Limit.
hihi number Upper Alarm Limit.
lolo number Lower Alarm Limit.
high number Upper Warning Limit.
low number Lower Warning Limit.

WicaChannelMetadataOther

Provides a type definition to describe the metadata associated with a channel based on a data source with minimal additional information.
Type:
  • Object
Properties:
Name Type Description
type string One of: "REAL", "INTEGER", "STRING", "REAL_ARRAY", "INTEGER_ARRAY", "STRING_ARRAY". This property is always present.

WicaChannelName

Provides a type definition for a JS string which defines the name of a channel.
Type:
  • string

WicaChannelProperties

Provides a type definition for a JS Object that specifies the properties of a Wica Channel. When not specified the property values will be taken from the module:shared-definitions.WicaChannelPropertyDefaults.
Type:
  • Object
Properties:
Name Type Attributes Description
daqmode string | null <optional>
 The data acquisition mode.
pollint number | null <optional>
 The interval between successive polls of the channel value.
fields string | null <optional>
 A semicolon delimited list defining the data fields that should be included when sending value information for this channel.
prec number | null <optional>
 The precision (= number of digits after the decimal point) to be used when sending numeric information.
filter string <optional>
 The type of filtering to be used on the channel. One of: "all-value", "last-n", "one-in-m", "rate-limiter", "changes".
n number <optional>
 The filter number of samples for the "last-n" filter.
m number <optional>
 The filter cycle length for the "one-in-m" filter.
interval number <optional>
 The filter sampling interval for the "rate-limiter" filter
deadband number <optional>
 The filter deadband for the "changes" filter

WicaChannelValue

Provides a type definition for a JS Object that specifies the instantaneous value of a Wica Channel. The value information includes the raw channel value, the timestamp at which the value was obtained, and the channel alarm status.
Type:
  • Object
Properties:
Name Type Description
val string | null JSON String representation of the current value. Set to null if the channel's data source is offline, or otherwise unavailable.
sevr number [Alarm Severity] - Present if the WicaStreamProperty 'includeAlarmInfo' is true. The following values are defined (0 = No Alarm; 1 = Minor Alarm, 2 = Major Alarm)
ts string [Timestamp] - present if the WicaStreamProperty 'includeTimestamp' is true.

WicaElementConnectionAttributes

Provides a type definition for a JS Object that defines the HTML element attributes used by the module:document-stream-connector.DocumentStreamConnector when communicating with the Wica server.
Type:
  • Object
Properties:
Name Type Description
streamName string The name of the element attribute which specifies the wica stream name.
assignedStreamName string The name of the element attribute which reflects the stream name assigned by wica following document scanning. Format: JS string literal.
streamProperties string The name of the element attribute which specifies the wica stream properties. Format: JSON string literal, representing JS module:shared-definitions.WicaStreamProperties object.
streamState string The name of the element attribute which reflects the state of the connection to the wica server's data stream. Format: JS string literal with possible values: [ "connect-CCC", "opened-XXX", "closed-XXX" ], where CCC represents the incrementing connection request counter and XXX the id of the last stream that was opened.
channelName string The name of the element attribute which specifies the wica channel name. This is the minimum information that must be present for an element to be considered a wica channel. Format: JS string literal.
channelProperties string The name of the element attribute which specifies the wica channel properties. Format: JSON string literal, representing JS module:shared-definitions.WicaChannelProperties object.
channelConnectionState string The name of the element attribute which reflects the state of the connection between the wica server and the wica channel's data source. Format: JS string literal with possible values: ["connecting-N", "opened-X", "closed-X"], where N represents the incrementing count of connection attempts and X represents the stream ID assigned by the server.
channelMetadata string The name of the element attribute which reflects the metadata obtained most recently from the wica channel. Format: JSON string literal, representing JS module:shared-definitions.WicaChannelMetadata object.
channelValueArray string The name of the attribute which reflects the most recently obtained values from the wica channel. Format: JSON string literal, representing JS Array of module:shared-definitions.WicaChannelValue objects.
channelValueLatest string The name of the attribute which is set to reflect the last value obtained from the channel. Format: JSON string literal, representing JS module:shared-definitions.WicaChannelValue object.
channelAlarmState string The name of the attribute which reflects the alarm status most recently obtained from the channel. Format: JS number literal with possible values: [ 0 (= "NO_ALARM"), 1 (= "MINOR_ALARM"), 2 (= "MAJOR_ALARM"), 3 (= "INVALID_ALARM") ].

WicaElementEventAttributes

Provides a type definition for a JS Object that defines the HTML element attributes used by the module:document-event-manager.DocumentEventManager in its mission to fire events on wica channel elements.
Type:
  • Object
Properties:
Name Type Attributes Description
eventHandler string <optional>
 The name of the attribute which will be examined to look for a wica custom event handler.

WicaElementTextRenderingAttributes

Provides a type definition for a JS Object that defines the HTML element attributes used by the module:document-text-renderer.DocumentTextRenderer when rendering the element's visual state.
Type:
  • Object
Properties:
Name Type Description
tooltip string The name of the attribute which specifies the tooltip to be displayed when the browser's cursor hovers over the element. When not explicitly set by the developer the wica channel name will be assigned to this attribute instead. Format: JS string literal.
renderingProperties string The name of the attribute which provides other miscellaneous properties which affect the way the element is rendered. Format: JS string literal.

WicaStreamProperties

Provides a type definition for a JS Object that specifies the properties of a Wica Stream. When not specified the property values will be taken from the module:shared-definitions.WicaStreamPropertyDefaults.
Type:
  • Object
Properties:
Name Type Attributes Description
hbflux number <optional>
 The interval in milliseconds between heartbeat messages.
metaflux number <optional>
 The interval in milliseconds between transmitting successive Server-Sent-Event (SSE) messages with the latest wica channel metadata.
monflux number <optional>
 The interval in milliseconds between transmitting successive Server-Sent-Event (SSE) messages with the latest wica channel monitored values.
pollflux number <optional>
 The interval in milliseconds between transmitting successive Server-Sent-Event (SSE) messages with the latest wica channel polled values.
daqmode string <optional>
 The default data acquisition mode.
pollint number <optional>
 The default polling interval in milliseconds.
prec number <optional>
 The precision (= number of digits after the decimal point) to be used when sending numeric information.
fields string <optional>
 A semicolon delimited list defining the data fields that should be included by default in the stream of WicaChannelValues.

WicaTextRenderingProperties

Provides a type definition for a JS Object that specifies the properties to be used when rendering a Wica element's textual content. When not specified the property values will be taken from the module:shared-definitions.WicaTextRenderingPropertyDefaults.
Type:
  • Object
Properties:
Name Type Attributes Description
disable boolean <optional>
 Disables rendering for this channel.
units string <optional>
 The units to be displayed when rendering numeric information. When this property is specified it will be used. When not specified an attempt will be made to obtain the units from the metadata.
exp boolean <optional>
 Sets the rendering format for channels which return numeric data. Possible values: [true: (use exponential format, eg 1.27E-1), false: (use fixed decimal point format, eg 0.127)].
prec number <optional>
 The precision (= number of digits after the decimal point) to be used for channels which return numeric data.