Interface PopupSource
-
- All Known Implementing Classes:
ArcGISFeatureTable
,ArcGISMapImageSublayer
,ArcGISSublayer
,ArcGISTiledSublayer
,FeatureCollectionTable
,FeatureLayer
,FeatureTable
,GeodatabaseFeatureTable
,GeoPackageFeatureTable
,GraphicsOverlay
,OgcFeatureCollectionTable
,ServiceFeatureTable
,ShapefileFeatureTable
,SubtypeFeatureLayer
,SubtypeSublayer
,WfsFeatureTable
public interface PopupSource
An interface to classes that support pop-up and have a PopupDefinition. It is implemented byFeatureLayer
,RasterLayer
,ArcGISSublayer
, andGraphicsOverlay
.You can configure many different types of layers, and also GraphicsOverlays, to use pop-ups that show information about the associated GeoElements. Pop-ups are typically used when a user clicks or taps on a GeoElement, or in response to a search or analysis operation.
The configured
Popup
can be shown within a UI component as required. To use pop-ups, the PopupSource must be enabled (isPopupEnabled()
returns true) and also have a PopupDefinition (getPopupDefinition()
) that is not null. For example, the identify methods onGeoview
can only return popups if the identified PopupSource satisfies both of these conditions.- Since:
- 100.0.0
- See Also:
Popup
,PopupDefinition
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description PopupDefinition
getPopupDefinition()
Gets the PopupDefinition that is currently defined or set on the entity.boolean
isPopupEnabled()
Checks if the pop-up definition returned fromgetPopupDefinition()
is enabled or disabled.void
setPopupDefinition(PopupDefinition popupDefinition)
Sets a new PopupDefinition on the entity, overriding any previously existing one.void
setPopupEnabled(boolean enabled)
Sets whether the pop-up definition returned fromgetPopupDefinition()
is enabled or disabled.
-
-
-
Method Detail
-
getPopupDefinition
PopupDefinition getPopupDefinition()
Gets the PopupDefinition that is currently defined or set on the entity.- Returns:
- the current PopupDefinition. Will return null if an error occurs or if the pop-up source is not associated with a pop-up definition.
- Since:
- 100.0.0
- See Also:
setPopupDefinition(PopupDefinition)
-
setPopupDefinition
void setPopupDefinition(PopupDefinition popupDefinition)
Sets a new PopupDefinition on the entity, overriding any previously existing one.- Parameters:
popupDefinition
- the PopupDefinition to set- Since:
- 100.0.0
- See Also:
getPopupDefinition()
-
isPopupEnabled
boolean isPopupEnabled()
Checks if the pop-up definition returned fromgetPopupDefinition()
is enabled or disabled.- Returns:
- true if the pop-up definition is enabled; false otherwise. Will return false if an error occurs.
- Since:
- 100.0.0
- See Also:
setPopupEnabled(boolean)
-
setPopupEnabled
void setPopupEnabled(boolean enabled)
Sets whether the pop-up definition returned fromgetPopupDefinition()
is enabled or disabled.- Parameters:
enabled
- true to enable the PopupDefinition; false otherwise- Since:
- 100.0.0
- See Also:
isPopupEnabled()
-
-