ArcGIS Runtime SDK for Java

Style WMS Layer

Shows how to change the style of a WMS layer.

How it works

To style a WMS Layer:

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


 * 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
 * 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.ogc.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.Basemap;
import com.esri.arcgisruntime.mapping.Viewpoint;
import com.esri.arcgisruntime.mapping.view.MapView;

public class StyleWmsLayerSample extends Application {

  private MapView mapView;

  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");

      // create a map and add it to the map view
      ArcGISMap map = new ArcGISMap(Basemap.createImagery());
      mapView = new MapView();

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

      // create a WMS layer
      List<String> wmsLayerNames = Collections.singletonList("fsa2017");
      String url = "";
      WmsLayer wmsLayer = new WmsLayer(url, wmsLayerNames);
      wmsLayer.addDoneLoadingListener(() -> {
        if (wmsLayer.getLoadStatus() == LoadStatus.LOADED) {
          // add the layer to the map

          // 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()) {
            } else {
              // default style

          // enable the toggle button

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

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

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

    if (mapView != null) {

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



In this topic
  1. How it works
  2. Code