Skip to content

3. Configuration parameters

Jump to bottom
Ismael Chivite edited this page May 20, 2019 · 13 revisions

ATTENTION:

QuickCapture Esri Labs is graduating into a fully supported ArcGIS product. ArcGIS QuickCapture is planned to be released on June 25, 2019 and its Esri Labs version will be retired a that time.

If you are new to ArcGIS QuickCapture and are looking for information into how to configure the app, we strongly recommend you start with the official ArcGIS QuickCapture app in our Esri Early Adopter Program at: https://earlyadopter.esri.com/key/ArcGISQuickCapture

If you are already using ArcGIS QuickCapture Esri Labs, you will also find detailed information in the Early Adopter Site about how to migrate your existing projects from ArcGIS QuickCapture Esri Labs to ArcGIS QuickCapture.

Beyond basic button styling, QuickCapture also supports custom parameters that can be used to change the behavior of the app. These parameter numbers/strings can be written into the service item properties, template groups, or individual feature templates.

It is important to note the following:

  1. In all case configuration parameters must be entered as comma separated name=value pairs following a pair of slashes (//)

  2. Color values must be specified as a color name or #RRGGBB value enclosed in double quotes (")

e.g.

// option1="green", option2=true, option3=123

Where you write the parameter will vary depending on the parameter in question and whether it needs to be applied to the layer/view, template group, or template. Please see the following sections for more information.

Project configuration parameters (Item level)

Project configuration properties are specified in the feature service's (or view's) Credits (Attribution) property on the item's information page:

credits

The following for the parameters can be written into the item:

Project parameters:

  • columns=<numberOfColumns> (Defines the number of columns buttons are organised over - default is 2)

  • columnSpacing=<numberOfLogicalPixels> (Defines the spacing between button columns in pixels)

  • rowSpacing=<numberOfLogicalPixels> (Defines the spacing between button rows in pixels)

  • backgroundColor="<color>" (Defines the background color for the project)

  • showMap=true (Determines whether of not an overview map is displayed in the project - default is false)

  • coordinateFormat="<format>" (This is for display - Default is DDM (degrees decimal minutes), other options are below)

         * DD (decimal degrees)
     * DMS (degrees minutes seconds)
     * DDM (degrees decimal minutes)
     * UTM
     * USNG
     * MGRS

Button configuration parameters (Template level)

Button configuration properties can be specified in each feature template's description property.

image

The following properties will override the default styling defined by the actual feature template symbology and apply to point, line and polygon layer types:

General parameters:

  • color="<color>" (Button color)
  • outlineColor="<color>" (Button outline color)
  • outlineWidth=<widthInPoints> (Button outline thickness)
  • textColor="<color>" (Button text color)

Point only parameters

  • captureImage=true (Adds image capture capability to the button. Default is false)
  • key=<Key code> (Links button to keyboard keycode, see Linkfor more info).

To enable image capture you must enable attachments on the feature service and once enabled you will see a camera icon the button:

Polyline and polygon specific parameters:

  • group="<group name>"
    Default grouping is defined by the template type groups defined by the feature service. Adding a common group property to a number of templates will create a new group and override the default behavior.

  • exclusive=<boolean>
    Default is true. Exclusive=true means that you can't collect multiple features in the same group, at the same time. Use this together with the group tag to control templates are exclusive of each other.

See the following example:
image

A Road, B Road, and C Road and Track are the default template groups, and within each group there are one or more templates. As exclusive is true by default, it means that you can collect either Sand, Gravel or Dirt, and you can't for example, collect Sand and Gravel together (i.e the templates are exclusive). To override the default groups used by the app, you need to apply a group tag to each of the templates you want to group. Applying group="roads" to each of the A Road, B Road and C Road templates would group them, and make them exclusive.

  • distance=<meters>
    Default is 0m. The minimum movement distance in meters from the last vertex captured, before a new vertex can be captured

  • interval=<seconds>
    Default is 0s. The minimum time interval in seconds from the last vertex, before a new vertex can be captured

Clone this wiki locally