Chart editor guide
Chart editor guide
In this guide, we'll guide you through the steps of creating custom charts using one or more GitHub boards or repositories as data sources.
See also these related guides:
To create your first chart, go to the Charts tab, and click Add new chart. You'll be shown the chart editor that allows creating charts from the selected data sources.
In this guide, we'll guide you through the steps of creating custom charts using one or more GitHub boards or repositories as data sources.
See also these related guides:
To create your first chart, go to the Charts tab, and click Add new chart. You'll be shown the chart editor that allows creating charts from the selected data sources.
In this guide, we'll guide you through the steps of creating custom charts using one or more GitHub boards or repositories as data sources.
See also these related guides:
To create your first chart, go to the Charts tab, and click Add new chart. You'll be shown the chart editor that allows creating charts from the selected data sources.
Select the chart type
You can select the chart type using the Chart type menu:
You can learn more about the available charts on the Charts Tour.
Select the chart type
You can select the chart type using the Chart type menu:
You can learn more about the available charts on the Charts Tour.
Select the data sources
In the Data sources menu, you can select one or more project boards or repositories to be used as data sources in the chart:
You can select multiple items from this menu by picking one, then another, and so on. The list contains the projects and repositories you have imported to Screenful.
You can import more projects and repositories by selecting Data sources from the main menu:
Select the data sources
In the Data sources menu, you can select one or more project boards or repositories to be used as data sources in the chart:
You can select multiple items from this menu by picking one, then another, and so on. The list contains the projects and repositories you have imported to Screenful.
You can import more projects and repositories by selecting Data sources from the main menu:
Select the unit for the chart
You can select the unit for the chart from the Unit menu. The default selection is Issues and PRs, which shows the counts as the number of issues and pull requests (you can use the filter feature to limit to either one):
You can change the unit to something else depending on what properties your data sources contain:
The selected unit is reflected in the chart as follows:
Issues and PRs -> Chart shows the count of issues and pull requests (e.g. completed issues within a date range).
Time in state -> Chart shows timing data e.g. time in progress, lead time, cycle time.
Custom fields -> These are your GitHub Projects Number fields.
Select the unit for the chart
You can select the unit for the chart from the Unit menu. The default selection is Issues and PRs, which shows the counts as the number of issues and pull requests (you can use the filter feature to limit to either one):
You can change the unit to something else depending on what properties your data sources contain:
The selected unit is reflected in the chart as follows:
Issues and PRs -> Chart shows the count of issues and pull requests (e.g. completed issues within a date range).
Time in state -> Chart shows timing data e.g. time in progress, lead time, cycle time.
Custom fields -> These are your GitHub Projects Number fields.
Select the metric for the chart
Once you have selected the unit for the chart, the next step is to choose the metric:
Pay attention to this step, as picking the wrong metric can produce undesired results. Some of these metrics require a date range, while others don't. The first three metrics show the current state, and therefore, there is no date range involved:
When you select a metric that requires a date range, the date range menu appears automatically:
The selected metric is reflected in the chart as below:
Total -> The total amount of the selected unit in the selected data sources
Not started & In progress -> The amount of selected unit not completed, according to the workflow settings
In progress -> The amount of selected unit in progress, according to the workflow settings
Created (within date range) -> How much of the selected unit was created within the date range
Completed (within date range) -> How much of the selected unit was completed within the date range
At the bottom of the menu, you have your project Date fields:
When you select a Date field as the metric, the date range menu appears. The selected date range will be applied to the selected Date field. You can learn more about creating charts using Date field.
Select the metric for the chart
Once you have selected the unit for the chart, the next step is to choose the metric:
Pay attention to this step, as picking the wrong metric can produce undesired results. Some of these metrics require a date range, while others don't. The first three metrics show the current state, and therefore, there is no date range involved:
When you select a metric that requires a date range, the date range menu appears automatically:
The selected metric is reflected in the chart as below:
Total -> The total amount of the selected unit in the selected data sources
Not started & In progress -> The amount of selected unit not completed, according to the workflow settings
In progress -> The amount of selected unit in progress, according to the workflow settings
Created (within date range) -> How much of the selected unit was created within the date range
Completed (within date range) -> How much of the selected unit was completed within the date range
At the bottom of the menu, you have your project Date fields:
When you select a Date field as the metric, the date range menu appears. The selected date range will be applied to the selected Date field. You can learn more about creating charts using Date field.
Select grouping
If the selected chart type supports grouping, the Group by menu allows the selection of the grouping criteria. Topmost in the list are the standard options, available for all GitHub data sources:
In the mid-section, you'll have the time-based grouping options: day, week, month, and quarter:
At the bottom of the menu, you'll find your project custom fields:
These are your project custom select fields.
If you want to group & filter by Text fields, you can adjust the default field mapping.
Select grouping
If the selected chart type supports grouping, the Group by menu allows the selection of the grouping criteria. Topmost in the list are the standard options, available for all GitHub data sources:
In the mid-section, you'll have the time-based grouping options: day, week, month, and quarter:
At the bottom of the menu, you'll find your project custom fields:
These are your project custom select fields.
If you want to group & filter by Text fields, you can adjust the default field mapping.