To make modifications to the application, browse to <your web server directory>\ResidentialCompFinder\js folder and open config.js in Microsoft Notepad or another text editor.
General settings
The application title, icon, theme and splash window content can be changed by modifying the following parameters:
Parameter | Description |
ApplicationName | Title of the application. This title displays at the top of the application. |
ApplicationIcon | Icon displayed in the upper left corner of the application. |
ApplicationFavIcon | Icon used for a shortcut to the application. |
CustomLogoUrl | Logo displayed in the lower left corner of the application. |
SplashScreen | Message displayed when the application starts. |
ApplicationTheme | Theme and color of the application window. See the styles folder for alternative CSS files. |
// Set application title
ApplicationName: "Residential Comp Finder",
// Set application icon path
ApplicationIcon: "/js/library/themes/images/residential-comp-finder-logo.png",
// Set application Favicon path
ApplicationFavicon: "/js/library/themes/images/faviconBlue.ico",
// Set custom logo url, displayed in lower left corner. Set to empty "" to disable.
CustomLogoUrl: "",
// Set splash window content - Message that appears when the application starts
SplashScreen: {
SplashScreenContent: "The Comp Finder application helps citizens and real estate professionals search for and locate recent residential property sales, and combine their sales search with key community and business demographic information. Access to this information facilitates better real estate decisions.",
IsVisible: true
},
ThemeColor: "js/library/themes/styles/blueTheme.css",
Basemap settings
Optionally, change the group name and owner if you would like to use your own basemaps.
Parameter | Description |
PortalAPIURL | Replace arcgis.com with your portal URL if you are using Portal for ArcGIS. |
BasemapGroupTitle | The group that contains the basemaps used in the basemap switcher. The basemap group must be shared with everyone. |
BasemapGroupOwner | The name of owner of the basemaps group. |
BasemapSpatialReferenceWKID | The spatial reference for all of the basemaps. |
NoThumbnail | Basemap thumbnail displayed in the basemap switcher. A basemap thumbnail is only necessary if a thumbnail image does not exist. |
// Specify URL to ArcGIS Portal REST API
PortalAPIURL: "http://www.arcgis.com/sharing/rest/",
// Specify the title of group that contains basemaps
BasemapGroupTitle: "Basemaps",
// Specify the user name of owner of the group that contains basemaps
BasemapGroupOwner: "GISITAdmin",
// Specify spatial reference for basemaps, since all basemaps need to use the same spatial reference
BasemapSpatialReferenceWKID: 102100,
// Specify path to image used to display the thumbnail for a basemap when portal does not provide it
NoThumbnail: "js/library/themes/images/not-available.png",
Map settings
The application consumes an ArcGIS Online map. To use a map, specify the web map ID.
Parameter | Description |
WebMapId | The identifier for the map containing the operational layers for the Residential Comp Finder application. |
Workflow settings
The appearance of each tab in the application can be configured.
Parameter | Description |
Name | The text that displays on the tab. |
Enabled |
Controls whether the tab is visible.
|
Search settings
The application can be configured to search one or more layers.
Parameter | Description |
Title | The map layer name or the service layer name defined in the map. The map layer Title setting must match the layer title on the map's item page. |
QueryLayerId | Layer index number used to perform queries. The map layer QueryLayerId setting must match the layer's index number on the map's item page. |
SearchDisplayTitle | Title of the grouped search results. |
SearchDisplayFields | Field containing values displayed in the search panel, after the search is completed and the grouped search result is expanded. |
SearchExpression | Query expression containing fields used in searching. |
Title: "Sales",
QueryLayerId: "0",
SearchDisplayTitle: "Parcel",
SearchDisplayFields: "${PARCELID}",
SearchExpression: "UPPER(PARCELID) LIKE UPPER('${0}%')",
Filter options
Filters can be configured for limiting search results for buildings and sites. There are three types of filter options: Range, Regular, and Additional.
Range filter options display as a set of text boxes for defining the From and To values to use when filtering results.
Parameter | Description |
DisplayText | Text to display in the application. |
FieldName | The name of the map layer's field that is used for the filter. |
FilterRangeFields: [
{
DisplayText: "Floor Area (sqft)",
FieldName: "RESFLRAREA"
},
{
DisplayText: "Sale Price",
FieldName: "SALEAMNT"
},
{
DisplayText: "Assessed Value",
FieldName: "CNTASSDVAL"
},
{
DisplayText: "Year Built",
FieldName: "RESYRBLT"
}
],
Regular filter options display as radio buttons that can be turned on or off on the filter panel.
Parameter | Description |
DisplayText | Text to display in the application. |
FieldName | The name of the map layer's field that is used for the filter. |
FieldValue | The desired value for the field used to filter the search results. |
Options | A list of values that can be used to filter search results. Values must come from the field indicated by the FieldName parameter. |
RegularFilterOptionFields: [{
FieldName: "RESSTRTYPE",
Options: [{
DisplayText: "Colonial",
FieldValue: "Colonial"
}, {
DisplayText: "Georgian",
FieldValue: "Georgian"
}, {
DisplayText: "Bungalow",
FieldValue: "Bungalow"
}, {
DisplayText: "Ranch",
FieldValue: "Ranch"
}]
Information panel settings
The information panel contains items such as search results and details about the selected feature. The information displayed on this panel can be configured.
Parameter | Description |
ShowAttachments | If attachments are enabled on the corresponding service, set ShowAttachments to True to display those attachments in the Residential Comp Finder application. |
DisplayFields | Field names from the corresponding service to include on the information panel, and the display text for each. |
GeoenrichmentContents | Fields from the GeoEnrichment service to include on the information panel, and the display text for each. |
InfoPanelSettings: {
ResultContents: {
ShowAttachments: true,
DisplayFields: [
{
DisplayText: "Parcel Number:",
FieldName: "PARCELID",
SortingEnabled: true
}, {
DisplayText: "Site Address:",
FieldName: "SITEADDRESS",
SortingEnabled: true
}, {
DisplayText: "Sale Price: $",
FieldName: "SALEAMNT",
SortingEnabled: false
}, {
DisplayText: "Current Assessed Value: $",
FieldName: "CNTASSDVAL",
SortingEnabled: true
}
]
GeoEnrichmentContents: {
DisplayTitle: "Neighborhood Information",
DisplayFields: [
{
DisplayText: "Median Home Value",
FieldName: "KeyUSFacts.MEDVAL_CY"
}, {
DisplayText: "Average Home Value",
FieldName: "KeyUSFacts.AVGVAL_CY"
}, {
DisplayText: "Average Household Income",
FieldName: "KeyUSFacts.AVGHINC_CY"
}
]
Address search settings
By default, the application is configured to use ArcGIS Online geocoding service. To use your geolocator or to modify location-related parameters such as the default search address, modify the following parameters:
Parameter | Description |
DisplayText | Name of the tab from which addresses can be searched. |
LocatorDefaultAddress | Default search address |
DisplayText:"Address",
LocatorDefaultAddress:"23 S Julian St, Naperville, Illinois, USA",
Buffer settings
The buffer symbology - which displays the distance from the searched address based on the distance indicated with the slider - can be changed by modifying the following parameters:
Parameter | Description |
FillSymbolColor | Polygon fill symbol in RGB values. |
FillSymbolTransparency | Transparency percentage applied to the polygon symbol. |
LineSymbolColor | Line fill symbol in RGB values. |
LineSymbolTransparency | Transparency percentage applied to the line symbol. |
RippleColor | Line fill symbol in RGB values that controls the color of the circle highlighting selected features. |
LocatorRippleSize | Size of the circle highlighting selected features. |
BufferSymbology: {
FillSymbolColor: "0,171,169",
FillSymbolTransparency: "0.15",
LineSymbolColor: "42,106,255",
LineSymbolTransparency: "0.30"
},
RippleColor: "0,255,255",
LocatorRippleSize: 40,