class Drawing in Geolocation Field 8.3
Same name and namespace in other branches
- 8.2 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("DEPRECATED - Drawing"),
description = @Translation("Draw lines and areas over markers."),
type = "google_maps",
)
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_google_maps\Plugin\geolocation\MapFeature\Drawing
- class \Drupal\geolocation\MapFeatureBase implements ContainerFactoryPluginInterface, MapFeatureInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
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\MapFeatureView 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) {
$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);
$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
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DependencySerializationTrait:: |
protected | property | An array of entity type IDs keyed by the property name of their storages. | |
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
Drawing:: |
public | function |
Alter render array. Overrides MapFeatureBase:: |
|
Drawing:: |
public static | function |
Provide a populated settings array. Overrides MapFeatureBase:: |
|
Drawing:: |
public | function |
Provide a generic map settings form array. Overrides MapFeatureBase:: |
|
Drawing:: |
public | function |
Provide a summary array to use in field formatters. Overrides MapFeatureBase:: |
|
MapFeatureBase:: |
public static | function |
Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface:: |
2 |
MapFeatureBase:: |
public | function |
Provide map feature specific settings ready to handover to JS. Overrides MapFeatureInterface:: |
|
MapFeatureBase:: |
public | function |
Validate Feature Form. Overrides MapFeatureInterface:: |
5 |
MessengerTrait:: |
protected | property | The messenger. | 29 |
MessengerTrait:: |
public | function | Gets the messenger. | 29 |
MessengerTrait:: |
public | function | Sets the messenger. | |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
protected | property | The plugin implementation definition. | 1 |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function |
Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
3 |
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
PluginBase:: |
public | function | Constructs a \Drupal\Component\Plugin\PluginBase object. | 92 |
StringTranslationTrait:: |
protected | property | The string translation service. | 1 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. |