Last updated

API / geotoolkit / schematics / labeling / LabelsFilter / LabelsFilter

Class: LabelsFilter

labeling.LabelsFilter.LabelsFilter

Table of contents

Constructors
Methods

Contents

Constructors

new LabelsFilter(options)

new LabelsFilter(options?)

Parameters

Name Type
Optional optionsOptions
Methods

afterLabeling

afterLabeling(labels, context, labelShape): LabelData[]

Runs after labeling, can be used for filter overlapped labels

Parameters

Name Type Description
labelsLabelData[]input array
contextRenderingContextrendering context
labelShapeLabelShapelabel shape template

Returns

LabelData[]

result filtered labels array


beforeLabeling

beforeLabeling(iterator, context, options): Iterator<ComponentNode>

Gets iterator over filtered components

Parameters

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

Returns

Iterator<ComponentNode>

iterator iterator over components to label


getClassName

getClassName(): string

Returns

string


labelInfo

labelInfo(node): string

Returns label in non legend mode

Parameters

Name Type Description
nodeComponentNodecomponent

Returns

string


nextLabel

nextLabel(): string

Returns label in legend mode

Returns

string


reset

reset(): LabelsFilter

Resets itself

Returns

LabelsFilter

this


getClassName

Static getClassName(): string

Returns

string