class LeafletControlScale in Geolocation Field 8.2

Provides Scale control element.

Plugin annotation

@MapFeature(
  id = "leaflet_control_scale",
  name = @Translation("Map Control - Scale"),
  description = @Translation("A simple scale control that shows the scale of the current center of screen in metric (m/km) and imperial (mi/ft) systems."),
  type = "leaflet",
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\geolocation\MapFeatureBase implements ContainerFactoryPluginInterface, MapFeatureInterface
      • class \Drupal\geolocation_leaflet\Plugin\geolocation\MapFeature\ControlElementBase
        • class \Drupal\geolocation_leaflet\Plugin\geolocation\MapFeature\LeafletControlScale

File

modules/geolocation_leaflet/src/Plugin/geolocation/MapFeature/LeafletControlScale.php, line 17

Namespace

Drupal\geolocation_leaflet\Plugin\geolocation\MapFeature

class LeafletControlScale extends ControlElementBase {

  /**
   * {@inheritdoc}
   */
  public static function getDefaultSettings() {
    return [
      'metric' => TRUE,
      'imperial' => TRUE,
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function getSettingsForm(array $settings, array $parents) {
    $form = parent::getSettingsForm($settings, $parents);
    $settings = $this
      ->getSettings($settings);
    $form['metric'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Metric'),
      '#description' => $this
        ->t('Whether to show the metric scale line (m/km).'),
      '#default_value' => $settings['metric'],
    ];
    $form['imperial'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Imperial'),
      '#description' => $this
        ->t('Whether to show the imperial scale line (mi/ft).'),
      '#default_value' => $settings['imperial'],
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function alterMap(array $render_array, array $feature_settings, array $context = []) {
    $render_array = parent::alterMap($render_array, $feature_settings, $context);
    $feature_settings = $this
      ->getSettings($feature_settings);
    $render_array['#attached'] = BubbleableMetadata::mergeAttachments(empty($render_array['#attached']) ? [] : $render_array['#attached'], [
      'drupalSettings' => [
        'geolocation' => [
          'maps' => [
            $render_array['#id'] => [
              $this
                ->getPluginId() => [
                'metric' => $feature_settings['metric'],
                'imperial' => $feature_settings['imperial'],
              ],
            ],
          ],
        ],
      ],
    ]);
    return $render_array;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ControlElementBase::validateSettingsForm	public	function	Validate Feature Form. Overrides MapFeatureBase::validateSettingsForm
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
LeafletControlScale::alterMap	public	function	Alter render array. Overrides ControlElementBase::alterMap
LeafletControlScale::getDefaultSettings	public static	function	Provide a populated settings array. Overrides ControlElementBase::getDefaultSettings
LeafletControlScale::getSettingsForm	public	function	Provide a generic map settings form array. Overrides ControlElementBase::getSettingsForm
MapFeatureBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create	2
MapFeatureBase::getSettings	public	function	Provide map feature specific settings ready to handover to JS. Overrides MapFeatureInterface::getSettings
MapFeatureBase::getSettingsSummary	public	function	Provide a summary array to use in field formatters. Overrides MapFeatureInterface::getSettingsSummary	1
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
PluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object.	92
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.