geocluster

This section covers the Geocluster model and the GeoclusterFinder class used to create, configure and query geoclusters and their features.

Subsections of geocluster

Geocluster

This is a base object that contains everything you can do with geoclusters.

constructor

Constructor

Parámetros

Nombre Tipo Opcional Descripción
ogapi InternalOpenGateAPI ❌ Reference to the API object.

withIdentifier(identifier)

Set the identifier attribute

Parámetros

Nombre Tipo Opcional Descripción
identifier string ❌ required field

Retorna

Tip

Tipo: Geocluster


Geocluster Finder

This class allows making GET requests to the geocluster resource in the OpenGate North API.

constructor

Constructor

Parámetros

Nombre Tipo Opcional Descripción
ogapi InternalOpenGateAPI ❌ Reference to the API object.

findAll()

Find all available geocluster. This execute a GET http method

Retorna

Tip

Tipo: Promise


findById(id)

Find a specify geocluster by an identifier. This execute a GET http method

Parámetros

Nombre Tipo Opcional Descripción
id string ❌ Identifier of the geocluster.

Retorna

Tip

Tipo: Promise


findFeatures(id, { zoom, topRight, bottomLeft })

Find features inside the coordinates. This execute a GET http method

Parámetros

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 .

Retorna

Tip

Tipo: Promise