interface LayerInterface in Openlayers 7.3

Interface LayerInterface.

Hierarchy

• interface \Drupal\openlayers\Types\ObjectInterface extends \Drupal\Component\Plugin\PluginInspectionInterface
  • interface \Drupal\openlayers\Types\LayerInterface

1 file declares its use of LayerInterface

OL3LayerSwitcher.php in modules/openlayers_library/src/Plugin/Control/OL3LayerSwitcher/OL3LayerSwitcher.php

Control: Attribution.

File

src/Types/LayerInterface.php, line 12

Interface LayerInterface.

Namespace

Drupal\openlayers\Types

interface LayerInterface extends ObjectInterface {

  /**
   * Returns the source of this layer.
   *
   * @return SourceInterface|FALSE
   *   The source of this layer.
   */
  public function getSource();

  /**
   * Set the source of this layer.
   *
   * @param SourceInterface $source
   *   The source object.
   *
   * @return LayerInterface
   *   The parent layer.
   */
  public function setSource(SourceInterface $source);

  /**
   * Returns the style of this layer.
   *
   * @return StyleInterface|FALSE
   *   The style of this layer.
   */
  public function getStyle();

  /**
   * Set the style of this layer.
   *
   * @param StyleInterface $style
   *   The style object.
   *
   * @return LayerInterface
   *   The parent layer.
   */
  public function setStyle(StyleInterface $style);

  /**
   * Set the opacity of the layer.
   *
   * @param float $opacity
   *   The opacity value, allowed values range from 0 to 1.
   *
   * @return LayerInterface
   *   The parent layer.
   */
  public function setOpacity($opacity);

  /**
   * Return the opacity of the layer (between 0 and 1).
   *
   * @return float
   *   The opacity of the layer.
   */
  public function getOpacity();

  /**
   * Set Z-index of the layer, which is used to order layers before rendering.
   *
   * @param int $zindex
   *   The Z-Index. Default is 0.
   *
   * @return LayerInterface
   *   The parent layer.
   */
  public function setZIndex($zindex);

  /**
   * Return the Z-index of the layer.
   *
   * @return int
   *   The Z-Index.
   */
  public function getZIndex();

  /**
   * Set the visibility of the layer.
   *
   * @param bool $visibility
   *   The visibility of the layer, TRUE or FALSE.
   *
   * @return LayerInterface
   *   The parent layer.
   */
  public function setVisible($visibility);

  /**
   * Return the visibility of the layer.
   *
   * @return bool
   *   The visibility of the layer, TRUE or FALSE.
   */
  public function getVisible();

}

Members

Name	Modifiers	Type	Description	Overrides
LayerInterface::getOpacity	public	function	Return the opacity of the layer (between 0 and 1).	2
LayerInterface::getSource	public	function	Returns the source of this layer.	2
LayerInterface::getStyle	public	function	Returns the style of this layer.	2
LayerInterface::getVisible	public	function	Return the visibility of the layer.	2
LayerInterface::getZIndex	public	function	Return the Z-index of the layer.	2
LayerInterface::setOpacity	public	function	Set the opacity of the layer.	2
LayerInterface::setSource	public	function	Set the source of this layer.	2
LayerInterface::setStyle	public	function	Set the style of this layer.	2
LayerInterface::setVisible	public	function	Set the visibility of the layer.	2
LayerInterface::setZIndex	public	function	Set Z-index of the layer, which is used to order layers before rendering.	2
ObjectInterface::addObject	public	function	Add an object into the collection of the parent object.	1
ObjectInterface::attached	public	function	Returns a list of attachments for building the render array.	1
ObjectInterface::clearOption	public	function	Remove an option.	1
ObjectInterface::dependencies	public	function	Defines dependencies.	1
ObjectInterface::getClassDirectory	public	function	Returns the path to the plugin directory.	1
ObjectInterface::getClassPath	public	function	Returns the path to the class file.	1
ObjectInterface::getCollection	public	function	Return the Collection object linked to the object.	1
ObjectInterface::getConfiguration	public	function	Return the object configuration.	1
ObjectInterface::getDependencies	public	function	Return all the dependencies objects of the parent object.	1
ObjectInterface::getDescription	public	function	Return the description of the object.	1
ObjectInterface::getExport	public	function	Return an object, CTools Exportable.	1
ObjectInterface::getFactoryService	public	function	Return the Factory Service of the object.	1
ObjectInterface::getId	public	function	Return the object unique ID.	2
ObjectInterface::getJS	public	function	Return the JS to insert in the page when building the object.	1
ObjectInterface::getMachineName	public	function	Return the unique machine name of the object.	1
ObjectInterface::getName	public	function	Return the human name of the object.	1
ObjectInterface::getObjects	public	function	Return an array of OL objects indexed by their type.	1
ObjectInterface::getOption	public	function	Returns an option.	1
ObjectInterface::getOptions	public	function	Return the options array.	1
ObjectInterface::getParents	public	function	Returns an array with the maps this object is attached on.	1
ObjectInterface::getPluginDescription	public	function	Return the description of the object's plugin.	1
ObjectInterface::getProvider	public	function	Return the module that provides this plugin.	1
ObjectInterface::getType	public	function	The type of this object.	1
ObjectInterface::getWeight	public	function	Get the weight of an object.	1
ObjectInterface::i18nStringsRefresh	public	function	Refresh string translations.	1
ObjectInterface::init	public	function	Initializes the object.	1
ObjectInterface::initCollection	public	function	Initializes the Collection, Import objects from options, Import the current object.	1
ObjectInterface::isAsynchronous	public	function	Whether or not this object has to be processed asynchronously.	1
ObjectInterface::optionsForm	public	function	Provides the options form to configure this object.	1
ObjectInterface::optionsFormSubmit	public	function	Submit callback for the options form.	1
ObjectInterface::optionsFormValidate	public	function	Validation callback for the options form.	1
ObjectInterface::optionsToObjects	public	function	Return a flat array containing Openlayers Objects from the options array.	1
ObjectInterface::postBuild	public	function	Invoked after an objects render array is built.	1
ObjectInterface::preBuild	public	function	Invoked before an objects render array is built.	1
ObjectInterface::removeObject	public	function	Remove an object from the collection.	1
ObjectInterface::resetCollection	public	function	Reset the object's Collection.	1
ObjectInterface::setFactoryService	public	function	Set the Factory Service of the object.	1
ObjectInterface::setId	public	function	Set the object ID.	1
ObjectInterface::setOption	public	function	Set an option.	1
ObjectInterface::setOptions	public	function	Set the options array.	1
ObjectInterface::setWeight	public	function	Set the weight of an object.	1