diff --git a/feature_layers/configure-clusters/ConfigureClusters.png b/feature_layers/configure-clusters/ConfigureClusters.png new file mode 100644 index 000000000..7ab4319c9 Binary files /dev/null and b/feature_layers/configure-clusters/ConfigureClusters.png differ diff --git a/feature_layers/configure-clusters/README.md b/feature_layers/configure-clusters/README.md new file mode 100644 index 000000000..e325262f8 --- /dev/null +++ b/feature_layers/configure-clusters/README.md @@ -0,0 +1,41 @@ +# Configure clusters + +Add clustering feature reduction to a point feature layer. + +![Image of configure clusters](ConfigureClusters.png) + +## Use case + +Feature clustering can be used to dynamically aggregate groups of points that are within proximity of each other in order to represent each group with a single symbol. Such grouping allows you to see patterns in the data that are difficult to visualize when a layer contains hundreds or thousands of points that overlap and cover each other. Users can add feature clustering to point feature layers. This is useful when the layer does not have the feature reduction defined or when the existing feature reduction properties need to be overridden. + +## How to use the sample + +Interact with the controls to customize clustering feature reduction properties. Click on any clustered aggregate geoelement to see the cluster feature count and aggregate fields in the popup. + +## How it works + +1. Create a map from a web map `PortalItem`. +2. Create a `ClassBreaksRenderer` and define a `FieldName` and `DefaultSymbol`. `FieldName` must be one of the summary fields in the `AggregateFields` collection. +3. Add `ClassBreak` objects each with an associated `SimpleMarkerSymbol` to the renderer. +4. Create a `ClusteringFeatureReduction` using the renderer. +5. Add `AggregateField` objects to the feature reduction where the `FieldName` is the name of the field to aggregate and the `StatisticType` is the type of aggregation to perform. +6. Define the `MinSymbolSize` and `MaxSymbolSize` for the feature reduction. If these are not defined they default to 12 and 70 respectively. +7. Add the `ClusteringFeatureReduction` to the `FeatureLayer`. +8. Create a `LabelDefinition` with a `SimpleLabelExpression` and `TextSymbol` to define the cluster label. + +## Relevant API + +* AggregateGeoElement +* ClassBreaksRenderer +* FeatureLayer +* FeatureReduction +* GeoElement +* IdentifyLayerResult + +## About the data + +This sample uses a [web map](https://www.arcgis.com/home/item.html?id=aa44e79a4836413c89908e1afdace2ea) that displays residential data for Zurich, Switzerland. + +## Tags + +aggregate, bin, cluster, group, merge, normalize, popup, reduce, renderer, summarize diff --git a/feature_layers/configure-clusters/README.metadata.json b/feature_layers/configure-clusters/README.metadata.json new file mode 100644 index 000000000..14c15277b --- /dev/null +++ b/feature_layers/configure-clusters/README.metadata.json @@ -0,0 +1,41 @@ +{ + "category": "Feature layers", + "description": "Add clustering feature reduction to a point feature layer.", + "ignore": false, + "images": [ + "ConfigureClusters.png" + ], + "keywords": [ + "aggregate", + "bin", + "cluster", + "group", + "merge", + "normalize", + "popup", + "reduce", + "renderer", + "summarize", + "AggregateGeoElement", + "ClassBreaksRenderer", + "FeatureLayer", + "FeatureReduction", + "GeoElement", + "IdentifyLayerResult" + ], + "redirect_from": [ + "/java/latest/sample-code/configure-clusters.htm" + ], + "relevant_apis": [ + "AggregateGeoElement", + "ClassBreaksRenderer", + "FeatureLayer", + "FeatureReduction", + "GeoElement", + "IdentifyLayerResult" + ], + "snippets": [ + "src/main/java/com/esri/samples/configure_clusters/ConfigureClustersSample.java" + ], + "title": "Configure clusters" +} diff --git a/feature_layers/configure-clusters/build.gradle b/feature_layers/configure-clusters/build.gradle new file mode 100644 index 000000000..3a38ffbcb --- /dev/null +++ b/feature_layers/configure-clusters/build.gradle @@ -0,0 +1,87 @@ +plugins { + id 'application' + id 'idea' + id 'org.openjfx.javafxplugin' // version is defined in settings.gradle +} + +idea { + module { + downloadJavadoc = true + } +} + +group = 'com.esri.samples' + +ext { + arcgisVersion = '200.3.0' +} + +javafx { + version = "21.0.1" + modules = [ 'javafx.controls', 'javafx.graphics', 'javafx.fxml', 'javafx.web', 'javafx.media' ] +} + +application { + mainModule = "com.esri.samples.configure_clusters" + mainClass = "com.esri.samples.configure_clusters.ConfigureClustersSample" +} + +compileJava.options.encoding = 'UTF-8' + +repositories { + mavenCentral() + maven { + url 'https://esri.jfrog.io/artifactory/arcgis' + } + maven { + url 'https://olympus.esri.com/artifactory/arcgisruntime-repo' + } +} + +configurations { + natives +} + +dependencies { + implementation "com.esri.arcgisruntime:arcgis-java:$arcgisVersion" + natives "com.esri.arcgisruntime:arcgis-java-jnilibs:$arcgisVersion" + natives "com.esri.arcgisruntime:arcgis-java-resources:$arcgisVersion" + // handle SLF4J http://www.slf4j.org/codes.html#StaticLoggerBinder + implementation 'org.slf4j:slf4j-nop:2.0.9' +} + +task createGradlePropertiesAndWriteApiKey { + description = "Creates a new gradle.properties file with an empty API key variable in the user home ./gradle folder, if the file doesn't already exist." + group = "build" + def propertiesFile = new File("${System.properties.getProperty("user.home")}/.gradle/gradle.properties") + if (!propertiesFile.exists()) { + print("Go to " + new URL("https://developers.arcgis.com/dashboard") + " to get an API key.") + print(" Add your API key to ${System.properties.getProperty("user.home")}\\.gradle\\gradle.properties.") + propertiesFile.write("apiKey = ") + } +} + +task copyNatives(type: Copy) { + description = "Copies the arcgis native libraries into the project build directory for development." + group = "build" + configurations.natives.asFileTree.each { + from(zipTree(it)) + } + // store native libraries in a common location shared with other samples + into "${System.properties.getProperty("user.home")}/.arcgis/$arcgisVersion" +} + +run { + doFirst { + // sets the API key from the gradle.properties file as a Java system property + systemProperty 'apiKey', apiKey + } + dependsOn copyNatives +} + +if (rootProject == project) { + // the wrapper task is only used if this project is the root project i.e. not a subproject + wrapper { + gradleVersion = '8.4' + } +} diff --git a/feature_layers/configure-clusters/gradle/wrapper/gradle-wrapper.properties b/feature_layers/configure-clusters/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 000000000..e411586a5 --- /dev/null +++ b/feature_layers/configure-clusters/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,5 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-8.4-bin.zip +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/feature_layers/configure-clusters/gradlew b/feature_layers/configure-clusters/gradlew new file mode 100644 index 000000000..4f906e0c8 --- /dev/null +++ b/feature_layers/configure-clusters/gradlew @@ -0,0 +1,185 @@ +#!/usr/bin/env sh + +# +# Copyright 2015 the original author or authors. +# +# 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 +# +# https://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. +# + +############################################################################## +## +## Gradle start up script for UN*X +## +############################################################################## + +# Attempt to set APP_HOME +# Resolve links: $0 may be a link +PRG="$0" +# Need this for relative symlinks. +while [ -h "$PRG" ] ; do + ls=`ls -ld "$PRG"` + link=`expr "$ls" : '.*-> \(.*\)$'` + if expr "$link" : '/.*' > /dev/null; then + PRG="$link" + else + PRG=`dirname "$PRG"`"/$link" + fi +done +SAVED="`pwd`" +cd "`dirname \"$PRG\"`/" >/dev/null +APP_HOME="`pwd -P`" +cd "$SAVED" >/dev/null + +APP_NAME="Gradle" +APP_BASE_NAME=`basename "$0"` + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD="maximum" + +warn () { + echo "$*" +} + +die () { + echo + echo "$*" + echo + exit 1 +} + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "`uname`" in + CYGWIN* ) + cygwin=true + ;; + Darwin* ) + darwin=true + ;; + MINGW* ) + msys=true + ;; + NONSTOP* ) + nonstop=true + ;; +esac + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD="$JAVA_HOME/jre/sh/java" + else + JAVACMD="$JAVA_HOME/bin/java" + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD="java" + which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." +fi + +# Increase the maximum file descriptors if we can. +if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then + MAX_FD_LIMIT=`ulimit -H -n` + if [ $? -eq 0 ] ; then + if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then + MAX_FD="$MAX_FD_LIMIT" + fi + ulimit -n $MAX_FD + if [ $? -ne 0 ] ; then + warn "Could not set maximum file descriptor limit: $MAX_FD" + fi + else + warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" + fi +fi + +# For Darwin, add options to specify how the application appears in the dock +if $darwin; then + GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" +fi + +# For Cygwin or MSYS, switch paths to Windows format before running java +if [ "$cygwin" = "true" -o "$msys" = "true" ] ; then + APP_HOME=`cygpath --path --mixed "$APP_HOME"` + CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` + + JAVACMD=`cygpath --unix "$JAVACMD"` + + # We build the pattern for arguments to be converted via cygpath + ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` + SEP="" + for dir in $ROOTDIRSRAW ; do + ROOTDIRS="$ROOTDIRS$SEP$dir" + SEP="|" + done + OURCYGPATTERN="(^($ROOTDIRS))" + # Add a user-defined pattern to the cygpath arguments + if [ "$GRADLE_CYGPATTERN" != "" ] ; then + OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" + fi + # Now convert the arguments - kludge to limit ourselves to /bin/sh + i=0 + for arg in "$@" ; do + CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` + CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option + + if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition + eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` + else + eval `echo args$i`="\"$arg\"" + fi + i=`expr $i + 1` + done + case $i in + 0) set -- ;; + 1) set -- "$args0" ;; + 2) set -- "$args0" "$args1" ;; + 3) set -- "$args0" "$args1" "$args2" ;; + 4) set -- "$args0" "$args1" "$args2" "$args3" ;; + 5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; + 6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; + 7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; + 8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; + 9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; + esac +fi + +# Escape application args +save () { + for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done + echo " " +} +APP_ARGS=`save "$@"` + +# Collect all arguments for the java command, following the shell quoting and substitution rules +eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS" + +exec "$JAVACMD" "$@" diff --git a/feature_layers/configure-clusters/gradlew.bat b/feature_layers/configure-clusters/gradlew.bat new file mode 100644 index 000000000..107acd32c --- /dev/null +++ b/feature_layers/configure-clusters/gradlew.bat @@ -0,0 +1,89 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem + +@if "%DEBUG%" == "" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%" == "" set DIRNAME=. +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if "%ERRORLEVEL%" == "0" goto execute + +echo. +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* + +:end +@rem End local scope for the variables with windows NT shell +if "%ERRORLEVEL%"=="0" goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 +exit /b 1 + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/feature_layers/configure-clusters/settings.gradle b/feature_layers/configure-clusters/settings.gradle new file mode 100644 index 000000000..6e4986e54 --- /dev/null +++ b/feature_layers/configure-clusters/settings.gradle @@ -0,0 +1,8 @@ +pluginManagement { + plugins { + // version defined in settings.gradle to avoid version error when this sample is used in a multiproject build + id 'org.openjfx.javafxplugin' version "0.1.0" + } +} + +rootProject.name = 'configure-clusters' diff --git a/feature_layers/configure-clusters/src/main/java/com/esri/samples/configure_clusters/ConfigureClustersSample.java b/feature_layers/configure-clusters/src/main/java/com/esri/samples/configure_clusters/ConfigureClustersSample.java new file mode 100644 index 000000000..94a0b8ec4 --- /dev/null +++ b/feature_layers/configure-clusters/src/main/java/com/esri/samples/configure_clusters/ConfigureClustersSample.java @@ -0,0 +1,365 @@ +/* + * Copyright 2024 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.configure_clusters; + +import java.util.ArrayList; +import java.util.List; +import java.util.Map; +import java.util.concurrent.ExecutionException; +import java.util.stream.Collectors; + +import com.esri.arcgisruntime.ArcGISRuntimeEnvironment; +import com.esri.arcgisruntime.arcgisservices.LabelDefinition; +import com.esri.arcgisruntime.arcgisservices.LabelingPlacement; +import com.esri.arcgisruntime.concurrent.ListenableFuture; +import com.esri.arcgisruntime.layers.FeatureLayer; +import com.esri.arcgisruntime.loadable.LoadStatus; +import com.esri.arcgisruntime.mapping.ArcGISMap; +import com.esri.arcgisruntime.mapping.LayerList; +import com.esri.arcgisruntime.mapping.labeling.SimpleLabelExpression; +import com.esri.arcgisruntime.mapping.popup.Popup; +import com.esri.arcgisruntime.mapping.popup.PopupDefinition; +import com.esri.arcgisruntime.mapping.reduction.AggregateField; +import com.esri.arcgisruntime.mapping.reduction.AggregateStatisticType; +import com.esri.arcgisruntime.mapping.reduction.ClusteringFeatureReduction; +import com.esri.arcgisruntime.mapping.view.IdentifyLayerResult; +import com.esri.arcgisruntime.mapping.view.MapView; +import com.esri.arcgisruntime.portal.Portal; +import com.esri.arcgisruntime.portal.PortalItem; +import com.esri.arcgisruntime.symbology.ClassBreaksRenderer; +import com.esri.arcgisruntime.symbology.SimpleMarkerSymbol; +import com.esri.arcgisruntime.symbology.TextSymbol; +import javafx.application.Application; +import javafx.application.Platform; +import javafx.geometry.Insets; +import javafx.geometry.Point2D; +import javafx.geometry.Pos; +import javafx.scene.Scene; +import javafx.scene.control.CheckBox; +import javafx.scene.control.ComboBox; +import javafx.scene.control.Label; +import javafx.scene.layout.Background; +import javafx.scene.layout.BackgroundFill; +import javafx.scene.layout.Border; +import javafx.scene.layout.BorderStroke; +import javafx.scene.layout.BorderStrokeStyle; +import javafx.scene.layout.BorderWidths; +import javafx.scene.layout.CornerRadii; +import javafx.scene.layout.HBox; +import javafx.scene.layout.StackPane; +import javafx.scene.layout.VBox; +import javafx.scene.paint.Color; +import javafx.scene.paint.Paint; +import javafx.scene.text.Font; +import javafx.stage.Stage; + +public class ConfigureClustersSample extends Application { + + private ArcGISMap map; + private CheckBox displayLabelsCheckbox; + private Label clusterRadiusLabel; + private ComboBox clusterRadiusPicker; + private Label maxScaleLabel; + private ComboBox maxScalePicker; + private Label currentMapScaleLabel; + private FeatureLayer layer; + private Label popupContentLabel; + private ClusteringFeatureReduction clusteringFeatureReduction; + private String popupContent; + private MapView mapView; + private PortalItem portalItem; // keep loadable in scope to avoid garbage collection + + private final int DEFAULT_CLUSTER_RADIUS = 60; + private final int MIN_WIDTH = 100; + private final int MAX_WIDTH = 300; + private final int SPACING = 6; + + @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("Configure Clusters 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 portal and portal item, using the portal and item ID + var portal = new Portal("https://www.arcgis.com/"); + portalItem = new PortalItem(portal, "aa44e79a4836413c89908e1afdace2ea"); + + map = new ArcGISMap(portalItem); + + VBox vBoxPopupInformation = new VBox(); + popupContentLabel = new Label(); + setupVBoxStyling(vBoxPopupInformation); + vBoxPopupInformation.getChildren().addAll(popupContentLabel); + vBoxPopupInformation.setVisible(false); + + // Get the Zurich buildings feature layer once the map has finished loading + map.addDoneLoadingListener(() -> { + if (map.getLoadStatus() == LoadStatus.LOADED) { + LayerList l = map.getOperationalLayers(); + if (l.isEmpty()) + return; + layer = (FeatureLayer) l.get(0); + + mapView.setOnMouseClicked(mouseEvent -> { + if (layer == null) { + return; + } + // Identify the tapped observation. + Point2D point = new Point2D(mouseEvent.getX(), mouseEvent.getY()); + ListenableFuture identifiedLayerResults = mapView.identifyLayerAsync(layer, point, 3.0, true); + identifiedLayerResults.addDoneListener(() -> { + try { + // clear the list of popup content + popupContent = ""; + IdentifyLayerResult layer = identifiedLayerResults.get(); + + popupContent = layer.getPopups().stream() + .flatMap(popup->popup.getGeoElement().getAttributes().entrySet().stream()) + .map(entry->entry.getKey() + ": " + entry.getValue().toString() + "\n") + .collect(Collectors.joining()); + + Platform.runLater(() ->{ + popupContentLabel.setText(popupContent); + popupContentLabel.setTextFill(Color.WHITE); + vBoxPopupInformation.setVisible(!popupContentLabel.getText().isEmpty()); + }); + + } catch (ExecutionException | InterruptedException e) { + System.err.println(e.getMessage()); + } + }); + }); + + // set up the user interface + VBox vBoxControls = controlsVBox(); + + // add the map view to the stack pane + stackPane.getChildren().addAll(mapView, vBoxControls, vBoxPopupInformation); + StackPane.setAlignment(vBoxControls, Pos.TOP_LEFT); + StackPane.setMargin(vBoxControls, new Insets(10, 0, 0, 10)); + StackPane.setAlignment(vBoxPopupInformation, Pos.TOP_RIGHT); + StackPane.setMargin(vBoxPopupInformation, new Insets(10, 0, 0, 10)); + + // Add a class break for each intended value range and define a symbol to display for features in that range. + // In this case, the average building height ranges from 0 to 8 stories. + // For each cluster of features with a given average building height, a symbol is defined with a specified + // color. + List classBreaks = new ArrayList<>(); + classBreaks.add(new ClassBreaksRenderer.ClassBreak("0", "0", 0.0, 1.0, + new SimpleMarkerSymbol(SimpleMarkerSymbol.Style.CIRCLE, Color.rgb(4, 251, 255), 8.0f))); + classBreaks.add(new ClassBreaksRenderer.ClassBreak("1", "1", 1.0, 2.0, + new SimpleMarkerSymbol(SimpleMarkerSymbol.Style.CIRCLE, Color.rgb(44, 211, 255), 8.0f))); + classBreaks.add(new ClassBreaksRenderer.ClassBreak("2", "2", 2.0, 3.0, + new SimpleMarkerSymbol(SimpleMarkerSymbol.Style.CIRCLE, Color.rgb(74, 181, 255), 8.0f))); + classBreaks.add(new ClassBreaksRenderer.ClassBreak("3", "3", 3.0, 4.0, + new SimpleMarkerSymbol(SimpleMarkerSymbol.Style.CIRCLE, Color.rgb(120, 135, 255), 8.0f))); + classBreaks.add(new ClassBreaksRenderer.ClassBreak("4", "4", 4.0, 5.0, + new SimpleMarkerSymbol(SimpleMarkerSymbol.Style.CIRCLE, Color.rgb(165, 90, 255), 8.0f))); + classBreaks.add(new ClassBreaksRenderer.ClassBreak("6", "6", 6.0, 7.0, + new SimpleMarkerSymbol(SimpleMarkerSymbol.Style.CIRCLE, Color.rgb(194, 61, 255), 8.0f))); + classBreaks.add(new ClassBreaksRenderer.ClassBreak("5", "5", 5.0, 6.0, + new SimpleMarkerSymbol(SimpleMarkerSymbol.Style.CIRCLE, Color.rgb(224, 31, 255), 8.0f))); + classBreaks.add(new ClassBreaksRenderer.ClassBreak("7", "7", 7.0, 8.0, + new SimpleMarkerSymbol(SimpleMarkerSymbol.Style.CIRCLE, Color.rgb(254, 1, 255), 8.0f))); + + // Create a class breaks renderer to apply to the custom feature reduction. + // Define the field to use for the class breaks renderer. + // Note that this field name must match the name of an aggregate field contained in the clustering feature + // reduction's aggregate fields property. + ClassBreaksRenderer classBreaksRenderer = new ClassBreaksRenderer("Average Building Height", classBreaks); + + // Define a default symbol to use for features that do not fall within any of the ranges defined by the + // class breaks. + classBreaksRenderer.setDefaultSymbol(new SimpleMarkerSymbol(SimpleMarkerSymbol.Style.CIRCLE, Color.PINK, 8)); + + // Create a new clustering feature reduction using the class breaks renderer. + clusteringFeatureReduction = new ClusteringFeatureReduction(classBreaksRenderer); + + // Set the feature reduction's aggregate fields. Note that the field names must match the names of fields + // in the feature layer's dataset. + // The aggregate fields summarize values based on the defined aggregate statistic type. + clusteringFeatureReduction.getAggregateFields().add( + new AggregateField("Total Residential Buildings", "Residential_Buildings", AggregateStatisticType.SUM)); + + clusteringFeatureReduction.getAggregateFields().add( + new AggregateField("Average Building Height", "Most_common_number_of_storeys", + AggregateStatisticType.MODE)); + + // Enable the feature reduction. + clusteringFeatureReduction.setEnabled(true); + + // Set the popup definition for the custom feature reduction. + clusteringFeatureReduction.setPopupDefinition(new PopupDefinition(clusteringFeatureReduction)); + + // Set values for the feature reduction's cluster minimum and maximum symbol sizes. + // Note that the default values for Max and Min symbol size are 70 and 12 respectively. + clusteringFeatureReduction.setMinSymbolSize(5.0); + clusteringFeatureReduction.setMaxSymbolSize(90.0); + + // Set the feature reduction for the layer. + layer.setFeatureReduction(clusteringFeatureReduction); + + // Set initial ComboBox values. + // Note that the default value for cluster radius is 60. + // Increasing the cluster radius increases the number of features that are grouped together into a cluster. + clusteringFeatureReduction.setRadius(DEFAULT_CLUSTER_RADIUS); + + // Note that the default value for max scale is 0. + // The max scale value is the maximum scale at which clustering is applied. + clusteringFeatureReduction.setMaxScale(0); + } + }); + + // create a map view and set the map to it + mapView = new MapView(); + mapView.setMap(map); + + } catch (Exception e) { + // on any error, display the stack trace. + e.printStackTrace(); + } + } + + /** + * Sets styling for the given VBox. + */ + private void setupVBoxStyling(VBox vBox) { + vBox.setBackground(new Background(new BackgroundFill(Paint.valueOf("rgba(0,0,0,0.5)"), + CornerRadii.EMPTY, + Insets.EMPTY))); + vBox.setPadding(new Insets(10.0)); + vBox.setMaxSize(MAX_WIDTH, MIN_WIDTH); + vBox.getStyleClass().add("panel-region"); + vBox.setBorder(new Border(new BorderStroke(Color.BLACK, BorderStrokeStyle.SOLID, CornerRadii.EMPTY, new BorderWidths(1)))); + } + + /** + * Creates a UI with a checkbox and two combo boxes. + * + * @return a vBox populated with checkbox, combo boxes, and labels + */ + private VBox controlsVBox() { + + Label label = new Label("Clustering properties"); + label.setStyle("-fx-font-weight: bold; -fx-text-color: black;"); + label.setFont(new Font(14)); + label.setTextFill(Color.WHITE); + + HBox displayHBox = new HBox(SPACING); + Label label1 = new Label("Display Labels: "); + label1.setMinWidth(MIN_WIDTH); + label1.setTextFill(Color.WHITE); + + // create checkbox to toggle the showing of cluster count + + SimpleLabelExpression simpleLabelExpression = new SimpleLabelExpression("[cluster_count]"); + TextSymbol textSymbol = new TextSymbol(15.0f, "", Color.BLUE, TextSymbol.HorizontalAlignment.CENTER, TextSymbol.VerticalAlignment.MIDDLE); + textSymbol.setFontWeight(TextSymbol.FontWeight.BOLD); + LabelDefinition labelDefinition = new LabelDefinition(simpleLabelExpression, textSymbol); + labelDefinition.setPlacement(LabelingPlacement.POINT_CENTER_CENTER); + + displayLabelsCheckbox = new CheckBox(); + displayLabelsCheckbox.setSelected(false); + displayLabelsCheckbox.setTextFill(Color.WHITE); + displayLabelsCheckbox.selectedProperty().addListener(o -> { + if (displayLabelsCheckbox.isSelected()) { + clusteringFeatureReduction.getLabelDefinitions().add(labelDefinition); + } + else { + clusteringFeatureReduction.getLabelDefinitions().clear(); + } + }); + displayHBox.getChildren().addAll(label1, displayLabelsCheckbox); + + HBox clusterRadiusHBox = new HBox(SPACING); + clusterRadiusLabel = new Label("Cluster radius: "); + clusterRadiusLabel.setMinWidth(MIN_WIDTH); + clusterRadiusLabel.setTextFill(Color.WHITE); + clusterRadiusPicker = new ComboBox<>(); + clusterRadiusPicker.getItems().addAll(30, 45, 60, 75, 90); + clusterRadiusPicker.setValue(DEFAULT_CLUSTER_RADIUS); + + // add a listener to the ComboBox's value property to set the cluster radius + clusterRadiusPicker.setOnAction(event -> { + clusteringFeatureReduction.setRadius(clusterRadiusPicker.getValue()); + }); + clusterRadiusHBox.getChildren().addAll(clusterRadiusLabel, clusterRadiusPicker); + + HBox maxScaleHBox = new HBox(SPACING); + maxScaleLabel = new Label("MaxScale: "); + maxScaleLabel.setMinWidth(MIN_WIDTH); + maxScaleLabel.setTextFill(Color.WHITE); + // create a ComboBox for adjusting max scale + maxScalePicker = new ComboBox<>(); + maxScalePicker.getItems().addAll(0, 1000, 5000, 10000, 50000, 100000, 500000); + maxScalePicker.setValue(0); + + // add a listener to the ComboBox's value property to set the max scale + maxScalePicker.setOnAction(event -> { + clusteringFeatureReduction.setMaxScale(maxScalePicker.getValue()); + }); + maxScaleHBox.getChildren().addAll(maxScaleLabel, maxScalePicker); + + // show current map scale in a label within the control panel + currentMapScaleLabel = new Label("Scale: 1:" + mapView.getMapScale()); + currentMapScaleLabel.setTextFill(Color.WHITE); + + // listen for map scale changes and update the label + currentMapScaleLabel.textProperty().bind(mapView.mapScaleProperty().map(i -> "Scale: 1:" + Math.round(i.doubleValue()))); + + VBox controlsVBox = new VBox(10); + setupVBoxStyling(controlsVBox); + controlsVBox.getChildren().addAll(label, displayHBox, clusterRadiusHBox, maxScaleHBox, currentMapScaleLabel); + + return controlsVBox; + } + + /** + * 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); + } + +} diff --git a/feature_layers/configure-clusters/src/main/java/module-info.java b/feature_layers/configure-clusters/src/main/java/module-info.java new file mode 100644 index 000000000..acba244b3 --- /dev/null +++ b/feature_layers/configure-clusters/src/main/java/module-info.java @@ -0,0 +1,27 @@ +/* + * Copyright 2024 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. + */ +module com.esri.samples.configure_clusters { + // require ArcGIS Maps SDK for Java module + requires com.esri.arcgisruntime; + + // handle SLF4J http://www.slf4j.org/codes.html#StaticLoggerBinder + requires org.slf4j.nop; + + // require JavaFX modules that the application uses + requires javafx.graphics; + + exports com.esri.samples.configure_clusters; +}