Overlay

class Overlay
property id

The id of the overlay.

Type

str, read-only

property name

The name of the overlay.

Type

str

Raises

ReadOnlyError -- If Database is in read only mode.

property group

The group of the overlay.

Type

OverlayGroup

Raises

ReadOnlyError -- If Database is in read only mode.

property alpha

The transparency of the overlay.

Type

float

Raises
list_layers()

List the layers of this overlay, in bottom to top order.

Returns

The list of layers in the overlay.

Return type

list(OverlayLayer)

duplicate()

Duplicate this overlay.

Returns

The duplicated overlay.

Return type

Overlay

Raises

ReadOnlyError -- If Database is in read only mode.

remove(force = False)

Delete this overlay

Note

By default, only not used overlay can be deleted (InUseError is raised otherwise), use force to force deletion of used overlays.

Parameters

force (bool) -- Force the deletion of the overlay even if it is in use.

Raises
create_layer(name)

Create a new layer.

Parameters

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

Returns

The newly created layer.

Return type

OverlayLayer

Raises

ReadOnlyError -- If Database is in read only mode.

OverlayLayer

class OverlayLayer
property id

The id of the layer.

Type

str, read-only

property name

The name of the layer.

Type

str

Raises

ReadOnlyError -- If Database is in read only mode.

property overlay

The overlay containing the layer.

Type

Overlay, read-only

property index

The index of this layer in the layer list.

Type

int

Raises

ReadOnlyError -- If Database is in read only mode.

property visible

Whether the layer is visible.

Type

bool

Raises

ReadOnlyError -- If Database is in read only mode.

property configured

Whether the layer is used in configuration.

Type

bool, read-only

duplicate()

Duplicate this layer.

Returns

The duplicated layer.

Return type

OverlayLayer

Raises

ReadOnlyError -- If Database is in read only mode.

remove()

Delete this layer.

Raises

ReadOnlyError -- If Database is in read only mode.