Class GeoView
- java.lang.Object
-
- javafx.scene.Node
-
- javafx.scene.Parent
-
- javafx.scene.layout.Region
-
- javafx.scene.control.Control
-
- com.esri.arcgisruntime.mapping.view.GeoView
-
- All Implemented Interfaces:
Styleable
,EventTarget
,Skinnable
public abstract class GeoView extends Control
A GeoView is the base class for working with views in an MVC architecture. In this architecture, an ArcGISMap or ArcGISScene represents the model and a GeoView represents the view. A GeoView provides properties and methods inherited by the 2D MapView and the 3D SceneView; these derived classes must only be created and used on the UI thread.- Since:
- 100.0.0
-
-
Field Summary
Fields Modifier and Type Field Description protected Callout
mCallout
protected com.esri.arcgisruntime.internal.mapping.view.GeoViewImpl
mGeoViewImpl
-
Fields inherited from class javafx.scene.layout.Region
USE_COMPUTED_SIZE, USE_PREF_SIZE
-
Fields inherited from class javafx.scene.Node
BASELINE_OFFSET_SAME_AS_HEIGHT
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
GeoView(com.esri.arcgisruntime.internal.jni.CoreGeoView coreGeoView)
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods Modifier and Type Method Description void
addAttributionTextChangedListener(AttributionTextChangedListener listener)
Registers an AttributionTextChangedListener to be called when the attribution text of the GeoView changes, for example if a layer is removed or added the attribution text needs to update.void
addDrawStatusChangedListener(DrawStatusChangedListener listener)
Adds a draw status changed listener.void
addLayerViewStateChangedListener(LayerViewStateChangedListener listener)
Adds a listener for changes to layer view state.void
addNavigationChangedListener(NavigationChangedListener listener)
Adds a listener for when navigation has changed.void
addSpatialReferenceChangedListener(SpatialReferenceChangedListener listener)
Adds a listener for changes to theSpatialReference
.void
addTimeExtentChangedListener(TimeExtentChangedListener listener)
Registers aTimeExtentChangedListener
to be called when the time extent of the GeoView is changed.void
addViewpointChangedListener(ViewpointChangedListener listener)
Adds a ViewpointChangedListener.BooleanProperty
attributionTextVisibleProperty()
If attribution text is visible.ReadOnlyDoubleProperty
attributionTopProperty()
Returns a read-only property containing the distance from the top of the view to the top of the attribution text.protected Skin<?>
createDefaultSkin()
void
dispose()
Dispose the GeoViewBooleanProperty
enableKeyboardNavigationProperty()
If true keyboard navigation is enabled.BooleanProperty
enableMousePanProperty()
If true mouse panning is enabled.BooleanProperty
enableMouseZoomProperty()
If true mouse wheel zooming is enabled.BooleanProperty
enableTouchPanProperty()
If true touch panning is enabled.BooleanProperty
enableTouchRotateProperty()
If true touch rotate is enabled.BooleanProperty
enableTouchZoomProperty()
If true touch zoom (pinch) is enabled.ListenableFuture<Image>
exportImageAsync()
Asynchronously exports the GeoView into an Image.String
getAttributionText()
Gets a concatenated string with attributions from all layers.double
getAttributionTop()
Returns the distance from the top of the view to the top of the attribution text.Callout
getCallout()
Gets the Callout for this GeoView.Viewpoint
getCurrentViewpoint(Viewpoint.Type viewpointType)
Gets the current viewpoint.DrawStatus
getDrawStatus()
Returns the current draw status.ListenableList<GraphicsOverlay>
getGraphicsOverlays()
Gets a modifiable list of the graphics overlays.InteractionListener
getInteractionListener()
Gets the current interaction listener.ViewLabelProperties
getLabeling()
Gets the view label properties.EnumSet<LayerViewStatus>
getLayerViewState(Layer layer)
Deprecated, for removal: This API element is subject to removal in a future version.since 100.10.0.SelectionProperties
getSelectionProperties()
Returns the selection properties that are applied to a GeoView.abstract SpatialReference
getSpatialReference()
Gets the spatial reference.TimeExtent
getTimeExtent()
Gets the current time extent.LayerViewState
getViewStateForLayer(Layer layer)
Retrieve the layer's view state.ListenableFuture<IdentifyGraphicsOverlayResult>
identifyGraphicsOverlayAsync(GraphicsOverlay graphicsOverlay, Point2D screenPoint, double tolerance, boolean returnPopupsOnly)
Asynchronously identifies the topmost visible graphic in the given graphics overlay, near given JavaFX local coordinate system point.ListenableFuture<IdentifyGraphicsOverlayResult>
identifyGraphicsOverlayAsync(GraphicsOverlay graphicsOverlay, Point2D screenPoint, double tolerance, boolean returnPopupsOnly, int maximumResults)
Asynchronously identifies visible graphics in the given graphics overlay, near the given JavaFX local coordinate system point.ListenableFuture<List<IdentifyGraphicsOverlayResult>>
identifyGraphicsOverlaysAsync(Point2D screenPoint, double tolerance, boolean returnPopupsOnly)
Asynchronously identifies the topmost visible graphic in each graphics overlay attached to this view, near the given JavaFX local coordinate system point.ListenableFuture<List<IdentifyGraphicsOverlayResult>>
identifyGraphicsOverlaysAsync(Point2D screenPoint, double tolerance, boolean returnPopupsOnly, int maximumResults)
Asynchronously identifies visible graphics in all graphics overlays attached to this view near a JavaFX local coordinate system point.ListenableFuture<IdentifyLayerResult>
identifyLayerAsync(Layer layer, Point2D screenPoint, double tolerance, boolean returnPopupsOnly)
Asynchronously identifies the topmost visible geoelement in the given layer, near the given JavaFX local coordinate system point.ListenableFuture<IdentifyLayerResult>
identifyLayerAsync(Layer layer, Point2D screenPoint, double tolerance, boolean returnPopupsOnly, int maximumResults)
Asynchronously identifies geoelements in the given layer, near the given JavaFX local coordinate system point.ListenableFuture<List<IdentifyLayerResult>>
identifyLayersAsync(Point2D screenPoint, double tolerance, boolean returnPopupsOnly)
Asynchronously identifies the topmost visible geoelement in each identifiable layer attached to the map, near the given JavaFX local coordinate system point.ListenableFuture<List<IdentifyLayerResult>>
identifyLayersAsync(Point2D screenPoint, double tolerance, boolean returnPopupsOnly, int maximumResults)
Asynchronously identifies geoelements on all identifiable layers attached to the map, near the given JavaFX local coordinate system point.boolean
isAttributionTextVisible()
Returns true if attribution text is visible, otherwise false.boolean
isEnableKeyboardNavigation()
Returns true if keyboard navigation is enabled, otherwise false.boolean
isEnableMousePan()
Returns true if mouse pan is enabled, otherwise false.boolean
isEnableMouseZoom()
Returns true if mouse wheel zoom is enabled, otherwise false.boolean
isEnableTouchPan()
Returns true if touch pan is enabled, otherwise false.boolean
isEnableTouchRotate()
Returns true if touch rotate is enabled, otherwise false.boolean
isEnableTouchZoom()
Returns true if touch zoom (pinch) is enabled, otherwise false.boolean
isLogoVisible()
Deprecated, for removal: This API element is subject to removal in a future version.As of 100.2.0, no replacement.boolean
isNavigating()
Indicates whether the GeoView is being interacted with or not.boolean
isResizable()
boolean
isWrapAroundEnabled()
Indicates whether wrap around mode is enabled.boolean
removeAttributionTextChangedListener(AttributionTextChangedListener listener)
Unregisters an AttributionTextChangedListener that was previously added usingaddAttributionTextChangedListener(AttributionTextChangedListener)
.boolean
removeDrawStatusChangedListener(DrawStatusChangedListener listener)
Removes a draw status changed listener.boolean
removeLayerViewStateChangedListener(LayerViewStateChangedListener listener)
Removes a layer view state listener.boolean
removeNavigationChangedListener(NavigationChangedListener listener)
Removes a navigation change listener.boolean
removeSpatialReferenceChangedListener(SpatialReferenceChangedListener listener)
Removes aSpatialReference
changed listener.boolean
removeTimeExtentChangedListener(TimeExtentChangedListener listener)
Unregisters aTimeExtentChangedListener
that was previously added usingaddTimeExtentChangedListener(TimeExtentChangedListener)
.boolean
removeViewpointChangedListener(ViewpointChangedListener listener)
Removes a ViewpointChangedListener.void
setAttributionTextVisible(boolean visible)
Sets the visibility of the Esri attribution text.ListenableFuture<Boolean>
setBookmarkAsync(Bookmark bookmark)
Asynchronously sets the bookmark, which consequently applies the viewpoint within the bookmark to the GeoView.void
setEnableKeyboardNavigation(boolean enable)
Enables or disables keyboard navigation.void
setEnableMousePan(boolean enable)
Enables or disables mouse panning.void
setEnableMouseZoom(boolean enable)
Enables or disables mouse wheel zooming.void
setEnableTouchPan(boolean enable)
Enables or disables touch panning.void
setEnableTouchRotate(boolean enable)
Enables or disables touch rotate.void
setEnableTouchZoom(boolean enable)
Enables or disables touch zoom (pinch).void
setInteractionListener(InteractionListener interactionListener)
Sets the listener to handle input interactions on the GeoView.void
setLabeling(ViewLabelProperties viewLabelProperties)
Sets the view label properties.void
setLogoVisible(boolean visible)
Deprecated, for removal: This API element is subject to removal in a future version.as of 100.2.0, no replacement.void
setTimeExtent(TimeExtent timeExtent)
Sets the time extent of the GeoView.void
setViewpoint(Viewpoint viewpoint)
Sets the view to a given location and scale.ListenableFuture<Boolean>
setViewpointAsync(Viewpoint viewpoint)
Sets the viewpoint asynchronously.ListenableFuture<Boolean>
setViewpointAsync(Viewpoint viewpoint, float durationSeconds)
Set viewpoint with duration asynchronously.-
Methods inherited from class javafx.scene.control.Control
computeMaxHeight, computeMaxWidth, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, contextMenuProperty, executeAccessibleAction, getBaselineOffset, getClassCssMetaData, getContextMenu, getControlCssMetaData, getCssMetaData, getInitialFocusTraversable, getSkin, getTooltip, layoutChildren, queryAccessibleAttribute, setContextMenu, setSkin, setTooltip, skinProperty, tooltipProperty
-
Methods inherited from class javafx.scene.layout.Region
backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, getBackground, getBorder, getHeight, getInsets, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getOpaqueInsets, getPadding, getPrefHeight, getPrefWidth, getShape, getUserAgentStylesheet, getWidth, heightProperty, insetsProperty, isCacheShape, isCenterShape, isScaleShape, isSnapToPixel, layoutInArea, layoutInArea, layoutInArea, layoutInArea, maxHeight, maxHeightProperty, maxWidth, maxWidthProperty, minHeight, minHeightProperty, minWidth, minWidthProperty, opaqueInsetsProperty, paddingProperty, positionInArea, positionInArea, prefHeight, prefHeightProperty, prefWidth, prefWidthProperty, resize, scaleShapeProperty, setBackground, setBorder, setCacheShape, setCenterShape, setHeight, setMaxHeight, setMaxSize, setMaxWidth, setMinHeight, setMinSize, setMinWidth, setOpaqueInsets, setPadding, setPrefHeight, setPrefSize, setPrefWidth, setScaleShape, setShape, setSnapToPixel, setWidth, shapeProperty, snappedBottomInset, snappedLeftInset, snappedRightInset, snappedTopInset, snapPosition, snapPositionX, snapPositionY, snapSize, snapSizeX, snapSizeY, snapSpace, snapSpaceX, snapSpaceY, snapToPixelProperty, widthProperty
-
Methods inherited from class javafx.scene.Parent
getChildren, getChildrenUnmodifiable, getManagedChildren, getStylesheets, isNeedsLayout, layout, lookup, needsLayoutProperty, requestLayout, requestParentLayout, setNeedsLayout, updateBounds
-
Methods inherited from class javafx.scene.Node
accessibleHelpProperty, accessibleRoleDescriptionProperty, accessibleRoleProperty, accessibleTextProperty, addEventFilter, addEventHandler, applyCss, autosize, blendModeProperty, boundsInLocalProperty, boundsInParentProperty, buildEventDispatchChain, cacheHintProperty, cacheProperty, clipProperty, computeAreaInScreen, contains, contains, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectiveNodeOrientationProperty, effectProperty, eventDispatcherProperty, fireEvent, focusedProperty, focusTraversableProperty, getAccessibleHelp, getAccessibleRole, getAccessibleRoleDescription, getAccessibleText, getBlendMode, getBoundsInLocal, getBoundsInParent, getCacheHint, getClip, getContentBias, getCursor, getDepthTest, getEffect, getEffectiveNodeOrientation, getEventDispatcher, getId, getInitialCursor, getInputMethodRequests, getLayoutBounds, getLayoutX, getLayoutY, getLocalToParentTransform, getLocalToSceneTransform, getNodeOrientation, getOnContextMenuRequested, getOnDragDetected, getOnDragDone, getOnDragDropped, getOnDragEntered, getOnDragExited, getOnDragOver, getOnInputMethodTextChanged, getOnKeyPressed, getOnKeyReleased, getOnKeyTyped, getOnMouseClicked, getOnMouseDragEntered, getOnMouseDragExited, getOnMouseDragged, getOnMouseDragOver, getOnMouseDragReleased, getOnMouseEntered, getOnMouseExited, getOnMouseMoved, getOnMousePressed, getOnMouseReleased, getOnRotate, getOnRotationFinished, getOnRotationStarted, getOnScroll, getOnScrollFinished, getOnScrollStarted, getOnSwipeDown, getOnSwipeLeft, getOnSwipeRight, getOnSwipeUp, getOnTouchMoved, getOnTouchPressed, getOnTouchReleased, getOnTouchStationary, getOnZoom, getOnZoomFinished, getOnZoomStarted, getOpacity, getParent, getProperties, getPseudoClassStates, getRotate, getRotationAxis, getScaleX, getScaleY, getScaleZ, getScene, getStyle, getStyleableParent, getStyleClass, getTransforms, getTranslateX, getTranslateY, getTranslateZ, getTypeSelector, getUserData, getViewOrder, hasProperties, hoverProperty, idProperty, inputMethodRequestsProperty, intersects, intersects, isCache, isDisable, isDisabled, isFocused, isFocusTraversable, isHover, isManaged, isMouseTransparent, isPickOnBounds, isPressed, isVisible, layoutBoundsProperty, layoutXProperty, layoutYProperty, localToParent, localToParent, localToParent, localToParent, localToParent, localToParentTransformProperty, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToSceneTransformProperty, localToScreen, localToScreen, localToScreen, localToScreen, localToScreen, lookupAll, managedProperty, mouseTransparentProperty, nodeOrientationProperty, notifyAccessibleAttributeChanged, onContextMenuRequestedProperty, onDragDetectedProperty, onDragDoneProperty, onDragDroppedProperty, onDragEnteredProperty, onDragExitedProperty, onDragOverProperty, onInputMethodTextChangedProperty, onKeyPressedProperty, onKeyReleasedProperty, onKeyTypedProperty, onMouseClickedProperty, onMouseDragEnteredProperty, onMouseDragExitedProperty, onMouseDraggedProperty, onMouseDragOverProperty, onMouseDragReleasedProperty, onMouseEnteredProperty, onMouseExitedProperty, onMouseMovedProperty, onMousePressedProperty, onMouseReleasedProperty, onRotateProperty, onRotationFinishedProperty, onRotationStartedProperty, onScrollFinishedProperty, onScrollProperty, onScrollStartedProperty, onSwipeDownProperty, onSwipeLeftProperty, onSwipeRightProperty, onSwipeUpProperty, onTouchMovedProperty, onTouchPressedProperty, onTouchReleasedProperty, onTouchStationaryProperty, onZoomFinishedProperty, onZoomProperty, onZoomStartedProperty, opacityProperty, parentProperty, parentToLocal, parentToLocal, parentToLocal, parentToLocal, parentToLocal, pickOnBoundsProperty, pressedProperty, pseudoClassStateChanged, relocate, removeEventFilter, removeEventHandler, requestFocus, resizeRelocate, rotateProperty, rotationAxisProperty, scaleXProperty, scaleYProperty, scaleZProperty, sceneProperty, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, screenToLocal, screenToLocal, screenToLocal, setAccessibleHelp, setAccessibleRole, setAccessibleRoleDescription, setAccessibleText, setBlendMode, setCache, setCacheHint, setClip, setCursor, setDepthTest, setDisable, setDisabled, setEffect, setEventDispatcher, setEventHandler, setFocused, setFocusTraversable, setHover, setId, setInputMethodRequests, setLayoutX, setLayoutY, setManaged, setMouseTransparent, setNodeOrientation, setOnContextMenuRequested, setOnDragDetected, setOnDragDone, setOnDragDropped, setOnDragEntered, setOnDragExited, setOnDragOver, setOnInputMethodTextChanged, setOnKeyPressed, setOnKeyReleased, setOnKeyTyped, setOnMouseClicked, setOnMouseDragEntered, setOnMouseDragExited, setOnMouseDragged, setOnMouseDragOver, setOnMouseDragReleased, setOnMouseEntered, setOnMouseExited, setOnMouseMoved, setOnMousePressed, setOnMouseReleased, setOnRotate, setOnRotationFinished, setOnRotationStarted, setOnScroll, setOnScrollFinished, setOnScrollStarted, setOnSwipeDown, setOnSwipeLeft, setOnSwipeRight, setOnSwipeUp, setOnTouchMoved, setOnTouchPressed, setOnTouchReleased, setOnTouchStationary, setOnZoom, setOnZoomFinished, setOnZoomStarted, setOpacity, setPickOnBounds, setPressed, setRotate, setRotationAxis, setScaleX, setScaleY, setScaleZ, setStyle, setTranslateX, setTranslateY, setTranslateZ, setUserData, setViewOrder, setVisible, snapshot, snapshot, startDragAndDrop, startFullDrag, styleProperty, toBack, toFront, toString, translateXProperty, translateYProperty, translateZProperty, usesMirroring, viewOrderProperty, visibleProperty
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface javafx.css.Styleable
getStyleableNode
-
-
-
-
Field Detail
-
mGeoViewImpl
protected com.esri.arcgisruntime.internal.mapping.view.GeoViewImpl mGeoViewImpl
-
mCallout
protected Callout mCallout
-
-
Method Detail
-
createDefaultSkin
protected Skin<?> createDefaultSkin()
- Overrides:
createDefaultSkin
in classControl
-
attributionTopProperty
public ReadOnlyDoubleProperty attributionTopProperty()
Returns a read-only property containing the distance from the top of the view to the top of the attribution text. This can be used to position nodes on the view such that they don't obscure the attribution. If the attribution text is not visible then the value will be the distance from the top of the view to the bottom of the displayed map or scene. You can check the visibility of the attribution text withattributionTextVisibleProperty()
.- Returns:
- the attribution top property
- Since:
- 100.1.0
-
getAttributionTop
public double getAttributionTop()
Returns the distance from the top of the view to the top of the attribution text. This can be used to position nodes on the view such that they don't obscure the attribution. If the attribution text is not visible then the distance returned will be the distance from the top of the view to the bottom of the displayed map or scene. You can check the visibility of the attribution text withattributionTextVisibleProperty()
.- Returns:
- the distance to the attribution top, or the bottom of the map or scene if attribution is not visible
- Since:
- 100.1.0
-
getSpatialReference
public abstract SpatialReference getSpatialReference()
Gets the spatial reference.- Returns:
- the spatial reference
- Since:
- 100.0.0
-
getDrawStatus
public DrawStatus getDrawStatus()
Returns the current draw status.- Returns:
- the current draw status
- Since:
- 100.0.0
-
isLogoVisible
@Deprecated(since="100.2.0", forRemoval=true) public boolean isLogoVisible()
Deprecated, for removal: This API element is subject to removal in a future version.As of 100.2.0, no replacement.Returns false.- Returns:
- false always
- Since:
- 100.0.0
-
setLogoVisible
@Deprecated(since="100.2.0", forRemoval=true) public void setLogoVisible(boolean visible)
Deprecated, for removal: This API element is subject to removal in a future version.as of 100.2.0, no replacement.This is a no-operation.- Parameters:
visible
- the new logo visible- Since:
- 100.0.0
-
isNavigating
public boolean isNavigating()
Indicates whether the GeoView is being interacted with or not.- Returns:
- true, if the GeoView is being interacted with.
- Since:
- 100.0.0
-
isWrapAroundEnabled
public boolean isWrapAroundEnabled()
Indicates whether wrap around mode is enabled.If a MapView is in wrap around mode then you can pan across the international date line if your BaseMap is in a suitable SpatialReference. A SceneView is always in wrap around mode.
- Returns:
- true, if wrap around is enabled
- Since:
- 100.0.0
-
setViewpoint
public void setViewpoint(Viewpoint viewpoint)
Sets the view to a given location and scale.In a MapView, only the geometry/location and scale properties of the viewpoint are used.
In a SceneView the
Camera
of the viewpoint is used first; if there is no Camera, the geometry/location and scale properties are used to calculate an approximate Camera. For SceneView, you could also useSceneView.setViewpointCamera(com.esri.arcgisruntime.mapping.view.Camera)
.- Parameters:
viewpoint
- the new viewpoint- Throws:
IllegalArgumentException
- if the argument is null- Since:
- 100.0.0
-
getCurrentViewpoint
public Viewpoint getCurrentViewpoint(Viewpoint.Type viewpointType)
Gets the current viewpoint.For a MapView, the
Camera
of the viewpoint will always be null.For a SceneView the Camera will never be null.
- Parameters:
viewpointType
- the viewpoint type- Returns:
- the current viewpoint
- Throws:
IllegalArgumentException
- if the argument is null- Since:
- 100.0.0
-
setViewpointAsync
public ListenableFuture<Boolean> setViewpointAsync(Viewpoint viewpoint)
Sets the viewpoint asynchronously.- Parameters:
viewpoint
- the new viewpoint- Returns:
- a ListenableFuture whose result indicates if the operation completed successfully or not. Add a listener to this to know when the viewpoint has finished animating.
- Throws:
IllegalArgumentException
- if the argument is null- Since:
- 100.0.0
- See Also:
setViewpoint(com.esri.arcgisruntime.mapping.Viewpoint)
-
setViewpointAsync
public ListenableFuture<Boolean> setViewpointAsync(Viewpoint viewpoint, float durationSeconds)
Set viewpoint with duration asynchronously.- Parameters:
viewpoint
- the viewpointdurationSeconds
- the duration seconds- Returns:
- a ListenableFuture whose result indicates if the operation completed successfully or not. Add a listener to this to know when the viewpoint has finished animating.
- Throws:
IllegalArgumentException
- if the viewpoint is null- Since:
- 100.0.0
-
getViewStateForLayer
public LayerViewState getViewStateForLayer(Layer layer)
Retrieve the layer's view state.- Parameters:
layer
- a layer object for which to get the view state- Returns:
- the current state of a layer in a view
- Throws:
ArcGISRuntimeException
- if layer isn't foundIllegalArgumentException
- if layer is null- Since:
- 100.10.0
-
getLayerViewState
@Deprecated(since="100.10.0", forRemoval=true) public EnumSet<LayerViewStatus> getLayerViewState(Layer layer)
Deprecated, for removal: This API element is subject to removal in a future version.since 100.10.0. UsegetViewStateForLayer(Layer)
instead.Gets the layer view status for a given layer.- Parameters:
layer
- the layer- Returns:
- the layer view status, which can be a set of statuses such as
LayerViewStatus.LOADING
andLayerViewStatus.NOT_VISIBLE
. - Throws:
IllegalArgumentException
- if the argument is null- Since:
- 100.0.0
-
addDrawStatusChangedListener
public void addDrawStatusChangedListener(DrawStatusChangedListener listener)
Adds a draw status changed listener.This listener will be invoked on the UI thread if it is added from the UI thread, otherwise it is not guaranteed on which thread the listener is invoked.
- Parameters:
listener
- the listener- Throws:
NullPointerException
- if the argument is null- Since:
- 100.0.0
-
removeDrawStatusChangedListener
public boolean removeDrawStatusChangedListener(DrawStatusChangedListener listener)
Removes a draw status changed listener.- Parameters:
listener
- the listener- Returns:
- true if listener successfully removed, false otherwise
- Throws:
NullPointerException
- if the argument is null- Since:
- 100.0.0
-
addSpatialReferenceChangedListener
public void addSpatialReferenceChangedListener(SpatialReferenceChangedListener listener)
Adds a listener for changes to theSpatialReference
.This listener will be invoked on the UI thread if it is added from the UI thread, otherwise it is not guaranteed on which thread the listener is invoked.
- Parameters:
listener
- the listener- Throws:
NullPointerException
- if the argument is null- Since:
- 100.0.0
-
removeSpatialReferenceChangedListener
public boolean removeSpatialReferenceChangedListener(SpatialReferenceChangedListener listener)
Removes aSpatialReference
changed listener.- Parameters:
listener
- the listener- Returns:
- true, if successful
- Throws:
NullPointerException
- if the argument is null- Since:
- 100.0.0
-
addNavigationChangedListener
public void addNavigationChangedListener(NavigationChangedListener listener)
Adds a listener for when navigation has changed.This listener will be invoked on the UI thread if it is added from the UI thread, otherwise it is not guaranteed on which thread the listener is invoked.
- Parameters:
listener
- the listener- Throws:
NullPointerException
- if the listener is null- Since:
- 100.0.0
-
removeNavigationChangedListener
public boolean removeNavigationChangedListener(NavigationChangedListener listener)
Removes a navigation change listener.- Parameters:
listener
- the listener- Returns:
- true, if successful
- Throws:
NullPointerException
- if the listener is null- Since:
- 100.0.0
-
addLayerViewStateChangedListener
public void addLayerViewStateChangedListener(LayerViewStateChangedListener listener)
Adds a listener for changes to layer view state.This listener will be invoked on the UI thread if it is added from the UI thread, otherwise it is not guaranteed on which thread the listener is invoked.
- Parameters:
listener
- the listener- Throws:
NullPointerException
- if the argument is null- Since:
- 100.0.0
-
removeLayerViewStateChangedListener
public boolean removeLayerViewStateChangedListener(LayerViewStateChangedListener listener)
Removes a layer view state listener.- Parameters:
listener
- the listener- Returns:
- true, if successful
- Throws:
NullPointerException
- if the argument is null- Since:
- 100.0.0
-
addViewpointChangedListener
public void addViewpointChangedListener(ViewpointChangedListener listener)
Adds a ViewpointChangedListener.This listener will fire when the Viewpoint of this GeoView has changed.
This listener will be invoked on the UI thread if it is added from the UI thread, otherwise it is not guaranteed on which thread the listener is invoked.
- Parameters:
listener
- the ViewpointChangedListener to add- Throws:
IllegalArgumentException
- if listener is null- Since:
- 100.0.0
- See Also:
removeViewpointChangedListener(com.esri.arcgisruntime.mapping.view.ViewpointChangedListener)
-
removeViewpointChangedListener
public boolean removeViewpointChangedListener(ViewpointChangedListener listener)
Removes a ViewpointChangedListener.- Parameters:
listener
- the ViewpointChangedListener to remove- Returns:
- true, if successful
- Since:
- 100.0.0
- See Also:
addViewpointChangedListener(com.esri.arcgisruntime.mapping.view.ViewpointChangedListener)
-
isResizable
public boolean isResizable()
- Overrides:
isResizable
in classControl
-
getGraphicsOverlays
public ListenableList<GraphicsOverlay> getGraphicsOverlays()
Gets a modifiable list of the graphics overlays. Add or remove graphics overlays from this list to modify what is displayed. The list returned can be empty but not null. You can add listeners to this list to monitor changes to the list. A graphics overlay can only be in the list once.- Returns:
- the graphics overlays
- Since:
- 100.0.0
-
identifyGraphicsOverlayAsync
public ListenableFuture<IdentifyGraphicsOverlayResult> identifyGraphicsOverlayAsync(GraphicsOverlay graphicsOverlay, Point2D screenPoint, double tolerance, boolean returnPopupsOnly, int maximumResults)
Asynchronously identifies visible graphics in the given graphics overlay, near the given JavaFX local coordinate system point.As locations from user gestures are not always accurate to the exact pixel, a tolerance for the identify can be defined. The tolerance parameter indicates the radius of a circle, centered at screenPoint. The result returned will include any visible graphics, when rendered with the appropriate symbols, that intersect this circle, up to the maximumResults parameter limit.
The
return_popups_only
parameter controls whether popups and graphics are available in theIdentifyGraphicsOverlayResult
returned by this method. Specifically, the parameter controls whetherIdentifyGraphicsOverlayResult.getPopups()
andIdentifyGraphicsOverlayResult.getGraphics()
return lists that are populated or empty:- true - only
getPopups()
will return a populated list, whereasgetGraphics()
will return an empty list. - false -
getGraphics()
andgetPopups()
will return populated lists (unless the overlay has no popups, in which casegetPopups()
returns an empty list).
- Parameters:
graphicsOverlay
- the graphics overlay to identify graphics withinscreenPoint
- the JavaFX local coordinates at which to identify graphicstolerance
- The radius, of a circle centered at the screenPoint within which to identify graphics. A value of 0 will only identify graphics at the screenPoint's physical pixel. The maximum allowed value is 100 density independent pixels, resulting in an identify circle of diameter 200 density independent pixels.returnPopupsOnly
- true to identify Popups only, false to identify Graphics as wellmaximumResults
- the maximum number of graphics to identify in the given overlay. Must be greater than zero with the exception that -1 can be used to indicate unlimited results. Limits size of list returned byIdentifyGraphicsOverlayResult.getGraphics
.- Returns:
- a ListenableFuture for tracking when the operation is done and getting the result;
Add a listener to the future to be notified when the identify operation is complete.
The result of the future is an
IdentifyGraphicsOverlayResult()
object if the operation completed successfully. - Throws:
ArcGISRuntimeException
- if screenPoint translates to a point outside the current viewpoint set to the GeoViewIllegalArgumentException
- if- graphicsOverlay is null
- screenPoint is null
- tolerance less than zero or greater than 100
- maximumResults is zero or less than -1
- Since:
- 100.0.0
- true - only
-
identifyGraphicsOverlayAsync
public ListenableFuture<IdentifyGraphicsOverlayResult> identifyGraphicsOverlayAsync(GraphicsOverlay graphicsOverlay, Point2D screenPoint, double tolerance, boolean returnPopupsOnly)
Asynchronously identifies the topmost visible graphic in the given graphics overlay, near given JavaFX local coordinate system point.As locations from user gestures are not always accurate to the exact pixel, a tolerance for the identify can be defined. The tolerance parameter indicates the radius of a circle, centered at
screenPoint
. The result returned will include the topmost visible graphic, when rendered with the appropriate symbol, that intersects this circle.The
return_popups_only
parameter controls whether popups and graphics are available in theIdentifyGraphicsOverlayResult
returned by this method. Specifically, the parameter controls whetherIdentifyGraphicsOverlayResult.getPopups()
andIdentifyGraphicsOverlayResult.getGraphics()
return lists that are populated or empty:- true - only
getPopups()
will return a populated list, whereasgetGraphics()
will return an empty list. - false -
getGraphics()
andgetPopups()
will return populated lists (unless the overlay has no popups, in which casegetPopups()
returns an empty list).
- Parameters:
graphicsOverlay
- the graphics overlay to identify a graphic withinscreenPoint
- the JavaFX local coordinates at which to identify a graphictolerance
- The radius, of a circle centered at the screenPoint within which to identify a graphic. A value of 0 will only identify a graphic at thescreenPoint
's physical pixel. The maximum allowed value is 100 density independent pixels, resulting in an identify circle of diameter 200 density independent pixels.returnPopupsOnly
- true to identify Popups only; false to identify Graphics as well.- Returns:
- a ListenableFuture for tracking when the operation is done and getting the result;
Add a listener to the future to be notified when the identify operation is complete.
The result of the future is an
IdentifyGraphicsOverlayResult
object if the operation completed successfully. - Throws:
ArcGISRuntimeException
- if screenPoint translates to a point outside the current viewpoint set to the GeoViewIllegalArgumentException
- if- graphicsOverlay is null
- screenPoint is null
- tolerance less than zero or greater than 100
- Since:
- 100.0.0
- true - only
-
identifyGraphicsOverlaysAsync
public ListenableFuture<List<IdentifyGraphicsOverlayResult>> identifyGraphicsOverlaysAsync(Point2D screenPoint, double tolerance, boolean returnPopupsOnly, int maximumResults)
Asynchronously identifies visible graphics in all graphics overlays attached to this view near a JavaFX local coordinate system point.As locations from user gestures are not always accurate to the exact pixel, a tolerance for the identify can be defined. The tolerance parameter indicates the radius of a circle, centered at screenPoint. The result returned will include any visible graphics, when rendered with the appropriate symbols, that intersect this circle, up to the maximumResults parameter limit for each graphics overlay.
The
return_popups_only
parameter controls whether popups and graphics are available in theIdentifyGraphicsOverlayResult
instances returned by this method. Specifically, the parameter controls whetherIdentifyGraphicsOverlayResult.getPopups()
andIdentifyGraphicsOverlayResult.getGraphics()
return lists that are populated or empty:- true - The
identifyGraphicsOverlaysAsync()
method will omit from its returned list all overlays that have no popups; and for each result that does have popups,IdentifyGraphicsOverlayResult.getPopups()
will return a populated list. The getterIdentifyGraphicsOverlayResult.getGraphics()
will return an empty list. - false -
IdentifyGraphicsOverlayResult.getGraphics()
will return a populated list of graphics for each overlay. AndIdentifyGraphicsOverlayResult.getPopups()
will return a populated list of popups (unless the overlay has no popups, in which casegetPopups()
returns an empty list).
- Parameters:
screenPoint
- the JavaFX local coordinates at which to identify graphicstolerance
- The radius, of a circle centered at the screenPoint within which to identify graphics. A value of 0 will only identify the graphics at the screenPoint's physical pixel. The maximum allowed value is 100 density independent pixels, resulting in an identify circle of diameter 200 density independent pixels.returnPopupsOnly
- true to identify Popups only, false to identify Graphics as wellmaximumResults
- the maximum number of graphics to identify per overlay; must be greater than zero with the exception that -1 can be used to indicate unlimited results. Limits size of list returned byIdentifyGraphicsOverlayResult.getGraphics()
.- Returns:
- a ListenableFuture for tracking when the operation is done and getting the result;
Add a listener to the future to be notified when the identify operation is complete.
The result of the future is a list of
IdentifyGraphicsOverlayResult
objects if the operation completed successfully. Results are returned in top-to-bottom order. - Throws:
ArcGISRuntimeException
- if screenPoint translates to a point outside the current viewpoint set to the GeoViewIllegalArgumentException
- if- screenPoint is null
- tolerance less than zero or greater than 100
- maximumResults is zero or less than -1
- Since:
- 100.0.0
- true - The
-
identifyGraphicsOverlaysAsync
public ListenableFuture<List<IdentifyGraphicsOverlayResult>> identifyGraphicsOverlaysAsync(Point2D screenPoint, double tolerance, boolean returnPopupsOnly)
Asynchronously identifies the topmost visible graphic in each graphics overlay attached to this view, near the given JavaFX local coordinate system point.As locations from user gestures are not always accurate to the exact pixel, a tolerance for the identify can be defined. The tolerance parameter indicates the radius of a circle, centered at screenPoint. The result returned will include the topmost visible graphic, when rendered with the appropriate symbol, from each graphics overlay that intersects this circle.
The
return_popups_only
parameter controls whether popups and graphics are available in theIdentifyGraphicsOverlayResult
instances returned by this method. Specifically, the parameter controls whetherIdentifyGraphicsOverlayResult.getPopups()
andIdentifyGraphicsOverlayResult.getGraphics()
return lists that are populated or empty:- true - The
identifyGraphicsOverlaysAsync()
method will omit from its returned list all overlays that have no popups; and for each overlay that does have popups,IdentifyGraphicsOverlayResult.getPopups()
will return a populated list. The getterIdentifyGraphicsOverlayResult.getGraphics()
will return an empty list. - false -
IdentifyGraphicsOverlayResult.getGraphics()
will return a populated list of graphics for each overlay. AndIdentifyGraphicsOverlayResult.getPopups()
will return a populated list of popups (unless the overlay has no popups, in which casegetPopups()
returns an empty list).
- Parameters:
screenPoint
- the JavaFX local coordinates at which to identify graphicstolerance
- The radius, of a circle centered at the screenPoint within which to identify graphics. A value of 0 will only identify the graphics at the screenPoint's physical pixel. The maximum allowed value is 100 density independent pixels, resulting in an identify circle of 200 density independent pixels.returnPopupsOnly
- true to identify Popups only, false to identify Graphics as well- Returns:
- a ListenableFuture for tracking when the operation is done and getting the result; Add a listener to the future to be notified when the identify operation is complete. The result of the future is a list of IdentifyGraphicsOverlayResult objects if the operation completed successfully. Results are returned in top-to-bottom order.
- Throws:
IllegalArgumentException
- if- screenPoint is null
- tolerance less than zero or greater than 100
ArcGISRuntimeException
- if screenPoint translates to a point outside the current viewpoint set to the GeoView- Since:
- 100.0.0
- true - The
-
identifyLayerAsync
public ListenableFuture<IdentifyLayerResult> identifyLayerAsync(Layer layer, Point2D screenPoint, double tolerance, boolean returnPopupsOnly)
Asynchronously identifies the topmost visible geoelement in the given layer, near the given JavaFX local coordinate system point.As locations from user gestures are not always accurate to the exact pixel, a tolerance for the identify can be defined. The tolerance parameter indicates the radius of a circle, centered at screenPoint. The result returned will include the topmost visible geoelement, when rendered with the appropriate symbol, that intersects this circle.
The
return_popups_only
parameter controls whether popups and geoelements are available in theIdentifyLayerResult
returned by this method. Specifically, the parameter controls whetherIdentifyLayerResult.getPopups()
andIdentifyLayerResult.getElements()
return lists that are populated or empty:- true - only
getPopups()
will return a populated list, whereasgetElements()
will return an empty list. - false -
getElements()
andgetPopups()
will return populated lists (unless the layer has no popups, in which casegetPopups()
returns an empty list).
- Parameters:
layer
- layer to identify a geoelement withinscreenPoint
- the JavaFX local coordinates to identify ontolerance
- The radius, of a circle centered at the screenPoint within which to identify a geoelement. A value of 0 will only identify a geoelement at the screenPoint's physical pixel. The maximum allowed value 100 density independent pixels, resulting in an identify circle of diameter 200 density independent pixels.returnPopupsOnly
- true to identify Popups only, false to identify GeoElements as well- Returns:
- a ListenableFuture that provides an IdentifyLayerResult upon successful completion of the async operation. Add a listener to the future to be notified when the identify operation is complete.
- Throws:
ArcGISRuntimeException
- if screenPoint translates to a point outside the current viewpoint set to the GeoViewIllegalArgumentException
- if- layer is null
- screenPoint is null
- tolerance less than zero or greater than 100
- Since:
- 100.0.0
- See Also:
IdentifyLayerResult
- true - only
-
identifyLayerAsync
public ListenableFuture<IdentifyLayerResult> identifyLayerAsync(Layer layer, Point2D screenPoint, double tolerance, boolean returnPopupsOnly, int maximumResults)
Asynchronously identifies geoelements in the given layer, near the given JavaFX local coordinate system point.As locations from user gestures are not always accurate to the exact pixel, a tolerance for the identify can be defined. The tolerance parameter indicates the radius of a circle, centered at screenPoint. The result returned will include any visible geoelement, when rendered with the appropriate symbol, that intersects this circle, up to the maximumResults parameter limit.
The
return_popups_only
parameter controls whether popups and geoelements are available in theIdentifyLayerResult
returned by this method. Specifically, the parameter controls whetherIdentifyLayerResult.getPopups()
andIdentifyLayerResult.getElements()
return lists that are populated or empty:- true - only
getPopups()
will return a populated list, whereasgetElements()
will return an empty list. - false -
getElements()
andgetPopups()
will return populated lists (unless the layer has no popups, in which casegetPopups()
returns an empty list).
- Parameters:
layer
- layer to identify geoelements wtihinscreenPoint
- the JavaFX local coordinates to identify ontolerance
- The radius, of a circle centered at the screenPoint within which to identify geoelements. A value of 0 will only identify geoelements at the screenPoint's physical pixel. The maximum allowed value is 100 density independent pixels, resulting in an identify circle of diameter 200 density independent pixels.returnPopupsOnly
- true to identify Popups only, false to identify GeoElements as wellmaximumResults
- the maximum number of geoelements to identify in the layer; must be greater than zero with the exception that -1 can be used to indicate unlimited results. Limits the size of list returned byIdentifyLayerResult.getElements()
.- Returns:
- A ListenableFuture that provides an IdentifyLayerResult upon successful completion of the async operation.
- Throws:
ArcGISRuntimeException
- if screenPoint translates to a point outside the current viewpoint set to the GeoViewIllegalArgumentException
- if- layer is null
- screenPoint is null
- tolerance less than zero or greater than 100
- maximumResults is zero or less than -1
- Since:
- 100.0.0
- See Also:
IdentifyLayerResult
- true - only
-
identifyLayersAsync
public ListenableFuture<List<IdentifyLayerResult>> identifyLayersAsync(Point2D screenPoint, double tolerance, boolean returnPopupsOnly)
Asynchronously identifies the topmost visible geoelement in each identifiable layer attached to the map, near the given JavaFX local coordinate system point.As locations from user gestures are not always accurate to the exact pixel, a tolerance for the identify can be defined. The tolerance parameter indicates the radius of a circle, centered at screenPoint. The result returned will include the topmost visible geoelement, when rendered with the appropriate symbol, that intersects this circle from each identifiable layer.
The
return_popups_only
parameter controls whether popups and geoelements are available in theIdentifyLayerResult
instances returned by this method. Specifically, the parameter controls whetherIdentifyLayerResult.getPopups()
andIdentifyLayerResult.getElements()
return lists that are populated or empty:- true - The
identifyLayersAsync()
method will omit from its returned list all layers that have no popups; and for each layer that does have popups,IdentifyLayerResult.getPopups()
will return a populated list. The getterIdentifyLayerResult.getElements()
will return an empty list. - false -
IdentifyLayerResult.getElements()
will return a populated list of geoelements for each layer. AndIdentifyLayerResult.getPopups()
will return a populated list of popups (unless the layer has no popups, in which casegetPopups()
returns an empty list).
- Parameters:
screenPoint
- the JavaFX local coordinates to identify ontolerance
- The radius, of a circle centered at the screenPoint within which to identify geoelements. A value of 0 will only identify geoelements at the screenPoint's physical pixel. The maximum allowed value is 100 density independent pixels, resulting in an identify circle of diameter 200 density independent pixels.returnPopupsOnly
- true to identify Popups only, false to identify GeoElements as well- Returns:
- A ListenableFuture that provides an unmodifiable list of IdentifyLayerResults upon successful completion of the async operation. The list contains an IdentifyLayerResult for each layer in which a geoelement was identified; layers with no identified geoelement are not represented in the list. Results are returned in top-to-bottom order.
- Throws:
IllegalArgumentException
- if- screenPoint is null
- tolerance less than zero or greater than 100
ArcGISRuntimeException
- if screenPoint translates to a point outside the current viewpoint set to the GeoView- Since:
- 100.0.0
- See Also:
IdentifyLayerResult
,IdentifyLayerResult.getSublayerResults()
- true - The
-
identifyLayersAsync
public ListenableFuture<List<IdentifyLayerResult>> identifyLayersAsync(Point2D screenPoint, double tolerance, boolean returnPopupsOnly, int maximumResults)
Asynchronously identifies geoelements on all identifiable layers attached to the map, near the given JavaFX local coordinate system point.As locations from user gestures are not always accurate to the exact pixel, a tolerance for the identify can be defined. The tolerance parameter indicates the radius of a circle, centered at screenPoint. The result returned will include any visible geoelements, when rendered with the appropriate symbol, that intersect this circle, up to the maximumResults parameter limit per identifiable layer.
The
return_popups_only
parameter controls whether popups and geoelements are available in theIdentifyLayerResult
instances returned by this method. Specifically, the parameter controls whetherIdentifyLayerResult.getPopups()
andIdentifyLayerResult.getElements()
return lists that are populated or empty:- true - The
identifyLayersAsync()
method will omit from its returned list all layers that have no popups; and for each layer that does have popups,IdentifyLayerResult.getPopups()
will return a populated list. The getterIdentifyLayerResult.getElements()
will return an empty list. - false -
IdentifyLayerResult.getElements()
will return a populated list of geoelements for each layer. AndIdentifyLayerResult.getPopups()
will return a populated list of popups (unless the layer has no popups, in which casegetPopups()
returns an empty list).
- Parameters:
screenPoint
- the JavaFX local coordinates to identify ontolerance
- The radius, of a circle centered at the screenPoint within which to identify geoelements. A value of 0 will only identify geoelements at the screenPoint's physical pixel. The maximum allowed value is 100 density independent pixels, resulting in an identify circle of diameter 200 density independent pixels.returnPopupsOnly
- true to identify Popups only, false to identify GeoElements as wellmaximumResults
- the maximum number of geoelements to identify per layer; must be greater than zero with the exception that -1 can be used to indicate unlimited results. Limits the size of list returned byIdentifyLayerResult.getElements()
.- Returns:
- A ListenableFuture that provides an unmodifiable list of IdentifyLayerResults upon successful completion of the asynchronous operation. The list contains an IdentifyLayerResult for each layer in which a geoelement was identified; layers with no identified geoelement are not represented in the list. Results are returned in top-to-bottom order.
- Throws:
ArcGISRuntimeException
- if screenPoint translates to a point outside the current viewpoint set to the GeoViewIllegalArgumentException
- if- screenPoint is null
- tolerance is less than one or greater than 100
- maximumResults is zero or less than -1
- Since:
- 100.0.0
- See Also:
IdentifyLayerResult
- true - The
-
exportImageAsync
public ListenableFuture<Image> exportImageAsync()
Asynchronously exports the GeoView into an Image. The Image will only contain content of an ArcGISMap or ArcGISScene that is currently visible. Elements drawn on top of the GeoView such asCallout
s will not be in the Image.- Returns:
- a ListenableFuture that provides an Image of GeoView upon successful completion of the asynchronous operation.
- Since:
- 100.0.0
-
setTimeExtent
public void setTimeExtent(TimeExtent timeExtent)
Sets the time extent of the GeoView. The Time Extent of the GeoView defines how time-enabled data is displayed. Time filtering is applied by participating layers. See theTimeAware
interface for details. Time filtering is not enabled until a non-null time extent is set on the GeoView. When the time extent is null on the GeoView, no time filtering is applied and all content is rendered.- Parameters:
timeExtent
- the time extent- Since:
- 100.3.0
- See Also:
getTimeExtent()
-
getTimeExtent
public TimeExtent getTimeExtent()
Gets the current time extent.- Returns:
- the time extent, or null if no time extent is set
- Since:
- 100.3.0
- See Also:
setTimeExtent(TimeExtent)
-
getSelectionProperties
public SelectionProperties getSelectionProperties()
Returns the selection properties that are applied to a GeoView.- Returns:
- the selection properties
- Since:
- 100.4.0
-
enableMouseZoomProperty
public BooleanProperty enableMouseZoomProperty()
If true mouse wheel zooming is enabled.- Returns:
- property for controlling mouse wheel zooming
- See Also:
isEnableMouseZoom()
,setEnableMouseZoom(boolean)
-
setEnableMouseZoom
public void setEnableMouseZoom(boolean enable)
Enables or disables mouse wheel zooming.- Parameters:
enable
- true to enable mouse wheel zoom
-
isEnableMouseZoom
public boolean isEnableMouseZoom()
Returns true if mouse wheel zoom is enabled, otherwise false.- Returns:
- true if enabled
-
enableMousePanProperty
public BooleanProperty enableMousePanProperty()
If true mouse panning is enabled.- Returns:
- property for controlling mouse panning
- See Also:
isEnableMousePan()
,setEnableMousePan(boolean)
-
setEnableMousePan
public void setEnableMousePan(boolean enable)
Enables or disables mouse panning.- Parameters:
enable
- true to enable mouse panning
-
isEnableMousePan
public boolean isEnableMousePan()
Returns true if mouse pan is enabled, otherwise false.- Returns:
- true, if mouse panning is enabled
-
enableKeyboardNavigationProperty
public BooleanProperty enableKeyboardNavigationProperty()
If true keyboard navigation is enabled.- Returns:
- property for controlling keyboard navigation
- See Also:
isEnableKeyboardNavigation()
,setEnableKeyboardNavigation(boolean)
-
setEnableKeyboardNavigation
public void setEnableKeyboardNavigation(boolean enable)
Enables or disables keyboard navigation.- Parameters:
enable
- true to enable keyboard navigation
-
isEnableKeyboardNavigation
public boolean isEnableKeyboardNavigation()
Returns true if keyboard navigation is enabled, otherwise false.- Returns:
- true, if keyboard navigation is enabled
-
enableTouchPanProperty
public BooleanProperty enableTouchPanProperty()
If true touch panning is enabled.- Returns:
- property for controlling touch panning
- See Also:
isEnableTouchPan()
,setEnableTouchPan(boolean)
-
setEnableTouchPan
public void setEnableTouchPan(boolean enable)
Enables or disables touch panning.- Parameters:
enable
- true to enable touch panning
-
isEnableTouchPan
public boolean isEnableTouchPan()
Returns true if touch pan is enabled, otherwise false.- Returns:
- true, if touch panning is enabled
-
enableTouchZoomProperty
public BooleanProperty enableTouchZoomProperty()
If true touch zoom (pinch) is enabled.- Returns:
- property for controlling touch zooming
- See Also:
isEnableTouchZoom()
,setEnableTouchZoom(boolean)
-
setEnableTouchZoom
public void setEnableTouchZoom(boolean enable)
Enables or disables touch zoom (pinch).- Parameters:
enable
- true to enable touch zooming
-
isEnableTouchZoom
public boolean isEnableTouchZoom()
Returns true if touch zoom (pinch) is enabled, otherwise false.- Returns:
- true, if touch zoom is enabled
-
enableTouchRotateProperty
public BooleanProperty enableTouchRotateProperty()
If true touch rotate is enabled.- Returns:
- property for controlling touch rotation
- See Also:
isEnableTouchRotate()
,setEnableTouchRotate(boolean)
-
setEnableTouchRotate
public void setEnableTouchRotate(boolean enable)
Enables or disables touch rotate.- Parameters:
enable
- true to enable touch rotate
-
isEnableTouchRotate
public boolean isEnableTouchRotate()
Returns true if touch rotate is enabled, otherwise false.- Returns:
- true, if touch rotate is enabled
-
attributionTextVisibleProperty
public BooleanProperty attributionTextVisibleProperty()
If attribution text is visible.- Returns:
- property for controlling attribution text visibility
- Since:
- 100.0.0
- See Also:
isAttributionTextVisible()
,setAttributionTextVisible(boolean)
-
isAttributionTextVisible
public boolean isAttributionTextVisible()
Returns true if attribution text is visible, otherwise false.- Returns:
- true if the attribution text is visible
- Since:
- 100.0.0
- See Also:
setAttributionTextVisible(boolean)
-
setAttributionTextVisible
public void setAttributionTextVisible(boolean visible)
Sets the visibility of the Esri attribution text. The Esri attribution text must be visible if your app uses data served by Esri through ArcGIS Online.- Parameters:
visible
- true if the attribution text should be visible- Since:
- 100.0.0
- See Also:
isAttributionTextVisible()
-
addAttributionTextChangedListener
public void addAttributionTextChangedListener(AttributionTextChangedListener listener)
Registers an AttributionTextChangedListener to be called when the attribution text of the GeoView changes, for example if a layer is removed or added the attribution text needs to update.This listener will be invoked on the UI thread if it is added from the UI thread, otherwise it is not guaranteed on which thread the listener is invoked.
- Parameters:
listener
- the listener to register- Throws:
NullPointerException
- if the listener is null- Since:
- 100.1.0
- See Also:
removeAttributionTextChangedListener(AttributionTextChangedListener)
,getAttributionText()
-
removeAttributionTextChangedListener
public boolean removeAttributionTextChangedListener(AttributionTextChangedListener listener)
Unregisters an AttributionTextChangedListener that was previously added usingaddAttributionTextChangedListener(AttributionTextChangedListener)
.- Parameters:
listener
- the listener to remove- Returns:
- true if the listener was successfully removed; false otherwise
- Throws:
NullPointerException
- if the listener is null- Since:
- 100.1.0
-
addTimeExtentChangedListener
public void addTimeExtentChangedListener(TimeExtentChangedListener listener)
Registers aTimeExtentChangedListener
to be called when the time extent of the GeoView is changed.This listener will be invoked on the UI thread if it is added from the UI thread, otherwise it is not guaranteed on which thread the listener is invoked.
- Parameters:
listener
- the listener to register- Throws:
IllegalArgumentException
- if listener is null- Since:
- 100.10.0
-
removeTimeExtentChangedListener
public boolean removeTimeExtentChangedListener(TimeExtentChangedListener listener)
Unregisters aTimeExtentChangedListener
that was previously added usingaddTimeExtentChangedListener(TimeExtentChangedListener)
.- Parameters:
listener
- the listener to unregister- Returns:
- true if the listener was successfully removed; false otherwise
- Throws:
IllegalArgumentException
- if listener is null- Since:
- 100.10.0
-
getAttributionText
public String getAttributionText()
Gets a concatenated string with attributions from all layers. This returns an empty string if there is no attribution text.- Returns:
- a concatenated string with attributions from all layers; empty string if there is no attribution text
- Since:
- 100.1.0
-
getCallout
public final Callout getCallout()
Gets the Callout for this GeoView. A callout displays a Region that contains text and/or other content. A GeoView has only one Callout.- Returns:
- the Callout object for this GeoView
- Since:
- 100.1.0
-
setInteractionListener
public void setInteractionListener(InteractionListener interactionListener)
Sets the listener to handle input interactions on the GeoView.- Parameters:
interactionListener
- listener to handle input interactions on the GeoView- Throws:
IllegalArgumentException
- if the interactionListener is null- Since:
- 100.1.0
-
getInteractionListener
public InteractionListener getInteractionListener()
Gets the current interaction listener.- Returns:
- the current interaction listener
- Since:
- 100.1.0
-
setBookmarkAsync
public ListenableFuture<Boolean> setBookmarkAsync(Bookmark bookmark)
Asynchronously sets the bookmark, which consequently applies the viewpoint within the bookmark to the GeoView.- Parameters:
bookmark
- bookmark to set- Returns:
- a ListenableFuture. Add a listener to this to know when the operation is complete. The result of the future indicates whether the bookmark was set
- Throws:
IllegalArgumentException
- if bookmark is null- Since:
- 100.3.0
-
getLabeling
public ViewLabelProperties getLabeling()
Gets the view label properties.The view label properties are an overall control for whether labels will be created and displayed for layers added to the view. Individual layers can also control whether labels should be displayed for their features. Labels need to be enabled both in the view and in the layer. By default the labeling for a view is enabled. The view label properties also control global aspects of the label appearance, for example animation effects.
- Returns:
- the view label properties
- Since:
- 100.10.0
-
setLabeling
public void setLabeling(ViewLabelProperties viewLabelProperties)
Sets the view label properties.The view label properties are an overall control for whether labels will be created and displayed for layers added to the view. Individual layers can also control whether labels should be displayed for their features. Labels need to be enabled both in the view and in the layer. By default the labeling for a view is enabled. The view label properties also control global aspects of the label appearance, for example animation effects.
- Parameters:
viewLabelProperties
- the view label properties- Throws:
IllegalArgumentException
- if viewLabelProperties is null- Since:
- 100.10.0
-
dispose
public void dispose()
Dispose the GeoView- Since:
- 100.0.0
-
-