MarkerClusterLayerOptions class

Constructors

MarkerClusterLayerOptions({required ClusterWidgetBuilder builder, bool? rotate, List<Marker> markers = const [], Size size = const Size(30, 30), Size computeSize(List<Marker>)?, Alignment? alignment, int maxClusterRadius = 80, int disableClusteringAtZoom = 20, AnimationsOptions animationsOptions = const AnimationsOptions(), EdgeInsets padding = EdgeInsets.zero, double maxZoom = 17.0, bool inside = false, bool forceIntegerZoomLevel = false, bool zoomToBoundsOnClick = true, bool centerMarkerOnClick = true, int spiderfyCircleRadius = 40, int spiderfySpiralDistanceMultiplier = 1, int circleSpiralSwitchover = 9, List<Point<num>> spiderfyShapePositions(int, Point<num>)?, bool spiderfyCluster = true, PolygonOptions polygonOptions = const PolygonOptions(), bool showPolygon = true, void onMarkerTap(Marker)?, void onMarkerDoubleTap(Marker)?, void onMarkerHoverEnter(Marker)?, void onMarkerHoverExit(Marker)?, void onClusterTap(MarkerClusterNode)?, void onMarkersClustered(List<Marker>)?, PopupOptions? popupOptions, bool markerChildBehavior = false})

Properties

alignment Alignment?
Cluster anchor
final
animationsOptions AnimationsOptions
animations options
final
builder ClusterWidgetBuilder
Cluster builder
final
centerMarkerOnClick bool
When click marker, center it with animation
final
circleSpiralSwitchover int
Show spiral instead of circle from this marker count upwards. 0 -> always spiral; Infinity -> always circle
final
computeSize → (Size Function(List<Marker>)?)
Cluster compute size
final
disableClusteringAtZoom int
If set, at this zoom level and below, markers will not be clustered. This defaults to 20 (max zoom)
final
forceIntegerZoomLevel bool
By default calculations will return fractional zoom levels. If this parameter is set to true fractional zoom levels will be round to the next suitable integer.
final
hashCode int
The hash code for this object.
no setterinherited
inside bool
final
markerChildBehavior bool
If set to true the marker will have only gesture behavior that is provided by the marker child. Can be used in cases where the marker child is a widget that already has gesture behavior and GestureDetector from the MarkerClusterLayer is interfering with it. If set to true onMarkerTap onMarkerHoverEnter onMarkerHoverExit centerMarkerOnClick will not work.
final
markers List<Marker>
List of markers
final
maxClusterRadius int
A cluster will cover at most this many pixels from its center
final
maxZoom double
final
onClusterTap → (void Function(MarkerClusterNode)?)
Function to call when a cluster Marker is tapped
final
onMarkerDoubleTap → (void Function(Marker)?)
Function to call when a Marker is double tapped
final
onMarkerHoverEnter → (void Function(Marker)?)
Function to call when a Marker starts to be hovered
final
onMarkerHoverExit → (void Function(Marker)?)
Function to call when a Marker stops to be hovered
final
onMarkersClustered → (void Function(List<Marker>)?)
Function to call when markers are clustered
final
onMarkerTap → (void Function(Marker)?)
Function to call when a Marker is tapped
final
padding EdgeInsets
final
polygonOptions PolygonOptions
Polygon's options that shown when tap cluster.
final
popupOptions PopupOptions?
Popup's options that show when tapping markers or via the PopupController.
final
rotate bool?
If true markers will be counter rotated to the map rotation
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
showPolygon bool
If true show polygon then tap on cluster
final
size Size
Cluster size
final
spiderfyCircleRadius int
Increase to increase the distance away that circle spiderfied markers appear from the center
final
spiderfyCluster bool
If false remove spiderfy effect on tap
final
spiderfyShapePositions → (List<Point<num>> Function(int, Point<num>)?)
Make it possible to provide custom function to calculate spiderfy shape positions
final
spiderfySpiralDistanceMultiplier int
Increase to increase the distance away that spiral spiderfied markers appear from the center
final
zoomToBoundsOnClick bool
Zoom buonds with animation on click cluster
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited