Read symbols from a mobile style

View inQMLC++
View on GitHub
Sample viewer app

Combine multiple symbols from a mobile style file into a single symbol.

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. Create a new SymbolStyle from a stylx file, and load it.
  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 multilayer symbol by passing the keys for the selected symbols into SymbolStyle::fetchSymbol.
  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::fetchSymbol
  • 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, mobile style, multilayer, stylx

Sample Code

ReadSymbolsFromMobileStyle.cppReadSymbolsFromMobileStyle.cppReadSymbolsFromMobileStyle.hSymbolComboBox.qmlSymbolImageProvider.cppSymbolImageProvider.hReadSymbolsFromMobileStyle.qml
Use dark colors for code blocksCopy
                                                                                                                                                                                                                                                                         
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
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
// [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]

#ifdef PCH_BUILD
#include "pch.hpp"
#endif // PCH_BUILD

#include "ReadSymbolsFromMobileStyle.h"

#include "Map.h"
#include "MapQuickView.h"
#include "GraphicsOverlay.h"
#include "Graphic.h"
#include "SymbolStyle.h"
#include "MultilayerSymbol.h"
#include "Point.h"
#include "MultilayerPointSymbol.h"

#include "SymbolImageProvider.h"

#include <QDir>
#include <QObject>
#include <QQmlContext>
#include <QTemporaryDir>
#include <QtCore/qglobal.h>

#ifdef Q_OS_IOS
#include <QStandardPaths>
#endif // Q_OS_IOS

using namespace Esri::ArcGISRuntime;

// helper method to get cross platform data path
namespace
{
QString defaultDataPath()
{
  QString dataPath;

#ifdef Q_OS_ANDROID
  dataPath = "/sdcard";
#elif defined Q_OS_IOS
  dataPath = QStandardPaths::writableLocation(QStandardPaths::DocumentsLocation);
#else
  dataPath = QDir::homePath();
#endif

  return dataPath;
}
} // namespace

ReadSymbolsFromMobileStyle::ReadSymbolsFromMobileStyle(QObject* parent /* = nullptr */) :
  QObject(parent),
  m_map(new Map(BasemapStyle::ArcGISTopographic, this)),
  m_graphicParent(new QObject())
{
  m_symbolStyle = new SymbolStyle(defaultDataPath() + "/ArcGIS/Runtime/Data/styles/emoji-mobile.stylx", this);

  // Connect to the search completed signal of the style
  connect(m_symbolStyle, &SymbolStyle::searchSymbolsCompleted, this, [this](QUuid id, SymbolStyleSearchResultListModel* results)
  {
    const int index = m_taskIds.indexOf(id);
    m_models[index] = results;

    emit symbolResultsChanged();
    updateSymbol(0, 0, 0, QColor(Qt::yellow), 40);
  });

  // Load the style
  connect(m_symbolStyle, &SymbolStyle::doneLoading, this, [this](Error e)
  {
    if (!e.isEmpty())
      return;

    // search for hat symbol layers
    SymbolStyleSearchParameters hatParams;
    hatParams.setCategories({"Hat"});
    TaskWatcher hatWatcher = m_symbolStyle->searchSymbols(hatParams);
    m_taskIds.append(hatWatcher.taskId());

    // search for mouth symbol layers
    SymbolStyleSearchParameters mouthParams;
    mouthParams.setCategories({"Mouth"});
    TaskWatcher mouthWatcher = m_symbolStyle->searchSymbols(mouthParams);
    m_taskIds.append(mouthWatcher.taskId());

    // search for eyes symbol layers
    SymbolStyleSearchParameters eyeParams;
    eyeParams.setCategories({"Eyes"});
    TaskWatcher eyeWatcher = m_symbolStyle->searchSymbols(eyeParams);
    m_taskIds.append(eyeWatcher.taskId());

    // search for face symbol layers
    SymbolStyleSearchParameters faceParams;
    faceParams.setCategories({"Face"});
    TaskWatcher faceWatcher = m_symbolStyle->searchSymbols(faceParams);
    m_taskIds.append(faceWatcher.taskId());
  });

  m_symbolStyle->load();

  // Connect to fetchSymbol completed signal
  connect(m_symbolStyle, &SymbolStyle::fetchSymbolCompleted, this, [this](QUuid, Symbol* symbol)
  {
    if (m_currentSymbol)
      delete m_currentSymbol;

    // store the resulting symbol
    m_currentSymbol = static_cast<MultilayerPointSymbol*>(symbol);

    // ensure cast was successful
    if (!m_currentSymbol)
      return;

    // set the size
    m_currentSymbol->setSize(m_symbolSize);

    // set the color preferences per layer
    for (SymbolLayer* lyr : *(m_currentSymbol->symbolLayers()))
    {
      lyr->setColorLocked(true);
    }

    m_currentSymbol->symbolLayers()->at(0)->setColorLocked(false);

    // set the color
    m_currentSymbol->setColor(m_currentColor);

    // request symbol swatch
    connect(m_currentSymbol, &MultilayerPointSymbol::createSwatchCompleted, m_currentSymbol, [this](QUuid id, QImage img)
    {
      if (!m_symbolImageProvider)
        return;

      // convert the QUuid into a QString
      const QString imageId = id.toString().remove("{").remove("}");

      // add the image to the provider
      m_symbolImageProvider->addImage(imageId, img);

      // update the URL with the unique id
      m_symbolImageUrl = QString("image://%1/%2").arg(SymbolImageProvider::imageProviderId(), imageId);

      // emit the signal to trigger the QML Image to update
      emit symbolImageUrlChanged();
    });

    m_currentSymbol->createSwatch();
  });
}

ReadSymbolsFromMobileStyle::~ReadSymbolsFromMobileStyle() = default;

void ReadSymbolsFromMobileStyle::init()
{
  // Register the map view for QML
  qmlRegisterType<MapQuickView>("Esri.Samples", 1, 0, "MapView");
  qmlRegisterType<ReadSymbolsFromMobileStyle>("Esri.Samples", 1, 0, "ReadSymbolsFromMobileStyleSample");
  qmlRegisterUncreatableType<SymbolStyleSearchResultListModel>("Esri.Samples", 1, 0, "SymbolStyleSearchResultListModel", "SymbolStyleSearchResultListModel is uncreateable");
}

MapQuickView* ReadSymbolsFromMobileStyle::mapView() const
{
  return m_mapView;
}

// Set the view (created in QML)
void ReadSymbolsFromMobileStyle::setMapView(MapQuickView* mapView)
{
  if (!mapView || mapView == m_mapView)
    return;

  m_mapView = mapView;
  m_mapView->setMap(m_map);

  // Get the image provider from the QML Engine
  QQmlEngine* engine = QQmlEngine::contextForObject(this)->engine();
  engine->addImageProvider(SymbolImageProvider::imageProviderId(), new SymbolImageProvider);
  m_symbolImageProvider = static_cast<SymbolImageProvider*>(engine->imageProvider(SymbolImageProvider::imageProviderId()));

  // add a graphics overlay
  GraphicsOverlay* overlay = new GraphicsOverlay(this);
  m_mapView->graphicsOverlays()->append(overlay);

  // connect to mouse clicked signal
  connect(m_mapView, &MapQuickView::mouseClicked, this, [this, overlay](QMouseEvent mouseEvent)
  {
    if (!m_currentSymbol)
      return;

    const Point clickedPoint = m_mapView->screenToLocation(mouseEvent.x(), mouseEvent.y());
    Graphic* graphic = new Graphic(clickedPoint, m_currentSymbol, m_graphicParent.get());
    overlay->graphics()->append(graphic);
  });

  emit mapViewChanged();
}

// Clear the graphics from the overlay and delete each object
void ReadSymbolsFromMobileStyle::clearGraphics()
{
  if (!m_mapView)
    return;

  GraphicsOverlay* overlay = m_mapView->graphicsOverlays()->first();
  if (!overlay)
    return;

  // clear the list model
  overlay->graphics()->clear();

  // reset m_graphicsParent to delete all children
  m_graphicParent.reset(new QObject());
}

void ReadSymbolsFromMobileStyle::updateSymbol(int hatIndex, int mouthIndex, int eyeIndex, QColor color, int size)
{
  if (!m_symbolStyle || !hatResults() || !mouthResults() || !eyeResults() || !faceResults())
    return;

  // set the color and size members
  m_currentColor = color;
  m_symbolSize = size;

  // fetch the new symbol based on keys
  QStringList keys;
  keys.append(faceResults()->searchResults().at(0).key());
  keys.append(eyeResults()->searchResults().at(eyeIndex).key());
  keys.append(mouthResults()->searchResults().at(mouthIndex).key());
  keys.append(hatResults()->searchResults().at(hatIndex).key());
  m_symbolStyle->fetchSymbol(keys);
}

SymbolStyleSearchResultListModel* ReadSymbolsFromMobileStyle::hatResults() const
{
  return m_models[0];
}

SymbolStyleSearchResultListModel* ReadSymbolsFromMobileStyle::mouthResults() const
{
  return m_models[1];
}

SymbolStyleSearchResultListModel* ReadSymbolsFromMobileStyle::eyeResults() const
{
  return m_models[2];
}

SymbolStyleSearchResultListModel* ReadSymbolsFromMobileStyle::faceResults() const
{
  return m_models[3];
}

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