WMSTileLayerOptions class

Inheritance

Constructors

WMSTileLayerOptions({String? templateUrl, dynamic subdomains, dynamic bounds, num? tileSize, double? minZoom, double? maxZoom, double? opacity, double? minNativeZoom, double? maxNativeZoom, bool? zoomReverse, double? zoomOffset, int? keepBuffer, ImageProvider<Object>? placeholderImage, ImageProvider<Object>? errorImage, required int updateInterval, required int tileFadeInDuration, double? tileFadeInStart, double? tileFadeInStartWhenOverride, bool? overrideTilesWhenUrlChanges, bool? retinaMode, dynamic onTileError(Tile, dynamic)?, TileProvider? tileProvider, bool tms = tmsDef, Map<String, dynamic> additionalOptions = const <String, dynamic>{}, bool interactive = interactiveDef, String attribution = attributionDef, Crs? crs, dynamic layers = '', dynamic styles = '', String format = 'image/jpeg', String version = '1.1.1', bool transparent = false, bool uppercase = false})

Properties

additionalOptions → Map<String, dynamic>?
finalinherited
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.
finalinherited
bounds → LatLngBounds?
If set, tiles will only be loaded inside the set LatLngBounds.
finalinherited
crs → Crs?
Coordinate Reference System to use for the WMS requests, defaults to map CRS. Don't change this if you're not sure what it means.
final
errorImage → ImageProvider<Object>?
Tile image to show in place of the tile that failed to load.
finalinherited
format → String
WMS image format (use 'image/png' for layers with transparency).
final
hasBounds → bool
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
hasMaxNativeZoom → bool
no setterinherited
hasMaxZoom → bool
no setterinherited
hasMinNativeZoom → bool
no setterinherited
hasMinZoom → bool
no setterinherited
hasOnDoubleTap → bool
no setterinherited
hasOnLongPress → bool
no setterinherited
hasOnLongPressEnd → bool
no setterinherited
hasOnLongPressMoveUpdate → bool
no setterinherited
hasOnLongPressStart → bool
no setterinherited
hasOnLongPressUp → bool
no setterinherited
hasOnSecondaryLongPress → bool
no setterinherited
hasOnSecondaryLongPressEnd → bool
no setterinherited
hasOnSecondaryLongPressMoveUpdate → bool
no setterinherited
hasOnSecondaryLongPressStart → bool
no setterinherited
hasOnSecondaryLongPressUp → bool
no setterinherited
hasOnSecondaryTap → bool
no setterinherited
hasOnSecondaryTapCancel → bool
no setterinherited
hasOnSecondaryTapDown → bool
no setterinherited
hasOnSecondaryTapUp → bool
no setterinherited
hasOnTap → bool
no setterinherited
hasOnTapCancel → bool
no setterinherited
hasOnTapDown → bool
no setterinherited
hasOnTapUp → bool
no setterinherited
interactive → bool
If false, the layer will not emit touch events and will act as a part of the underlying map.
finalinherited
isRetinaMode → bool
no setterinherited
keepBuffer → int?
When panning the map, keep this many rows and columns of tiles before unloading them.
finalinherited
layers → List<String>
List of WMS layers to show.
final
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.
finalinherited
maxZoom → double?
The maximum zoom level up to which this layer will be displayed (inclusive). In most tile providers goes from 0 to 19.
finalinherited
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.
finalinherited
minZoom → double?
The minimum zoom level down to which this layer will be displayed (inclusive).
finalinherited
onDoubleTap → DoubleTapLayerCallback?
finalinherited
onLongPress → LongPressLayerCallback?
finalinherited
onLongPressEnd → LongPressEndLayerCallback?
finalinherited
onLongPressMoveUpdate → LongPressMoveUpdateLayerCallback?
finalinherited
onLongPressStart → LongPressStartLayerCallback?
finalinherited
onLongPressUp → LongPressUpLayerCallback?
finalinherited
onSecondaryLongPress → LongPressLayerCallback?
finalinherited
onSecondaryLongPressEnd → LongPressEndLayerCallback?
finalinherited
onSecondaryLongPressMoveUpdate → LongPressMoveUpdateLayerCallback?
finalinherited
onSecondaryLongPressStart → LongPressStartLayerCallback?
finalinherited
onSecondaryLongPressUp → LongPressUpLayerCallback?
finalinherited
onSecondaryTap → TapLayerCallback?
finalinherited
onSecondaryTapCancel → TapLayerCallback?
finalinherited
onSecondaryTapDown → TapDownLayerCallback?
finalinherited
onSecondaryTapUp → TapUpLayerCallback?
finalinherited
onTap → TapLayerCallback?
finalinherited
onTapCancel → TapLayerCallback?
finalinherited
onTapDown → TapDownLayerCallback?
finalinherited
onTapUp → TapUpLayerCallback?
finalinherited
onTileError → (dynamic Function(Tile, dynamic)?)
This callback will be execute if some errors by getting tile
finalinherited
opacity → double?
Opacity of the tiles.
finalinherited
overrideTilesWhenUrlChanges → bool?
false: current Tiles will be first dropped and then reload via new url (default) true: current Tiles will be visible until new ones aren't loaded (new Tiles are loaded independently)
finalinherited
paramBbox → String
no setter
paramFormat → String
no setter
paramHeight → String
no setter
paramLayers → String
no setter
paramProjection → String
no setter
paramRequest → String
no setter
paramService → String
no setter
paramStyles → String
no setter
paramTransparent → String
no setter
paramVersion → String
no setter
paramWidth → String
no setter
placeholderImage → ImageProvider<Object>?
Placeholder to show until tile images are fetched by the provider.
finalinherited
projection → String
no setter
request → String
final
retinaMode → bool?
If true, it will request four tiles of half the specified size and a bigger zoom level in place of one to utilize the high resolution.
finalinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
service → String
final
styles → List<String>
list of WMS styles
final
subdomains → List<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.
finalinherited
templateUrl → String?
Defines the structure to create the URLs for the tiles. {s} means one of the available subdomains (can be omitted) {z} zoom level {x} and {y} — tile coordinates {r} can be used to add "@2x" to the URL to load retina tiles (can be omitted)
finalinherited
tileFadeInCurve → Curve
Tiles fade in curve. Default: Curves.easeInOut
finalinherited
tileFadeInDuration → Duration
Tiles fade in duration in milliseconds (default 100), it can be null to avoid fade in
finalinherited
tileFadeInStart → double?
Opacity start value when Tile starts fade in (0.0 - 1.0) Takes effect if tileFadeInDuration is not null
finalinherited
tileFadeInStartWhenOverride → double?
Opacity start value when an exists Tile starts fade in with different Url (0.0 - 1.0) Takes effect when tileFadeInDuration is not null and if overrideTilesWhenUrlChanges if true
finalinherited
tileProvider → TileProvider?
The type of tile provider used to load tiles.
finalinherited
tileSize → Size
Size for the tile. Default is 256 x 256
finalinherited
tms → bool
If true, inverses Y axis numbering for tiles (turn this on for TMS services).
finalinherited
transparent → bool
If true, the WMS service will return images with transparency.
final
updateInterval → Duration
Tiles will not update more than once every updateInterval (default 200 milliseconds) when panning. It can be null (but it will calculating for loading tiles every frame when panning / zooming, flutter is fast) This can save some fps and even bandwidth (ie. when fast panning / animating between long distances in short time)
finalinherited
updateWhenZooming → bool
By default, a smooth zoom animation (during a touch zoom or a flyTo()) will update grid layers every integer zoom level.
finalinherited
uppercase → bool
If true, WMS request parameter keys will be uppercase.
final
version → String
Version of the WMS service to use
final
versionNumber → double
no setter
zoomOffset → double?
The zoom number used in tile URLs will be offset with this value.
finalinherited
zoomReverse → bool?
If set to true, the zoom number used in tile URLs will be reversed (maxZoom - zoom instead of zoom)
finalinherited

Methods

copy({String? templateUrl, dynamic subdomains, dynamic bounds, num? tileSize, double? minZoom, double? maxZoom, double? opacity, double? minNativeZoom, double? maxNativeZoom, bool? zoomReverse, double? zoomOffset, int? keepBuffer, ImageProvider<Object>? placeholderImage, ImageProvider<Object>? errorImage, int? updateInterval, int? tileFadeInDuration, Curve? tileFadeInCurve, double? tileFadeInStart, double? tileFadeInStartWhenOverride, bool? overrideTilesWhenUrlChanges, bool? retinaMode, dynamic onTileError(Tile, dynamic)?, TileProvider? tileProvider, bool? tms, Map<String, String>? additionalOptions, bool? interactive, String? attribution, TapLayerCallback? onTap, TapUpLayerCallback? onTapUp, TapDownLayerCallback? onTapDown, TapLayerCallback? onTapCancel, TapLayerCallback? onSecondaryTap, TapDownLayerCallback? onSecondaryTapDown, TapUpLayerCallback? onSecondaryTapUp, TapLayerCallback? onSecondaryTapCancel, DoubleTapLayerCallback? onDoubleTap, LongPressLayerCallback? onLongPress, LongPressStartLayerCallback? onLongPressStart, LongPressMoveUpdateLayerCallback? onLongPressMoveUpdate, LongPressUpLayerCallback? onLongPressUp, LongPressEndLayerCallback? onLongPressEnd, LongPressLayerCallback? onSecondaryLongPress, LongPressStartLayerCallback? onSecondaryLongPressStart, LongPressMoveUpdateLayerCallback? onSecondaryLongPressMoveUpdate, LongPressUpLayerCallback? onSecondaryLongPressUp, LongPressEndLayerCallback? onSecondaryLongPressEnd}) → TileLayerOptions
inherited
getBaseUrl(Crs crs) → String
override
getTemplateUrl(Crs mapCrs, Coordinate? coordinate) → String
override
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