Chart Component
Overview
Charts are a great way to display data sets in your application. Using the Chart component, you can add and configure different types of charts on your dashboard, letting your end-user End-users, also known as Express Users, are the individuals accessing an application through Express View. In most cases, end-users are the customers using the product. visualize your data in a meaningful way.
Below are some common examples of when to use the Chart component:
-
To display a scatter plot to track the number of sales for each sales agent in your department.
-
To display a pie chart to show the percentages of end-user submissions Also known as Record Data. Submission data consists of information saved by Unqork components. View submission data by using the angular command, or in Record Collections..
-
To display a bar graph that shows product consumption by demographic.
About the Configuration Window
To learn more about general component settings and those that display when a component is associated with Data Models, view our General Component Settings article.
Display Panel
Field Text
Setting |
Description |
---|---|
Label Text |
Label Text conveys what the input component is and what information it displays. Enter the purpose of the corresponding component or field. User-friendly labels make your module more accessible. Keep labels short and descriptive (a word or two) using title case. For longer entries, use sentence case. |
Formatting
Setting |
Description |
---|---|
Chart Title |
The title that displays above your chart in Express View Express View is how your end-user views your application. Express View also lets you preview your applications to test your configuration and view the styling. This is also the view your end-users will see when interacting with your application. After configuring a module, click Preview in the Module Builder to interact with the module in Express View.. |
Chart Subtitle |
The subtitle that displays below the chart title in Express View. |
Chart Height (in px) |
Adjusts the height (in pixels) of the frame that contains your chart in Express View. As you adjust the height of your chart box, the chart resizes accordingly. |
Print Chart, Download CSV, XLS, and PDF Label |
Customizes the label of the download options in the chart drop-down menu. |
Data Panel
Series Configuration
Setting |
Description |
---|---|
Stack Series |
Overlays multiple data sets in your chart, preventing multiple data inputs from overlapping in your application. If only a single data input exists, this setting has no effect. |
Inputs & Event Outputs
Setting |
Description |
||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Inputs |
Use this section to input and organize the data that your chart must display. To access the Inputs settings, select Edit.
|
||||||||||||||||||
Event Outputs |
Lets the end-user select a category on your chart's user interface. You can then output the selected category to a Property ID A Property ID is the unique field ID used by Unqork to track and link components in your module.. To access the Event Outputs settings, select Edit.
|
Advanced Panel
Additional Display Options
Setting |
Description |
---|---|
Chart Theme |
Sets the theme or color scheme of your chart. |
Override Series Colors |
Enter a HEX code to change the Series colors. |
Axes Configuration
Setting |
Description |
---|---|
Series Axis Type |
Use this drop-down to define the axis type depending on the Series data you want to display. Options include:
|
Series Axis Label Text |
Enter a label for the Series axis of your chart. This label represents the y-axis in a default bar graph. |
Reverse Series Axis |
When set to (ON), this setting reverses the value order of your Series axis. Be default, this setting is (OFF). |
Value Axis Type |
Use this drop-down to define the axis type depending on the Value data you want to display. Options include:
|
Value Axis Label Text |
Enter a label for the Value axis of your chart. This label represents the x-axis in a default bar graph. |
Secondary Value Axis Label Text |
Enter a secondary label for the Value axis of your chart. |
Value Axis Maximum |
Lets you set the maximum value length of your Value axis. |
Reverse Value Axis |
When set to (ON), this setting reverses the value order of your Value axis. Be default, this setting is (OFF). |
Label Configuration
Setting |
Description |
---|---|
Series Label Format |
Use this field to change the Series label format. |
Tooltip Format |
Use this field to change the interactive hover-over tooltip format. |
Show Legend |
When set to (ON), this setting adds a legend to your chart. Be default, this setting is (OFF). |
Enable Dynamic Legend |
When set to (ON), this setting only includes line keys plotted on a line chart. Be default, this setting is (OFF). |
Additional Data Options
Setting |
Description |
---|---|
Month Format |
Changse the month format of date values on your chart. |
Drilldown |
Narrows down to any nested categories. |
Aggregation |
Aggregates a variable in the tracking cascading status. |
Top |
Returns only the top records. |
Adding a Chart Component
To expand on the example from earlier, say you want to build an application that shows the popularity of insurance providers to clients. You can use a Chart component to display this data in a pie chart. The Chart component can only display data, so you must first determine the number of membership submissions for each insurance provider for the chart to display correctly.
These instructions assume that you have an open module saved with a title.
Configure the Data Table Component
Begin by creating a data set that contains customer insurance enrollment data.
1. | In the Module Builder, drag and drop a Data Table component onto your canvas. |
3. | In the Inputs data table, enter the following: |
|
A |
B |
---|---|---|
1 |
submission |
provider |
2 |
1 |
Aetna |
3 |
2 |
Cigna |
4 |
3 |
BCBS |
5 |
4 |
Kaiser |
6 |
5 |
UHC |
7 |
6 |
Aetna |
8 |
7 |
Cigna |
9 |
8 |
BCBS |
10 |
9 |
Kaiser |
11 |
10 |
UHC |
4. | Click Save Component. |
Configure the Hidden Component
This Hidden component stores your provider popularity data. Your Chart component references this data to display to the end-user.
1. | Drag and drop a Hidden component onto the canvas, placing it below your dtUserSubmissionData Data Table component. |
3. | Click Save Component. |
Configure the Data Workflow Component
Chart components cannot make advanced calculations, so you'll configure a Data Workflow component to aggregate the data you want to display to the end-user.
1. | Drag and drop a Data Workflow component onto the canvas, placing it between the dtUserSubmissionData Data Table and providerCount Hidden components. |
Configure the Input Operator
1. | Drag and drop an Input operator onto your Data Workflow canvas. |
2. | Configure the operator's Info window as follows: |
Setting |
Value |
---|---|
Category |
Input |
Component |
userSubmissionData |
Required |
Yes |
Source |
Default |
Configure the Pick Operator
1. | Drag and drop a Pick operator onto the Data Workflow canvas. |
2. | Configure the operator's Info window as follows: |
Setting |
Value |
---|---|
Category |
Input |
Label |
Pick Provider |
Pick Keys |
provider |
3. | Connect the output port (right) of the Input operator to the input port (left) of the Pick operator. |
Configure the Aggregate Operator
1. | Drag and drop an Aggregate operator onto the Data Workflow canvas. |
2. | Configure the operator's Info window as follows: |
Setting |
Value |
---|---|
Category |
Aggregate By |
Label |
Count Provider |
Aggregation Type |
Count By |
Join Group Keys? |
No |
Group Key |
provider |
Value Key |
count |
3. | Connect the output port (right) of the Pick operator to the input port (left) of the Aggregate operator. |
Configure the Output Operator
1. | Drag and drop an Output operator onto the Data Workflow canvas. |
2. | Configure the operator's Info window as follows: |
Setting |
Value |
---|---|
Category |
Output |
Component |
providerCount |
Action |
value |
3. | Connect the output port (right) of the Aggregate operator to the input port (left) of the Output operator. |
4. | Click Save Component. |
Configure the Chart Component
Using a Chart component, you can display the aggregated provider data.
1. | Drag and drop a Chart component onto the canvas, placing below the providerCount Hidden component. |
3. | In the Chart Title field, enter Providers. |
4. | In the Inputs table, enter the following: |
|
ID |
Label |
Chart Type |
Categories |
Values |
---|---|---|---|---|---|
1 |
providerCount |
Member Count |
Pie |
provider |
count |
5. | Under Label Configuration in Advanced settings, set Show Legend to (ON). |
6. | Click Save Component. |
Configure the Initializer Component
To initiate your application on page load, you'll use an Initializer component.
1. | Drag and drop an Initializer component onto your canvas, placing it above your dtUserSubmissionData Data Table component. |
3. | Navigate to the Initializer component's Actions settings. |
5. | Next to Inputs & Outputs, click Edit. |
6. | In the Outputs table Enter outputs components and actions you want the component to perform., enter the following: |
|
Source |
Type |
Value |
---|---|---|---|
1 |
dwfProviderCount |
Trigger |
GO |
7. | Click Save Component. |
8. | Save your module. |
Preview your module in Express View Express View is how your end-user views your application. Express View also lets you preview your applications to test your configuration and view the styling. This is also the view your end-users will see when interacting with your application. After configuring a module, click Preview in the Module Builder to interact with the module in Express View.. Notice how you can hover over and select portions of the pie chart to identify specific information.
Structure of a Chart Component's Data
The Chart component uses input Property IDs A Property ID is the unique field ID used by Unqork to track and link components in your module. to display array data.
Overview
Charts are a great way to display data sets in your application. Using the Chart component, you can add and configure different types of charts on your dashboard, letting your end-user End-users, also known as Express Users, are the individuals accessing an application through Express View. In most cases, end-users are the customers using the product. visualize your data in a meaningful way.
Below are some common examples of when to use the Chart component:
-
To display a scatter plot to track the number of sales for each sales agent in your department.
-
To display a pie chart to show the percentages of end-user submissions Also known as Record Data. Submission data consists of information saved by Unqork components. View submission data by using the angular command, or in Record Collections..
-
To display a bar graph that shows product consumption by demographic.
You can find the Chart component under the Charts & Graphs group to the left of the Module Builder.
About the Configuration Window
To learn more about general component settings and those that display when a component is associated with Data Models, view our General Component Settings article.
General
Setting |
Description |
---|---|
Chart tab |
Selected by default and on opening of the modal A modal is a window that appears on top of the content you are currently viewing.. This tab gives you access to display settings for naming, Series, Theme, and Format. |
Formatting tab |
Select this tab to access configuration for your chart's axis. You can also add a legend to your chart in this tab. To add a legend, select the Show Legend checkbox. |
Permissions tab |
Select this tab to see the RBAC RBAC (Role-Based Access Control) is a method to control system access for authorized users. The role in RBAC refers to the levels of access employees have to a network. settings of the component. |
Cancel |
Click this button to undo any unsaved configuration changes and return to the Module Builder canvas. |
Save |
Click this button to save all setting configuration changes and return to the Module Builder canvas. |
Chart Tab
Setting |
Description |
---|---|
Label |
A Label indicates the purpose of the corresponding field or component. For input components, the Label tells the end-user how to interact with the field. For non-input components, the Label is not end-user facing, and only appears in the Module Builder. User-friendly Labels make your module more accessible. Keep Labels short and descriptive (a word or two) using title case. For longer entries, use sentence case. |
Property Name |
A Property Name is the unique field ID used by Unqork to track and link components in your module. The Property Name is how the software identifies your component. Using Property Names lets you link components, creating logic-based configurations and API APIs (application programming interfaces) are a set of protocols and definitions developers use to build and integrate application software. APIs act as the connective tissue between products and services. (application programming interface) calls. Property Names must use camel case (stylized as camelCase) without spaces or punctuation. |
Chart Title |
The title that displays above your chart in Express View Express View is how your end-user views your application. Express View also lets you preview your applications to test your configuration and view the styling. This is also the view your end-users will see when interacting with your application. After configuring a module, click Preview in the Module Builder to interact with the module in Express View.. |
Chart Subtitle |
The subtitle that displays below your chart title in Express View. |
Chart Height |
Adjusts the height (in pixels) of the frame that contains your chart. As you adjust the height of your chart box, the chart resizes accordingly. |
Series Configuration
Setting |
Description |
---|---|
Stack Series |
Overlays multiple data sets in your graph. This setting prevents multiple data inputs from overlapping in your application. If only a single data input exists, this setting has no effect. |
Inputs |
Use this section to input and organize the data that your chart must display. |
ID |
In this field, enter the Property ID A Property ID is the unique field ID used by Unqork to track and link components in your module. of your input data. All data you reference in your input must come from the same array as the data ID. When you input additional data, it creates a separate chart. |
Label |
In this field, enter the value for what you're counting. For example, if your graph displays a count of numbers, enter Number. If you're displaying a percentage of businesses involved in an industry, enter Businesses. |
Chart Type |
This field lets you set the type of chart to display your data. Below are the available chart types:
|
Categories |
In this field, enter the data categories you want displayed on your chart. Enter only the key of your data's key/value pairs for each category. |
Values |
Use this field to display the values for each category on your chart. Enter only the key of your data's key/value pairs for each category value. |
Colors |
Manipulates the color of an input category if the input data array contains colors. Your color data can be in word or HEX form. |
Size |
This setting expands the size of your chart, in pixels. |
Inner Size |
Adds an inner-hole to make your pie chart into a doughnut chart. This setting only applies to pie charts. |
Event Output |
Lets the end-user select a category on your chart's user interface. You can then output the selected category to a Property ID A Property ID is the unique field ID used by Unqork to track and link components in your module.. |
ID |
The Property ID A Property ID is the unique field ID used by Unqork to track and link components in your module. you use to output your Filter Category. For example, if you want to store the selected Filter Category in a Hidden component named idOutput, enter idOutput. |
Filter Category |
Enter the input category value displayed on your chart. For example, if your Input category is provider, enter provider. |
Chart Theme
Setting |
Description |
---|---|
Chart Theme |
Sets the theme or color scheme of your chart. |
Month Format
Setting |
Description |
---|---|
Month Format |
Changes the month format of date values on your chart. |
Additional Settings
Setting |
Description |
---|---|
Drilldown |
Narrows down to any nested categories. |
Aggregation |
Aggregates a variable in the tracking cascading status. |
Top |
Returns only the top records. |
Print Chart, Download CSV, XLS, and PDF Label |
Customizes the label of the download options in the chart drop-down menu. |
Field Tags |
Assign components one-word labels to help organize, identify, and group the components in your application. Consider an example from the API Specification Snippet: Field Tags are applied to Hidden components in the panelRequest and panelResponse Panel components. The Field Tags identify the data type of parameters included in the API APIs (application programming interfaces) are a set of protocols and definitions developers use to build and integrate application software. APIs act as the connective tissue between products and services. request and response. The API Docs Dashboard tool populates with information about each parameter’s data type, identified by the Field Tag. Field Tags act as a type of Property ID A Property ID is the unique field ID used by Unqork to track and link components in your module. group and let you group components for configuration purposes. Field Tags let you target two or more components using a simple logic component. For example, add the Field Tag tagForDecision to multiple components in your module. Open the Inputs table of a Decisions component and reference the tagForDecision Field Tag as the input of the Decisions component. The output of the Decisions component then affects all components with the tagForDecision Field Tag. Save your Field Tags by pressing Enter (Return) or adding a comma after each entry. |
Comment |
Use this field to keep your teammates informed about what this Chart component does. |
Formatting Tab
Series Configuration
Setting | Description |
---|---|
Series Axis Label Text |
Enter a label for the Series axis of your chart. This label represents the y-axis in a default bar graph. |
Series Axis Type |
Use this drop-down to define the axis type depending on the Series data you want to display. Options include:
|
Value Axis Label Text |
Enter a label for the Value axis of your chart. This label represents the x-axis in a default bar graph. |
Secondary Value Axis Label Text |
Enter a secondary label for the Value axis of your chart. |
Value Axis Type |
Use this drop-down to define the axis type depending on the Value data you want to display. Options include:
|
Value Axis Maximum |
Lets you set the maximum value length of your Value axis. |
Override Series Colors |
Enter a HEX code to change the Series colors. |
Reverse Series Axis |
Check () this box to reverse the value order of your Series axis. Be default, this box is unchecked (). |
Reverse Value Axis |
Check () this box to reverse the value order of your Value axis. Be default, this box is unchecked (). |
Label Configuration
Setting | Description |
---|---|
Series Label Format |
Use this field to change the Series label format. |
Tooltip Format |
Use this field to change the interactive hover-over tooltip format. |
Show Legend |
Check () this box to add a legend to your chart. Be default, this box is unchecked (). |
Enable Dynamic Legend |
Check () this box to only include line keys plotted on a line chart. Be default, this box is unchecked (). |
Adding a Chart Component
To expand on the example from earlier, say you want to build an application that shows the popularity of insurance providers to clients. You can use a Chart component to display this data in a pie chart. The Chart component can only display data, so you must first determine the number of membership submissions for each insurance provider for the chart to display correctly.
These instructions assume that you have an open module saved with a title.
What You Need
For this configuration, you need the following components:
-
1 Data Table component
-
1 Hidden component
-
1 Chart component
-
1 Initializer component
-
1 Data Workflow component
To set up your Data Workflow, you need:
Configure the Data Table Component
Begin by creating a data set that contains customer insurance enrollment data.
1. | In the Module Builder, drag and drop a Data Table component onto your canvas. |
3. | To the left of the component's configuration window, click Data. |
4. | In the data table, enter the following: |
A | B | |
---|---|---|
1 |
submission |
provider |
2 |
1 |
Aetna |
3 |
2 |
Cigna |
4 |
3 |
BCBS |
5 |
4 |
Kaiser |
6 |
5 |
UHC |
7 |
6 |
Aetna |
8 |
7 |
Cigna |
9 |
8 |
BCBS |
10 |
9 |
Kaiser |
11 |
10 |
UHC |
5. | Click Save & Close. |
Configure the Hidden Component
This Hidden component stores your provider popularity data. Your Chart component references this data to display to the end-user.
1. | Drag and drop a Hidden component onto the canvas, placing it below your dtUserSubmissionData Data Table component. |
3. | Click Save & Close. |
Configure the Data Workflow Component
Chart components cannot make advanced calculations, so you'll configure a Data Workflow component to aggregate the data you want to display to the end-user.
1. | Drag and drop a Data Workflow component onto the canvas, placing it between the dtUserSubmissionData Data Table and providerCount Hidden components. |
2. | In the Canvas Label Text and Property Name fields, enter dwfProviderCount. |
Configure the Input Operator
1. | Drag and drop an Input operator onto your Data Workflow canvas. |
2. | Configure the operator's Info window as follows: |
Setting |
Value |
---|---|
Category |
Input |
Component |
userSubmissionData |
Required |
Yes |
Source |
Default |
Configure the Pick Operator
1. | Drag and drop a Pick operator onto the Data Workflow canvas. |
2. | Configure the operator's Info window as follows: |
Setting |
Value |
---|---|
Category |
Input |
Label |
Pick Provider |
Pick Keys |
provider |
3. | Connect the output port (right) of the Input operator to the input port (left) of the Pick operator. |
Configure the Aggregate Operator
1. | Drag and drop an Aggregate operator onto the Data Workflow canvas. |
2. | Configure the operator's Info window as follows: |
Setting |
Value |
---|---|
Category |
Aggregate By |
Label |
Count Provider |
Aggregation Type |
Count By |
Join Group Keys? |
No |
Group Key |
provider |
Value Key |
count |
3. | Connect the output port (right) of the Pick operator to the input port (left) of the Aggregate operator. |
Configure the Output Operator
1. | Drag and drop an Output operator onto the Data Workflow canvas. |
2. | Configure the operator's Info window as follows: |
Setting |
Value |
---|---|
Category |
Output |
Component |
providerCount |
Action |
value |
3. | Connect the output port (right) of the Aggregate operator to the input port (left) of the Output operator. |
4. | Click Save. |
Configure the Chart Component
Using a Chart component, you can display the aggregated provider data.
1. | Drag and drop a Chart component onto the canvas, placing below the providerCount Hidden component. |
2. | In the Label and Property Name fields, enter submissionChart. |
3. | In the Chart Title field, enter Providers. |
4. | In the Inputs table, enter the following: |
id |
Label |
Chart Type | Categories | Values |
---|---|---|---|---|
providerCount |
Member Count |
Pie |
provider |
count |
5. | To the top right of the component's configuration window, click Formatting. |
6. | Set Show Legend to (Checked). |
7. | Click Save. |
Configure the Initializer Component
To initiate your application on page load, you'll use an Initializer component.
1. | Drag and drop an Initializer component onto your canvas, placing it above your dtUserSubmissionData Data Table component. |
3. | To the left of the component's configuration window, click Actions. |
5. | In the Outputs table, enter the following: |
Property ID |
Type |
Value |
---|---|---|
dwfProviderCount |
Trigger |
GO |
6. | Click Save & Close. |
7. | Save your module. |
Preview your module in Express View Express View is how your end-user views your application. Express View also lets you preview your applications to test your configuration and view the styling. This is also the view your end-users will see when interacting with your application. After configuring a module, click Preview in the Module Builder to interact with the module in Express View.. Notice how you can hover over and select portions of the pie chart to identify specific information.
Structure of a Chart Component's Data
The Chart component uses input Property IDs A Property ID is the unique field ID used by Unqork to track and link components in your module. to display array data.