Skip to main content

BaseOverlayImage

Abstract class for image overlays displayed through OverlayImageLayer.

The following overlay image types are available:

Inherits: BaseControl

Properties

  • filter_quality - The rendering quality of the image.
  • gapless_playback - Whether to continue showing the old image (True), or briefly show nothing (False), when the image provider changes.
  • opacity - The opacity in which the image should get rendered on the map.
  • src - The image source.

Properties​

filter_qualityclass-attributeinstance-attribute​

filter_quality: FilterQuality = FilterQuality.MEDIUM

The rendering quality of the image.

gapless_playbackclass-attributeinstance-attribute​

gapless_playback: bool = False

Whether to continue showing the old image (True), or briefly show nothing (False), when the image provider changes.

opacityclass-attributeinstance-attribute​

opacity: Annotated[Number, V.between(0.0, 1.0)] = 1.0

The opacity in which the image should get rendered on the map.

Raises:

  • ValueError - If it is not between 0.0 and 1.0, inclusive.

srcinstance-attribute​

src: Union[str, bytes]

The image source.

It can be one of the following:

  • A URL or local asset file path;
  • A base64 string;
  • Raw bytes.