v3
User Interfaces
Configuration
Line Chart
A line chart that can display output from scripts and APIs.
About
Line charts can retrieve output from scripts and APIs to display the data in a chart.‌
Display Data from an API
You will need to return an array of JSON objects from your API in order to use a bar chart. An example would be returning a list of hashtables serialized to JSON.
1
@(
2
@{
3
Name = "Name1"
4
Value = Get-Random
5
}
6
@{
7
Name = "Name2"
8
Value = Get-Random
9
}
10
@{
11
Name = "Name3"
12
Value = Get-Random
13
}
14
) | ConvertTo-Json
Copied!
In this example, you would configure the data source to an API and select your API endpoint.
You would then specify Name as the X axis and Value as the Y axis.​​
The resulting chart contains the data from the API. Each time the page is loaded, the API is called.​
Display Data from a Script
You will need to return PSCustomObjects, objects or hashtables from your script in order to display a chart from a script.
1
​
2
@(
3
@{
4
Name = "Name1"
5
Value = Get-Random
6
}
7
@{
8
Name = "Name2"
9
Value = Get-Random
10
}
11
@{
12
Name = "Name3"
13
Value = Get-Random
14
}
15
)
Copied!
You will need to set the data source to script and select the script you want to retrieve data for.​
You will need to set the Y and X axis to the properties of the object returned from the script.​‌
The chart will appear on the page like this. Loading the page will not call the script again. It will load the result of the last time the script ran.​
‌
Properties
Property
Description
Available Since
Id
The ID of this component
2.2.0
X Axis Field
The field to use as the X Axis for data within the chart.
2.2.0
Y Axis Field
The field to use as the Y Axis for data within the chart.
2.2.0
Data Source Type
Whether to use a script or API as a data source.
2.2.0
Data Source
The script or API to use as data for the chart.
2.2.0
Color
The bar color to use for the chart.
2.2.0
Last modified 3mo ago
Copy link