Skip to main content

Line Chart custom widget in the Landing Experience

The Line Chart widget shows information from a User Report as a line graph grouped by a required "Category Name" column in the user report.  It is possible to create a chart with multiple lines using

Updated over 2 weeks ago

The Line Chart widget shows information from a User Report as a line graph grouped by a required "Category Name" column in the user report.

It is possible to create a chart with multiple lines using the optional "Subcategory Name" column in the user report. Each subcategory represents a line in the chart and their definition is depicted in the chart’s legend.

The widget supports drill-in to view the data within the chart. The report behind the widget is simple to configure as it does not require the user to aggregate the data in report as the widget will perform this instead.

A single line chart is shown on the left and a multiple line chart on the right:

Line Chart Widget Examples

Functionality

The following functionality can be done when using the Line Chart Widget:

  • Click the

    refresh data

    to refresh data.

  • Click the

    export to spreadsheet

    to export the data to Microsoft Excel in .xlsx format.

  • Click the

    expand

    to expand the widget to view more data.

Expanded Line Chart Widget

  • Clicking on one of the lines in the widget will drill-down into the output of the widget's backing user report.

Line Chart Widget Drill Down

  • When in the drill-down view of the widget, utilize the Search box to look for specific records. If filters are set on the columns, any value entered on the Search box will be cleared.

  • Click on

    View_Additional_Columns_to_Sort_Button.png

    to view the additional columns that can be sorted on.

  • Click the

    expand

    to expand the drill-down to view more columns from the widget's backing user report. You can also zoom in via the

    zoom in

    and zoom out via the

    zoom out

    in the Expanded view.

Expanded Line Chart Drill Down

  • Click on

    Sort_and_Filter_Button.png

    to sort & filter the data on chosen columns. Filters set on these conditions will be applied whether the data table widget is in the Expanded or Summary view. Columns for filter supports text, dates, numeric, and monetary fields. You can also search values to filter. Note that custom HTML fields are not supported. Additional columns that are not visible on the Summary view of the data widget cannot be filtered on. Make sure to expand the widget first, and then apply the filters on the desired columns.

Sort and Filter Columns

Creating Widget

Select Line Chart from the Add Widget Templates side panel. Click the

mceclip0.png

button that appears.

mceclip0.png

The Configure Widget side panel appears on the right.

mceclip10.png

From here you can modify the following fields:

  • Name: This is a mandatory field. Users should give the widget a specific name to differentiate it from other instances of the widget.

  • Title: The title of the chart appears on the widget.

  • Description: Description of the widget which is only viewable by users editing the dashboard. Descriptions are limited to 500 characters.

  • Theme: Select a color using the color picker. This will be the background color of the widget title. If no color is selected, white will be the defaulted color used.

  • User Report: Specify a user report from the list. This is a mandatory field. The selected Data User Report must have one column named “Category Name”. Values in this Column determine the X-axis values in the chart. The chart will count the number of records within each category and this determines the value of the point on the line.

Order of the X-axis values is determined by the order of the “Category Name” column in the report. Showing Months on the X-axis is a popular case for using a Line Chart. To properly sort months by name, create another column in the report that converts the month to an integer and then sort the report on that column. This will cause the Category Name column to end up being sorted correctly (January, February, etc).

The Data User Report can optionally have one column named “Subcategory Name” that will allow multiple lines in a line chart. Values in this column further separate data into subcategories within each main category. The sort order specified for the Subcategory Name column will be honored and will automatically sort in ascending order when no sort order is specified. When the Sum or Average function option is selected, the report must have a column named "Aggregate".

Please consult the Things to Note section for more details about User Reports including a screenshot of the user report for this example.

  • Refresh Time Override (Hours): The number of hours to refresh the report data can be set to override the default dashboard refresh setting. A higher value improves general system performance by running reports less often. A lower value refreshes data more frequently. Certain widgets can override this setting. A user can always force a refresh in a widget to see the latest data and update their cache.

  • Function: Displays the output of the function selected and is a required field. Select from 3 options:

    • Count - counts the number of rows

    • Sum - sum of all values in the Aggregate column

    • Average - average of all values in the Aggregate column

  • Color Settings: Expanded theming options can be applied on this widget type through the Color Settings section. To learn more about controlling the colors on your Line Chart widget, click here.

After saving the widget, the newly added widget will be added to the grid. Widgets can be moved around and resized whilst in editing mode. Click on any point on the line graph to open the drill-in data table.

Selecting a point on the chart line will open a data table that shows all records for the selected point. The chart supports drill-in to further analyze the data in the chart. The required “Category Name” column is hidden from the drill-in table.

The Data User Report should contain additional columns that provide useful drill-in data.

The drill-in data table can be resized. To return to the Line Chart widget, click on the Widget Title. Changes will only apply if the

PP_-_Save.jpg

button is clicked at the top of the Landing Experience Dashboard screen.

The newly added widget will be added. Widgets can be moved around and resized whilst in editing mode. You can change configuration with the

Cog

icon and delete it with

Trash

icon.

mceclip12.png

Things to Note

  • User Role security still limits report data however User Report filters must be used to further filter report data

  • User Report prompts are supported for context filters

  • After selecting a user report the user can run or edit the report for easy setup

  • The Refresh Time Override (Hours) can be set to override the default dashboard refresh time

  • The configuration report can have more rows when it is run but only the first row will be used to populate the widget

  • With the exception of Category Name and Aggregate, all columns will be displayed in the drill-in data table unless they are marked hidden in the User Report

  • If the Category Name field is missing from the backing User Report of the widget, then the following prompt will be visible in the widget in the dashboard: 'Category Name' column is required for bar, column, pie, and line chart widgets.

  • If Sum or Average is selected as the Function and there is no Aggregate column included in the user report, the widget is blank and shows no data. Count does not require an Aggregate column

  • Basic data table HTML is supported (links, icons, etc)

  • An "Excel" button on the widget exports the displayed data to Microsoft Excel in XLXS format

Here is an example of the user report used to create the example widget using the Count Function. When using a Count function, the Aggregate field is not required in the user report.

Sample User Report

The columns: Category Name and Subcategory Name are automatically hidden in the chart. The report must include Category Name for it to work on column charts.

The Sort column is used to convert the category to integer. For this example, it is months to their respective integer.

Did this answer your question?