GridLayerOptions class

Inheritance
Implementers
Annotations
  • @JS()
  • @anonymous

Constructors

GridLayerOptions({String? pane, String? attribution, Point? tileSize, double? opacity, bool? updateWhenIdle, bool? updateWhenZooming, double? updateInterval, double? zIndex, LatLngBounds? bounds, double? minZoom, double? maxZoom, double? maxNativeZoom, double? minNativeZoom, bool? noWrap, String? className, double? keepBuffer})
factory

Properties

attribution String
String to be shown in the attribution control, e.g. "© OpenStreetMap contributors". It describes the layer data and is often a legal obligation towards copyright holders and tile providers.
getter/setter pairinherited
bounds LatLngBounds
If set, tiles will only be loaded inside the set LatLngBounds.
getter/setter pair
className String
A custom class name to assign to the tile layer. Empty by default.
getter/setter pair
hashCode int
The hash code for this object.
no setterinherited
keepBuffer double
When panning the map, keep this many rows and columns of tiles before unloading them.
getter/setter pair
maxNativeZoom double
Maximum zoom number the tile source has available. If it is specified, the tiles on all zoom levels higher than maxNativeZoom will be loaded from maxNativeZoom level and auto-scaled.
getter/setter pair
maxZoom double
The maximum zoom level up to which this layer will be displayed (inclusive).
getter/setter pair
minNativeZoom double
Minimum zoom number the tile source has available. If it is specified, the tiles on all zoom levels lower than minNativeZoom will be loaded from minNativeZoom level and auto-scaled.
getter/setter pair
minZoom double
The minimum zoom level down to which this layer will be displayed (inclusive)
getter/setter pair
noWrap bool
Whether the layer is wrapped around the antimeridian. If true, the GridLayer will only be displayed once at low zoom levels. Has no effect when the map CRS doesn't wrap around. Can be used in combination with bounds to prevent requesting tiles outside the CRS limits.
getter/setter pair
opacity double
Opacity of the tiles. Can be used in the createTile() function.
getter/setter pair
pane String
Map pane where the grid layer will be added.
getter/setter pairoverride
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
tileSize Point
Width and height of tiles in the grid. Use a number if width and height are equal, or L.point(width, height) otherwise.
getter/setter pair
updateInterval double
Tiles will not update more than once every updateInterval milliseconds when panning.
getter/setter pair
updateWhenIdle bool
Load new tiles only when panning ends. true by default on mobile browsers, in order to avoid too many requests and keep smooth navigation. false otherwise in order to display new tiles during panning, since it is easy to pan outside the keepBuffer option in desktop browsers.
getter/setter pair
updateWhenZooming bool
By default, a smooth zoom animation (during a touch zoom or a flyTo()) will update grid layers every integer zoom level. Setting this option to false will update the grid layer only when the smooth animation ends.
getter/setter pair
zIndex double
The explicit zIndex of the tile layer.
getter/setter pair

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