Last updated

API / geotoolkit / charts / painters / ShadowPainter / ShadowPainter

Class: ShadowPainter

painters.ShadowPainter.ShadowPainter

Special painter to draw shadow around original painter. For proper drawing original painter should be set via setProperties.

Hierarchy

Table of contents

Constructors
Methods
Css Properties
Name Type Description
geometryGroupGeometry
geometry-automodellimitsmodebooleanAuto model limits mode
geometry-boundsRectDefine position of the group in the parent
geometry-bounds-heightnumberHeight
geometry-bounds-readonlybooleanReadonly
geometry-bounds-widthnumberWidth
geometry-bounds-xnumberLeft
geometry-bounds-ynumberTop
geometry-clippingbooleanEnable clipping, this does not consider the clipstyle, it is related to bounds-clipping
geometry-clipstyleClipStyleClipping style
geometry-clipstyle-evenoddbooleanTrue if evenodd mode is on ('nonzero' mode otherwise)
geometry-clipstyle-geometryGraphicsPathClipping geometry
geometry-clipstyle-geometry-boundsRectBounds
geometry-clipstyleGraphicsPathClipping style
geometry-contentorientationOrientationContent orientation
geometry-cssclassstringThe css class name of this node
geometry-csscursorstringCSS cursor associated with node
geometry-cssstylestringCSS style to be applied to inserted elements
geometry-fillstylestringFill style
geometry-fillstyleFillStyleFill style
geometry-fillstyle-colorstringColor in CSS form
geometry-fillstyle-evenoddmodebooleanEven-odd fill mode
geometry-fillstyle-fillpatternPatternPattern
geometry-fillstyle-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
geometry-fillstyle-fillpattern-patternnamestringName of this pattern for indexing
geometry-fillstyle-fillpattern-scalablebooleanFlag that sets scalability of the pattern coordinates, or relative to the shape it is filling (It is not supported)
geometry-fillstyle-foregroundstringForeground color
geometry-fillstyle-patternPatternPattern
geometry-horizontalflipbooleanHorizontal axis goes from right to left
geometry-idstring | numberId of the node, its a unique identifier
geometry-infinitybooleanMode to render outside the model limits
geometry-layoutstyleLayoutStyleLayout style to be used for parent layout
geometry-layoutstyle-constraintSizeConstraintLayout constrains
geometry-layoutstyle-flexgrownumberNumber specifying how much the item will grow relative to the rest of the items inside the same container
geometry-layoutstyle-flexshrinknumberNumber specifying how much the item will shrink relative to the rest of the items inside the same container
geometry-layoutstyle-floatstringFloat position
geometry-layoutstyle-positionstringLayout position
geometry-layoutstyle-sizenumber | stringLayout size
geometry-linestylestringLine style
geometry-linestyleLineStyleLine style
geometry-linestyle-colorstringColor in CSS form
geometry-linestyle-fillstringOptional fill style to be used to fill lines generated with this style
geometry-linestyle-fillFillStyleOptional fill style to be used to fill lines generated with this style
geometry-linestyle-linecapCapStyleThe line cap style
geometry-linestyle-linedashoffsetnumberLine dash offset of dashed line
geometry-linestyle-linejoinJoinStyleThe line join style
geometry-linestyle-pixelsnapmodebooleanPixel Snap Mode, default(
geometry-linestyle-scalablebooleanTrue if width should depend on transformation
geometry-linestyle-unitstringOptional unit for the width
geometry-linestyle-widthnumber | stringThe line thickness
geometry-localtransformTransformationLocal transformation
geometry-localtransform-dxnumberX axis translation
geometry-localtransform-dynumberY axis translation
geometry-localtransform-xxnumberX scale
geometry-localtransform-xynumberXy skew
geometry-localtransform-yxnumberYx skew
geometry-localtransform-yynumberY scale
geometry-marginsnumber | stringIt has properties for specifying the margins for each side
geometry-modellimitsRectDefine inner model coordinates of the group
geometry-namestringName of the node. It is often used for debugging purposes or to simplify queries
geometry-opacitynumberNode opacity (from 0 to 1). If it is undefined or null it inherits property from the parent. It changes globalAlpha on the rendering context
geometry-opacityblendmodeBlendModeNode opacity mode to blend it
geometry-paddingnumber | stringIt has properties for specifying the padding for each side
geometry-pickingchildrenbooleanEnable picking children
geometry-scalescrollstrategyScaleScrollStrategyScale scroll strategy
geometry-scalescrollstrategy-enabledbooleanEnable flag
geometry-selectablebooleanSelectable node, a boolean to determine if selection should consider this node
geometry-taganyCustom information associated with node. It is a user object which can be used by client code to store information or attach an application object to the shape
geometry-transformstringAdditional CSS transformation applied to node or 'none'
geometry-transformTransformationAdditional CSS transformation applied to node or 'none'
geometry-verticalflipbooleanVertical axis goes from bottom to top
geometry-viewcachebooleanView cache to cache child nodes
geometry-visiblebooleanVisibility of the node, a boolean to determine if the node should be rendered or not
geometry-z-indexnumberDefine node z-index
painterstring

Contents

Constructors

new ShadowPainter()

new ShadowPainter()

Overrides

GeometryPainter.constructor

Methods

clone

clone(): GeometryPainter

Returns clone

Returns

GeometryPainter

clone

Inherited from

GeometryPainter.clone


dispose

dispose(): void

Dispose.

Returns

void

Inherited from

GeometryPainter.dispose


enumerateNodes

enumerateNodes(callback, target?): void

Enumerate children nodes

Parameters

Name Type Description
callbackCallback<Node>callback
Optional targetQueryBuilder<any>target

Returns

void

Inherited from

GeometryPainter.enumerateNodes


getClassName

getClassName(): string

Returns

string

Inherited from

GeometryPainter.getClassName


getGeometry

getGeometry(): Group<Node>

Return geometry

Returns

Group<Node>

geometry

Inherited from

GeometryPainter.getGeometry


getProperties

getProperties(): OptionsOut

Returns all the properties pertaining to the geometry painter

Returns

OptionsOut

geometry painter properties

Inherited from

GeometryPainter.getProperties


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

GeometryPainter.hasEventListener


isDisposed

isDisposed(): boolean

Returns whether this object has been disposed

Returns

boolean

Inherited from

GeometryPainter.isDisposed


isSilent

isSilent(): boolean

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

Returns

boolean

Inherited from

GeometryPainter.isSilent


notify

notify(type, source, args?): ShadowPainter

Notify listeners

Parameters

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

Returns

ShadowPainter

this

Inherited from

GeometryPainter.notify


off

off(type?, callback?): ShadowPainter

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

ShadowPainter

this

Inherited from

GeometryPainter.off

off<E>(type, callback): ShadowPainter

Type parameters

NameType
Eextends string

Parameters

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

Returns

ShadowPainter

Inherited from

GeometryPainter.off


on

on(type, callback, options?): ShadowPainter

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

ShadowPainter

this

Inherited from

GeometryPainter.on

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

Type parameters

NameType
Eextends string

Parameters

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

Returns

ShadowPainter

Inherited from

GeometryPainter.on


render

render(context, symbol, bbox): void

Renders parsed svg file on provided context

Parameters

Name Type Description
contextRenderingContextRendering context
symbolSymbolShapesymbol to render
bboxRectBounds of the symbol in context transformation

Returns

void

Inherited from

GeometryPainter.render


setGeometry

setGeometry(geometry): ShadowPainter

Set geometry

Parameters

Name Type Description
geometryGroup<Node>root geometry

Returns

ShadowPainter

Inherited from

GeometryPainter.setGeometry


setProperties

setProperties(props?): ShadowPainter

Sets all the properties pertaining to the painter

Parameters

Name Type Description
Optional propsOptionsgeometry painter properties

Returns

ShadowPainter

this

Overrides

GeometryPainter.setProperties


setSilent

setSilent(bool): ShadowPainter

Set silent mode

Parameters

Name Type Description
boolbooleanflag to enable silent mode

Returns

ShadowPainter

this

Inherited from

GeometryPainter.setSilent


getClassName

Static getClassName(): string

Returns

string

Inherited from

GeometryPainter.getClassName