Class Bookmark


  • public final class Bookmark
    extends java.lang.Object
    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:
    ArcGISMap.getBookmarks(), BookmarkList
    • Constructor Summary

      Constructors 
      Constructor Description
      Bookmark()
      Creates an empty Bookmark instance.
      Bookmark​(java.lang.String name, Viewpoint viewpoint)
      Creates a Bookmark instance with a name and a geographic location.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Bookmark copy()
      Creates a copy of this Bookmark instance.
      java.lang.String getName()
      Gets the name of this Bookmark.
      Viewpoint getViewpoint()
      Gets the geographic location of this Bookmark.
      void setName​(java.lang.String name)
      Sets the name of this Bookmark.
      void setViewpoint​(Viewpoint viewpoint)
      Sets the geographic location of this Bookmark.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • Bookmark

        public Bookmark()
        Creates an empty Bookmark instance.
        Since:
        100.0.0
      • Bookmark

        public Bookmark​(java.lang.String name,
                        Viewpoint viewpoint)
        Creates a Bookmark instance with a name and a geographic location.
        Parameters:
        name - the name of the Bookmark
        viewpoint - the geographic location of the Bookmark
        Throws:
        java.lang.IllegalArgumentException - if the specified viewpoint is null
        Since:
        100.0.0
    • Method Detail

      • getViewpoint

        public Viewpoint getViewpoint()
        Gets the geographic location of this Bookmark.
        Returns:
        the geographic location of this Bookmark
        Since:
        100.0.0
      • setViewpoint

        public void setViewpoint​(Viewpoint viewpoint)
        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

        public java.lang.String getName()
        Gets the name of this Bookmark.
        Returns:
        the name of this Bookmark
        Since:
        100.0.0
      • setName

        public void setName​(java.lang.String name)
        Sets the name of this Bookmark.
        Parameters:
        name - the name of this Bookmark
        Since:
        100.0.0
      • copy

        public Bookmark 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