Class: QgsBookmark

Represents a spatial bookmark, with a name, CRS and extent.

QgsBookmark objects are typically used alongside the QgsBookmarkManager class, which handles storage of a set of bookmarks.

Added in version 3.10.

Methods

extent

Returns the bookmark's spatial extent.

group

Returns the bookmark's group, which is a user-visible string identifying the bookmark's category.

id

Returns the bookmark's unique ID.

name

Returns the bookmark's name, which is a user-visible string identifying the bookmark.

rotation

Returns the bookmark's map rotation.

setExtent

Sets the bookmark's spatial extent.

setGroup

Sets the bookmark's group, which is a user-visible string identifying the bookmark's category.

setId

Sets the bookmark's unique id.

setName

Sets the bookmark's name, which is a user-visible string identifying the bookmark.

setRotation

Sets the bookmark's spatial map rotation.

writeXml

Returns a DOM element representing the bookmark's properties.

Static Methods

fromXml

Creates a bookmark using the properties from a DOM element.
class qgis.core.QgsBookmark[source]

Bases: object

__init__()

Default constructor, creates an empty bookmark.

__init__(a0: QgsBookmark)
Parameters:

a0 (QgsBookmark)

extent(self) → QgsReferencedRectangle[source]

Returns the bookmark’s spatial extent.

See also

setExtent()

Return type:

QgsReferencedRectangle

static fromXml(element: QDomElement, doc: QDomDocument) → QgsBookmark[source]

Creates a bookmark using the properties from a DOM element.

See also

writeXml()

Parameters:

  • element (QDomElement)

  • doc (QDomDocument)

Return type:

QgsBookmark

group(self) → str[source]

Returns the bookmark’s group, which is a user-visible string identifying the bookmark’s category.

See also

setGroup()

Return type:

str

id(self) → str[source]

Returns the bookmark’s unique ID.

See also

setId()

Return type:

str

name(self) → str[source]

Returns the bookmark’s name, which is a user-visible string identifying the bookmark.

See also

setName()

Return type:

str

rotation(self) → float[source]

Returns the bookmark’s map rotation.

See also

setRotation()

Added in version 3.32.

Return type:

float

setExtent(self, extent: QgsReferencedRectangle)[source]

Sets the bookmark’s spatial extent.

See also

extent()

Parameters:

extent (QgsReferencedRectangle)

setGroup(self, group: str | None)[source]

Sets the bookmark’s group, which is a user-visible string identifying the bookmark’s category.

See also

group()

Parameters:

group (Optional[str])

setId(self, id: str | None)[source]

Sets the bookmark’s unique id.

See also

id()

Parameters:

id (Optional[str])

setName(self, name: str | None)[source]

Sets the bookmark’s name, which is a user-visible string identifying the bookmark.

See also

name()

Parameters:

name (Optional[str])

setRotation(self, rotation: float)[source]

Sets the bookmark’s spatial map rotation.

See also

rotation()

Added in version 3.32.

Parameters:

rotation (float)

writeXml(self, doc: QDomDocument) → QDomElement[source]

Returns a DOM element representing the bookmark’s properties.

See also

fromXml()

Parameters:

doc (QDomDocument)

Return type:

QDomElement