class JSGeocoder in Openlayers 7.3
Class JSGeocoder.
Plugin annotation
@OpenlayersPlugin(
id = "JSGeocoder",
description = "JSGeocoder input to geocode addresses to coordinates using Google services."
)
Hierarchy
- class \Drupal\openlayers\Types\Base extends \Drupal\Component\Plugin\PluginBase implements ObjectInterface
- class \Drupal\openlayers\Types\Control implements ControlInterface
- class \Drupal\openlayers_library\Plugin\Control\JSGeocoder\JSGeocoder
- class \Drupal\openlayers\Types\Control implements ControlInterface
Expanded class hierarchy of JSGeocoder
File
- modules/
openlayers_library/ src/ Plugin/ Control/ JSGeocoder/ JSGeocoder.php, line 19 - Control: JSGeocoder.
Namespace
Drupal\openlayers_library\Plugin\Control\JSGeocoderView source
class JSGeocoder extends Control {
/**
* {@inheritdoc}
*/
public function optionsForm(array &$form, array &$form_state) {
$form['options']['placeholder'] = array(
'#type' => 'textfield',
'#title' => 'Placeholder',
'#default_value' => $this
->getOption('placeholder', 'Search with Google...'),
);
$form['options']['loadingPlaceholder'] = array(
'#type' => 'textfield',
'#title' => 'Placeholder to display while loading the Google libraries',
'#default_value' => $this
->getOption('loadingPlaceholder', 'Loading the Google awesomeness...'),
);
$form['options']['size'] = array(
'#type' => 'textfield',
'#title' => 'Size of the textbox',
'#default_value' => $this
->getOption('size', 25),
);
$form['options']['autocomplete'] = array(
'#type' => 'checkbox',
'#title' => 'Autocomplete the text input when a result is found ?',
'#default_value' => $this
->getOption('autocomplete', FALSE),
);
$form['options']['timeout'] = array(
'#type' => 'textfield',
'#title' => 'Debounce timeout',
'#default_value' => $this
->getOption('timeout', 500),
'#description' => 'Time in milliseconds before the input is submitted to Google.',
);
$form['options']['zoom'] = array(
'#type' => 'textfield',
'#title' => 'Zoom to apply in when a result is found ?',
'#default_value' => $this
->getOption('zoom', '0'),
'#description' => 'Zoom to set the map to when Google return a successful result. 0 to disable.',
);
}
}
Members
Name![]() |
Modifiers | Type | Description | Overrides |
---|---|---|---|---|
Base:: |
protected | property | Holds all the attachment used by this object. | 6 |
Base:: |
protected | property | Holds the Collection object. | |
Base:: |
protected | property | A unique ID for the object. | |
Base:: |
public | function |
Add an object into the collection of the parent object. Overrides ObjectInterface:: |
|
Base:: |
public | function |
Returns a list of attachments for building the render array. Overrides ObjectInterface:: |
6 |
Base:: |
public | function |
Remove an option. Overrides ObjectInterface:: |
|
Base:: |
public | function |
Defines dependencies. Overrides ObjectInterface:: |
3 |
Base:: |
public | function |
Returns the path to the plugin directory. Overrides ObjectInterface:: |
|
Base:: |
public | function |
Returns the path to the class file. Overrides ObjectInterface:: |
|
Base:: |
public | function |
Return the Collection object linked to the object. Overrides ObjectInterface:: |
|
Base:: |
public | function |
Return the object configuration. Overrides ObjectInterface:: |
|
Base:: |
public | function |
Return all the dependencies objects of the parent object. Overrides ObjectInterface:: |
|
Base:: |
public | function |
Return the description of the object. Overrides ObjectInterface:: |
|
Base:: |
public | function |
Return an object, CTools Exportable. Overrides ObjectInterface:: |
|
Base:: |
public | function |
Return the Factory Service of the object. Overrides ObjectInterface:: |
|
Base:: |
public | function |
Return the object unique ID. Overrides ObjectInterface:: |
|
Base:: |
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:: |
6 |
Base:: |
public | function |
Return the unique machine name of the object. Overrides ObjectInterface:: |
|
Base:: |
public | function |
Return the human name of the object. Overrides ObjectInterface:: |
|
Base:: |
public | function |
Return an array of OL objects indexed by their type. Overrides ObjectInterface:: |
|
Base:: |
public | function |
Returns an option. Overrides ObjectInterface:: |
|
Base:: |
public | function |
Return the options array. Overrides ObjectInterface:: |
|
Base:: |
public | function |
Returns an array with the maps this object is attached on. Overrides ObjectInterface:: |
|
Base:: |
public | function |
Return the description of the object's plugin. Overrides ObjectInterface:: |
|
Base:: |
public | function |
Return the module that provides this plugin. Overrides ObjectInterface:: |
|
Base:: |
public | function |
The type of this object. Overrides ObjectInterface:: |
|
Base:: |
public | function |
Get the weight of an object. Overrides ObjectInterface:: |
|
Base:: |
public | function |
Refresh string translations. Overrides ObjectInterface:: |
1 |
Base:: |
public | function |
Initializes the object. Overrides ObjectInterface:: |
2 |
Base:: |
public | function |
Initializes the Collection,
Import objects from options,
Import the current object. Overrides ObjectInterface:: |
|
Base:: |
public | function |
Whether or not this object has to be processed asynchronously. Overrides ObjectInterface:: |
3 |
Base:: |
public | function |
Submit callback for the options form. Overrides ObjectInterface:: |
11 |
Base:: |
public | function |
Validation callback for the options form. Overrides ObjectInterface:: |
|
Base:: |
public | function |
Return a flat array containing Openlayers Objects from the options array. Overrides ObjectInterface:: |
9 |
Base:: |
public | function |
Invoked after an objects render array is built. Overrides ObjectInterface:: |
13 |
Base:: |
public | function |
Invoked before an objects render array is built. Overrides ObjectInterface:: |
4 |
Base:: |
public | function |
Remove an object from the collection. Overrides ObjectInterface:: |
|
Base:: |
public | function |
Reset the object's Collection. Overrides ObjectInterface:: |
|
Base:: |
public | function |
Set the Factory Service of the object. Overrides ObjectInterface:: |
|
Base:: |
public | function |
Set the object ID. Overrides ObjectInterface:: |
|
Base:: |
public | function |
Set an option. Overrides ObjectInterface:: |
|
Base:: |
public | function |
Set the options array. Overrides ObjectInterface:: |
|
Base:: |
public | function |
Set the weight of an object. Overrides ObjectInterface:: |
|
Control:: |
protected | property |
The array containing the options. Overrides Base:: |
|
JSGeocoder:: |
public | function |
@TODO What is this return? If it is the form, why is form by reference? Overrides Base:: |