Combine multiple symbols from a mobile style file into a single symbol.
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 "Reset" to clear all graphics from the display.
How it works
Create a new SymbolStyle from a stylx file, and load it.
Get a set of default search parameters using symbolStyle.getDefaultSearchParametersAsync(), and use these to retrieve a list of all symbols within the style file: symbolStyle.searchSymbolsAsync(defaultSearchParameters).
Get the SymbolStyleSearchResult, which contains the symbols, as well as their names, keys, and categories.
Use a List of keys of the desired symbols to build a composite symbol using symbolStyle.getSymbolAsync(symbolKeys).
Create a Graphic using the MultilayerPointSymbol.
Relevant API
MultilayerPointSymbol
MultilayerSymbol
SymbolLayer
SymbolStyle
SymbolStyleSearchParameters
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 Maps SDKs for Native Apps 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
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
266
267
268
269
270
271
/*
* 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.
*/package com.esri.samples.read_symbols_from_mobile_style_file;
import java.io.File;
import java.util.Arrays;
import java.util.List;
import java.util.concurrent.ExecutionException;
import javafx.beans.value.ChangeListener;
import javafx.fxml.FXML;
import javafx.geometry.Point2D;
import javafx.scene.control.Alert;
import javafx.scene.control.ColorPicker;
import javafx.scene.control.ListView;
import javafx.scene.control.Slider;
import javafx.scene.image.Image;
import javafx.scene.image.ImageView;
import javafx.scene.input.MouseButton;
import javafx.scene.input.MouseEvent;
import javafx.scene.paint.Color;
import com.esri.arcgisruntime.ArcGISRuntimeEnvironment;
import com.esri.arcgisruntime.concurrent.ListenableFuture;
import com.esri.arcgisruntime.geometry.Point;
import com.esri.arcgisruntime.loadable.LoadStatus;
import com.esri.arcgisruntime.mapping.ArcGISMap;
import com.esri.arcgisruntime.mapping.BasemapStyle;
import com.esri.arcgisruntime.mapping.view.Graphic;
import com.esri.arcgisruntime.mapping.view.GraphicsOverlay;
import com.esri.arcgisruntime.mapping.view.MapView;
import com.esri.arcgisruntime.symbology.MultilayerPointSymbol;
import com.esri.arcgisruntime.symbology.Symbol;
import com.esri.arcgisruntime.symbology.SymbolStyle;
import com.esri.arcgisruntime.symbology.SymbolStyleSearchParameters;
import com.esri.arcgisruntime.symbology.SymbolStyleSearchResult;
publicclassReadSymbolsFromMobileStyleFileController{
@FXMLprivate MapView mapView;
@FXMLprivate ListView<SymbolStyleSearchResult> hatSelectionListView;
@FXMLprivate ListView<SymbolStyleSearchResult> eyesSelectionListView;
@FXMLprivate ListView<SymbolStyleSearchResult> mouthSelectionListView;
@FXMLprivate Slider sizeSlider;
@FXMLprivate ImageView symbolPreview;
@FXMLprivate ColorPicker colorPicker;
private GraphicsOverlay graphicsOverlay;
private MultilayerPointSymbol faceSymbol;
private SymbolStyle emojiStyle;
@FXMLpublicvoidinitialize(){
// authentication with an API key or named user is required to access basemaps and other location services String yourAPIKey = System.getProperty("apiKey");
ArcGISRuntimeEnvironment.setApiKey(yourAPIKey);
// create a map with the topographic basemap style ArcGISMap map = new ArcGISMap(BasemapStyle.ARCGIS_TOPOGRAPHIC);
// set the map to the map view mapView.setMap(map);
// create a graphics overlay and add it to the map graphicsOverlay = new GraphicsOverlay();
mapView.getGraphicsOverlays().add(graphicsOverlay);
// load the available symbols from the style file loadSymbolsFromStyleFile();
// create a listener that builds the composite symbol when an item from the list view is selected ChangeListener<Object> changeListener = (obs, oldValue, newValue) -> buildCompositeSymbol();
// create a list of the ListView objects and iterate over it List<ListView<SymbolStyleSearchResult>> listViews = Arrays.asList(hatSelectionListView, eyesSelectionListView, mouthSelectionListView);
for (ListView<SymbolStyleSearchResult> listView : listViews) {
// add the cell factory to show the symbol within the list view listView.setCellFactory(c -> new SymbolLayerInfoListCell());
// add the change listener to rebuild the preview when a selection is made listView.getSelectionModel().selectedItemProperty().addListener(changeListener);
// add an empty entry to the list view to allow selecting 'nothing', and make it selected by default listView.getItems().add(null);
listView.getSelectionModel().select(0);
}
}
/**
* Loads the stylx file and searches for all symbols contained within. Puts the resulting symbols into the GUI
* based on their category (eyes, mouth, hat, face).
*/privatevoidloadSymbolsFromStyleFile(){
// create a SymbolStyle with the .stylx file File stylxFile = new File(System.getProperty("data.dir"), "./samples-data/stylx/emoji-mobile.stylx");
emojiStyle = new SymbolStyle(stylxFile.getAbsolutePath());
emojiStyle.loadAsync();
// wait for the symbol style to load emojiStyle.addDoneLoadingListener(() -> {
if (emojiStyle.getLoadStatus() == LoadStatus.FAILED_TO_LOAD) {
new Alert(Alert.AlertType.ERROR, "Error: could not load .stylx file. Details: " + emojiStyle.getLoadError().getMessage()).show();
return;
}
// load the default search parameters ListenableFuture<SymbolStyleSearchParameters> defaultSearchParametersFuture = emojiStyle.getDefaultSearchParametersAsync();
defaultSearchParametersFuture.addDoneListener(() -> {
try {
SymbolStyleSearchParameters defaultSearchParameters = defaultSearchParametersFuture.get();
// use the default parameters to perform the search, getting all the available symbols within the file ListenableFuture<List<SymbolStyleSearchResult>> symbolStyleSearchResultFuture = emojiStyle.searchSymbolsAsync(defaultSearchParameters);
symbolStyleSearchResultFuture.addDoneListener(() -> {
try {
// loop through the results and add each item to a list view according to category List<SymbolStyleSearchResult> symbolStyleSearchResults = symbolStyleSearchResultFuture.get();
symbolStyleSearchResults.forEach(symbolStyleSearchResult -> {
// add the SymbolStyleSearchResult object to the correct list for its categoryswitch (symbolStyleSearchResult.getCategory()) {
case"Hat":
hatSelectionListView.getItems().add(symbolStyleSearchResult);
break;
case"Eyes":
eyesSelectionListView.getItems().add(symbolStyleSearchResult);
break;
case"Mouth":
mouthSelectionListView.getItems().add(symbolStyleSearchResult);
break;
}
});
// create the symbol to populate the preview buildCompositeSymbol();
} catch (InterruptedException | ExecutionException e) {
new Alert(Alert.AlertType.ERROR, "Error performing the symbol search" + e.getMessage()).show();
}
});
} catch (InterruptedException | ExecutionException e) {
new Alert(Alert.AlertType.ERROR, "Error retrieving default search parameters for symbol search" + e.getMessage()).show();
}
});
});
}
/**
* Gets the keys of the selected symbol components, and constructs a multilayer point symbol, and updates the symbol preview.
*/@FXMLprivatevoidbuildCompositeSymbol(){
// retrieve the requested keys for the selected hat, eyes and mouth symbols String hatKey = getRequestedSymbolKey(hatSelectionListView);
String eyesKey = getRequestedSymbolKey(eyesSelectionListView);
String mouthKey = getRequestedSymbolKey(mouthSelectionListView);
// create a list of keys to use for getting the requested symbol List<String> symbolKeys = Arrays.asList("Face1", eyesKey, mouthKey, hatKey);
// get the symbol from the SymbolStyle ListenableFuture<Symbol> symbolFuture = emojiStyle.getSymbolAsync(symbolKeys);
symbolFuture.addDoneListener(() -> {
try {
faceSymbol = (MultilayerPointSymbol) symbolFuture.get();
if (faceSymbol == null) {
return;
}
// loop through all the symbol layers and lock the color faceSymbol.getSymbolLayers().forEach(symbolLayer -> symbolLayer.setColorLocked(true));
// unlock the color of the base layer. Changing the symbol layer color will now only change this layer's color faceSymbol.getSymbolLayers().get(0).setColorLocked(false);
// set the color of the symbol faceSymbol.setColor(colorPicker.getValue());
// set the size of the symbol faceSymbol.setSize((float) sizeSlider.getValue());
// update the symbol preview updateSymbolPreview(faceSymbol);
} catch (ExecutionException | InterruptedException e) {
new Alert(Alert.AlertType.ERROR, "Error creating symbol with the provided symbol keys" + e.getMessage()).show();
}
});
}
/**
* Returns the symbol key of the symbol style search result that is currently selected in the list view.
*
* @param listView the list view of which to query the selected item
* @return String representing the key of the selected symbol style
*/private String getRequestedSymbolKey(ListView<SymbolStyleSearchResult> listView){
SymbolStyleSearchResult requestedSymbol = listView.getSelectionModel().getSelectedItem();
return (requestedSymbol != null ? requestedSymbol.getKey() : "");
}
/**
* Creates an ImageView object from a provided symbol and displays it in the preview area.
*
* @param multilayerPointSymbol the symbol used to create the image view
*/privatevoidupdateSymbolPreview(MultilayerPointSymbol multilayerPointSymbol){
// remove the previously displayed image view symbolPreview.setImage(null);
// create an image and image view from the symbol ListenableFuture<Image> symbolImageFuture = multilayerPointSymbol.createSwatchAsync(Color.TRANSPARENT, 1);
try {
// display the image view in the preview area symbolPreview.setImage(symbolImageFuture.get());
} catch (InterruptedException | ExecutionException e) {
new Alert(Alert.AlertType.ERROR, "Error creating preview ImageView from provided MultilayerPointSymbol" + e.getMessage()).show();
}
}
/**
* Adds graphics to the map view on mouse clicks.
*
* @param e mouse button click event
*/@FXMLprivatevoidhandleMouseClicked(MouseEvent e){
if (e.getButton() == MouseButton.PRIMARY && e.isStillSincePress()) {
// convert clicked point to a map point Point mapPoint = mapView.screenToLocation(new Point2D(e.getX(), e.getY()));
// create a new graphic with the point and symbol Graphic graphic = new Graphic(mapPoint, faceSymbol);
graphicsOverlay.getGraphics().add(graphic);
}
}
/**
* Clears all the graphics from the graphics overlay.
*/@FXMLprivatevoidclearView(){
graphicsOverlay.getGraphics().clear();
}
/**
* Stops and releases all resources used in application.
*/publicvoidterminate(){
if (mapView != null) {
mapView.dispose();
}
}
}