Line card schema

Use line graph cards to plot time series data on a graph.

The structure of the line graph card schema is as follows:

• Cards
  • Content
    • Series
  • DataSource
    • Attributes
    • Range
    • AdditionalData

For the dashboard schema, see the Dashboard JSON reference topic.

For more information about how to use a line graph card, see the Line graph card topic.

Cards

A line graph card is defined in a cards array.

Example:

{
    "cards": [{
        "id": "air_flow_mean",
        "size": "LARGE",
        "title": "Air flow mean vs max",
        "type": "TIMESERIES",
        "content": {
            "series": [{
                    "dataSourceId": "airflow_mean",
                    "label": "Airflow Mean"
                },
                {
                    "dataSourceId": "airflow_max",
                    "label": "Airflow Max",
                    "color": "#1192e8"
                }
            ],
            "xLabel": "X axis",
            "yLabel": "Y axis",
            "showLegend": false,
            "decimalPrecision": "2",
            "unit": "PSI",
            "timeDataSourceId": "timestamp"
        },
        "dataSource": {
            "attributes": [{
                    "aggregator": "mean",
                    "attribute": "air_flow_rate",
                    "id": "airflow_mean"
                },
                {
                    "aggregator": "max",
                    "attribute": "air_flow_rate",
                    "id": "airflow_max"
                }
            ],
            "range": {
                "type": "periodToDate",
                "count": -7,
                "interval": "day"
            },
            "additionalData": {
                "type": "alert",
                            "dataFilter": {
                                "name": "alert_air_flow_rate_greater_than_1"
                }
            },
            "timeGrain": "day"
        }
    }],
    "title": "Example"
}

Table 1. Cards

Content

In cards.content, specify the information to display in the series and the unit of the data items.

Example:

{
    "content": {
        "series": [{
                "dataSourceId": "airflow_mean",
                "label": "Airflow Mean"
            },
            {
                "dataSourceId": "airflow_max",
                "label": "Airflow Max",
                "color": "#1192e8"
            }                 
        ],
        "xLabel": "X axis",
        "yLabel": "Y axis",
        "showLegend": false,
        "decimalPrecision": "2",
        "unit": "PSI",
        "timeDataSourceId": "timestamp"
    }
}

Table 2. Content

Series

In cards.content.series, specify the information to display in the series on the graph.

Example:

{
    "series": [{
            "dataSourceId": "airflow_mean",
            "label": "Airflow Mean"
        },
        {
            "dataSourceId": "airflow_max",
            "label": "Airflow Max",
            "color": "#1192e8"
        }
    ]
}

Table 3. Series

DataFilter

In cards.content.attributes.dataFilter, you can specify a filter to apply to the attribute or value.

Example: - filter by deviceID

{
    "dataFilter": {
        "deviceid": "73000"
    }
}

Example: - filter by dimension

{
    "dataFilter": {
        "manufacturer: "Rentech"
    }
}

Example: - filter by alert field value

{
    "dataFilter": {
        "severity: "Critical"
    }
}

Specify a deviceid, a dimension name and value, or an alarm field value. You can only specify one filter for each series. If you specify a data filter, you must include the filter in the groupBy field in the dataSource configuration

DataSource

In cards.dataSource, connect the information that is displayed in the series or that is used in alerts to data items in the data lake. You can apply a range and a time grain to the series.

Example:

{
    "dataSource": {
        "attributes": [{
                "aggregator": "mean",
                "attribute": "air_flow_rate",
                "id": "airflow_mean"
            },
            {
                "aggregator": "max",
                "attribute": "air_flow_rate",
                "id": "airflow_max"
            }
        ],
        "range": {
            "type": "periodToDate",
            "count": -7,
            "interval": "day"
        },
        "additionalData": {
            "type": "alert",
            "dataFilter": {
                "name": "alert_air_flow_rate_greater_than_1"
            }
        },
        "timeGrain": "day"
    }
}

Table 4. Series

Attributes

In cards.dataSource.attributes, specify the aggregation method to apply to each attribute or data item.

Example:

{
    "attributes": [{
            "aggregator": "mean",
            "attribute": "air_flow_rate",
            "id": "airflow_mean"
        },
        {
            "aggregator": "max",
            "attribute": "air_flow_rate",
            "id": "airflow_max"
        }
    ]
}

Table 5. attributes

Range

In cards.dataSource.range, specify a time range to apply to the whole time series.

Example:

{
    "range": {
        "type": "periodToDate",
        "count": -7,
        "interval": "day"
    }
}

Table 6. range

AdditionalData

In cards.dataSource.additionalData, enhance the data that is displayed on the graph with additional information. Currently, you can enhance the data on the graph by displaying alert information for one or more lines in the series.

Example:

{
    "additionalData": {
        "type": "alert",
        "dataFilter": {
            "name": "alert_air_flow_rate_greater_than_1"
        }
    }
}

Table 6. additonalData

Table 7. name