Skip to main content

Change Default Map Click Behavior

VertiGIS Studio Mobile comes with default behavior that runs on a map click. The default behavior will identify and display details for results in the nearby area. But what if you want to replace the functionality with your own behavior? This can be accomplished by leveraging VertiGIS Studio Workflow and editing the app config.

note

It's actually possible to configure the Map's onClick event in VertiGIS Studio Mobile Designer, by setting a workflow as the action for the Maps click event. However, the point of this tutorial is to demonstrate the concept of configuring actions using the app config.

What you're Building​

We will modify the default map on click behavior to buffer the click geometry by a user provided distance and create a graphic which visualizes this buffer.

Map Click Workflow with Buffer Behavior

Prerequisites​

Follow along by setting up the VertiGIS Studio Mobile SDK and editing the minimal layout and app config provided.

tip

If you just need to make a small change to the layout and app config of an existing application, you can download the config and layout files for the application, tweak them, and then re-upload them.

Initial Set up​

Start the VertiGIS Studio Mobile SDK with the following layout and app JSON. You should see a simple application with one layer, Fire Hydrants, which has a related table Fire Hydrant Surveys.

Try clicking the map. It should return results for the point you clicked in the results list.

app/layout-large.xml
<?xml version="1.0" encoding="utf-8" ?>
<layout
    xmlns="https://geocortex.com/layout/v1"
    xmlns:gxm="https://geocortex.com/layout/mobile/v1"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="https://geocortex.com/layout/v1 ../../ViewerSpec/layout/layout-mobile.xsd">
  <gxm:taskbar id="taskbar" orientation="vertical">
    <map config="map-1" slot="main"/>
    <panel>
      <results-list config="results" />
      <feature-details config="feature-details"/>
      <gxm:update-feature/>
      <gxm:add-related-feature />
    </panel>
  </gxm:taskbar>
</layout>

Set up a Workflow to Run on Map Click​

The first thing we need to do is override the default map click behavior. We can do this by editing the default behavior for the <map/> component in the app config. The default behavior for the map's onClick event is a command chain that runs tasks.identify and then highlights.pulse, and finally, results.display.

{
    "$schema": "..\\..\\ViewerFramework\\app-config\\mobile\\mobile-app-config.schema.json",
    "schemaVersion": "1.0",
    "items": [
        ...
        {
          "$type": "map-extension",
          "id": "map-1",
          "onClick": [
              "tasks.identify",
              "highlights.pulse",
              "results.display"
          ]
          ...
        }
    ]
}

First, we are going to replace the command chain with a workflow.run command that replicates this behavior.

  1. Open up VertiGIS Studio Workflow Designer and create and save a new workflow.
  2. Add an "Alert" activity as a test.
  3. Copy the ID of the the workflow from the URL

  1. Add the workflow as an app item to your app config.
{
    "$schema": "..\\..\\ViewerFramework\\app-config\\mobile\\mobile-app-config.schema.json",
    "schemaVersion": "1.0",
    "items": [
        ...
        {
            "$type": "workflow",
            "id": "map-click-workflow",
            "title": "Map Click Workflow",
            "commandArgumentInput": "context",
            "target": "#taskbar",
            "portalItem": "<your-workflow-id-here>"
        },
        ...
    ]
}
  1. Next, configure the onClick property of the Map Component in the app config to run the workflow.
{
    "$schema": "..\\..\\ViewerFramework\\app-config\\mobile\\mobile-app-config.schema.json",
    "schemaVersion": "1.0",
    "items": [
        ...
        {
            "id": "default",
            "$type": "map-extension",
            "onClick": "workflow.run-map-click-workflow",
            ...
        }
    ]
}
  1. Run the app and test your workflow. You should see your alert pop up when you try to click on the map.
Map Click Workflow with Alert
  1. Open up your workflow in the VertiGIS Studio Workflow Designer again. The default behavior we just overrode can be recreated with the use of RunCommand and RunOperation activities. tasks.identify is an operation, so it needs a RunOperation activity, and highlights.pulse and results.display are commands, so they need RunCommand Activities. Chain these three activities together, passing the workflow context to tasks.identify and then passing the output of that operation to highlights.pulse, and results.display.
note

You can

download this workflow

and then

import it into the VertiGIS Studio Workflow Designer.

Map Click Workflow with Original Operations
  1. Save the workflow and reload the application. Test the map click functionality and ensure it works as it originally did.

Extend the Workflow to Create a Graphic Buffering the Click Geometry​

At this point, you can choose to extend the map click behavior with VertiGIS Studio Workflow in whatever way is appropriate for your use case. You could execute a different "identify" for external results and add them to the set of results displayed, or zoom the map to a specific orientation and scale, or display a form for the user to fill out with relevant information to that location. For this example, a workflow was created which asks a user for a buffer distance, and creates a graphic showing the buffer around the click location.

note

You can

download this buffer geometry workflow

and then

import it into the VertiGIS Studio Workflow Designer.

Map Click Workflow with Buffer Behavior

Relevant SDK Samples​

The VertiGIS Studio Mobile SDK Samples project has a variety of workflow samples:

Next Steps​

This pattern of configuring behavior with a workflow can be applied to numerous components. You can use a workflow to control the behavior of the Map, Feature Details, Geolocate, Custom Components, and more. Often, a workflow can be created and used to execute custom behavior instead of requiring the implementation of a custom command or operation.

VertiGIS Studio Workflow

Learn more about VertiGIS Studio Workflow

Get Started

Change Default Behavior

Learn more about overriding default behaviors

Get Started

SDK Sample that Demonstrates Overriding Default Behaviors

Check out the SDK Sample for overriding default behaviors

Get Started

Implement Custom Command or Operation

Implement a custom command or operation with the Mobile SDK

Get Started