Display utility associations

View in

QML

C++

View on GitHub

Sample viewer app

Create graphics for utility associations in a utility network.

screenshot

Use case

Visualizing utility associations can help you to better understand trace results and the topology of your utility network. For example, connectivity associations allow you to model connectivity between two junctions that don't have geometric coincidence (are not in the same location); structural attachment associations allow you to model equipment that may be attached to structures; and containment associations allow you to model features contained within other features.

How to use the sample

Pan and zoom around the map. Observe graphics that show utility associations between junctions.

How it works

Create a UtilityNetwork with a feature service URL, add it to the map's utilityNetworks list, then load it.
Add a FeatureLayer to the map for every UtilityNetworkSource of type Edge or Junction.
Create a GraphicsOverlay for the utility associations.
Add connection for the ViewpointChanged signal of the MapView.
When the sample starts and every time the viewpoint changes, do the following steps.
Get the geometry of the mapview's extent using currentViewpointExtent.extent.
Get the associations that are within the current extent using associationsWithEnvelope(extent).
Get the UtilityAssociationType for each association.
Create a Graphic using the Geometry property of the association and a preferred symbol.
Add the graphic to the graphics overlay.

Relevant API

GraphicsOverlay
ServiceGeodatabase
UtilityAssociation
UtilityAssociationType
UtilityNetwork

About the data

The Naperville electrical network feature service, hosted on ArcGIS Online (authentication required: this is handled within the sample code), contains a utility network used to run the subnetwork-based trace in this sample.

Additional information

Using utility network on ArcGIS Enterprise 10.8 requires an ArcGIS Enterprise member account licensed with the Utility Network user type extension. Please refer to the utility network services documentation.

Credentials:

Username: viewer01
Password: I68VGU^nMurF

Sample Code

DisplayUtilityAssociations.qml
Use dark colors for code blocksCopy
// [WriteFile Name=DisplayUtilityAssociations, Category=UtilityNetwork]
// [Legal]
// Copyright 2020 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
import QtQuick.Controls
import QtQuick.Layouts
import Esri.ArcGISRuntime

Rectangle {
    id: rootRectangle
    clip: true
    width: 800
    height: 600

    readonly property url featureServerUrl: "https://sampleserver7.arcgisonline.com/server/rest/services/UtilityNetwork/NapervilleElectric/FeatureServer"
    readonly property int maxScale: 2000
    readonly property int viewpointScale: 40

    MapView {
        id: mapView
        anchors.fill: parent

        Component.onCompleted: {
            // Set the focus on MapView to initially enable keyboard navigation
            forceActiveFocus();
        }

        Control {
            background: Rectangle {
                border.color: "black"
                border.width: 1
            }

            padding: 5
            anchors {
                top: parent.top
                left: parent.left
                margins: 20
            }

            contentItem: GridLayout {
                id: grid
                columns: 2
                anchors.horizontalCenter: parent.horizontalCenter

                Label {
                    text: "Utility association types"
                    color: "#000000"
                    Layout.alignment: Qt.AlignHCenter
                    Layout.fillWidth: true
                    Layout.columnSpan: 2
                }

                Image {
                    id: attachmentImage
                    fillMode: Image.PreserveAspectFit
                }
                Label {
                    id: attachmentLabel
                    text: "Attachment symbol"
                    color: "#000000"
                }

                Image {
                    id: connectivityImage
                }
                Label {
                    id: connectivityLabel
                    text: "Connectivity symbol"
                    color: "#000000"
                }
            }
        }

        Point {
            id: centerPoint
            x: -9812698.37297436
            y: 5131928.33743317
            SpatialReference {wkid: 3857}
        }

        Map {
            id: map
            Basemap {
                initStyle: Enums.BasemapStyleArcGISTopographic
            }

            Component.onCompleted: {
                utilityNetwork.load();
                map.utilityNetworks.append(utilityNetwork);
            }

            UtilityNetwork {
                id: utilityNetwork
                url: featureServerUrl

                Credential {
                    username: "viewer01"
                    password: "I68VGU^nMurF"
                }

                onLoadStatusChanged: {
                    if (loadStatus !== Enums.LoadStatusLoaded)
                        return;

                    let edges = [];
                    let junctions = [];

                    // get all the edges and junctions in the network
                    for (let i = 0; i < definition.networkSources.length; i++) {
                        if (definition.networkSources[i].sourceType === Enums.UtilityNetworkSourceTypeEdge) {
                            edges.push(definition.networkSources[i]);
                        } else if (definition.networkSources[i].sourceType === Enums.UtilityNetworkSourceTypeJunction) {
                            junctions.push(definition.networkSources[i]);
                        }
                    }

                    // add all edges that are not subnet lines to the map
                    for (let j = 0; j < edges.length; j++) {
                        if (edges[j].sourceUsageType !== Enums.UtilityNetworkSourceUsageTypeSubnetLine && edges[j].featureTable !== null) {
                            map.operationalLayers.append(ArcGISRuntimeEnvironment.createObject("FeatureLayer", {featureTable: edges[j].featureTable}));
                        }
                    }

                    // add all junctions to the map
                    for (let k = 0; k < junctions.length; k++) {
                        if (junctions[k].featureTable !== null) {
                            map.operationalLayers.append(ArcGISRuntimeEnvironment.createObject("FeatureLayer", {featureTable: junctions[k].featureTable}));
                        }
                    }

                    attachmentValue.values = [Enums.UtilityAssociationTypeAttachment];
                    connectivityValue.values = [Enums.UtilityAssociationTypeConnectivity];

                    mapView.setViewpointCenterAndScale(centerPoint, viewpointScale);
                }

                onAssociationsStatusChanged: {
                    if (associationsStatus !== Enums.TaskStatusCompleted)
                        return;

                    let isGraphicUnique = (graphics, id) => {
                        for (let j = 0; j < graphics.count; j++) {
                            const attributes = graphics.get(j).attributes;
                            if (attributes.containsAttribute("GlobalId") && attributes.attributeValue("GlobalId") === id) {
                                return false;
                            }
                        }
                        return true;
                    }

                    for (let i = 0; i < associationsResults.length; i++) {
                        const association = associationsResults[i];

                        if (isGraphicUnique(associationsOverlay.graphics, association.globalId)) {
                            const graphic = ArcGISRuntimeEnvironment.createObject("Graphic", {geometry: association.geometry});
                            graphic.attributes.insertAttribute("GlobalId", association.globalId);
                            graphic.attributes.insertAttribute("AssociationType", association.associationType);
                            associationsOverlay.graphics.append(graphic);
                        }
                    }
                }
            }
        }

        GraphicsOverlay {
            id: associationsOverlay

            // create a renderer for the associations
            UniqueValueRenderer {
                id: uniqueValueRenderer
                fieldNames: ["AssociationType"]

                UniqueValue {
                    id: attachmentValue
                    label: "Attachment"
                    SimpleLineSymbol {
                        id: attachmentSymbol
                        style: Enums.SimpleLineSymbolStyleDot
                        color: "lime"
                        width: 5

                        // create swatch image for the legend
                        Component.onCompleted: {
                            createSwatch();
                        }
                        onSwatchImageChanged: {
                            attachmentImage.source = swatchImage;
                        }
                    }
                }

                UniqueValue {
                    id: connectivityValue
                    label: "Connectivity"
                    SimpleLineSymbol {
                        id: connectivitySymbol
                        style: Enums.SimpleLineSymbolStyleDot
                        color: "red"
                        width: 5

                        // create swatch image for the legend
                        Component.onCompleted: {
                            createSwatch();
                        }
                        onSwatchImageChanged: {
                            connectivityImage.source = swatchImage;
                        }
                    }
                }
            }
        }

        // add associations to the map view
        function addAssociations() {
            // check if outside maximum scale
            if (currentViewpointCenter.targetScale >= maxScale)
                return;

            let currentExtent = currentViewpointExtent.extent;
            if (currentExtent.empty) {
                console.warn("Extent not valid.");
                return;
            }

            utilityNetwork.associationsWithEnvelope(currentExtent);
        }

        onSetViewpointCompleted: succeeded => {
            if (!succeeded)
                return;

            addAssociations();
        }

        // add new associations when navigation is finished
        onNavigatingChanged: {
            if (navigating)
                return;

            addAssociations();
        }
    }
}

ArcGIS Maps SDK for QtQML samples

Display utility associations

Was this page helpful?

Was this page helpful?

ArcGIS Maps SDK for QtQML samples

Display utility associations

Use case

How to use the sample

How it works

Relevant API

About the data

Additional information

Tags

Sample Code

Was this page helpful?

Was this page helpful?