Clip Geometry

Demonstrates how to clip a geometry with an envelope using the GeometryEngine.

How it works

To clip a Geometry with an Geometry:

  1. Use the static method GeometryEngine.clip(geometry, envelope).
  2. Keep in mind that the resulting geometry may be null if the envelope does not intersect the geometry you are clipping.


 * 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.geometry.clip_geometry;

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

import com.esri.arcgisruntime.geometry.Envelope;
import com.esri.arcgisruntime.geometry.Geometry;
import com.esri.arcgisruntime.geometry.GeometryEngine;
import com.esri.arcgisruntime.geometry.Point;
import com.esri.arcgisruntime.geometry.SpatialReferences;
import com.esri.arcgisruntime.mapping.ArcGISMap;
import com.esri.arcgisruntime.mapping.Basemap;
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.SimpleFillSymbol;
import com.esri.arcgisruntime.symbology.SimpleLineSymbol;

public class ClipGeometrySample 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("Clip Geometry Sample");

      // create a map with a basemap and add it to the map view
      ArcGISMap map = new ArcGISMap(SpatialReferences.getWebMercator());
      mapView = new MapView();

      // create a graphics overlay to contain the geometry to clip
      GraphicsOverlay graphicsOverlay = new GraphicsOverlay();

      // create a blue graphic of Colorado
      Envelope colorado = new Envelope(new Point(-11362327.128340, 5012861.290274),
          new Point(-12138232.018408, 4441198.773776));
      SimpleFillSymbol fillSymbol = new SimpleFillSymbol(SimpleFillSymbol.Style.SOLID, 0x220000FF,
          new SimpleLineSymbol(SimpleLineSymbol.Style.SOLID, 0xFF0000FF, 2));
      Graphic coloradoGraphic = new Graphic(colorado, fillSymbol);

      // create a graphics overlay to contain the clipping envelopes
      GraphicsOverlay envelopesOverlay = new GraphicsOverlay();

      // create a dotted red outline symbol
      SimpleLineSymbol redOutline = new SimpleLineSymbol(SimpleLineSymbol.Style.DOT, 0xFFFF0000, 3);

      // create a envelope outside Colorado
      Envelope outsideEnvelope =
          new Envelope(new Point(-11858344.321294, 5147942.225174), new Point(-12201990.219681, 5297071.577304));
      Graphic outside = new Graphic(outsideEnvelope, redOutline);

      // create a envelope intersecting Colorado
      Envelope intersectingEnvelope =
          new Envelope(new Point(-11962086.479298, 4566553.881363), new Point(-12260345.183558, 4332053.378376));
      Graphic intersecting = new Graphic(intersectingEnvelope, redOutline);

      // create a envelope inside Colorado
      Envelope containedEnvelope =
          new Envelope(new Point(-11655182.595204, 4741618.772994), new Point(-11431488.567009, 4593570.068343));
      Graphic contained = new Graphic(containedEnvelope, redOutline);

      // zoom to show the polygon graphic
      mapView.setViewpointGeometryAsync(coloradoGraphic.getGeometry(), 200);

      // create a graphics overlay to contain the clipped areas
      GraphicsOverlay clipAreasOverlay = new GraphicsOverlay();

      // create a button to perform the clip operation
      Button clipButton = new Button("Clip");
      clipButton.setOnAction(e -> {
        // for each envelope, clip the Colorado geometry and show the result, replacing the original Colorado graphic
        envelopesOverlay.getGraphics().forEach(graphic -> {
          Geometry geometry = GeometryEngine.clip(coloradoGraphic.getGeometry(), (Envelope) graphic.getGeometry());
          if (geometry != null) {
            Graphic clippedGraphic = new Graphic(geometry, fillSymbol);
        // only clip once

      // add the map view to the stack pane
      stackPane.getChildren().addAll(mapView, clipButton);
      StackPane.setAlignment(clipButton, Pos.TOP_LEFT);
      StackPane.setMargin(clipButton, 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