Style WMS layer

View on GitHub
Sample viewer app

Change the style of a Web Map Service (WMS) layer.

Image of style WMS layers

Use case

Layers hosted on WMS may have different pre-set styles available to apply to them. Swapping between these styles can help during visual examination of the data. For example, increasing the contrast of satellite images can help in identifying urban and agricultural areas within forested areas.

How to use the sample

Once the layer loads, the toggle button will be enabled. Click it to toggle between the first and second styles of the WMS layer.

How it works

  1. Create a WmsLayer specifying the URL of the service and the layer names you want as parameters.
  2. When the layer is done loading, get its list of style strings using wmsLayer.getSublayers().get(0).getSublayerInfo().getStyles().
  3. Set one of the styles using wmsLayer.getSublayers().get(0).setCurrentStyle(styleString).

Relevant API

  • WmsLayer
  • WmsSublayer
  • WmsSublayerInfo

About the data

This sample uses a public service managed by the State of Minnesota and provides composite imagery for the state and the surrounding areas.

Tags

imagery, styles, visualization, WMS

Sample Code

StyleWmsLayerSample.java
                                                                                                                                        
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
/*
 * Copyright 2018 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.style_wms_layer;

import java.util.Collections;
import java.util.List;

import javafx.application.Application;
import javafx.geometry.Insets;
import javafx.geometry.Pos;
import javafx.scene.Scene;
import javafx.scene.control.Alert;
import javafx.scene.control.ToggleButton;
import javafx.scene.layout.StackPane;
import javafx.stage.Stage;

import com.esri.arcgisruntime.layers.WmsLayer;
import com.esri.arcgisruntime.loadable.LoadStatus;
import com.esri.arcgisruntime.mapping.ArcGISMap;
import com.esri.arcgisruntime.mapping.Viewpoint;
import com.esri.arcgisruntime.geometry.SpatialReference;
import com.esri.arcgisruntime.mapping.view.MapView;

public class StyleWmsLayerSample extends Application {

  private MapView mapView;
  private WmsLayer wmsLayer; // keep loadable in scope to avoid garbage collection

  @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("Style WMS Layer Sample");
      stage.setWidth(800);
      stage.setHeight(700);
      stage.setScene(scene);
      stage.show();

      // create a map with spatial reference appropriate for the service (North American Datum 83)
      ArcGISMap map = new ArcGISMap(SpatialReference.create(26915));
      map.setMinScale(7000000);
      // set the map to the map view
      mapView = new MapView();
      mapView.setMap(map);

      // create style toggle button, disable until layer is loaded
      ToggleButton styleToggleButton = new ToggleButton();
      styleToggleButton.setText("Toggle style");
      styleToggleButton.setDisable(true);

      // create a WMS layer
      List<String> wmsLayerNames = Collections.singletonList("fsa2017");
      String url = "http://geoint.lmic.state.mn.us/cgi-bin/wms?VERSION=1.3.0&SERVICE=WMS&REQUEST=GetCapabilities";
      wmsLayer = new WmsLayer(url, wmsLayerNames);
      wmsLayer.addDoneLoadingListener(() -> {
        if (wmsLayer.getLoadStatus() == LoadStatus.LOADED) {
          // add the layer to the map
          map.getOperationalLayers().add(wmsLayer);

          // zoom to the layer on the map
          mapView.setViewpoint(new Viewpoint(wmsLayer.getFullExtent()));

          // get styles
          List<String> styles = wmsLayer.getSublayers().get(0).getSublayerInfo().getStyles();

          // set the style when the button is toggled
          styleToggleButton.selectedProperty().addListener((observable, oldValue, newValue) -> {
            if (styleToggleButton.isSelected()) {
              wmsLayer.getSublayers().get(0).setCurrentStyle(styles.get(1));
            } else {
              // default style
              wmsLayer.getSublayers().get(0).setCurrentStyle(styles.get(0));
            }
          });

          // enable the toggle button
          styleToggleButton.setDisable(false);

        } else {
          Alert alert = new Alert(Alert.AlertType.ERROR, "Failed to load WMS layer");
          alert.show();
        }
      });
      wmsLayer.loadAsync();

      // add the map view to stack pane
      stackPane.getChildren().addAll(mapView, styleToggleButton);
      StackPane.setAlignment(styleToggleButton, Pos.TOP_LEFT);
      StackPane.setMargin(styleToggleButton, new Insets(10, 0, 0, 10));
    } catch (Exception e) {
      // on any error, display the stack trace.
      e.printStackTrace();
    }
  }

  /**
   * 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.