You are here

Home » API reference » Openlayers 7.3 » Interaction.php

abstract class Interaction in Openlayers 7.3

Class Interaction.

Hierarchy

Expanded class hierarchy of Interaction

19 files declare their use of Interaction
DoubleClickZoom.php in src/Plugin/Interaction/DoubleClickZoom/DoubleClickZoom.php
Interaction: DoubleClickZoom.
DragAndDrop.php in src/Plugin/Interaction/DragAndDrop/DragAndDrop.php
Interaction: DragAndDrop.
DragBox.php in src/Plugin/Interaction/DragBox/DragBox.php
Interaction: DragBox.
DragPan.php in src/Plugin/Interaction/DragPan/DragPan.php
Interaction: DragPan.
DragRotate.php in src/Plugin/Interaction/DragRotate/DragRotate.php
Interaction: DragRotate.

... See full list

7 string references to 'Interaction'
openlayers.services.yml in ./openlayers.services.yml
openlayers.services.yml
openlayers_interaction_form_options in modules/openlayers_ui/src/Plugin/export_ui/OpenlayersInteractions.inc
Interaction options config form handler.
openlayers_interaction_form_options_submit in modules/openlayers_ui/src/Plugin/export_ui/OpenlayersInteractions.inc
Interaction options config form submit handler.
openlayers_interaction_form_options_validate in modules/openlayers_ui/src/Plugin/export_ui/OpenlayersInteractions.inc
Interaction options config form validation handler.
openlayers_interaction_form_type in modules/openlayers_ui/src/Plugin/export_ui/OpenlayersInteractions.inc
Interaction type config form handler.

... See full list

File

src/Types/Interaction.php, line 12
Class Interaction.

Namespace

Drupal\openlayers\Types
View source 
abstract class Interaction extends Base implements InteractionInterface {

  /**
   * The array containing the options.
   *
   * @var array
   */
  protected $options;

}

Members

Namesort descending Modifiers Type Description Overrides
Base::$attached protected property Holds all the attachment used by this object. 6
Base::$collection protected property Holds the Collection object.
Base::$id protected property A unique ID for the object.
Base::addObject public function Add an object into the collection of the parent object. Overrides ObjectInterface::addObject
Base::attached public function Returns a list of attachments for building the render array. Overrides ObjectInterface::attached 6
Base::clearOption public function Remove an option. Overrides ObjectInterface::clearOption
Base::dependencies public function Defines dependencies. Overrides ObjectInterface::dependencies 3
Base::getClassDirectory public function Returns the path to the plugin directory. Overrides ObjectInterface::getClassDirectory
Base::getClassPath public function Returns the path to the class file. Overrides ObjectInterface::getClassPath
Base::getCollection public function Return the Collection object linked to the object. Overrides ObjectInterface::getCollection
Base::getConfiguration public function Return the object configuration. Overrides ObjectInterface::getConfiguration
Base::getDependencies public function Return all the dependencies objects of the parent object. Overrides ObjectInterface::getDependencies
Base::getDescription public function Return the description of the object. Overrides ObjectInterface::getDescription
Base::getExport public function Return an object, CTools Exportable. Overrides ObjectInterface::getExport
Base::getFactoryService public function Return the Factory Service of the object. Overrides ObjectInterface::getFactoryService
Base::getId public function Return the object unique ID. Overrides ObjectInterface::getId
Base::getJS public function !Attention! This function will remove any option that is named after a plugin type e.g.: layers, controls, styles, interactions, components . Overrides ObjectInterface::getJS 6
Base::getMachineName public function Return the unique machine name of the object. Overrides ObjectInterface::getMachineName
Base::getName public function Return the human name of the object. Overrides ObjectInterface::getName
Base::getObjects public function Return an array of OL objects indexed by their type. Overrides ObjectInterface::getObjects
Base::getOption public function Returns an option. Overrides ObjectInterface::getOption
Base::getOptions public function Return the options array. Overrides ObjectInterface::getOptions
Base::getParents public function Returns an array with the maps this object is attached on. Overrides ObjectInterface::getParents
Base::getPluginDescription public function Return the description of the object's plugin. Overrides ObjectInterface::getPluginDescription
Base::getProvider public function Return the module that provides this plugin. Overrides ObjectInterface::getProvider
Base::getType public function The type of this object. Overrides ObjectInterface::getType
Base::getWeight public function Get the weight of an object. Overrides ObjectInterface::getWeight
Base::i18nStringsRefresh public function Refresh string translations. Overrides ObjectInterface::i18nStringsRefresh 1
Base::init public function Initializes the object. Overrides ObjectInterface::init 2
Base::initCollection public function Initializes the Collection, Import objects from options, Import the current object. Overrides ObjectInterface::initCollection
Base::isAsynchronous public function Whether or not this object has to be processed asynchronously. Overrides ObjectInterface::isAsynchronous 3
Base::optionsForm public function @TODO What is this return? If it is the form, why is form by reference? Overrides ObjectInterface::optionsForm 54
Base::optionsFormSubmit public function Submit callback for the options form. Overrides ObjectInterface::optionsFormSubmit 11
Base::optionsFormValidate public function Validation callback for the options form. Overrides ObjectInterface::optionsFormValidate
Base::optionsToObjects public function Return a flat array containing Openlayers Objects from the options array. Overrides ObjectInterface::optionsToObjects 9
Base::postBuild public function Invoked after an objects render array is built. Overrides ObjectInterface::postBuild 13
Base::preBuild public function Invoked before an objects render array is built. Overrides ObjectInterface::preBuild 4
Base::removeObject public function Remove an object from the collection. Overrides ObjectInterface::removeObject
Base::resetCollection public function Reset the object's Collection. Overrides ObjectInterface::resetCollection
Base::setFactoryService public function Set the Factory Service of the object. Overrides ObjectInterface::setFactoryService
Base::setId public function Set the object ID. Overrides ObjectInterface::setId
Base::setOption public function Set an option. Overrides ObjectInterface::setOption
Base::setOptions public function Set the options array. Overrides ObjectInterface::setOptions
Base::setWeight public function Set the weight of an object. Overrides ObjectInterface::setWeight
Interaction::$options protected property The array containing the options. Overrides Base::$options