Last updated

API / geotoolkit / schematics / labeling / FunctionComponentsFilter / FunctionComponentsFilter

Class: FunctionComponentsFilter

labeling.FunctionComponentsFilter.FunctionComponentsFilter

Filter implementation accepting a function with three parameters:

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

Deprecated

since 4.0. Use LabelsFilter instead.

Implements

Table of contents

Constructors
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>

Gets iterator over filtered components

Parameters

Name Type Description
iteratorIterator<ComponentNode>input components iterator
contextRenderingContextrendering context

Returns

Iterator<ComponentNode>

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