Local Server map image layer

View on GitHub
Sample viewer app

Start the Local Server and Local Map Service, create an ArcGIS Map Image Layer from the Local Map Service, and add it to a map.

screenshot

Use case

For executing offline geoprocessing tasks in your ArcGIS Runtime apps via an offline (local) server.

How to use the sample

The Local Server and local map service will automatically be started and, once running, a map image layer will be created and added to the map.

How it works

  1. Create and run the Local Server.

    • LocalServer::instance creates the Local Server.
    • LocalServer::start() starts the server asynchronously.
  2. Wait for server to be in the LocalServerStatus::Started state.

    • LocalServer::statusChanged() fires whenever the running status of the Local Server changes.
  3. Create and run a local service, example of running a LocalMapService.

    • new LocalMapService(Url), creates a local map service with the given URL path to the map package (mpkx file).
    • LocalMapService::start() starts the service asynchronously.
    • The service is added to the Local Server automatically.
  4. Wait for map service to be in the LocalServerStatus::Started state.

    • LocalMapService::statusChanged() signal fires whenever the status of the local service has changed.
  5. Create an ArcGIS map image layer from local map service.

    • Create a ArcGISMapImageLayer(Url) from local map service URL, LocalMapService::url()
    • Add the layer to the map's operational layers.
    • Connect to the map image layer's LoadStatusChanged signal.
    • When the layer's status is Loaded, set the map view's extent to the layer's full extent.

Relevant API

  • ArcGISMapImageLayer
  • LocalMapService
  • LocalServer
  • LocalServerStatus

Offline data

Read more about how to set up the sample's offline data here.

Link Local Location
RelationshipID map package <userhome>/ArcGIS/Runtime/Data/mpkx/RelationshipID.mpkx

Additional information

Local Server can be downloaded for Windows and Linux platforms. Local Server is not supported on macOS.

Tags

image, layer, local, offline, server

Sample Code

LocalServerMapImageLayer.qmlLocalServerMapImageLayer.cppLocalServerMapImageLayer.h
                                
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
// [WriteFile Name=LocalServerMapImageLayer, Category=LocalServer]
// [Legal]
// Copyright 2017 Esri.

// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0

// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// [Legal]

import QtQuick 2.6
import Esri.Samples 1.0

LocalServerMapImageLayerSample {
    id: localServerMapImageLayerSample
    width: 800
    height: 600

    // Create MapQuickView here, and create its Map etc. in C++ code
    MapView {
        anchors.fill: parent
        objectName: "mapView"
        // set focus to enable keyboard navigation
        focus: true
    }
}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.