API / geotoolkit / map / features / converters / Aggregator / Aggregator
converters.Aggregator.Aggregator
Converts features into a binary tree for the purpose of aggregation nearby points. Only point-like features are supported.
↳
Aggregator
Constructors
Methods
Methods
▸ clear(): Aggregator
Clears all the features from the store
this
▸ dispose(): void
Dispose.
void
▸ getClassName(): string
string
▸ getFeatures(options): AbstractFeature[]
Returns saved features corresponded to the options
| Name | Type | Description |
|---|---|---|
options | FeaturesOptions | request options |
features stored
▸ getOptions(): Required<Options>
Gets current conversion options.
Required<Options>
convert options
▸ hasEventListener(type, callback?): boolean
Check if a list of event listeners for this type contains this listener
| Name | Type | Description |
|---|---|---|
type | string | type of event or property |
Optional callback | Function | to be called, if null, check if any callback is registered |
boolean
BaseConverter.hasEventListener
▸ isDisposed(): boolean
Returns whether this object has been disposed
boolean
▸ isSilent(): boolean
Return true if the event dispatcher doesn't notify any events
boolean
▸ notify<E>(type, source, args?): Aggregator
Notify listeners
| Name | Type |
|---|---|
E | extends string |
| Name | Type | Description |
|---|---|---|
type | E | event types |
source | BaseConverter | of the event |
Optional args | EventMap[E] | arguments of the event |
this
▸ off<E>(type?, callback?): Aggregator
Detach listener on event. Calling .off() with no arguments removes all attached listeners. Calling .off(type) with no callback removes all attached listeners for specific type.
| Name | Type |
|---|---|
E | extends string |
| Name | Type | Description |
|---|---|---|
Optional type | E | type of the event |
Optional callback | (eventType: E, sender: Aggregator, args: EventMap[E]) => void | function to be called |
this
▸ on<E>(type, callback): Aggregator
Attach listener on event that will be called whenever the specified event is delivered to the target
If the callback function is already in the list of event listeners for this target, the function is not added a second time.
If a particular anonymous function is in the list of event listeners registered for a certain target, and then later in the code, an identical anonymous function is given in an "on" call, the second function will also be added to the list of event listeners for that target.
| Name | Type |
|---|---|
E | extends string |
| Name | Type | Description |
|---|---|---|
type | E | type of event or property |
callback | (eventType: E, sender: Aggregator, args: EventMap[E]) => void | to be called |
this
▸ removeFeatures(features): Aggregator
Removes feature(s) from the store
| Name | Type | Description |
|---|---|---|
features | AbstractFeature | Iterator<AbstractFeature> | feature(s) to remove |
this
▸ saveConvertedFeatures(features): AbstractFeature[]
Converts and saves new features in array. All features are supported.
| Name | Type | Description |
|---|---|---|
features | AbstractFeature[] | new features to add |
features that were not processed
BaseConverter.saveConvertedFeatures
▸ setOptions(options): Aggregator
Sets new conversion options.
| Name | Type | Description |
|---|---|---|
options | Options | convert options |
this
▸ setSilent(bool): Aggregator
Set silent mode
| Name | Type | Description |
|---|---|---|
bool | boolean | flag to enable silent mode |
this
▸ Static getClassName(): string
string