You are here

class OpenlayersInteraction in Openlayers 8.4

Same name in this branch
  1. 8.4 src/Annotation/OpenlayersInteraction.php \Drupal\openlayers\Annotation\OpenlayersInteraction
  2. 8.4 src/Entity/OpenlayersInteraction.php \Drupal\openlayers\Entity\OpenlayersInteraction

Defines an image effect annotation object.

Plugin Namespace: Plugin\ImageEffect

For a working example, see \Drupal\image\Plugin\ImageEffect\ResizeImageEffect

Hierarchy

Expanded class hierarchy of OpenlayersInteraction

See also

hook_image_effect_info_alter()

\Drupal\image\ConfigurableImageEffectInterface

\Drupal\image\ConfigurableImageEffectBase

\Drupal\image\ImageEffectInterface

\Drupal\image\ImageEffectBase

\Drupal\image\ImageEffectManager

\Drupal\Core\ImageToolkit\Annotation\ImageToolkitOperation

Plugin API

5 classes are annotated with OpenlayersInteraction
DragPan in src/Plugin/OpenlayersInteraction/DragPan.php
Defines the Drag Pan interaction for an Openlayers map.
DragRotate in src/Plugin/OpenlayersInteraction/DragRotate.php
Defines the Drag Rotate interaction for an Openlayers map.
KeyboardPan in src/Plugin/OpenlayersInteraction/KeyboardPan.php
Defines the Keyboard Pan interaction for an Openlayers map.
KeyboardZoom in src/Plugin/OpenlayersInteraction/KeyboardZoom.php
Defines the Keyboard Zoom interaction for an Openlayers map.
MouseWheelZoom in src/Plugin/OpenlayersInteraction/MouseWheelZoom.php
Defines the Mouse Wheel Zoom interaction for an Openlayers map.

File

src/Annotation/OpenlayersInteraction.php, line 26

Namespace

Drupal\openlayers\Annotation
View source
class OpenlayersInteraction extends Plugin {

  /**
   * The plugin ID.
   *
   * @var string
   */
  public $id;

  /**
   * The human-readable name of the image effect.
   *
   * @ingroup plugin_translatable
   *
   * @var \Drupal\Core\Annotation\Translation
   */
  public $label;

  /**
   * A brief description of the image effect.
   *
   * This will be shown when adding or configuring this image effect.
   *
   * @ingroup plugin_translatable
   *
   * @var \Drupal\Core\Annotation\Translation (optional)
   */
  public $description = '';

}

Members

Namesort descending Modifiers Type Description Overrides
OpenlayersInteraction::$description public property A brief description of the image effect.
OpenlayersInteraction::$id public property The plugin ID.
OpenlayersInteraction::$label public property The human-readable name of the image effect.
Plugin::$definition protected property The plugin definition read from the class annotation. 1
Plugin::get public function Gets the value of an annotation. Overrides AnnotationInterface::get 5
Plugin::getClass public function Gets the class of the annotated class. Overrides AnnotationInterface::getClass
Plugin::getId public function Gets the unique ID for this annotated class. Overrides AnnotationInterface::getId
Plugin::getProvider public function Gets the name of the provider of the annotated class. Overrides AnnotationInterface::getProvider
Plugin::parse protected function Parses an annotation into its definition.
Plugin::setClass public function Sets the class of the annotated class. Overrides AnnotationInterface::setClass
Plugin::setProvider public function Sets the name of the provider of the annotated class. Overrides AnnotationInterface::setProvider
Plugin::__construct public function Constructs a Plugin object. 2