| Name | Description | Property Type |
|---|
| name | The name of the alarm journal to query. Default is "Journal". | string | | enableHeader | Enables the table header. Default is true. | value: boolean | | enableDetails | Enables the details action. Default is true. | value: boolean | | toolbar | Settings for the toolbar. | Expand |
|---|
| title | Click to see the Toolbar properties |
|---|
|
| Name | Description | Property Type |
|---|
| enabled | Enables the visibility of the table toolbar. Default is true. | value: boolean | | enableDateRange | Enables the visibility of the date range toggle. Default is true. | value: boolean | | enableFilter | Enables the visibility of the text filter toggle. Default is true. | value: boolean | | enableFilterResults | Enables the visibility of the filters results count message. Default is true. | value: boolean | | enablePreFilters | Enables the visibility of the prefilter toggle. Default is true. | value: boolean | | enableConfiguration | Enables the visibility of the configuration toggle. Default is true. | value: boolean |
|
| object | | dateFormat | A date format string to be applied against dates. Options are none, date in the format "10/15/2018", time in format "3:59:00 PM", or date time in format "10/15/208 15:59:00". | value: string dropdown | | responsive | Responsive layout configuration. Rows are converted to cards. While in responsive layout, disables or removes certain table features that are no longer applicable. | Name | Description | Property Type |
|---|
| enabled | Enables responsive layout. Default is false. | value: boolean | | breakpoint | Width in pixels that triggers change in responsive layout. | value: numeric |
| object | | dateRange | Settings for date range state. | Name | Description | Property Type |
|---|
| mode | The current mode: realtime or historical. | value: string dropdown | | realtime | Realtime mode state settings. | Name | Description | Property Type |
|---|
| interval | The realtime interval as an integer | value: numeric | | unit | The realtime interval unit: hours, days, months and years. | value: string dropdown |
| object |
| object | | filter | Filter settings. | Name | Description | Property Type |
|---|
| text | The alarm events filter text. | value: string | | events | Alarm event types. | Name | Description | Property Type |
|---|
| active | Whether to display alarms with active events. Default is true. | value: boolean | | acked | Whether to display alarms with acked events. Default is true. | value: boolean | | cleared | Whether to display alarms with cleared events. Default is true. | value: boolean | | system | Whether to display alarms with system events. Default is false. | value: boolean |
| object | | priorities | Alarm event priority pre-filters. | Name | Description | Property Type |
|---|
| diagnostic | Whether to display alarms with diagnostic priority. Default is false. | value: boolean | | low | Whether to display alarms with low priority. Default is true. | value: boolean | | medium | Whether to display alarms with medium priority. Default is true. | value: boolean | | high | Whether to display alarms with high priority. Default is true. | value: boolean | | critical | Whether to display alarms with critical priority. Default is true. | value: boolean |
| object | | conditions | Gateway side alarm query conditions. | Name | Description | Property Type |
|---|
| source | Filter alarms by alarm source path. Specify multiple paths by separating them with commas. Supports the wildcard *. | value: string | | displayPath | Filter alarms by display path, falling back to the source path if a custom display path in not set. Specify multiple paths by separating them with commas. Supports the wildcard *. | value: string | | provider | Filter alarms by provider. | value: string |
| object | | results | Alarm event filtering results configuration and data. | Name | Description | Property Type |
|---|
| enabled | Enable filtering results to be written back to props. | Warning |
|---|
Enabling this property may cause a performance decline. |
| value: boolean | | data | An array of objects representing the current filtered data, if enabled and active. | array |
| object
|
| object | | rowStyles | Styles to apply to rows given their alarm event and designated priority. | Expand |
|---|
| title | Expand to see rowStyles properties |
|---|
|
| Name | Description | Property Type |
|---|
| active | Style settings for rows with active alarms. | Expand |
|---|
| title | Expand to see the active properties |
|---|
|
| Name | Description | Property Type |
|---|
| base | Base style settings for active alarms. Full menu of style options is available for text, background, margin and padding, border, shape and miscellaneous. You can also specify a style class. | object | | priorities | Style settings for the alarm row based on priority. | Expand |
|---|
| title | Expand to see priorities settings |
|---|
|
| Name | Description | Property Type |
|---|
| diagnostic | Style for active alarms with diagnostic priority. Full menu of style options is available. You can also specify a style class. | object | | low | Style for active alarms with low priority. Full menu of style options is available. You can also specify a style class. | object | | medium | Style for active alarms with medium priority. Full menu of style options is available. You can also specify a style class. | object | | high | Style for active alarms with high priority. Full menu of style options is available. You can also specify a style class. | object | | critical | Style for active alarms with critical priority. Full menu of style options is available. You can also specify a style class. | object |
|
| object |
|
| object | | acked | Style settings for rows with acked alarms.
| Expand |
|---|
| title | Expand to see the acked properties |
|---|
|
| Name | Description | Property Type |
|---|
| base | Base style settings for acked alarms. Full menu of style options is available for text, background, margin and padding, border, shape and miscellaneous. You can also specify a style class. | object | | priorities | Style settings for the alarm row based on priority. | Expand |
|---|
| title | Expand to see priorities settings |
|---|
|
| Name | Description | Property Type |
|---|
| diagnostic | Style for acked alarms with diagnostic priority. Full menu of style options is available. You can also specify a style class. | object | | low | Style for acked alarms with low priority. Full menu of style options is available. You can also specify a style class. | object | | medium | Style for acked alarms with medium priority. Full menu of style options is available. You can also specify a style class. | object | | high | Style for acked alarms with high priority. Full menu of style options is available. You can also specify a style class. | object | | critical | Style for acked alarms with critical priority. Full menu of style options is available. You can also specify a style class. | object |
|
| object |
|
| object | | cleared | Style settings for rows with cleared alarms. | Expand |
|---|
| title | Expand to see the cleared properties |
|---|
|
| Name | Description | Property Type |
|---|
| base | Base style settings for cleared alarms. Full menu of style options is available for text, background, margin and padding, border, shape and miscellaneous. You can also specify a style class. | object | | priorities | Style settings for the alarm row based on priority. | Expand |
|---|
| title | Expand to see priorities settings |
|---|
|
| Name | Description | Property Type |
|---|
| diagnostic | Style for cleared alarms with diagnostic priority. Full menu of style options is available. You can also specify a style class. | object | | low | Style for cleared alarms with low priority. Full menu of style options is available. You can also specify a style class. | object | | medium | Style for cleared alarms with medium priority. Full menu of style options is available. You can also specify a style class. | object | | high | Style for cleared alarms with high priority. Full menu of style options is available. You can also specify a style class. | object | | critical | Style for cleared alarms with critical priority. Full menu of style options is available. You can also specify a style class. | object |
|
| object |
|
| object | | system | Style settings for rows with system alarms.
| Expand |
|---|
| title | Expand to see the system properties |
|---|
|
| Name | Description | Property Type |
|---|
| base | Base style settings for systemalarms. Full menu of style options is available for text, background, margin and padding, border, shape and miscellaneous. You can also specify a style class. | object | | priorities | Style settings for the alarm row based on priority. | Expand |
|---|
| title | Expand to see priorities settings |
|---|
|
| Name | Description | Property Type |
|---|
| diagnostic | Style for systemalarms with diagnostic priority. Full menu of style options is available. You can also specify a style class. | object | | low | Style for system alarms with low priority. Full menu of style options is available. You can also specify a style class. | object | | medium | Style for system alarms with medium priority. Full menu of style options is available. You can also specify a style class. | object | | high | Style for system alarms with high priority. Full menu of style options is available. You can also specify a style class. | object | | critical | Style for system alarms with critical priority. Full menu of style options is available. You can also specify a style class. | object |
|
| object |
|
| object |
|
| object | | columns | Used for determining what column properties to display on the Alarm Journal Table.
| Expand |
|---|
| title | Click to see column properties |
|---|
|
| Name | Description | Property Type |
|---|
| eventTime | Settings for the eventTime column. | Expand |
|---|
| title | Expand to see eventTime properties |
|---|
|
| Name | Description | Property Type |
|---|
| enabled | Whether the column is enabled. Default is true. | value: boolean | | width | The column's width, which when not strict represents a proportion of the available space, i.e., flex grow. If strictWidth is enabled, the column will be fixed and static. | value: numeric | | strictWidth | If enabled, the width of the column (set with the width property) becomes static. Default is false. | value: boolean | | sort | Default sort order of the column. Options are none, ascending, or descending. | value: string dropdown |
|
| object | | eventId | Settings for the eventId column. | Expand |
|---|
| title | Expand to see eventId properties |
|---|
|
| Name | Description | Property Type |
|---|
| enabled | Whether the column is enabled. Default is true. | value: boolean | | width | The column's width, which when not strict represents a proportion of the available space, i.e., flex grow. If strictWidth is enabled, the column will be fixed and static. | value: numeric | | strictWidth | If enabled, the width of the column (set with the width property) becomes static. Default is false. | value: boolean | | sort | Default sort order of the column. Options are none, ascending, or descending. | value: string dropdown |
|
| object | | name | Settings for the name column. | Expand |
|---|
| title | Expand to see name properties |
|---|
|
| Name | Description | Property Type |
|---|
| enabled | Whether the column is enabled. Default is true. | value: boolean | | width | The column's width, which when not strict represents a proportion of the available space, i.e., flex grow. If strictWidth is enabled, the column will be fixed and static. | value: numeric | | strictWidth | If enabled, the width of the column (set with the width property) becomes static. Default is false. | value: boolean | | sort | Default sort order of the column. Options are none, ascending, or descending. | value: string dropdown |
|
| object | | source | Settings for the source column. | Expand |
|---|
| title | Expand to see source properties |
|---|
|
| Name | Description | Property Type |
|---|
| enabled | Whether the column is enabled. Default is true. | value: boolean | | width | The column's width, which when not strict represents a proportion of the available space, i.e., flex grow. If strictWidth is enabled, the column will be fixed and static. | value: numeric | | strictWidth | If enabled, the width of the column (set with the width property) becomes static. Default is false. | value: boolean | | sort | Default sort order of the column. Options are none, ascending, or descending. | value: string dropdown |
|
| object | | eventState | Settings for the eventState column. | Expand |
|---|
| title | Expand to see eventState properties |
|---|
|
| Name | Description | Property Type |
|---|
| enabled | Whether the column is enabled. Default is true. | value: boolean | | width | The column's width, which when not strict represents a proportion of the available space, i.e., flex grow. If strictWidth is enabled, the column will be fixed and static. | value: numeric | | strictWidth | If enabled, the width of the column (set with the width property) becomes static. Default is false. | value: boolean | | sort | Default sort order of the column. Options are none, ascending, or descending. | value: string dropdown |
|
| object | | priority | Settings for the priority column. | Expand |
|---|
| title | Expand to see priority properties |
|---|
|
| Name | Description | Property Type |
|---|
| enabled | Whether the column is enabled. Default is true. | value: boolean | | width | The column's width, which when not strict represents a proportion of the available space, i.e., flex grow. If strictWidth is enabled, the column will be fixed and static. | value: numeric | | strictWidth | If enabled, the width of the column (set with the width property) becomes static. Default is false. | value: boolean | | sort | Default sort order of the column. Options are none, ascending, or descending. | value: string dropdown |
|
| object | | state | Settings for the state column. | Expand |
|---|
| title | Expand to see state properties |
|---|
|
| Name | Description | Property Type |
|---|
| enabled | Whether the column is enabled. Default is true. | value: boolean | | width | The column's width, which when not strict represents a proportion of the available space, i.e., flex grow. If strictWidth is enabled, the column will be fixed and static. | value: numeric | | strictWidth | If enabled, the width of the column (set with the width property) becomes static. Default is false. | value: boolean | | sort | Default sort order of the column. Options are none, ascending, or descending. | value: string dropdown |
|
| object | | displayPath | Settings for the displayPath column. | Expand |
|---|
| title | Expand to see displayPath properties |
|---|
|
| Name | Description | Property Type |
|---|
| enabled | Whether the column is enabled. Default is true. | value: boolean | | width | The column's width, which when not strict represents a proportion of the available space, i.e., flex grow. If strictWidth is enabled, the column will be fixed and static. | value: numeric | | strictWidth | If enabled, the width of the column (set with the width property) becomes static. Default is false. | value: boolean | | sort | Default sort order of the column. Options are none, ascending, or descending. | value: string dropdown |
|
| object | | label | Settings for the label column. | Expand |
|---|
| title | Expand to see label properties |
|---|
|
| Name | Description | Property Type |
|---|
| enabled | Whether the column is enabled. Default is true. | value: boolean | | width | The column's width, which when not strict represents a proportion of the available space, i.e., flex grow. If strictWidth is enabled, the column will be fixed and static. | value: numeric | | strictWidth | If enabled, the width of the column (set with the width property) becomes static. Default is false. | value: boolean | | sort | Default sort order of the column. Options are none, ascending, or descending. | value: string dropdown |
|
| object | | eventValue | Settings for the eventValue column. | Expand |
|---|
| title | Expand to see eventValue properties |
|---|
|
| Name | Description | Property Type |
|---|
| enabled | Whether the column is enabled. Default is true. | value: boolean | | width | The column's width, which when not strict represents a proportion of the available space, i.e., flex grow. If strictWidth is enabled, the column will be fixed and static. | value: numeric | | strictWidth | If enabled, the width of the column (set with the width property) becomes static. Default is false. | value: boolean | | sort | Default sort order of the column. Options are none, ascending, or descending. | value: string dropdown |
|
| object | | isSystemEvent | Settings for the isSystemEvent column. | Expand |
|---|
| title | Expand to see isSystemEvent properties |
|---|
|
| Name | Description | Property Type |
|---|
| enabled | Whether the column is enabled. Default is true. | value: boolean | | width | The column's width, which when not strict represents a proportion of the available space, i.e., flex grow. If strictWidth is enabled, the column will be fixed and static. | value: numeric | | strictWidth | If enabled, the width of the column (set with the width property) becomes static. Default is false. | value: boolean | | sort | Default sort order of the column. Options are none, ascending, or descending. | value: string dropdown |
|
| object | | ackUser | Settings for the ackUser column. | Expand |
|---|
| title | Expand to see ackUser properties |
|---|
|
| Name | Description | Property Type |
|---|
| enabled | Whether the column is enabled. Default is true. | value: boolean | | width | The column's width, which when not strict represents a proportion of the available space, i.e., flex grow. If strictWidth is enabled, the column will be fixed and static. | value: numeric | | strictWidth | If enabled, the width of the column (set with the width property) becomes static. Default is false. | value: boolean | | sort | Default sort order of the column. Options are none, ascending, or descending. | value: string dropdown |
|
| object | | ackNotes | Settings for the ackNotes column. | Expand |
|---|
| title | Expand to see ackNotes properties |
|---|
|
| Name | Description | Property Type |
|---|
| enabled | Whether the column is enabled. Default is true. | value: boolean | | width | The column's width, which when not strict represents a proportion of the available space, i.e., flex grow. If strictWidth is enabled, the column will be fixed and static. | value: numeric | | strictWidth | If enabled, the width of the column (set with the width property) becomes static. Default is false. | value: boolean | | sort | Default sort order of the column. Options are none, ascending, or descending. | value: string dropdown |
|
| object |
|
| object | | sortOrder |
The default weighted order in which columns and their contents are sorted relative to other columns and their contents. Only works if used when the component loads. Columns need to have sort configured in order for this to work. | array | | pager | Settings for the pager. | Name | Description | Property Type |
|---|
| enabled | Enables the pager to be displayed. Default is true. | value: boolean | | hide | Visually hides the pager from view. Useful when pager is manipulated in a controlled fashion via the activePage property. Default is false. | value: boolean | | options | Rows to show per pager option. | array | | initialOption | The initial option to use when the table first loads. It must exist as an available option. | value: numeric | | activePage | Represents the current active page and corresponds to the value of the page jump input field. | value: numeric |
| object | | style | Sets a style that applies to the component. Full menu of style options is available for text, background, margin and padding, border, shape and miscellaneous. You can also specify a style class. | object |
|
