API / geotoolkit / schematics / labeling / FunctionComponentsFilter / FunctionComponentsFilter
labeling.FunctionComponentsFilter.FunctionComponentsFilter
Filter implementation accepting a function with three parameters:<br>
- component node (see ComponentNode)<br>
- rendering context (see RenderingContext)<br>
- options (with options['locationtype'] of LocationType)<br>
Deprecated
since 4.0. Use LabelsFilter instead.
Constructors
- [new FunctionComponentsFilter(f)](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit.schematics.labeling.functioncomponentsfilter.functioncomponentsfilter.md#new functioncomponentsfilter(f))
Constructors
• new FunctionComponentsFilter(f)
| Name | Type | Description |
|---|---|---|
f | Function | function to operate on ComponentNode, RenderingContext and options |
Methods
▸ filterComponents(iterator, context): Iterator<ComponentNode>
Gets iterator over filtered components
| Name | Type | Description |
|---|---|---|
iterator | Iterator<ComponentNode> | input components iterator |
context | RenderingContext | rendering context |
iterator over components to label
IComponentsFilter.filterComponents
▸ getClassName(): string
string
IComponentsFilter.getClassName
▸ reset(options): FunctionComponentsFilter
Resets itself
| Name | Type | Description |
|---|---|---|
options | ResetOptions | options |
▸ Static getClassName(): string
string