This document describes the properties of the config.json file, and how to use it to configure the app to your desired implementation.
This property is used to fill the application title used in the window/tab bar.
This property is used to refer to the feature service that will be used as the source for the data
https://services7.arcgis.com/sampleid/ArcGIS/rest/services/sampleservice/FeatureServer/0
This property is nullable. If it is not null, it references a specific feature by its objectid to fill the potential values of the userFilters property below. It overrides any specific values applied directly in userFilters. In this case, all values would have their selectable property set to true. The label would be the same as the value with underscores replaced for spaces, and set in Title Case.
32
This property is an array of the filters that a user can apply to the gallery items to narrow down their results. The array could be empty, implying that no attribute data should be used for the filtration of results. If the array is empty, no filters show in the application and the ability to toggle away attribute filters in and out of view is removed.
Making multiple selections within the same filter is an OR operation. Making selections across different filters is an AND operation.
The elements of the array are described below.
The name of the field that should be used
The label of the filter displayed to the user
In order to support having multiple values in the same field, the values contained within each row could be separated. In this case, you need to define the separator used (eg. ","). If the field would only contain one value, null should be used as the separator.
This property is used in case you want to directly configure what values should be used for the filter. It is important to note that the root property filterValuesSource overrides these explicitly stated values.
If filterValuesSource is not set, the app will use the explicitly defined values in the config file. If there are no explicitly defined values, the app will determine the unique values contained within the field and use them. To determine the unique values, the app uses the existing features after the filtration done by appliedFilters.
values is an array of JSON Objects described below.
The actual value applied in the field. This could be null for values where selectable is set to false
The user-friendly label to be used for that value
Determines if that value should be used as an actual filtration value that is selectable via checkbox or just displayed as a regular label.
This property is used to "pre-filter" the features in the source Feature Service to a specific set before any user filters could be applied.
It is an array of JSON Objects structured as described below.
The name of the field to be used to pre-filter the features.
An array of values to be used as filters for those fields. Only features that have these values in that field will be used in the app at all.
This property is used to map the application items to the feature attribute data as a JSON object described below.
The field to be used to fill the card's name
The field to be used to fill the card's URL
The field to be used to fill the card's description
This property is used to determine how to display the thumbnail in the card, described below.
Whether or not a thumbnail should be displayed in the card
Determines if the thubmnail should be populated from the feature attachment. In that case, the value would be attachment. If the thumbnail should be populated from a field containing the url, then the value would be field.
Determines the field that should be used to populate the thumbnail if type is set to field.
JSON Object determining how the map should be displayed, described below. Location filtration is ANDed with selected attribute filters. Only one location can be selected at a time.
Determines whether or not a map is displayed for location filtration at all.
Determines the basemap to be used within the map.
Determines the center of the map to be shown.
Determines the zoom level of the map to be shown.
Determines whether to show or hide the zoom buttons on the map.
The symbol to be used to display the features. This can be filled from the JS API Sample Playground.
The symbol to be used to display the selected location. This can be filled from the JS API Sample Playground.
The maximum length of the description including the ellipsis. The maximum length will not cut off a word, but will find the nearest space to the length to add the ellipsis.
The number of cards to display per row on a mid-size to large screen.
The number of cards to display per row on a small screen.
Determines whether the app should be displayed in dark mode.