Search dictionary symbol style

View inQMLC++
View on GitHub
Sample viewer app

Find symbols within the mil2525d specification that match a keyword.

screenshot

Use case

You can use support for military symbology to allow users to report changes in the field using the correct military symbols.

How to use the sample

By default, leaving the fields blank and hitting search will find all symbols.

To search for certain symbols, enter text into one or more search boxes and click 'Search for symbols'. Results are shown in a list. Pressing 'Clear' will reset the search.

How it works

  1. Create a symbol dictionary with the mil2525d specification by passing the string "mil2525d" and the path to a .stylx file to the SymbolDictionary constructor.
  2. Create SymbolStyleSearchParameters.
  3. Add members to the names, tags, symbolClasses, categories, and keys list fields of the search parameters.
  4. Search for symbols using the parameters with DictionarySymbolStyle::searchSymbols(SymbolStyleSearchParameters).
  5. Get the Symbol from the list of returned SymbolStyleSearchResultListModels.

Relevant API

  • DictionarySymbolStyle
  • Symbol
  • SymbolStyleSearchParameters
  • SymbolStyleSearchResultListModel

Offline Data

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

Link Local Location
Mil2525d Stylx File <userhome>/ArcGIS/Runtime/Data/styles/arcade_style/mil2525d.stylx

Additional information

This sample features the mil2525D specification. ArcGIS Runtime supports other military symbology standards, including mil2525C and mil2525B(change 2). See the Military Symbology Styles overview on ArcGIS Solutions for Defense for more information about support for military symbology.

While developing, you can omit the path to the .stylx style file; Runtime will refer to a copy installed with the SDK. For production, you should take care to deploy the proper style files and explicitly specify the path to that file when creating the symbol dictionary. See the Military Symbology Styles overview on ArcGIS Solutions for Defense for more information about support for military symbology.

Tags

CIM, defense, look up, MIL-STD-2525B, MIL-STD-2525C, MIL-STD-2525D, mil2525b, mil2525c, mil2525d, military, military symbology, search, symbology

Sample Code

SearchDictionarySymbolStyle.cppSearchDictionarySymbolStyle.cppSearchDictionarySymbolStyle.hSearchDictionarySymbolStyle.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
// [WriteFile Name=SearchDictionarySymbolStyle, Category=Search]
// [Legal]
// Copyright 2016 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 "SearchDictionarySymbolStyle.h"
#include "DictionarySymbolStyle.h"

#include <QDir>
#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

using namespace Esri::ArcGISRuntime;

SearchDictionarySymbolStyle::SearchDictionarySymbolStyle(QQuickItem* parent) :
  QQuickItem(parent)
{
}

SearchDictionarySymbolStyle::~SearchDictionarySymbolStyle() = default;

void SearchDictionarySymbolStyle::init()
{
  qmlRegisterType<SearchDictionarySymbolStyle>("Esri.Samples", 1, 0, "SearchDictionarySymbolStyleSample");
  qmlRegisterUncreatableType<QAbstractListModel>("Esri.Samples", 1, 0, "AbstractListModel", "AbstractListModel is uncreateable");
}

void SearchDictionarySymbolStyle::componentComplete()
{
  QQuickItem::componentComplete();

  //Get the data path
  QString datapath = defaultDataPath() + "/ArcGIS/Runtime/Data/styles/arcade_style/mil2525d.stylx";

  //Create the dictionary from datapath (added since 100.6)
  m_dictionarySymbolStyle = DictionarySymbolStyle::createFromFile(datapath, this);

  //Connect to the search completed signal of the dictionary
  connect(m_dictionarySymbolStyle, &DictionarySymbolStyle::searchSymbolsCompleted, this, [this](QUuid, SymbolStyleSearchResultListModel* results)
  {
    m_searchResults = results;
    emit searchResultsListModelChanged();
    emit searchCompleted(results->size());
  });
}

QAbstractListModel* SearchDictionarySymbolStyle::searchResultsListModel() const
{
  return m_searchResults;
}

void SearchDictionarySymbolStyle::search(const QStringList& namesSearchParam, const QStringList& tagsSearchParam,
                                         const QStringList& classesSearchParam,const QStringList& categoriesSearchParam,
                                         const QStringList& keysSearchParam)
{
  //Create search parameters and search with the parameters
  SymbolStyleSearchParameters searchParameters;
  searchParameters.setCategories(categoriesSearchParam);
  searchParameters.setKeys(keysSearchParam);
  searchParameters.setNames(namesSearchParam);
  searchParameters.setSymbolClasses(classesSearchParam);
  searchParameters.setTags(tagsSearchParam);
  m_dictionarySymbolStyle->searchSymbols(searchParameters);
}

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