TileLayer Class¶

class BeastBytes\Yii\Leaflet\Layers\Raster\TileLayer¶

TileLayer loads and displays tile layers on the map

Note

Most tile servers require attribution, which can be set using the attribution option

__construct(string $url, array $options = [])¶

Create a new TileLayer instance

Parameters:

$url (string) – Tile URL template
$options (array<string, mixed>.) – TileLayer options

Returns:

A new TileLayer instance

Return type:

TileLayer

Inherited from Layer¶

BeastBytes\Yii\Leaflet\Layers\Raster\TileLayer::popup(string $content, array $options = [])¶

Binds a popup to the layer

Parameters:

$content (string) – The popup content

$options (array<string, mixed>.) – Popup options

Returns:

A new instance of TileLayer with the popup

Return type:

TileLayer

BeastBytes\Yii\Leaflet\Layers\Raster\TileLayer::tooltip(string $content, array $options = [])¶

Binds a tooltip to the layer

Parameters:

$content (string) – The tooltip content

$options (array<string, mixed>.) – Tooltip options

Returns:

A new instance of TileLayer with the tooltip

Return type:

TileLayer

Inherited from Component¶

BeastBytes\Yii\Leaflet\Layers\Raster\TileLayer::addToMap(bool $addToMap)¶

Whether to add the component to the map

By default, a component is added to the map.

Parameters:

$addToMap (bool) – Whether the component is added to the map

Returns:

A new instance of TileLayer with the addToMap parameter set

Return type:

TileLayer

BeastBytes\Yii\Leaflet\Layers\Raster\TileLayer::getJsVar()¶

Returns the JavaScript variable name

Returns:

The JavaScript variable name

Return type:

string

BeastBytes\Yii\Leaflet\Layers\Raster\TileLayer::jsVar(string $jsVar)¶

Set the JavaScript variable name

Parameters:

$jsVar (string) – The JavaScript variable name

Returns:

A new instance of TileLayer with the JavaScript variable name set

Return type:

TileLayer