Class: Bookmark

Cadcorp.UI.Bookmark

new Bookmark(name, bounds, userCreated, isHomeLocationopt)

Instances of this class respresent named locations
Parameters:
Name Type Attributes Description
name string The name of this bookmark
bounds OpenLayers.Bounds The bounds for this bookmark
userCreated boolean True if the user has created this bookmark
isHomeLocation boolean <optional>
 True if this bookmark has been set as the home location

Members

bounds

Properties:
Name Type Description
bounds OpenLayers.Bounds The bounds for this bookmark

events

Properties:
Name Type Description
events Cadcorp.Util.Events The events object

events

Properties:
Name Type Description
events Cadcorp.Util.Events The events object

isHomeLocation

Properties:
Name Type Description
isHomeLocation boolean True if this bookmark has been set as the home location

name

Properties:
Name Type Description
name string The name of this bookmark

userCreated

Properties:
Name Type Description
userCreated boolean True if the user has created this bookmark

Methods

destroy()

Destroys this bookmark

setIsHomeLocation(isHomeLocation)

Sets the home location property
Parameters:
Name Type Description
isHomeLocation boolean True if this is the home location, otherwise false
Fires:

toCookieObject() → {Cadcorp.UI.SerialisableBookmark}

Gets a simple object that can be serialised into a cookie
Returns:
Type
Cadcorp.UI.SerialisableBookmark

Events

isHomeLocationChanged

Open event
Type:
  • Object
Properties:
Name Type Description
object Cadcorp.UI.Bookmark The sender of the event