Last updated

API / geotoolkit / scene / shapes / painters / LineAndSymbolPainter / LineAndSymbolPainter

Class: LineAndSymbolPainter

painters.LineAndSymbolPainter.LineAndSymbolPainter

Draws line and symbol defined by painter

Hierarchy

Implements

Table of contents

Constructors
Methods
Css Properties
Name Type Description
linestylestringStyle for the line (if it should be different with the symbol)
linestyleLineStyleStyle for the line (if it should be different with the symbol)
linestyle-colorstringColor in CSS form
linestyle-fillstringOptional fill style to be used to fill lines generated with this style
linestyle-fillFillStyleOptional fill style to be used to fill lines generated with this style
linestyle-fill-colorstringColor in CSS form
linestyle-fill-evenoddmodebooleanEven-odd fill mode
linestyle-fill-fillpatternPatternPattern
linestyle-fill-fillpattern-containernamestringAn optional container name, which creates an image pattern. This parameter is used for serialization if you want to save are reference to pattern instead of the pattern itself
linestyle-fill-fillpattern-patternnamestringName of this pattern for indexing
linestyle-fill-fillpattern-scalablebooleanFlag that sets scalability of the pattern coordinates, or relative to the shape it is filling (It is not supported)
linestyle-fill-foregroundstringForeground color
linestyle-fill-patternPatternPattern
linestyle-linecapCapStyleThe line cap style
linestyle-linedashoffsetnumberLine dash offset of dashed line
linestyle-linejoinJoinStyleThe line join style
linestyle-pixelsnapmodebooleanPixel Snap Mode, default(
linestyle-scalablebooleanTrue if width should depend on transformation
linestyle-unitstringOptional unit for the width
linestyle-widthnumber | stringThe line thickness
painterstringPainter to be displayed with Horizontal line painter

Contents

Constructors

new LineAndSymbolPainter(painter)

new LineAndSymbolPainter(painter?)

Create LineAndSymbolPainter

Parameters

Name Type Description
Optional painterPainter | OptionsPainter to be displayed with Horizontal line painter or properties object

Overrides

EventDispatcher.constructor

Methods

dispose

dispose(): void

Dispose.

Returns

void

Inherited from

EventDispatcher.dispose


getClassName

getClassName(): string

Returns

string

Inherited from

EventDispatcher.getClassName


getPainter

getPainter(): EventDispatcher & IPainter | PainterFunction

Returns symbol painter

Returns

EventDispatcher & IPainter | PainterFunction

painter


getProperties

getProperties(): OptionsOut

Gets all the properties pertaining to the line and symbol painter

Returns

OptionsOut

line and symbol painter properties


hasEventListener

hasEventListener(type, callback?): boolean

Check if a list of event listeners for this type contains this listener

Parameters

Name Type Description
typestringtype of event or property
Optional callbackFunctionto be called, if null, check if any callback is registered

Returns

boolean

Inherited from

EventDispatcher.hasEventListener


isDisposed

isDisposed(): boolean

Returns whether this object has been disposed

Returns

boolean

Inherited from

EventDispatcher.isDisposed


isSilent

isSilent(): boolean

Return true if the event dispatcher doesn't notify any events

Returns

boolean

Inherited from

EventDispatcher.isSilent


notify

notify(type, source, args?): LineAndSymbolPainter

Notify listeners

Parameters

Name Type Description
typestringevent types
sourceanyof the event
Optional argsanyarguments of the event

Returns

LineAndSymbolPainter

this

Inherited from

EventDispatcher.notify


off

off(type?, callback?): LineAndSymbolPainter

Detach listener on event. Calling .off() with no arguments removes all attached listeners. Calling .off(type) with no callback removes all attached listeners for specific type.

Parameters

Name Type Description
Optional typestringtype of the event
Optional callbackEventListenerfunction to be called

Returns

LineAndSymbolPainter

this

Inherited from

EventDispatcher.off

off<E>(type, callback): LineAndSymbolPainter

Type parameters

NameType
Eextends string

Parameters

Name Type
typeE
callback(eventType: E, sender: LineAndSymbolPainter, args: EventMap[E]) => void

Returns

LineAndSymbolPainter

Inherited from

EventDispatcher.off


on

on(type, callback, options?): LineAndSymbolPainter

Attach listener on event that will be called whenever the specified event is delivered to the target

If the callback function is already in the list of event listeners for this target, the function is not added a second time.

If a particular anonymous function is in the list of event listeners registered for a certain target, and then later in the code, an identical anonymous function is given in an "on" call, the second function will also be added to the list of event listeners for that target.

Parameters

Name Type Description
typestringtype of event or property
callbackEventListenerto be called
Optional optionsOptionsoptions of subscription

Returns

LineAndSymbolPainter

this

Inherited from

EventDispatcher.on

on<E>(type, callback, options?): LineAndSymbolPainter

Type parameters

NameType
Eextends string

Parameters

Name Type
typeE
callback(eventType: E, sender: LineAndSymbolPainter, args: EventMap[E]) => void
Optional optionsOptions

Returns

LineAndSymbolPainter

Inherited from

EventDispatcher.on


render

render(context, symbol, bbox): void

Draw text on context

Parameters

Name Type Description
contextRenderingContextrendering context
symbolSymbolShapesymbol, which uses this painter
bboxRectbounding box

Returns

void

Implementation of

IPainter.render


setLineStyle

setLineStyle(style): LineAndSymbolPainter

Sets style for the line (if it should be different with the symbol)

Parameters

Name Type Description
styleTypestyle for the line (if it should be different with the symbol)

Returns

LineAndSymbolPainter

this


setPainter

setPainter(painter?): LineAndSymbolPainter

Sets symbol painter for Line Chart

Parameters

Name Type Description
Optional painterPainterPainter to be displayed with Horizontal line painter

Returns

LineAndSymbolPainter

this


setProperties

setProperties(props?): LineAndSymbolPainter

Sets all the properties pertaining to this object

Parameters

Name Type Description
Optional propsOptionsline and symbol painter properties

Returns

LineAndSymbolPainter

this


setSilent

setSilent(bool): LineAndSymbolPainter

Set silent mode

Parameters

Name Type Description
boolbooleanflag to enable silent mode

Returns

LineAndSymbolPainter

this

Inherited from

EventDispatcher.setSilent


getClassName

Static getClassName(): string

Returns

string

Inherited from

EventDispatcher.getClassName