Scale Class¶

class BeastBytes\Yii\Leaflet\Controls\Scale¶

Represents a scale control

__construct(array $options)¶

Create a new Scale control

Parameters:

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

Returns:

A new Scale instance

Return type:

Scale

Inherited from Component¶

BeastBytes\Yii\Leaflet\Controls\Scale::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 Scale with the addToMap parameter set

Return type:

Scale

BeastBytes\Yii\Leaflet\Controls\Scale::getJsVar()¶

Returns the JavaScript variable name

Returns:

The JavaScript variable name

Return type:

string

BeastBytes\Yii\Leaflet\Controls\Scale::jsVar(string $jsVar)¶

Set the JavaScript variable name

Parameters:

$jsVar (string) – The JavaScript variable name

Returns:

A new instance of Scale with the JavaScript variable name set

Return type:

Scale