OverlayGroup

class OverlayGroup

property id

The id of the group.

Type

str, read-only

property name

The name of the group.

Type

str

Raises

ReadOnlyError -- If Database is in read only mode.

list_overlays()

List the overlays of this group.

Returns

The list of overlays in the group.

Return type

list(Overlay)

duplicate()

Duplicate this overlay group.

Returns

The duplicated group.

Return type

OverlayGroup

Raises

ReadOnlyError -- If Database is in read only mode.

remove(force = False)

Delete a overlay group

Note

By default, only empty groups can be deleted (NotEmptyError is raised otherwise), use force to force deletion of non empty groups.

Parameters

force (bool) -- Force the deletion of the group even if it contains overlays.

Raises

• NotEmptyError -- If force is False and the group contains overlays.

• ReadOnlyError -- If Database is in read only mode.

create_overlay(name)

Create a new overlay.

Parameters

name (str) -- The name of the new overlay.

Returns

The newly created overlay.

Return type

Overlay

Raises

ReadOnlyError -- If Database is in read only mode.