Read symbols from a mobile style

View inQMLC++
View on GitHub
Sample viewer app

Open a mobile style (.stylx) and read its contents. Combine several symbols from the style into a single multilayer point symbol, then use it to display graphics in the map view.

screenshot

Use case

You may choose to display individual elements of a dataset like a water infrastructure network (such as valves, nodes, or endpoints) with the same basic shape, but wish to modify characteristics of elements according to some technical specifications. Multilayer symbols lets you add or remove components or modify the colors to create advanced symbol styles.

How to use the sample

Select a symbol and a color from each of the category lists to create an emoji. A preview of the symbol is updated as selections are made. The size of the symbol can be set using the slider. Click the map to create a point graphic using the customized emoji symbol, and click Clear to clear all graphics from the display.

How it works

  1. On startup, read a mobile style file by creating and loading a SymbolStyle.
  2. Get a list of symbols in the style by calling SymbolStyle.searchSymbols.
  3. Display the resulting SymbolStyleSearchResultListModel inside a series of ComboBoxes.
  4. When symbol selections change, create a new MultilayerPointSymbol by passing the keys for the selected symbols into SymbolStyle.fetchSymbolWithKeyList.
  5. Iterate through the symbol layers and color lock all symbol layers except the base layer and update the current symbol preview image by calling Symbol.createSwatch.
  6. Create Graphics symbolized with the current symbol when the user taps the map view.

Relevant API

  • MultilayerPointSymbol
  • Symbol.createSwatch
  • SymbolLayer
  • SymbolStyle
  • SymbolStyle.searchSymbols
  • SymbolStyle.fetchSymbolWithKeyList
  • SymbolStyleSearchResultListModel
  • SymbolStyleSearchResult
  • SymbolStyleSearchParameters

Offline Data

A mobile style file (created using ArcGIS Pro) provides the symbols used by the sample.

Link Local Location
Emoji mobile style <userhome>/ArcGIS/Runtime/Data/style/emoji-mobile.stylx

About the data

The mobile style file used in this sample was created using ArcGIS Pro, and is hosted on ArcGIS Online. It contains symbol layers that can be combined to create emojis.

Additional information

While each of these symbols can be created from scratch, a more convenient workflow is to author them using ArcGIS Pro and store them in a mobile style file (.stylx). ArcGIS Runtime can read symbols from a mobile style, and you can modify and combine them as needed in your app.

Tags

advanced symbology, multilayer, mobile style, stylx

Sample Code

ReadSymbolsFromMobileStyle.qmlSymbolComboBox.qml
                                                                                                                                                                                                                                               
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
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
// [WriteFile Name=ReadSymbolsFromMobileStyle, Category=DisplayInformation]
// [Legal]
// Copyright 2019 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.11
import QtQuick.Controls 2.5
import QtQuick.Layouts 1.3
import Esri.ArcGISRuntime 100.12
import Esri.ArcGISExtras 1.1

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

    readonly property url styleDataPath: System.userHomePath + "/ArcGIS/Runtime/Data/styles/emoji-mobile.stylx"
    property var currentSymbol
    property var currentFace
    property var currentEyes
    property var currentMouth
    property var currentHat

    MapView {
        id: mapView
        anchors.fill: parent

        Map {
            Basemap {
                initStyle: Enums.BasemapStyleArcGISTopographic
            }
        }

        GraphicsOverlay {
            id: graphicsOverlay
        }

        onMouseClicked: {
            const graphic = ArcGISRuntimeEnvironment.createObject("Graphic");
            graphic.geometry = mouse.mapPoint;
            graphic.symbol = currentSymbol;
            graphicsOverlay.graphics.append(graphic);
        }

        Button {
            anchors {
                bottom: mapView.attributionTop
                horizontalCenter: parent.horizontalCenter
                bottomMargin: 10
            }
            text: "Clear Graphics"
            onClicked: graphicsOverlay.graphics.clear();
        }
    }

    SymbolStyle {
        id: symbolStyle
        styleLocation: styleDataPath
        Component.onCompleted: load()

        onLoadStatusChanged: {
            // fetch the default parameters
            if (loadStatus === Enums.LoadStatusLoaded) {
                defaultSearchParameters();
            }
        }

        onDefaultSearchParametersStatusChanged: {
            // search the symbol style with defaults - all symbols will be returned
            if (defaultSearchParametersStatus === Enums.TaskStatusCompleted) {
                searchSymbols(defaultSearchParametersResult);
            }
        }

        onSearchSymbolsStatusChanged: {
            if (searchSymbolsStatus !== Enums.TaskStatusCompleted)
                return;

            // get initial list of symbols
            for (let i = 0; i < searchSymbolsResult.count; i++) {
                const result = searchSymbolsResult.get(i);
                if (result.category === "Face") {
                    currentFace = result;
                    break;
                }
            }

            // fetch a new symbol with the initial symbol layer keys
            updateSymbol();
        }

        onFetchSymbolStatusChanged: {
            if (fetchSymbolStatus !== Enums.TaskStatusCompleted)
                return;

            // set the current symbol
            currentSymbol = fetchSymbolResult;

            // set the color locked preferences per layer
            currentSymbol.symbolLayers.forEach(symbolLyr => symbolLyr.colorLocked = true);

            currentSymbol.symbolLayers.get(0).colorLocked = false;

            // update size
            currentSymbol.size = sizeSlider.value;

            // update color
            currentSymbol.color = colorComboBox.currentText;

            // update swatch
            currentSymbol.swatchImageChanged.connect(()=> {
                symbolImage.source = currentSymbol.swatchImage;
            });

            currentSymbol.createSwatch();
        }
    }

    function updateSymbol() {
        if (!currentFace || !currentEyes || !currentMouth || !currentHat)
            return;

        // fetch the multilayer symbol composed of these 4 symbol layers
        symbolStyle.fetchSymbolWithKeyList([currentFace.key, currentEyes.key, currentMouth.key, currentHat.key]);
    }

    Rectangle {
        anchors {
            fill: optionGrid
            margins: -5
        }
        color: "#efefef"
    }

    GridLayout {
        id: optionGrid
        anchors {
            left: parent.left
            top: parent.top
            margins: 10
        }

        columns: 2

        Label {
            Layout.columnSpan: 2
            Layout.alignment: Qt.AlignCenter
            text: "Change Options to Modify Symbol"
            font.underline: true
        }

        Label {
            text: "Eyes"
        }

        SymbolComboBox {
            dataPath: styleDataPath
            filterKeyword: "Eyes"
            onSelectionCompleted: {
                currentEyes = currentItem;
                updateSymbol();
            }
        }

        Label {
            text: "Mouth"
        }

        SymbolComboBox {
            dataPath: styleDataPath
            filterKeyword: "Mouth"
            onSelectionCompleted: {
                currentMouth = currentItem;
                updateSymbol();
            }
        }

        Label {
            text: "Hat"
        }

        SymbolComboBox {
            dataPath: styleDataPath
            filterKeyword: "Hat"
            onSelectionCompleted: {
                currentHat = currentItem;
                updateSymbol();
            }
        }

        Label {
            text: "Base Color"
        }

        ComboBox {
            id: colorComboBox
            model: ["yellow", "green", "pink"]
            onCurrentTextChanged: updateSymbol()
        }

        Label {
            text: "Size"
        }

        Slider {
            id: sizeSlider
            Layout.preferredWidth: parent.width / 2
            from: 1
            to: 60
            value: 40
            onValueChanged: updateSymbol()
        }

        Label {
            text: "Preview:"
        }

        Image {
            id: symbolImage
            sourceSize.width: 40
            sourceSize.height: 40
            fillMode: Image.PreserveAspectFit
            width: 40
            height: 40
        }
    }
}

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