Image Registry topic

Classes

ImageDescriptor Image Registry
Defines an image. For marker this class can be used to set the image of the marker icon.
ImageDescriptor Image Registry
Defines an image. For marker this class can be used to set the image of the marker icon.
ImageDescriptor Image Registry
Defines an image. For marker this class can be used to set the image of the marker icon.

Functions

clearRegisteredImages() Future<void> Image Registry
Remove all registered bitmaps from image registry.
clearRegisteredImages() Future<void> Image Registry
Remove all registered bitmaps from image registry.
getRegisteredImages() Future<List<ImageDescriptor>> Image Registry
Get all registered bitmaps from image registry.
getRegisteredImages() Future<List<ImageDescriptor>> Image Registry
Get all registered bitmaps from image registry.
registerBitmapImage({required ByteData bitmap, double imagePixelRatio = 1.0, double? width, double? height}) Future<ImageDescriptor> Image Registry
Register bitmap image to image registry. Returns ImageDescriptor that can be used to reference the bitmap when creating MarkerOptions. bitmap is the bytes of bitmap to be registered, in PNG format. Set imagePixelRatio if bitmap is larger tha it's intended display size. For example, if image width is 64 pixels and it need's to be displayed in 32 logical pixel size, set imagePixelRatio to 2. Optionally specify wanted logical pixel size with width or height. If only width or height is specified the other dimension is scaled according to the aspect ratio of the bitmap.
registerBitmapImage({required ByteData bitmap, double imagePixelRatio = 1.0, double? width, double? height}) Future<ImageDescriptor> Image Registry
Register bitmap image to image registry. Returns ImageDescriptor that can be used to reference the bitmap when creating MarkerOptions. bitmap is the bytes of bitmap to be registered, in PNG format. Set imagePixelRatio if bitmap is larger tha it's intended display size. For example, if image width is 64 pixels and it need's to be displayed in 32 logical pixel size, set imagePixelRatio to 2. Optionally specify wanted logical pixel size with width or height. If only width or height is specified the other dimension is scaled according to the aspect ratio of the bitmap.
unregisterImage(ImageDescriptor imageDescriptor) Future<void> Image Registry
Delete previously registered bitmap from image registry.
unregisterImage(ImageDescriptor imageDescriptor) Future<void> Image Registry
Delete previously registered bitmap from image registry.

Exceptions / Errors

ImageDecodingFailedException Image Registry
registerBitmapImage failed to decode bitmap from byte array.
ImageDecodingFailedException Image Registry
registerBitmapImage failed to decode bitmap from byte array.