TileLayerOptions class

Inheritance
Annotations
  • @JS.new()
  • @anonymous

Constructors

TileLayerOptions({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? pane, String? className, double? keepBuffer, String? subdomains, String? errorTileUrl, double? zoomOffset, bool? tms, bool? zoomReverse, bool? detectRetina, String? crossOrigin})
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 pairinherited
className String
A custom class name to assign to the tile layer. Empty by default.
getter/setter pairinherited
crossOrigin String
Whether the crossOrigin attribute will be added to the tiles. If a String is provided, all tiles will have their crossOrigin attribute set to the String provided. This is needed if you want to access tile pixel
getter/setter pair
detectRetina bool
If true and user is on a retina display, it will request four tiles of half the specified size and a bigger zoom level in place of one to utilize the high resolution.
getter/setter pair
errorTileUrl String
URL to the tile image to show in place of the tile that failed to load.
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 pairinherited
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 pairinherited
maxZoom double
The maximum zoom level up to which this layer will be displayed (inclusive).
getter/setter pairinherited
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 pairinherited
minZoom double
The minimum zoom level down to which this layer will be displayed (inclusive)
getter/setter pairinherited
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 pairinherited
opacity double
Opacity of the tiles. Can be used in the createTile() function.
getter/setter pairinherited
pane String
Map pane where the grid layer will be added.
getter/setter pairinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
subdomains String
Subdomains of the tile service. Can be passed in the form of one string (where each letter is a subdomain name) or an array of strings.
getter/setter pair
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 pairinherited
tms bool
If true, inverses Y axis numbering for tiles (turn this on for TMS services).
getter/setter pair
updateInterval double
Tiles will not update more than once every updateInterval milliseconds when panning.
getter/setter pairinherited
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 pairinherited
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 pairinherited
zIndex double
The explicit zIndex of the tile layer.
getter/setter pairinherited
zoomOffset double
The zoom number used in tile URLs will be offset with this value.
getter/setter pair
zoomReverse bool
If set to true, the zoom number used in tile URLs will be reversed (maxZoom - zoom instead of zoom)
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