Change the style of a Web Map Service (WMS) layer.
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 style button will be enabled. Tap it to toggle between the first and second styles of the WMS layer.
How it works
- Create a
WmsLayer
specifying the URL of the service and the layer names you want as parameters. - When the layer is done loading, get its list of style strings using
wmsLayer.getSublayers().get(0).getSublayerInfo().getStyles()
. - 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
/* 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.arcgisruntime.stylewmslayer;
import java.util.Collections;
import java.util.List;
import android.os.Bundle;
import android.util.Log;
import android.widget.Toast;
import android.widget.ToggleButton;
import androidx.appcompat.app.AppCompatActivity;
import com.esri.arcgisruntime.geometry.SpatialReference;
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.mapping.view.MapView;
public class MainActivity extends AppCompatActivity {
private static final String TAG = MainActivity.class.getSimpleName();
private MapView mMapView;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
// create a map with spatial reference appropriate for the service
ArcGISMap map = new ArcGISMap(SpatialReference.create(26915));
map.setMinScale(7000000.0);
// get a reference to the map view
mMapView = findViewById(R.id.mapView);
// set the map to the map view
mMapView.setMap(map);
// create a WMS layer
List<String> wmsLayerNames = Collections.singletonList(getString(R.string.wms_layer_name_minnesota));
WmsLayer wmsLayer = new WmsLayer(getString(R.string.wms_layer_url_minnesota), wmsLayerNames);
// add the layer to the map
map.getOperationalLayers().add(wmsLayer);
wmsLayer.addDoneLoadingListener(() -> {
if (wmsLayer.getLoadStatus() == LoadStatus.LOADED) {
// zoom to the layer on the map
mMapView.setViewpoint(new Viewpoint(wmsLayer.getFullExtent()));
// get styles
List<String> styles = wmsLayer.getSublayers().get(0).getSublayerInfo().getStyles();
// set the style when the button is toggled
ToggleButton toggle = findViewById(R.id.toggleStyleButton);
toggle.setOnCheckedChangeListener((buttonView, isChecked) -> {
if (isChecked) {
// set the sublayer's current style
wmsLayer.getSublayers().get(0).setCurrentStyle(styles.get(1));
} else {
//[DocRef: Name=Set WMS Layer Style, Category=Fundamentals, Topic=Symbols and Renderers]
// set the sublayer's current style
wmsLayer.getSublayers().get(0).setCurrentStyle(styles.get(0));
//[DocRef: END]
}
});
} else {
String error = "Failed to load WMS layer: " + wmsLayer.getLoadError().getMessage();
Log.e(TAG, error);
Toast.makeText(this, error, Toast.LENGTH_LONG).show();
}
});
}
@Override
protected void onPause() {
super.onPause();
mMapView.pause();
}
@Override
protected void onResume() {
super.onResume();
mMapView.resume();
}
@Override
protected void onDestroy() {
super.onDestroy();
mMapView.dispose();
}
}