Last updated

API / geotoolkit / attributes / LineDecoration / LineDecoration

Class: LineDecoration

attributes.LineDecoration.LineDecoration

Defines a class that contains line rendering decoration strategies.

Table of contents

Constructors
Accessors
Methods

Contents

Constructors

new LineDecoration()

new LineDecoration()

Accessors

Double

Static get Double(): ILineDecoration

Double line decoration type

Name

module:geotoolkit/attributes/LineDecoration~LineDecoration~Double

Returns

ILineDecoration


DoubleWavy

Static get DoubleWavy(): ILineDecoration

Double-Wavy line decoration type

Name

module:geotoolkit/attributes/LineDecoration~LineDecoration~DoubleWavy

Returns

ILineDecoration


Solid

Static get Solid(): ILineDecoration

Solid line decoration type

Name

module:geotoolkit/attributes/LineDecoration~LineDecoration~Solid

Returns

ILineDecoration


Wavy

Static get Wavy(): ILineDecoration

Wavy line decoration type

Name

module:geotoolkit/attributes/LineDecoration~LineDecoration~Wavy

Returns

ILineDecoration

Methods

getClassName

getClassName(): string

Returns

string


fromObject

Static fromObject(decoration?): ILineDecoration

Create or get line decoration strategy from object

Parameters

Name Type Description
Optional decorationstring | ILineDecorationdecoration can be a name of LineDecoration instance if it is registered

Returns

ILineDecoration

line decoration strategy


getClassName

Static getClassName(): string

Returns

string


getLineDecoration

Static getLineDecoration(lineDecorationType): ILineDecoration

Return line decoration by type name

Parameters

Name Type Description
lineDecorationTypestringline decoration type

Returns

ILineDecoration

instance of line decoration


getPainter

Static getPainter(painter, size): ILineDecoration

Return line decoration as painter

Parameters

Name Type Description
painterPainterpainter of line decoration
sizeDimensionsize of parinter

Returns

ILineDecoration


registerLineDecoration

Static registerLineDecoration(shortTypeName, lineDecoration): void

Register line decoration type by name

Parameters

Name Type Description
shortTypeNamestringtype name of the line decoration
lineDecorationILineDecorationline decoration instance

Returns

void