RetinaMode enum

Retina mode improves the resolution of map tiles, particularly on high density displays

Map tiles can look pixelated on high density displays, so some servers support "@2x" tiles, which are tiles at twice the resolution of normal. However, not all tile servers support this, so flutter_map can attempt to simulate retina behaviour.

---

Enabling or disabling of retina mode functionality is done through TileLayer's constructor, with the retinaMode argument.

If this is true, the '{r}' placeholder inside TileLayer.urlTemplate will be filled with "@2x" to request high resolution tiles from the server, if it is present. If not present, flutter_map will simulate retina behaviour by requesting four tiles at a larger zoom level and combining them together in place of one.

Note that simulating retina mode will increase tile requests, decrease the effective maximum zoom by 1, and may result in map labels/text/POIs appearing smaller than normal.

It is recommended to enable retina mode on high density retina displays automatically, using RetinaMode.isHighDensity.

If this is false (default), then retina mode is disabled.

---

Caution is advised when mixing retina mode with different tileSizes, especially when simulating retina mode.

It is expected that TileLayer.fallbackUrl follows the same retina support behaviour as TileLayer.urlTemplate.

Inheritance

• Object
• Enum
• RetinaMode

Constructors

RetinaMode(String friendlyName)

const

Values

disabled → const RetinaMode

Resolved to disable retina mode

This should not be referred to by users, but is open for internal and plugin use by TileLayer.resolvedRetinaMode.

const RetinaMode('Disabled')

server → const RetinaMode

Resolved to use the '{r}' placeholder to request native retina tiles from the server

This should not be referred to by users, but is open for internal and plugin use by TileLayer.resolvedRetinaMode.

const RetinaMode('Server')

simulation → const RetinaMode

Resolved to simulate retina mode

This should not be referred to by users, but is open for internal and plugin use by TileLayer.resolvedRetinaMode.

const RetinaMode('Simulation')

Properties

friendlyName → String

final

hashCode → int

The hash code for this object.

no setter, inherited

index → int

A numeric identifier for the enumerated value.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

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

Static Methods

isHighDensity(BuildContext context) → bool

Recommended switching method to assign to TileLayer.retinaMode

Constants

values → const List<RetinaMode>

A constant List of the values in this enum, in order of their declaration.