TileLayer
Bases: MapLayer
Displays square raster images in a continuous grid,
sourced from the provided url_template and fallback_url.
Typically the first layer to be added to a Map,
as it provides the tiles on which
other layers are displayed.
| RAISES | DESCRIPTION |
|---|---|
AssertionError
|
If one or more of the following is negative:
|
Static information that should replace placeholders in the url_template.
Applying API keys, for example, is a good usecase of this parameter.
col: ResponsiveNumber = 12
If a parent of the control is ResponsiveRow, col property is used to determine
how many virtual columns of a screen the control will span.
Can be a number or a dictionary configured to have a different value for specific
breakpoints, for example col={"sm": 6}. Breakpoints are named dimension ranges:
| Breakpoint | Dimension |
|---|---|
| xs | <576px |
| sm | ≥576px |
| md | ≥768px |
| lg | ≥992px |
| xl | ≥1200px |
| xxl | ≥1400px |
If col property is not specified, it spans the maximum number of columns (12).
disabled: bool = False
Every control has disabled property which is False by default - control and all
its children are enabled.
disabled property is mostly used with data entry controls like TextField,
Dropdown, Checkbox, buttons.
However, disabled could be set to a parent control and its value will be
propagated down to all children recursively.
For example, if you have a form with multiple entry controls you can disable them all together by disabling container:
display_mode: TileDisplay = field(
default_factory=lambda: FadeInTileDisplay()
)
Defines how tiles are displayed on the map.
enable_retina_mode: bool = False
Whether to enable retina mode. Retina mode improves the resolution of map tiles, particularly on high density displays.
enable_tms: bool = False
Whether to inverse Y-axis numbering for tiles. Turn this on for TMS services.
error_image_src: str | None = None
The source of the tile image to show in place of the tile that failed to load.
See on_image_error property for details on the error.
evict_error_tile_strategy: (
TileLayerEvictErrorTileStrategy | None
) = NONE
If a tile was loaded with error, the tile provider will be asked to evict the image based on this strategy.
When a child Control is placed into a Column
or a Row you can "expand" it to fill the
available space.
expand property could be a boolean value (True - expand control to fill all
available space) or an integer - an "expand factor" specifying how to divide a free
space with other expanded child controls.
For more information and examples about expand property see "Expanding children"
sections in Column or
Row.
Here is an example of expand being used in action for both Column
and Row:
import flet as ft
def main(page: ft.Page):
page.spacing = 0
page.padding = 0
page.add(
ft.Column(
controls=[
ft.Row(
[
ft.Card(
content=ft.Text("Card_1"),
color=ft.Colors.ORANGE_300,
expand=True,
height=page.height,
margin=0,
),
ft.Card(
content=ft.Text("Card_2"),
color=ft.Colors.GREEN_100,
expand=True,
height=page.height,
margin=0,
),
],
expand=True,
spacing=0,
),
],
expand=True,
spacing=0,
),
)
ft.app(main)
expand_loose: bool | None = None
Effective only if expand is True.
If expand_loose is True, the child control of a
Column or a Row
will be given the flexibility to expand to fill the available space in the main
axis (e.g., horizontally for a Row or vertically for a Column), but will not be
required to fill the available space.
The default value is False.
Here is the example of Containers placed in Rows with expand_loose = True:
import flet as ft
class Message(ft.Container):
def __init__(self, author, body):
super().__init__()
self.content = ft.Column(
controls=[
ft.Text(author, weight=ft.FontWeight.BOLD),
ft.Text(body),
],
)
self.border = ft.border.all(1, ft.Colors.BLACK)
self.border_radius = ft.border_radius.all(10)
self.bgcolor = ft.Colors.GREEN_200
self.padding = 10
self.expand = True
self.expand_loose = True
def main(page: ft.Page):
chat = ft.ListView(
padding=10,
spacing=10,
controls=[
ft.Row(
alignment=ft.MainAxisAlignment.START,
controls=[
Message(
author="John",
body="Hi, how are you?",
),
],
),
ft.Row(
alignment=ft.MainAxisAlignment.END,
controls=[
Message(
author="Jake",
body="Hi I am good thanks, how about you?",
),
],
),
ft.Row(
alignment=ft.MainAxisAlignment.START,
controls=[
Message(
author="John",
body="Lorem Ipsum is simply dummy text of the printing and
typesetting industry. Lorem Ipsum has been the industry's
standard dummy text ever since the 1500s, when an unknown
printer took a galley of type and scrambled it to make a
type specimen book.",
),
],
),
ft.Row(
alignment=ft.MainAxisAlignment.END,
controls=[
Message(
author="Jake",
body="Thank you!",
),
],
),
],
)
page.window.width = 393
page.window.height = 600
page.window.always_on_top = False
page.add(chat)
ft.run(main)
fallback_url: str | None = None
Fallback URL template, used if an error occurs when fetching tiles from
the url_template.
Note that specifying this (non-none) will result in tiles not being cached
in memory. This is to avoid issues where the url_template is flaky, to
prevent different tilesets being displayed at the same time.
It is expected that this follows the same retina support behaviour
as url_template.
keep_buffer: int = 2
When panning the map, keep this many rows and columns of tiles before unloading them.
max_native_zoom: int = 19
Maximum zoom number supported by the tile source has available.
Tiles from above this zoom level will not be displayed, instead tiles at this zoom level will be displayed and scaled.
Most tile servers support up to zoom level 19, which is the default.
Otherwise, this should be specified.
Note
Must be greater than or equal to 0.0.
The maximum zoom level up to which this layer will be displayed (inclusive).
The main usage for this property is to display a different TileLayer
when zoomed far in.
Prefer max_native_zoom for setting the maximum zoom level supported by the
tile source.
Typically set to infinity so that there are tiles always displayed.
Note
Must be greater than or equal to 0.0.
min_native_zoom: int = 0
Minimum zoom level supported by the tile source.
Tiles from below this zoom level will not be displayed, instead tiles at this zoom level will be displayed and scaled.
This should usually be 0 (as default), as most tile sources will support zoom levels onwards from this.
Note
Must be greater than or equal to 0.0.
min_zoom: Number = 0.0
The minimum zoom level at which this layer is displayed (inclusive).
Typically 0.0.
Note
Must be greater than or equal to 0.0.
on_image_error: ControlEventHandler[TileLayer] | None = None
Fires if an error occurs when fetching the tiles.
Event handler argument data property contains
information about the error.
opacity: Number = 1.0
Defines the transparency of the control.
Value ranges from 0.0 (completely transparent) to 1.0 (completely opaque
without any transparency) and defaults to 1.0.
The page (of type Page or PageView) to which this control belongs to.
pan_buffer: int = 1
When loading tiles only visible tiles are loaded by default. This option
increases the loaded tiles by the given number on both axis which can help
prevent the user from seeing loading tiles whilst panning. Setting the
pan buffer too high can impact performance, typically this is set to 0 or 1.
parent: BaseControl | None
The direct ancestor(parent) of this control.
It defaults to None and will only have a value when this control is mounted (added to the page tree).
The Page control (which is the root of the tree) is an exception - it always has parent=None.
List of subdomains used in the URL template.
For example, if subdomains is set to ["a", "b", "c"] and the
url_template is "https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png",
the resulting tile URLs will be:
"https://a.tile.openstreetmap.org/{z}/{x}/{y}.png""https://b.tile.openstreetmap.org/{z}/{x}/{y}.png""https://c.tile.openstreetmap.org/{z}/{x}/{y}.png"
tile_bounds: MapLatitudeLongitudeBounds | None = None
Defines the bounds of the map. Only tiles that fall within these bounds will be loaded.
tile_size: int = 256
The size in pixels of each tile image. Should be a positive power of 2.
Note
Must be greater than or equal to 0.0.
tooltip: TooltipValue | None = None
The tooltip property supports both strings
and Tooltip objects.
url_template: str
The URL template is a string that contains placeholders, which, when filled in, create a URL/URI to a specific tile.
user_agent_package_name: str = 'unknown'
The package name of the user agent.
visible: bool = True
Every control has visible property which is True by default - control is
rendered on the page. Setting visible to False completely prevents control (and
all its children if any) from rendering on a page canvas. Hidden controls cannot be
focused or selected with a keyboard or mouse and they do not emit any events.
zoom_offset: Number = 0.0
The zoom number used in tile URLs will be offset with this value.
Note
Must be greater than or equal to 0.0.