Web Components for Insights Hub and Industrial IoT
Time Series Table
The Time Series Table displays data provided by the IoT Time Series API in a table view.
The table provides possibilities to sort or filter for specific variables or values. A maximum of the last 256 time series objects are requested from the API for the provided time range.
Example¶
Interface¶
Selector¶
<mdsp-time-series-table></mdsp-time-series-table>
Properties¶
Name | Type | Corresponding attribute | Default | Description | Allowed Values |
---|---|---|---|---|---|
context | string | context | Configures the context of the component. See also here. | ||
dateRange | TimeZoneDateRange | Specifies the date range using from , to , isAllDay and timeZone properties. | |||
errorNotification | boolean | error-notification | Enables error control if an error is thrown. This can be used for debug purposes. For productive use, the error event should be caught and handled in the application. See also here. | ||
filterable | `` | filterable | false | Enables filter options in the table if true . | |
locale | string | locale | Specifies the locale in which the component is displayed. The locales en and de are provided by default.See also here. | ||
localeManager | LocaleManager | Returns a LocaleManager object. This can be used to add locales or to get the locale settings. See also here. | |||
model | IDataModel | Returns an object for data model handling, refer to IDataModel model. | |||
pagerMode | PagerMode | pager-mode | Simple | Configures the table's pagination mode. | - Simple - Advanced - Advanced2 - Hidden |
pageSize | number | page-size | 10 | Configures the initial page size. | 1 - (pageSizeLimit of this component) |
sharedAssets | boolean | shared-assets | false | Specifies whether shared assets from other tenants are supported. | |
sortable | `` | sortable | true | Enables sortable options in the table if true . | |
tableFormatters | IDataTableFormatters | undefined | Used to define formatters for column header and values. Pass an object which fulfills the interface IDataTableFormatters. | ||
timeZone | TimeZone | time-zone | Specifies the selected time zone. | ||
variablePaths | ITimeSeriesPathInfo | Specifies an array of objects which defines the selected aspects/variables. | |||
variablesLimit | number | variables-limit | undefined | Specifies the allowed variables count limit. If the limit is exceeded error -event will be triggered with theinformation, which variables could not be added. | 1-25 |
view | IViewModel | Returns an object for view handling, refer to IViewModel model. |
Events¶
Name | Type | Description |
---|---|---|
connected | EventEmitter<any> | Triggered after the component is created, initialized and appended to the DOM tree. |
error | EventEmitter<MdspUiError> | Triggered when an error occurs in the component or while accessing APIs. See also here. |
Models¶
TimeZoneDateRange
interface TimeZoneDateRange {
from: Date;
to: Date;
isAllDay: boolean;
timeZone: TimeZone;
}
IDataModel
interface IDataModel {
// forces reload of data, e.g. re-loading the table
refresh(): void;
}
IViewModel
interface IViewModel {
refresh(): void;
}
TimeZone
enum TimeZone {
Local = 'Local',
UTC = 'UTC',
}
Remarks¶
- For performance reasons, it is recommended to limit the number of variables displayed in the Time Series Table to 10.
Roles¶
mdsp:core:iot.timUser
(IoT TimeSeries API is used)
Snippets¶
Using the table with filter and paging controls¶
<mdsp-time-series-table pager-mode="Advanced2" filterable="true"></mdsp-time-series-table>
Last update: February 23, 2024
Except where otherwise noted, content on this site is licensed under the Development License Agreement.