Picture marker symbol

View on GitHubSample viewer app

Use pictures for markers.

Image of picture marker symbol

Use case

When marking geoelements on a map, using custom, unique symbols can be helpful for highlighting and differentiating between locations. For example, a tourism office may use pictures of landmarks as symbols on an online map or app, to help prospective visitors to orient themselves more easily around a city.

How to use the sample

When launched, this sample displays a map with three picture marker symbols. Pan and zoom to explore the map.

How it works

  1. Create a PictureMarkerSymbol using the URI to an online or local image.
  2. Create a Graphic and set its symbol to the PictureMarkerSymbol.

Relevant API

  • PictureMarkerSymbol

About the data

The picture marker symbols in this sample are all constructed from different types of resources:

Tags

graphics, marker, picture, symbol, visualization

Sample Code

PictureMarkerSymbolSample.java
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
/*
 * Copyright 2017 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.picture_marker_symbol;

import java.io.File;

import javax.imageio.ImageIO;

import javafx.application.Application;
import javafx.embed.swing.SwingFXUtils;
import javafx.scene.Scene;
import javafx.scene.control.Alert;
import javafx.scene.image.Image;
import javafx.scene.layout.StackPane;
import javafx.stage.Stage;

import com.esri.arcgisruntime.ArcGISRuntimeEnvironment;
import com.esri.arcgisruntime.geometry.Envelope;
import com.esri.arcgisruntime.geometry.Point;
import com.esri.arcgisruntime.geometry.SpatialReferences;
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.PictureMarkerSymbol;

public class PictureMarkerSymbolSample extends Application {

  private MapView mapView;
  private File orangeSymbolPath;
  private GraphicsOverlay graphicsOverlay;

  // keep loadables in scope to avoid garbage collection
  private ArcGISMap map;
  private PictureMarkerSymbol campsiteSymbol;
  private PictureMarkerSymbol blueSymbol;
  private PictureMarkerSymbol orangeSymbol;

  private static final String CAMPSITE_SYMBOL = "https://static.arcgis.com/images/Symbols/OutdoorRecreation/Camping.png";

  @Override
  public void start(Stage stage) {

    try {
      // create stack pane and application scene
      StackPane stackPane = new StackPane();
      Scene scene = new Scene(stackPane);

      // set title, size, and add scene to stage
      stage.setTitle("Picture Marker Symbol Sample");
      stage.setWidth(800);
      stage.setHeight(700);
      stage.setScene(scene);
      stage.show();

      // 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
      map = new ArcGISMap(BasemapStyle.ARCGIS_TOPOGRAPHIC);

      // create a map view and set the map to it
      mapView = new MapView();
      mapView.setMap(map);

      // create graphics overlay and add it to the map view
      graphicsOverlay = new GraphicsOverlay();
      mapView.getGraphicsOverlays().add(graphicsOverlay);

      // create points for displaying graphics
      Point leftPoint = new Point(-228835, 6550763, SpatialReferences.getWebMercator()); // Disk
      Point rightPoint = new Point(-223560, 6552021, SpatialReferences.getWebMercator()); // URL
      Point middlePoint = new Point(-226773, 6550477, SpatialReferences.getWebMercator());

      // create orange picture marker symbol from disk
      if (saveResourceToExternalStorage()) {
        // create orange picture marker symbol
        orangeSymbol = new PictureMarkerSymbol(orangeSymbolPath.getAbsolutePath());
        // place orange picture marker symbol on ArcGISMap
        placePictureMarkerSymbol(orangeSymbol, leftPoint);
      }

      // create blue picture marker symbol from local
      Image newImage = new Image("/blue_symbol.png");
      blueSymbol = new PictureMarkerSymbol(newImage);
      // place blue picture marker symbol on ArcGISMap
      placePictureMarkerSymbol(blueSymbol, middlePoint);

      // create campsite picture marker symbol from URL
      campsiteSymbol = new PictureMarkerSymbol(CAMPSITE_SYMBOL);

      // place campsite picture marker symbol on ArcGISMap
      map.addDoneLoadingListener(() -> {
        if (map.getLoadStatus() == LoadStatus.LOADED) {
          placePictureMarkerSymbol(campsiteSymbol, rightPoint);
        } else {
          Alert alert = new Alert(Alert.AlertType.ERROR, "Map Failed to Load!");
          alert.show();
        }
      });

      // set viewpoint on mapview with padding
      Envelope envelope = new Envelope(leftPoint, rightPoint);
      mapView.setViewpointGeometryAsync(envelope, 100.0);

      // add the map view and control panel to stack pane
      stackPane.getChildren().add(mapView);
    } catch (Exception e) {
      e.printStackTrace();
    }
  }

  /**
   * Adds a Graphic to the Graphics Overlay using a Point and a Picture Marker
   * Symbol.
   *
   * @param markerSymbol PictureMarkerSymbol to be used
   * @param graphicPoint where the Graphic is going to be placed
   */
  private void placePictureMarkerSymbol(PictureMarkerSymbol markerSymbol, Point graphicPoint) {

    // set size of the image
    markerSymbol.setHeight(40);
    markerSymbol.setWidth(40);

    // load symbol asynchronously
    markerSymbol.loadAsync();

    // add to the graphic overlay once done loading
    markerSymbol.addDoneLoadingListener(() -> {
      if (markerSymbol.getLoadStatus() == LoadStatus.LOADED) {
        Graphic symbolGraphic = new Graphic(graphicPoint, markerSymbol);
        graphicsOverlay.getGraphics().add(symbolGraphic);
      } else {
        Alert alert = new Alert(Alert.AlertType.ERROR, "Picture Marker Symbol Failed to Load!");
        alert.show();
      }
    });

  }

  /**
   * Writes a resource image to a file.
   *
   * @return true if successful
   */
  private boolean saveResourceToExternalStorage() {

    try {
      // create a file that will be deleted automatically
      orangeSymbolPath = File.createTempFile("orange_symbol", ".png");

      // save image from resources folder to computer's disk
      Image orangeImage = new Image("orange_symbol.png");

      ImageIO.write(SwingFXUtils.fromFXImage(orangeImage, null), "png", orangeSymbolPath.getAbsoluteFile());

    } catch (Exception e) {
      e.printStackTrace();
    }

    // check to see if the resource was created on disk
    return orangeSymbolPath.exists();
  }

  /**
   * Stops and releases all resources used in application.
   */
  @Override
  public void stop() {

    // release resources when the application closes
    if (mapView != null) {
      mapView.dispose();
    }
  }

  /**
   * Opens and runs application.
   *
   * @param args arguments passed to this application
   */
  public static void main(String[] args) {

    Application.launch(args);
  }

}

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