java.lang.Object
com.esri.arcgisruntime.mapping.Bookmark
A spatial bookmark that identifies a particular geographic location and time on an ArcGISMap.
Bookmarks can be added to or removed from an ArcGISMap via the BookmarkList.
- Since:
- 100.0.0
- See Also:
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptioncopy()
Creates a copy of this Bookmark instance.getName()
Gets the name of this Bookmark.Gets the geographic location of this Bookmark.void
Sets the name of this Bookmark.void
setViewpoint
(Viewpoint viewpoint) Sets the geographic location of this Bookmark.
-
Constructor Details
-
Bookmark
public Bookmark()Creates an empty Bookmark instance.- Since:
- 100.0.0
-
Bookmark
Creates a Bookmark instance with a name and a geographic location.- Parameters:
name
- the name of the Bookmarkviewpoint
- the geographic location of the Bookmark- Throws:
IllegalArgumentException
- if the specified viewpoint is null- Since:
- 100.0.0
-
-
Method Details
-
getViewpoint
Gets the geographic location of this Bookmark.- Returns:
- the geographic location of this Bookmark
- Since:
- 100.0.0
-
setViewpoint
Sets the geographic location of this Bookmark.- Parameters:
viewpoint
- the geographic location of this Bookmark. The spatial reference of this location has to match the spatial reference of the ArcGISMap it is added to, otherwise it will represent an invalid location.- Since:
- 100.0.0
-
getName
Gets the name of this Bookmark.- Returns:
- the name of this Bookmark
- Since:
- 100.0.0
-
setName
Sets the name of this Bookmark.- Parameters:
name
- the name of this Bookmark- Since:
- 100.0.0
-
copy
Creates a copy of this Bookmark instance.- Returns:
- a deep copy of this Bookmark instance, which means that copies of all fields of this Bookmark are made as well and no state is shared between the two instances
- Since:
- 100.0.0
-