Skip to content

Dictionary renderer with feature layer

View on GitHubSample viewer app

Convert features into graphics to show them with mil2525d symbols.

Image of dictionary renderer with feature layer

Use case

A dictionary renderer uses a style file along with a rule engine to display advanced symbology. This is useful for displaying features using precise military symbology.

How to use the sample

Pan and zoom around the map. Observe the displayed military symbology on the map.

How it works

  1. Create a Geodatabase using Geodatabase(geodatabasePath).
  2. Load the geodatabase asynchronously using Geodatabase.loadAsync().
  3. Create a DictionarySymbolStyle using DictionarySymbolStyle.createFromFile(stylxFile.getAbsolutePath())
  4. Load the symbol dictionary asynchronously using dictionarySymbolStyle.loadAsync().
  5. Wait for geodatabase to completely load by connecting to Geodatabase.addDoneLoadingListener().
  6. Cycle through each GeodatabaseFeatureTable from the geodatabase using Geodatabase.getGeodatabaseFeatureTables().
  7. Create a FeatureLayer from each table within the geodatabase using FeatureLayer(GeodatabaseFeatureTable).
  8. Load the feature layer asynchronously with FeatureLayer.loadAsync().
  9. Wait for each layer to load using FeatureLayer.addDoneLoadingListener.
  10. After the last layer has loaded, then create a new Envelope from a union of the extents of all layers.
    • Set the envelope to be the Viewpoint of the map view using MapView.setViewpoint(new Viewpoint(Envelope)).
  11. Add the feature layer to map using Map.getOperationalLayers().add(FeatureLayer).
  12. Create DictionaryRenderer(dictionarySymbolStyle) and attach to the feature layer using FeatureLayer.setRenderer(dictionaryRenderer).

Relevant API

  • DictionaryRenderer
  • DictionarySymbolStyle

Tags

dictionary, military, symbol

Sample Code

FeatureLayerDictionaryRendererSample.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 /*  * 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.feature_layer_dictionary_renderer;  import javafx.application.Application; import javafx.scene.Scene; import javafx.scene.control.Alert; import javafx.scene.layout.StackPane; import javafx.stage.Stage;  import com.esri.arcgisruntime.ArcGISRuntimeEnvironment; import com.esri.arcgisruntime.data.Geodatabase; import com.esri.arcgisruntime.layers.FeatureLayer; import com.esri.arcgisruntime.loadable.LoadStatus; import com.esri.arcgisruntime.mapping.ArcGISMap; import com.esri.arcgisruntime.mapping.BasemapStyle; import com.esri.arcgisruntime.mapping.view.MapView; import com.esri.arcgisruntime.symbology.DictionaryRenderer; import com.esri.arcgisruntime.symbology.DictionarySymbolStyle;  import java.io.File;  public class FeatureLayerDictionaryRendererSample extends Application {   private MapView mapView;  private Geodatabase geodatabase; // keep loadable in scope to avoid garbage collection   @Override  public void start(Stage stage) {   mapView = new MapView();  StackPane appWindow = new StackPane(mapView);  Scene scene = new Scene(appWindow);   // set title, size, and add scene to stage  stage.setTitle("Feature Layer Dictionary Renderer 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 and set it to the map view  ArcGISMap map = new ArcGISMap(BasemapStyle.ARCGIS_TOPOGRAPHIC);  mapView.setMap(map);   // define and load a dictionary symbol style from a local style file  File stylxFile = new File(System.getProperty("data.dir"), "./samples-data/stylx/mil2525d.stylx");  var dictionarySymbolStyle = DictionarySymbolStyle.createFromFile(stylxFile.getAbsolutePath());  dictionarySymbolStyle.loadAsync();   // create a new geodatabase instance from the geodatabase stored at the local location  File geodatabaseFile = new File(System.getProperty("data.dir"), "./samples-data/dictionary/militaryoverlay" +  ".geodatabase");  geodatabase = new Geodatabase(geodatabaseFile.getAbsolutePath());   geodatabase.addDoneLoadingListener(() -> {  // check if the geodatabase has loaded successfully  if (geodatabase.getLoadStatus() == LoadStatus.LOADED) {  var mapOperationalLayersList = map.getOperationalLayers();  var geodatabaseFeatureTablesList = geodatabase.getGeodatabaseFeatureTables();   geodatabaseFeatureTablesList.forEach(table -> {  // create a new feature layer from each geodatabase feature table and  // add it to the map's list of operational layers  mapOperationalLayersList.add(new FeatureLayer(table));  });   // check the map operational layers size matches that of the geodatabase's feature tables size  if (!mapOperationalLayersList.isEmpty() && mapOperationalLayersList.size() == geodatabaseFeatureTablesList.size()) {   // check that each layer has loaded correctly and if not display an error message  mapOperationalLayersList.forEach(layer ->  layer.addDoneLoadingListener(() -> {  if (layer.getLoadStatus() == LoadStatus.LOADED) {   // set the feature layer's minimum scale so that features no longer show after this scale  layer.setMinScale(1000000);   // set the dictionary renderer as the feature layer's renderer  if (layer instanceof FeatureLayer) {  ((FeatureLayer) layer).setRenderer(new DictionaryRenderer(dictionarySymbolStyle));  }   // set the map view viewpoint  mapView.setViewpointGeometryAsync(layer.getFullExtent());   } else {  new Alert(Alert.AlertType.ERROR,  "Feature layer failed to load: " + layer.getLoadError().getCause().getMessage()).show();  }  })  );  } else {  new Alert(Alert.AlertType.ERROR, "Error: Map operational list size does not match geodatabase feature table list size").show();  }  } else {  new Alert(Alert.AlertType.ERROR, "Geodatabase Failed to Load!").show();  }  });   // load the geodatabase  geodatabase.loadAsync();  }   /**  * Stops and releases all resources used in application.  */  @Override  public void stop() {   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.