geocluster
This section covers the Geocluster model and the GeoclusterFinder class used to create, configure and query geoclusters and their features.
This section covers the Geocluster model and the GeoclusterFinder class used to create, configure and query geoclusters and their features.
This is a base object that contains everything you can do with geoclusters.
Constructor
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| ogapi | InternalOpenGateAPI |
❌ | Reference to the API object. |
Set the identifier attribute
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| identifier | string |
❌ | required field |
Tipo: Geocluster
This class allows making GET requests to the geocluster resource in the OpenGate North API.
Constructor
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| ogapi | InternalOpenGateAPI |
❌ | Reference to the API object. |
Find all available geocluster. This execute a GET http method
Tipo: Promise
Find a specify geocluster by an identifier. This execute a GET http method
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| id | string |
❌ | Identifier of the geocluster. |
Tipo: Promise
Find features inside the coordinates. This execute a GET http method
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| id | string |
❌ | Identifier of the geocluster. |
| coordinates | Object |
❌ | square defined by the coordinates and the zoom used to find the inside features . |
Tipo: Promise