ImageOverlay Class¶

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

ImageOverlay loads and displays an image file over specific bounds of the map

@template T of array{float, float}|array{float, float, float}|array{lat: float, lng: float}|array{lat: float, lng: float, alt: float}|LatLng

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

Create a new ImageOverlay instance

Parameters:

$url (string) – Image URL
$bounds (array{T, T}|LatLngBounds) – The bounds of the overlay
$options (array<string, mixed>.) – ImageOverlay options

Returns:

A new ImageOverlay instance

Return type:

ImageOverlay

Inherited from Layer¶

BeastBytes\Yii\Leaflet\Layers\Raster\ImageOverlay::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 ImageOverlay with the popup

Return type:

ImageOverlay

BeastBytes\Yii\Leaflet\Layers\Raster\ImageOverlay::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 ImageOverlay with the tooltip

Return type:

ImageOverlay

Inherited from Component¶

BeastBytes\Yii\Leaflet\Layers\Raster\ImageOverlay::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 ImageOverlay with the addToMap parameter set

Return type:

ImageOverlay

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

Returns the JavaScript variable name

Returns:

The JavaScript variable name

Return type:

string

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

Set the JavaScript variable name

Parameters:

$jsVar (string) – The JavaScript variable name

Returns:

A new instance of ImageOverlay with the JavaScript variable name set

Return type:

ImageOverlay