Skip to content
Last updated

API / geotoolkit / schematics / labeling / FunctionComponentsFilter / FunctionComponentsFilter

Class: FunctionComponentsFilter

labeling.FunctionComponentsFilter.FunctionComponentsFilter

Filter implementation accepting a function with three parameters:<br>

  1. component node (see ComponentNode)<br>
  2. rendering context (see RenderingContext)<br>
  3. options (with options['locationtype'] of LocationType)<br>

Deprecated

since 4.0. Use LabelsFilter instead.

Implements

Table of contents

Constructors
  • [new FunctionComponentsFilter(f)](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit.schematics.labeling.functioncomponentsfilter.functioncomponentsfilter.md#new functioncomponentsfilter(f))
Methods

Contents

Constructors

new FunctionComponentsFilter(f)

• new FunctionComponentsFilter(f)

Parameters

Name Type Description
fFunctionfunction to operate on ComponentNode, RenderingContext and options
Methods

filterComponents

▸ filterComponents(iterator, context): Iterator<ComponentNode&gt;

Gets iterator over filtered components

Parameters

Name Type Description
iteratorIterator<ComponentNode&gt;input components iterator
contextRenderingContextrendering context

Returns

Iterator<ComponentNode&gt;

iterator over components to label

Implementation of

IComponentsFilter.filterComponents


getClassName

▸ getClassName(): string

Returns

string

Implementation of

IComponentsFilter.getClassName


reset

▸ reset(options): FunctionComponentsFilter

Resets itself

Parameters

Name Type Description
optionsResetOptionsoptions

Returns

FunctionComponentsFilter

Implementation of

IComponentsFilter.reset


getClassName

▸ Static getClassName(): string

Returns

string