TileOverlay

A tile overlay is a set of images to be displayed on a map. It can be transparent and enable you to add new functions to an existing map.

Name	Type	Description
tileOverlayId	TileOverlayId	Unique tile overlay ID.
fadeIn	bool?	Indicates whether a tile overlay fades in.
transparency	double?	Transparency of a tile overlay.
visible	bool?	Indicates whether a tile overlay is visible. If the tile overlay is invisible, it will not be drawn but all other states will be preserved. By default, a tile overlay is visible.
zIndex	double?	Z-index of a tile overlay. The z-index indicates the overlapping order of a tile overlay. A tile overlay with a larger z-index overlaps that with a smaller z-index. Tile overlays with the same z-index overlap each other in a random order.
tileProvider	dynamic	Provider of a tile overlay.

Constructor	Description
TileOverlay({required TileOverlayId tileOverlayId, required dynamic tileProvider, bool? fadeIn, double? transparency, bool? visible, double? zIndex})	Creates a TileOverlay object.

Creates a TileOverlay object.

Parameter	Type	Description
tileOverlayId	TileOverlayId	Unique tile overlay ID.
fadeIn	bool?	Indicates whether a tile overlay fades in.
transparency	double?	Transparency of a tile overlay.
visible	bool?	Indicates whether a tile overlay is visible. If the tile overlay is invisible, it will not be drawn but all other states will be preserved. By default, a tile overlay is visible.
zIndex	double?	Z-index of a tile overlay. The z-index indicates the overlapping order of a tile overlay. A tile overlay with a larger z-index overlaps that with a smaller z-index. Tile overlays with the same z-index overlap each other in a random order.
tileProvider	dynamic	Provider of a tile overlay.

Method	Return Type	Description
TileOverlay.updateCopy({bool? fadeIn, double? transparency, bool? visible, double? zIndex, dynamic tileProvider})	TileOverlay	Copies an existing TileOverlay object and updates the specified attributes.
TileOverlay.clone()	TileOverlay	Clones a TileOverlay object.

Copies an existing TileOverlay object and updates the specified attributes.

Parameter	Type	Description
fadeIn	bool?	Indicates whether a tile overlay fades in.
transparency	double?	Transparency of a tile overlay.
visible	bool?	Indicates whether a tile overlay is visible. If the tile overlay is invisible, it will not be drawn but all other states will be preserved. By default, a tile overlay is visible.
zIndex	double?	Z-index of a tile overlay. The z-index indicates the overlapping order of a tile overlay. A tile overlay with a larger z-index overlaps that with a smaller z-index. Tile overlays with the same z-index overlap each other in a random order.
tileProvider	dynamic	Provider of a tile overlay.

Return Type	Description
TileOverlay	TileOverlay object.

Call example:

// Define a TileOverlay object.
TileOverlay tileOverlay; 
 
// Call the updateCopy method.
tileOverlay = tileOverlay!.updateCopy(visible: true);

Clones a TileOverlay object.

Return Type	Description
TileOverlay	TileOverlay object.

Call example:

// Define a TileOverlay object.
TileOverlay tileOverlay; 
TileOverlay tileOverlay2; 
 
// Call the clone method.
tileOverlay2 = tileOverlay!.clone();

TileOverlay