Last updated

API / geotoolkit / map / features / adapters / AlongPath / AlongPath

Class: AlongPath

adapters.AlongPath.AlongPath

Looks for a geometry point that is not overlapping with other labels (NoAnnotationOverlap filter) and applies it to Text as an anchor to render shape along the path

Implements

Table of contents

Constructors
Methods

Contents

Constructors

new AlongPath(options)

new AlongPath(options?)

Parameters

Name Type Description
Optional optionsOffsetoptions
Methods

apply

apply(geometry, text, context?): void

Appliess saved point of polyline to Text as an anchor

Parameters

Name Type Description
geometryGeometry | Geometryfeature geometry
textAnchoredShapetext shape to set the anchor on
Optional contextTransformation | RenderingContextrendering context or its transformation

Returns

void

Implementation of

IGeometryToText.apply


getClassName

getClassName(): string

Returns

string


setOptions

setOptions(options): AlongPath

Sets feature_geometry-to-text_anchor_position offset options. For the new options to take effect on layer, the layer has to be invalidated.

Parameters

Name Type Description
optionsOffsetoptions

Returns

AlongPath

this


getClassName

Static getClassName(): string

Returns

string