You are here

class GeolocationMapPolyline in Geolocation Field 8.3

Provides a render element for a single geolocation map location.

Usage example:

$form['map'] = [
  '#type' => 'geolocation_map_polyline',
  '#coordinates' => NULL,
  '#id' => NULL,
  '#stroke_color' => NULL,
  '#stroke_width' => NULL,
  '#stroke_opacity' => NULL,
];

Plugin annotation

@FormElement("geolocation_map_polyline");

Hierarchy

Expanded class hierarchy of GeolocationMapPolyline

3 #type uses of GeolocationMapPolyline
GeolocationGeometry::getShapesFromItem in modules/geolocation_geometry/src/Plugin/geolocation/DataProvider/GeolocationGeometry.php
Get shapes from field item list.
GeolocationGpx::getShapesFromItem in modules/geolocation_gpx/src/Plugin/geolocation/DataProvider/GeolocationGpx.php
Get shapes from field item list.
GeolocationShapes::alterMap in src/Plugin/geolocation/MapFeature/GeolocationShapes.php
Alter render array.

File

src/Element/GeolocationMapPolyline.php, line 22

Namespace

Drupal\geolocation\Element
View source
class GeolocationMapPolyline extends GeolocationMapShapeBase {

  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    $class = get_class($this);
    return [
      '#process' => [
        [
          $class,
          'processGroup',
        ],
      ],
      '#pre_render' => [
        [
          $class,
          'preRenderGroup',
        ],
        [
          $this,
          'preRenderPolyline',
        ],
      ],
      '#title' => NULL,
      '#coordinates' => NULL,
      '#id' => NULL,
      '#stroke_color' => NULL,
      '#stroke_width' => NULL,
      '#stroke_opacity' => NULL,
    ];
  }

  /**
   * Polyline element.
   *
   * @param array $render_array
   *   Element.
   *
   * @return array
   *   Renderable map.
   */
  public function preRenderPolyline(array $render_array) {
    $render_array = parent::preRenderGeolocationShape($render_array);
    $render_array['#theme'] = 'geolocation_map_polyline';
    $render_array['#attributes']
      ->addClass('geolocation-polyline');
    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
GeolocationMapPolyline::getInfo public function Returns the element properties for this element. Overrides ElementInterface::getInfo
GeolocationMapPolyline::preRenderPolyline public function Polyline element.
GeolocationMapShapeBase::preRenderGeolocationShape public function Shape element.
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
RenderElement::preRenderAjaxForm public static function Adds Ajax information about an element to communicate with JavaScript.
RenderElement::preRenderGroup public static function Adds members of this group as actual elements for rendering.
RenderElement::processAjaxForm public static function Form element processing handler for the #ajax form property. 1
RenderElement::processGroup public static function Arranges elements into groups.
RenderElement::setAttributes public static function Sets a form element's class attribute. Overrides ElementInterface::setAttributes
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.