Integration Guide

The integration options mainly revolve around filtering. There are two ways to dynamically/automatically filter your gantt chart display items - via URL, and via automatically setting web part JSON config in the page.

Filtering via URL

If you're loading your SharePoint page from an external system, you can dynamically pass filter values via the URL:

The format for the filtering URL parameters follows the same schema as SharePoint List filtering.

For example:

FilterField1=<field internal name>&FilterValue1=<field value to search for>&FieldType1=<field type>

Additionally, another parameter is supported: FilterName1. This can optionally be used to customise the display name of the field being filtered.

Finding your field internal name and type

The field internal name can be retrieved by inspecting your List page. The easiest way to do this is to filter the list by your field:

When you do this, the URL parameters will be added to the page - and you can just copy these:

If your field name contains spaces, the internal name may be encoded with "_x0020_" characters. This is normal and a valid part of the internal name.

Filtering on multiple fields

If you are filtering on multiple fields, then you can increment the number of the end of the parameters: FilterField2, FilterValue2, etc.

Filtering via page JSON config

When editing the web part, you can set a filter option as shown:

However, to avoid the need to manually select this option, you may wish to automatically set it during page creation. Note that this is only possible when creating the page programmatically, e.g. by creating the page using Powershell, or PnP Provisioning.

Firtly, select a filter field and filter value as shown above. Then, enter page maintenance mode by adding "maintenancemode=true" to the URL:

Now, within your web part JSON, you will find the configuration option for this filter:

Now comes the difficult part - within your page provisioning process, you can programmatically replace this series1_filterFieldValue option with a value of your choice. When the page is created, you will find your gantt chart configured as requested.