Skip to content

3. Configuration parameters

Jump to bottom
John Hasthorpe edited this page Sep 24, 2018 · 13 revisions

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)

Polyline and polygon specific parameters:

  • group="<group name>" (Default group is determined by template type grouping. Adding a common group property to a number 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 templates in the same group, at the same time.
  • distance=<meters> (Default is 0m) (The minimum movement distance in meters from the last vertex captured, before a new feature can be captured)
  • interval=<seconds> (Default is 0s) (The minimum time interval in seconds from the last vertex, before are new feature can be captured)

Other parameters

  • captureImage=true (Adds image capture capability to the button. Default is false)

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

Clone this wiki locally