You are here

Home » API reference » Openlayers 7.3 » SpinJS.php

class SpinJS in Openlayers 7.3

Class SpinJS.

Plugin annotation


@OpenlayersPlugin(
  id = "SpinJS",
  description = "Provides a JS Spinner when the map is loading."
)

Hierarchy

Expanded class hierarchy of SpinJS

File

modules/openlayers_library/src/Plugin/Component/SpinJS/SpinJS.php, line 22
Component: SpinJS. Author: http://fgnass.github.io/spin.js/

Namespace

Drupal\openlayers_library\Plugin\Component\SpinJS
View source 
class SpinJS extends Component {

  /**
   * {@inheritdoc}
   */
  public function postBuild(array &$build, ObjectInterface $context = NULL) {
    $build['#attached']['js'][] = array(
      'data' => array(
        'spinjs' => array(
          $context
            ->getId() => $this
            ->getOptions(),
        ),
      ),
      'type' => 'setting',
    );
  }

  /**
   * {@inheritdoc}
   */
  public function optionsForm(array &$form, array &$form_state) {
    $form['options']['lines'] = array(
      '#type' => 'textfield',
      '#title' => 'Lines',
      '#description' => 'The number of lines to draw',
      '#default_value' => $this
        ->getOption('lines', 12),
    );
    $form['options']['length'] = array(
      '#type' => 'textfield',
      '#title' => 'Length',
      '#description' => 'The length of each line',
      '#default_value' => $this
        ->getOption('length', 7),
    );
    $form['options']['width'] = array(
      '#type' => 'textfield',
      '#title' => 'Width',
      '#description' => 'The line thickness',
      '#default_value' => $this
        ->getOption('width', 5),
    );
    $form['options']['radius'] = array(
      '#type' => 'textfield',
      '#title' => 'Radius',
      '#description' => 'The radius of the inner circle',
      '#default_value' => $this
        ->getOption('radius', 10),
    );
    $form['options']['scale'] = array(
      '#type' => 'textfield',
      '#title' => 'Scale',
      '#description' => 'Scales overall size of the spinner',
      '#default_value' => $this
        ->getOption('scale', 1.0),
    );
    $form['options']['corners'] = array(
      '#type' => 'textfield',
      '#title' => 'Corners',
      '#description' => 'Corner roundness (0..1)',
      '#default_value' => $this
        ->getOption('corners', 1),
    );
    $form['options']['color'] = array(
      '#type' => 'textfield',
      '#title' => 'Color',
      '#description' => '#rgb or #rrggbb',
      '#default_value' => $this
        ->getOption('color', '#000'),
    );
    $form['options']['opacity'] = array(
      '#type' => 'textfield',
      '#title' => 'Opacity',
      '#description' => 'Opacity',
      '#default_value' => $this
        ->getOption('opacity', 0.25),
    );
    $form['options']['rotate'] = array(
      '#type' => 'textfield',
      '#title' => 'Rotate',
      '#description' => 'Rotation offset',
      '#default_value' => $this
        ->getOption('rotate', 0),
    );
    $form['options']['direction'] = array(
      '#type' => 'textfield',
      '#title' => 'Direction',
      '#description' => '1: clockwise, -1: counterclockwise',
      '#default_value' => $this
        ->getOption('direction', 1),
    );
    $form['options']['speed'] = array(
      '#type' => 'textfield',
      '#title' => 'Speed',
      '#description' => 'Rounds per second',
      '#default_value' => $this
        ->getOption('speed', 1),
    );
    $form['options']['trail'] = array(
      '#type' => 'textfield',
      '#title' => 'Trail',
      '#description' => 'Afterglow percentage',
      '#default_value' => $this
        ->getOption('trail', 100),
    );
    $form['options']['fps'] = array(
      '#type' => 'textfield',
      '#title' => 'FPS',
      '#description' => 'Frames per second when using setTimeout()',
      '#default_value' => $this
        ->getOption('fps', 20),
    );
    $form['options']['zIndex'] = array(
      '#type' => 'textfield',
      '#title' => 'z-index',
      '#description' => 'Use a high z-index by default',
      '#default_value' => $this
        ->getOption('zIndex', 0),
    );
    $form['options']['className'] = array(
      '#type' => 'textfield',
      '#title' => 'Classname',
      '#description' => 'Use a high z-index by default',
      '#default_value' => $this
        ->getOption('className', 'spinner'),
    );
    $form['options']['top'] = array(
      '#type' => 'textfield',
      '#title' => 'Top',
      '#description' => 'Center vertically',
      '#default_value' => $this
        ->getOption('top', '50%'),
    );
    $form['options']['left'] = array(
      '#type' => 'textfield',
      '#title' => 'Left',
      '#description' => 'Center horizontally',
      '#default_value' => $this
        ->getOption('left', '50%'),
    );
    $form['options']['shadow'] = array(
      '#type' => 'checkbox',
      '#title' => 'Shadow',
      '#description' => 'Whether to render a shadow',
      '#default_value' => $this
        ->getOption('shadow', FALSE),
    );
    $form['options']['hwaccel'] = array(
      '#type' => 'checkbox',
      '#title' => 'Hardware acceleration',
      '#description' => 'Whether to use hardware acceleration (might be buggy)',
      '#default_value' => $this
        ->getOption('hwaccel', FALSE),
    );
    $form['options']['position'] = array(
      '#type' => 'textfield',
      '#title' => 'Position',
      '#description' => 'Element positioning',
      '#default_value' => $this
        ->getOption('position', 'absolute'),
    );
  }

  /**
   * {@inheritdoc}
   */
  public function optionsFormSubmit(array $form, array &$form_state) {
    $form_state['values']['options']['shadow'] = (bool) $form_state['values']['options']['shadow'];
    $form_state['values']['options']['hwaccel'] = (bool) $form_state['values']['options']['hwaccel'];
    parent::optionsFormSubmit($form, $form_state);
  }

}

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::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::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
Component::$options protected property The array containing the options. Overrides Base::$options
SpinJS::optionsForm public function @TODO What is this return? If it is the form, why is form by reference? Overrides Base::optionsForm
SpinJS::optionsFormSubmit public function Submit callback for the options form. Overrides Base::optionsFormSubmit
SpinJS::postBuild public function Invoked after an objects render array is built. Overrides Base::postBuild