You are here

class FitLocations in Geolocation Field 8.2

Same name and namespace in other branches
  1. 8.3 src/Plugin/geolocation/MapCenter/FitLocations.php \Drupal\geolocation\Plugin\geolocation\MapCenter\FitLocations

Fixed coordinates map center.

ID for compatibility with v1.

Plugin annotation


@MapCenter(
  id = "fit_bounds",
  name = @Translation("Fit locations"),
  description = @Translation("Automatically fit map to displayed locations."),
)

Hierarchy

Expanded class hierarchy of FitLocations

File

src/Plugin/geolocation/MapCenter/FitLocations.php, line 19

Namespace

Drupal\geolocation\Plugin\geolocation\MapCenter
View source
class FitLocations extends MapCenterBase implements MapCenterInterface {

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

  /**
   * {@inheritdoc}
   */
  public function getSettingsForm($option_id = NULL, array $settings = [], $context = NULL) {
    $form = parent::getSettingsForm($option_id, $settings, $context);
    $form['reset_zoom'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Reset zoom after fit.'),
      '#default_value' => $settings['reset_zoom'],
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function alterMap(array $map, $center_option_id, array $center_option_settings, $context = NULL) {
    $map = parent::alterMap($map, $center_option_id, $center_option_settings, $context);
    $map['#attached'] = array_merge_recursive($map['#attached'], [
      'library' => [
        'geolocation/map_center.fitlocations',
      ],
    ]);
    return $map;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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
FitLocations::alterMap public function Alter map.. Overrides MapCenterBase::alterMap
FitLocations::getDefaultSettings public static function Provide a populated settings array. Overrides MapCenterBase::getDefaultSettings
FitLocations::getSettingsForm public function Settings form by ID and context. Overrides MapCenterBase::getSettingsForm
MapCenterBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 1
MapCenterBase::getAvailableMapCenterOptions public function For one MapCenter (i.e. boundary filter), return all options (all filters). Overrides MapCenterInterface::getAvailableMapCenterOptions 3
MapCenterBase::getSettings public function Provide MapCenter option specific settings. Overrides MapCenterInterface::getSettings
MapCenterBase::validateSettingsForm public function
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.