You are here

Home » API reference » Geolocation Field 8.2 » Drawing.php

class Drawing in Geolocation Field 8.2

Same name and namespace in other branches
  1. 8.3 modules/geolocation_google_maps/src/Plugin/geolocation/MapFeature/Drawing.php \Drupal\geolocation_google_maps\Plugin\geolocation\MapFeature\Drawing

Provides Drawing.

Plugin annotation


@MapFeature(
  id = "drawing",
  name = @Translation("Drawing"),
  description = @Translation("Draw lines and areas over markers."),
  type = "google_maps",
)

Hierarchy

Expanded class hierarchy of Drawing

File

modules/geolocation_google_maps/src/Plugin/geolocation/MapFeature/Drawing.php, line 18

Namespace

Drupal\geolocation_google_maps\Plugin\geolocation\MapFeature
View source 
class Drawing extends MapFeatureBase {

  /**
   * {@inheritdoc}
   */
  public static function getDefaultSettings() {
    return [
      'polyline' => FALSE,
      'strokeColor' => '#FF0000',
      'strokeOpacity' => 0.8,
      'strokeWeight' => 2,
      'geodesic' => FALSE,
      'polygon' => FALSE,
      'fillColor' => '#FF0000',
      'fillOpacity' => 0.35,
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function getSettingsSummary(array $settings) {
    $summary = parent::getSettingsSummary($settings);
    $summary[] = $this
      ->t('Draw polyline: @polyline', [
      '@polyline' => $settings['polyline'] ? $this
        ->t('Yes') : $this
        ->t('No'),
    ]);
    $summary[] = $this
      ->t('Draw polygon: @polygon', [
      '@polygon' => $settings['polygon'] ? $this
        ->t('Yes') : $this
        ->t('No'),
    ]);
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function getSettingsForm(array $settings, array $parents) {
    $settings = $this
      ->getSettings($settings);
    $states_prefix = array_shift($parents) . '[' . implode($parents, '][') . ']';
    $form['polyline'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Draw polyline'),
      '#description' => $this
        ->t('A polyline is a linear overlay of connected line segments on the map.'),
      '#default_value' => $settings['polyline'],
    ];
    $form['strokeColor'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Stroke color'),
      '#description' => $this
        ->t('The stroke color. All CSS3 colors are supported except for extended named colors.'),
      '#size' => 4,
      '#default_value' => $settings['strokeColor'],
      '#states' => [
        'visible' => [
          [
            'input[name="' . $states_prefix . '[polyline]"]' => [
              'checked' => TRUE,
            ],
          ],
          [
            'input[name="' . $states_prefix . '[polygon]"]' => [
              'checked' => TRUE,
            ],
          ],
        ],
      ],
    ];
    $form['strokeOpacity'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Stroke opacity'),
      '#description' => $this
        ->t('The stroke opacity between 0.0 and 1.0.'),
      '#size' => 2,
      '#default_value' => $settings['strokeOpacity'],
      '#states' => [
        'visible' => [
          [
            'input[name="' . $states_prefix . '[polyline]"]' => [
              'checked' => TRUE,
            ],
          ],
          [
            'input[name="' . $states_prefix . '[polygon]"]' => [
              'checked' => TRUE,
            ],
          ],
        ],
      ],
    ];
    $form['strokeWeight'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Stroke weight'),
      '#description' => $this
        ->t('The stroke width in pixels.'),
      '#size' => 2,
      '#default_value' => $settings['strokeWeight'],
      '#states' => [
        'visible' => [
          [
            'input[name="' . $states_prefix . '[polyline]"]' => [
              'checked' => TRUE,
            ],
          ],
          [
            'input[name="' . $states_prefix . '[polygon]"]' => [
              'checked' => TRUE,
            ],
          ],
        ],
      ],
    ];
    $form['geodesic'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Geodesic lines'),
      '#description' => $this
        ->t('When true, edges of the polygon are interpreted as geodesic and will follow the curvature of the Earth. When false, edges of the polygon are rendered as straight lines in screen space.'),
      '#default_value' => $settings['geodesic'],
      '#states' => [
        'visible' => [
          [
            'input[name="' . $states_prefix . '[polyline]"]' => [
              'checked' => TRUE,
            ],
          ],
          [
            'input[name="' . $states_prefix . '[polygon]"]' => [
              'checked' => TRUE,
            ],
          ],
        ],
      ],
    ];
    $form['polygon'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Draw polygon'),
      '#description' => $this
        ->t('Polygons form a closed loop and define a filled region.'),
      '#default_value' => $settings['polygon'],
    ];
    $form['fillColor'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Fill color'),
      '#description' => $this
        ->t('The fill color. All CSS3 colors are supported except for extended named colors.'),
      '#size' => 4,
      '#default_value' => $settings['fillColor'],
      '#states' => [
        'visible' => [
          'input[name="' . $states_prefix . '[polygon]"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    $form['fillOpacity'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Fill opacity'),
      '#description' => $this
        ->t('The fill opacity between 0.0 and 1.0.'),
      '#size' => 4,
      '#default_value' => $settings['fillOpacity'],
      '#states' => [
        'visible' => [
          'input[name="' . $states_prefix . '[polygon]"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    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'], [
      'library' => [
        'geolocation_google_maps/mapfeature.' . $this
          ->getPluginId(),
      ],
      'drupalSettings' => [
        'geolocation' => [
          'maps' => [
            $render_array['#id'] => [
              $this
                ->getPluginId() => [
                'enable' => TRUE,
                'settings' => $feature_settings,
              ],
            ],
          ],
        ],
      ],
    ]);
    return $render_array;
  }

}

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
Drawing::alterMap public function Alter render array. Overrides MapFeatureBase::alterMap
Drawing::getDefaultSettings public static function Provide a populated settings array. Overrides MapFeatureBase::getDefaultSettings
Drawing::getSettingsForm public function Provide a generic map settings form array. Overrides MapFeatureBase::getSettingsForm
Drawing::getSettingsSummary public function Provide a summary array to use in field formatters. Overrides MapFeatureBase::getSettingsSummary
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::validateSettingsForm public function Validate Feature Form. Overrides MapFeatureInterface::validateSettingsForm 5
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.