Last updated

API / geotoolkit / welllog / LogFill / LogFill

Class: LogFill

welllog.LogFill.LogFill

LogFill class implements a fill between two LogPointSet.

Those LogPointSet are generally either LogCurves or LogReferenceLine.
The LogFill accepts 3 fillstyles, 'default', 'left' and 'right'.
FillType can be one of the following types.

  1. Left
  2. Right
  3. Left and Right(Dual left and right with different fill styles or Single which only has one fill style) please refer to the example below. The given FillType will determine which fillstyles should be applied to each area in between given LogPointSet.
    If no FillType is specified the internal logic will assign the fillType based on the fillStyle. It is recommended to pass both curve1 and curve2 parameters (even if the internal logic will try to fill missing parameters).

Example

//Single Fill, one fill style is specified
import {LogFill} from '@int/geotoolkit/welllog/LogFill';
import {FillStyle} from '@int/geotoolkit/attributes/FillStyle';
const fill = new LogFill({
'curve1': orangeCurve,
'curve2': redCurve,
'fillstyle': new FillStyle(...)
});

Example

import {FillType} from '@int/geotoolkit/welllog/LogFill';
//Dual Fill will use different fillstyles for left and right sides of orangeCurve
const fill = new LogFill({
'curve1': orangeCurve,
'curve2': ..., //if not specified, will be left (default case)
'rightfillstyle': new FillStyle(...),
'leftfillstyle': new FillStyle(...),
'filltype': FillType.Dual
});

Hierarchy

Table of contents

Constructors
Methods
addCssClassaddInvalidateHandlerapplyOpacity
applyResponsiveStylecheckCollisionclone
connectStylecopyConstructordisconnectStyle
disposeenableEventPropagationexecute
filtergetAnimationStylegetBaseName
getBoundsgetClassNamegetClipStyle
getContentsTransformgetCssgetCssClass
getCssClassesgetCssTransformgetCurve1
getCurve2getDataLimitsgetDescription
getFillStylegetFillTypegetHeader
getHeadersgetIdgetInvalidateMethod
getLeftFillStylegetLineStylegetLocalTransform
getMarginsStylegetMicroPositionLeftgetMicroPositionRight
getMicroPositionTransformationgetModelLimitsgetName
getNegativeFillStylegetOpacitygetOpacityBlendMode
getParentgetPositiveFillStylegetProperties
getPropertygetPropertyKeysgetRenderingFilter
getResponsiveStylegetRightFillStylegetRoot
getScaleScrollStrategygetScaledDatagetSceneTransform
getTaggetTrackgetVisible
getWorldTransformgetZIndexhasCssClass
hasEventListenerinvalidateinvalidateParent
isAutoBoundsisDisposedisEventPropagationEnabled
isHorizontalFlipisNotificationEnabledisSelectable
isSilentnotifyoff
ononHeaderSetonMicroPositionChanged
onParentChangedonVisibilityChangedpostRendering
preRenderingregisterAnimationStyleremoveCssClass
removeInvalidateHandlerrenderrenderAsync
renderContentrenderDepthRangerenderInternal
rotatescalesetAnimationStyle
setAutoBoundssetBaseNamesetBounds
setClipStylesetCsssetCssClass
setCssTransformsetCurve1setCurve2
setDescriptionsetFillStylesetFillType
setHeadersetIdsetLeftFillStyle
setLineStylesetLocalTransformsetMarginsStyle
setMicroPositionsetNamesetNegativeFillStyle
setNotificationsetOpacitysetPositiveFillStyle
setPropertiessetPropertysetRenderingFilter
setResponsiveStylesetRightFillStylesetScaleScrollStrategy
setSelectablesetSilentsetTag
setVisiblesetZIndexshear
toStringtranslateunregisterAnimationStyle
updateSceneTransformationupdateStateupdateTimeStamp
enableSceneGraphNotificationfindParentgetClassName
getShortFillTypeisSceneGraphNotificationEnabled
Css Properties
Name Type Description
autoboundsbooleanEnables or disables auto bounds
basenamestringThe base name
boundsRectThe rectangle specifying position of the visual in the track. If set, autobounds will be switched off
bounds-heightnumberHeight
bounds-readonlybooleanReadonly
bounds-widthnumberWidth
bounds-xnumberLeft
bounds-ynumberTop
clipstyleClipStyleClipping style
clipstyle-evenoddbooleanTrue if evenodd mode is on ('nonzero' mode otherwise)
clipstyle-geometryGraphicsPathClipping geometry
clipstyle-geometry-boundsRectBounds
clipstyleGraphicsPathClipping style
cssclassstringThe css class name of this node
csscursorstringCSS cursor associated with node
cssstylestringCSS style to be applied to inserted elements
curve1numberLeft point set
curve1LogCurveLeft point set
curve1-autoboundsbooleanEnables or disables auto bounds
curve1-autoupdatebooleanAutomatic update from datasource. If true, curve listens to data changes from source
curve1-barlinestylestringValue-bar line style
curve1-barlinestyleLineStyleValue-bar line style
curve1-barlinestyle-colorstringColor in CSS form
curve1-barlinestyle-fillstringOptional fill style to be used to fill lines generated with this style
curve1-barlinestyle-fillFillStyleOptional fill style to be used to fill lines generated with this style
curve1-barlinestyle-fill-colorstringColor in CSS form
curve1-barlinestyle-fill-evenoddmodebooleanEven-odd fill mode
curve1-barlinestyle-fill-fillpatternPatternPattern
curve1-barlinestyle-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
curve1-barlinestyle-fill-fillpattern-patternnamestringName of this pattern for indexing
curve1-barlinestyle-fill-fillpattern-scalablebooleanFlag that sets scalability of the pattern coordinates, or relative to the shape it is filling (It is not supported)
curve1-barlinestyle-fill-foregroundstringForeground color
curve1-barlinestyle-fill-patternPatternPattern
curve1-barlinestyle-linecapCapStyleThe line cap style
curve1-barlinestyle-linedashoffsetnumberLine dash offset of dashed line
curve1-barlinestyle-linejoinJoinStyleThe line join style
curve1-barlinestyle-pixelsnapmodebooleanPixel Snap Mode, default(
curve1-barlinestyle-scalablebooleanTrue if width should depend on transformation
curve1-barlinestyle-unitstringOptional unit for the width
curve1-barlinestyle-widthnumber | stringThe line thickness
curve1-basenamestringThe base name
curve1-boundsRectThe rectangle specifying position of the visual in the track. If set, autobounds will be switched off
curve1-centeronzeroonnegativeminbooleanFlag set to center the limits
curve1-cliplimitsmaxnumberMax clipping limits
curve1-cliplimitsminnumberMin clipping limits
curve1-clippingbooleanFlag to enable clipping
curve1-clipstyleClipStyleClipping style
curve1-clipstyleGraphicsPathClipping style
curve1-cssclassstringThe css class name of this node
curve1-csscursorstringCSS cursor associated with node
curve1-cssstylestringCSS style to be applied to inserted elements
curve1-descriptionstringThe description
curve1-displayunitstringDisplay unit
curve1-gradientlinestyleLogGradientStyleGradient line style
curve1-gradientlinestyle-colorstringColor in CSS form
curve1-gradientlinestyle-colorproviderstringColor provider
curve1-gradientlinestyle-colorproviderColorProviderColor provider
curve1-gradientlinestyle-colorprovider-maxnumber
curve1-gradientlinestyle-colorprovider-minnumber
curve1-gradientlinestyle-colorprovider-scaleKnownScales
curve1-gradientlinestyle-colorrangeRangeColor range (min and max value)
curve1-gradientlinestyle-colorrange-highnumberUpper range boundary
curve1-gradientlinestyle-colorrange-lownumberLower range boundary
curve1-gradientlinestyle-colorrange-maxnumber
curve1-gradientlinestyle-colorrange-minnumber
curve1-gradientlinestyle-datasourcestringLog data id
curve1-gradientlinestyle-evenoddmodebooleanEven-odd fill mode
curve1-gradientlinestyle-fillpatternPatternPattern
curve1-gradientlinestyle-foregroundstringForeground color
curve1-gradientlinestyle-normalizebooleanNormalize data value to color space, default true
curve1-gradientlinestyle-patternPatternPattern
curve1-gradientlinestyle-renderbackgroundbooleanExtra style parameter for background fill
curve1-gradientlinestyle-renderforegroundbooleanExtra style parameter for foreground fill. Normally to render patterns
curve1-gradientlinestyle-transparencynumberValue for alpha chanel
curve1-hideoverlappedvaluesbooleanHide overlapped value
curve1-horizontalflipbooleanHorizontal flip
curve1-idstring | numberId of the node, its a unique identifier
curve1-interpolationedgeInterpolationEdgeEdge values interpolation type in case of properties.limitstype==LimitsType.Manual
curve1-interpolationtypeInterpolationTypeInterpolation type
curve1-limitsmaxnumberMax limits value in case of data.limitstype==LimitsType.Manual
curve1-limitsminnumberMin limits value in case of data.limitstype==LimitsType.Manual
curve1-limitstypeLimitsTypeLimits type
curve1-linestylestringLinestyle
curve1-linestyleLineStyleLinestyle
curve1-localtransformTransformationLocal transformation
curve1-localtransform-dxnumberX axis translation
curve1-localtransform-dynumberY axis translation
curve1-localtransform-xxnumberX scale
curve1-localtransform-xynumberXy skew
curve1-localtransform-yxnumberYx skew
curve1-localtransform-yynumberY scale
curve1-marginsnumber | stringIt has properties for specifying the margins for each side
curve1-maxwrapsnumberMaximum count of wraps (by default 5)
curve1-microposleftnumberLeft micro position
curve1-microposrightnumberRight micro position
curve1-namestringName of the node. It is often used for debugging purposes or to simplify queries
curve1-nullvaluesymbolSymbolShapeNull value symbol
curve1-nullvaluesymbol-alignmentAnchorTypeAlignment according to the anchor point
curve1-nullvaluesymbol-alignmentAnchorTypeAnchor type of symbol
curve1-nullvaluesymbol-axnumberAnchor x position
curve1-nullvaluesymbol-aynumberAnchor y position
curve1-nullvaluesymbol-cachebooleanSet it to true if you want to cache complex geometry to raster
curve1-nullvaluesymbol-clipstyleClipStyleClipping style
curve1-nullvaluesymbol-clipstyleGraphicsPathClipping style
curve1-nullvaluesymbol-cssclassstringThe css class name of this node
curve1-nullvaluesymbol-csscursorstringCSS cursor associated with node
curve1-nullvaluesymbol-cssstylestringCSS style to be applied to inserted elements
curve1-nullvaluesymbol-fillstylestringStyle applied on fill
curve1-nullvaluesymbol-fillstyleFillStyleStyle applied on fill
curve1-nullvaluesymbol-heightnumberShape height
curve1-nullvaluesymbol-idstring | numberId of the node, its a unique identifier
curve1-nullvaluesymbol-ispointingupbooleanDefines whether the shape is always pointing up
curve1-nullvaluesymbol-layoutstyleLayoutStyleLayout style to specify how to lay out shape
curve1-nullvaluesymbol-layoutstyle-constraintSizeConstraintLayout constrains
curve1-nullvaluesymbol-layoutstyle-flexgrownumberNumber specifying how much the item will grow relative to the rest of the items inside the same container
curve1-nullvaluesymbol-layoutstyle-flexshrinknumberNumber specifying how much the item will shrink relative to the rest of the items inside the same container
curve1-nullvaluesymbol-layoutstyle-floatstringFloat position
curve1-nullvaluesymbol-layoutstyle-positionstringLayout position
curve1-nullvaluesymbol-layoutstyle-sizenumber | stringLayout size
curve1-nullvaluesymbol-linestylestringStyle applied on outline
curve1-nullvaluesymbol-linestyleLineStyleStyle applied on outline
curve1-nullvaluesymbol-localtransformTransformationLocal transformation
curve1-nullvaluesymbol-marginsnumber | stringIt has properties for specifying the margins for each side
curve1-nullvaluesymbol-maxdimensionDimensionMaximum size for rendering
curve1-nullvaluesymbol-maxdimension-heightnumberHeight of dimension
curve1-nullvaluesymbol-maxdimension-widthnumberWidth of dimension or properties
curve1-nullvaluesymbol-mindimensionDimensionMinimum size for rendering
curve1-nullvaluesymbol-namestringName of the node. It is often used for debugging purposes or to simplify queries
curve1-nullvaluesymbol-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
curve1-nullvaluesymbol-opacityblendmodeBlendModeNode opacity mode to blend it
curve1-nullvaluesymbol-painterstringA function with has parameters: symbol, box, context
curve1-nullvaluesymbol-painterpropertiesanySymbol's painter's properties
curve1-nullvaluesymbol-preserveaspectratiobooleanPreserve aspect ratio of the anchored shape
curve1-nullvaluesymbol-preservereadingorientationbooleanPreserve reading orientation for local transform
curve1-nullvaluesymbol-preserverightanglebooleanPreserve right angle for local transformation
curve1-nullvaluesymbol-rotationanglenumberRotation angle at anchor
curve1-nullvaluesymbol-scalescrollstrategyScaleScrollStrategyScale scroll strategy
curve1-nullvaluesymbol-scalescrollstrategy-enabledbooleanEnable flag
curve1-nullvaluesymbol-selectablebooleanSelectable node, a boolean to determine if selection should consider this node
curve1-nullvaluesymbol-sizeisindevicespacebooleanIs coordinate in device space
curve1-nullvaluesymbol-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
curve1-nullvaluesymbol-transformstringAdditional CSS transformation applied to node or 'none'
curve1-nullvaluesymbol-transformTransformationAdditional CSS transformation applied to node or 'none'
curve1-nullvaluesymbol-useminmaxdimensionsbooleanUse the min max dimensions to limit visual size
curve1-nullvaluesymbol-visiblebooleanVisibility of the node, a boolean to determine if the node should be rendered or not
curve1-nullvaluesymbol-widthnumberShape width
curve1-nullvaluesymbol-z-indexnumberDefine node z-index
curve1-nullvaluesymbolvisiblebooleanFlag to change visibility of null value symbol
curve1-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
curve1-opacityblendmodeBlendModeNode opacity mode to blend it
curve1-optimizationbooleanOptimization flags
curve1-outofrangevaluesbooleanOutofrangevalues flag
curve1-scalescrollstrategyScaleScrollStrategyScale scroll strategy
curve1-scaletypeScaleTypeValues scale type
curve1-selectablebooleanSelectable node, a boolean to determine if selection should consider this node
curve1-symbolSymbolShapeSymbol to be used
curve1-symboldecimationdistancenumberSymbol decimation distance
curve1-symboldecimationstepnumberSymbol decimation step or level
curve1-symbolgapnumberSymbol gap
curve1-symbolgapDimensionSymbol gap
curve1-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
curve1-textautoalignmentbooleanAutomatic text alignment for text values, which intersects border of the track
curve1-textautoalignmentoffsetnumberText offset from anchor for automatic text alignment
curve1-textautoalignmentoffsetPointText offset from anchor for automatic text alignment
curve1-textautoalignmentoffset-xnumberX coordinate
curve1-textautoalignmentoffset-ynumberY coordinate
curve1-textdecimationstepnumberText decimation step
curve1-textreferenceTextReferenceType of the text to be put on the track
curve1-textstylestringText style
curve1-textstyleTextStyleText style
curve1-textstyle-alignmentAlignmentStyleAlignment
curve1-textstyle-autosizebooleanAuto font size on high definition display
curve1-textstyle-backgroundstringBackground style
curve1-textstyle-backgroundFillStyleBackground style
curve1-textstyle-baselineBaseLineStyleBase line
curve1-textstyle-colorstringColor in CSS form
curve1-textstyle-fillFillStyleText fill style
curve1-textstyle-fontstringFont see
curve1-textstyle-fonturlstringThe place from which the font will be loaded, if null - uses system fonts. It can be base64 with url keyword
curve1-textstyle-lineheightstring | numberLine height
curve1-textstyle-multilinebooleanAllow multi-line text
curve1-textstyle-outlinestringOutline style
curve1-textstyle-outlineLineStyleOutline style
curve1-textstyle-overflowwrapOverflowWrapStyleOverflow wrap
curve1-textstyle-strikethroughstringStrikethrough style
curve1-textstyle-strikethroughLineStyleStrikethrough style
curve1-textstyle-textoverflowTextOverflowStyleText overflow
curve1-textstyle-underlinestringUnderline style
curve1-textstyle-underlineLineStyleUnderline style
curve1-textstyle-underlineoffsetstring | numberUnderline offset distance
curve1-textstyle-whitespaceWhiteSpaceStyleWhite space
curve1-textstyle-wordbreakWordBreakStyleWord break
curve1-transformstringAdditional CSS transformation applied to node or 'none'
curve1-transformTransformationAdditional CSS transformation applied to node or 'none'
curve1-visiblebooleanVisibility of the node, a boolean to determine if the node should be rendered or not
curve1-wrappingbooleanFlag to enable wrapping based on if you want to see the clipped part of the track or not
curve1-z-indexnumberDefine node z-index
curve1LogReferenceLineLeft point set
curve1-autoboundsbooleanEnables or disables auto bounds
curve1-basenamestringThe base name
curve1-boundsRectThe rectangle specifying position of the visual in the track. If set, autobounds will be switched off
curve1-clipstyleClipStyleClipping style
curve1-clipstyleGraphicsPathClipping style
curve1-cssclassstringThe css class name of this node
curve1-csscursorstringCSS cursor associated with node
curve1-cssstylestringCSS style to be applied to inserted elements
curve1-curveLogCurveReference curve
curve1-descriptionstringThe description
curve1-idstring | numberId of the node, its a unique identifier
curve1-levelnumberCurrent level of wrap interpolation
curve1-linestylestringLinestyle
curve1-linestyleLineStyleLinestyle
curve1-localtransformTransformationLocal transformation
curve1-marginsnumber | stringIt has properties for specifying the margins for each side
curve1-microposleftnumberLeft micro position
curve1-microposrightnumberRight micro position
curve1-namestringName of the node. It is often used for debugging purposes or to simplify queries
curve1-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
curve1-opacityblendmodeBlendModeNode opacity mode to blend it
curve1-scalescrollstrategyScaleScrollStrategyScale scroll strategy
curve1-selectablebooleanSelectable node, a boolean to determine if selection should consider this node
curve1-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
curve1-transformstringAdditional CSS transformation applied to node or 'none'
curve1-transformTransformationAdditional CSS transformation applied to node or 'none'
curve1-typeReferenceTypeReference model type
curve1-valuenumberCurrent value in track coordinates. by default from 0 to 1
curve1-visiblebooleanVisibility of the node, a boolean to determine if the node should be rendered or not
curve1-z-indexnumberDefine node z-index
curve2numberRight point set
curve2LogCurveRight point set
curve2LogReferenceLineRight point set
descriptionstringThe description
fillstylestringFillstyle
fillstyleFillStyleFillstyle
filltypeFillTypeFilltype
idstring | numberId of the node, its a unique identifier
leftfillstylestringFillstyle for left part
leftfillstyleFillStyleFillstyle for left part
linestylestringLinestyle
linestyleLineStyleLinestyle
localtransformTransformationLocal transformation
marginsnumber | stringIt has properties for specifying the margins for each side
microposleftnumberLeft micro position
microposrightnumberRight micro position
namestringName of the node. It is often used for debugging purposes or to simplify queries
negativefillstylestringFill style to be used to fill negative areas
negativefillstyleFillStyleFill style to be used to fill negative areas
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
opacityblendmodeBlendModeNode opacity mode to blend it
positivefillstylestringFill style to be used to positive areas
positivefillstyleFillStyleFill style to be used to positive areas
rightfillstylestringFillstyle for right part
rightfillstyleFillStyleFillstyle for right part
scalescrollstrategyScaleScrollStrategyScale scroll strategy
selectablebooleanSelectable node, a boolean to determine if selection should consider this node
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
transformstringAdditional CSS transformation applied to node or 'none'
transformTransformationAdditional CSS transformation applied to node or 'none'
visiblebooleanVisibility of the node, a boolean to determine if the node should be rendered or not
z-indexnumberDefine node z-index

Contents

Constructors

new LogFill(options, curve2, fillstyle, leftfillstyle, rightfillstyle, filltype)

new LogFill(options?, curve2?, fillstyle?, leftfillstyle?, rightfillstyle?, filltype?)

Constructor

Parameters

Name Type Description
Optional optionsnumber | LogCurve | Options | LogReferenceLineleft points set or a JSON
Optional curve2number | LogCurve | LogReferenceLineright point set
Optional fillstyleTypefillstyle
Optional leftfillstyleTypefillstyle for left part
Optional rightfillstyleTypefillstyle for right part
Optional filltypeFillTypefilltype

Overrides

LogPointSet.constructor

Methods

addCssClass

addCssClass(cssclass): LogFill

Adds new css class to node

Parameters

Name Type Description
cssclassstring | string[]css class name('s)

Returns

LogFill

this

Inherited from

LogPointSet.addCssClass


addInvalidateHandler

addInvalidateHandler(handler): LogFill

Add invalidate handler

Deprecated

since 4.0, use Node.on instead

Parameters

Name Type Description
handlerFunctionhandler to be notified about invalidation

Returns

LogFill

this

Inherited from

LogPointSet.addInvalidateHandler


applyOpacity

Protected applyOpacity(context): LogFill

This method is called to apply opacity if it is specified on the rendering context. The default implementation sets global alpha on the rendering context

Parameters

Name Type Description
contextRenderingContextRendering Context

Returns

LogFill

this

Inherited from

LogPointSet.applyOpacity


applyResponsiveStyle

Protected applyResponsiveStyle(): void

Apply a responsive style rules it is exists

Returns

void

Inherited from

LogPointSet.applyResponsiveStyle


checkCollision

checkCollision(context): boolean

Check culling. Returns true if object is inside of renderable area

Parameters

Name Type Description
contextRenderingContextRendering Context

Returns

boolean

Inherited from

LogPointSet.checkCollision


clone

clone(): LogFill

All subclasses should override copyConstructor or provide custom implementation for this method

Returns

LogFill

clone

Overrides

LogPointSet.clone


connectStyle

connectStyle(style, type, callback): LogFill

Connects style.

This convenience method subscribes a listener to given style for the specified type.
And automatically un-subscribes listener if node is disposed to prevent memory leaks

Parameters

Name Type Description
styleEventDispatcherconnect style
typestringtype of event or property
callbackAttributeCallback<EventDispatcher>function to be called

Returns

LogFill

this

Inherited from

LogPointSet.connectStyle


copyConstructor

Protected copyConstructor(src, deepCopy?): LogFill

Copy constructor function.
Function used as part of the cloning mechanism.
Implementations should copy the given instance state to this instance.

Parameters

Name Type Description
srcLogFillSource to copy from
Optional deepCopybooleandeep copy

Returns

LogFill

this

Overrides

LogPointSet.copyConstructor


disconnectStyle

disconnectStyle(style, type, callback): LogFill

Disconnect style
This convenience method un-subscribes a listener to given style for the specified type.

Parameters

Name Type Description
styleEventDispatcherconnect style
typestringtype of event or property
callbackAttributeCallback<EventDispatcher>function to be called

Returns

LogFill

this

Inherited from

LogPointSet.disconnectStyle


dispose

dispose(): void

Disposes this node, once disposes a node should not be used anymore.
Clear all listeners, and disconnect styles to avoid memory leaks.
Also aggressively 'cleanup' this node by setting some of its members to null.

Returns

void

Inherited from

LogPointSet.dispose


enableEventPropagation

enableEventPropagation(enable): LogFill

Enable event propagation from the node hierarchy from bottom to top

This option is similar to DOM Event bubbling, which allows to get any event from child node. By default it is disabled for better performance.

Example

import {Group} from '@int/geotoolkit/scene/Group';
import {Events as SceneEvents} from '@int/geotoolkit/scene/Node';
const parentGroup = new Group()
.setName('ParentGroup')
.enableEventPropagation(true);
const childGroup = new Group()
.setName('ChildGroup');

parentGroup.addChild(childGroup);
parentGroup.on(SceneEvents.Invalidate, (eventName, sender, args) => {
// Got notifications from all children of parent group
});
childGroup.invalidate();

Parameters

Name Type Description
enablebooleanenable

Returns

LogFill

this

Inherited from

LogPointSet.enableEventPropagation


execute

execute(delegate): LogFill

Executes delegate and return the result. It allows us to keep all initialization calls in one place,
and we do not need to scroll up or down in IDE to find how and where it was initialized.

Example

// All setters (.setName() for example) returns reference to the this.
// In order to modify inner object like LineStyle or Pattern, to get this object (property) we should call getter to get object reference.
// Then modify it as shown below in Option 1 or you can use execute methods shown in Option 2.
import {Group} from '@int/geotoolkit/scene/Group';
import {Rect} from '@int/geotoolkit/util/Rect';
// Option 1
const group = new Group()
.setName('MyGroup')
.setBounds(new Rect(0, 0, 42, 16))
.enableClipping(true)
.setTag({'type': 'sometype'});

group.getLineStyle().setPattern('pattern');
return group;

// Options 2 ( using execute method )
return group
.execute(function () {
this.getLineStyle()
.setPattern("pattern");
});

Parameters

Name Type Description
delegate(this: LogFill) => voidFunction to execute

Returns

LogFill

The result if any or this

Inherited from

LogPointSet.execute

execute<T>(delegate): T

Type parameters

Name
T

Parameters

Name Type
delegate(this: LogFill) => T

Returns

T

Inherited from

LogPointSet.execute


filter

Protected filter(context): boolean

Filter node

Parameters

Name Type Description
contextRenderingContextRendering Context

Returns

boolean

flag filter flag ("true" to render node; "false" otherwise)

Inherited from

LogPointSet.filter


getAnimationStyle

getAnimationStyle(): AnimationStyle

Return animation style

Returns

AnimationStyle

animationStyle current animation style

Inherited from

LogPointSet.getAnimationStyle


getBaseName

getBaseName(): string

Returns the base name

Returns

string

The base name

Inherited from

LogPointSet.getBaseName


getBounds

getBounds(): Rect

Gets bounds

Returns

Rect

Overrides

LogPointSet.getBounds


getClassName

getClassName(): string

Returns

string

Inherited from

LogPointSet.getClassName


getClipStyle

getClipStyle(): ClipStyle

Gets the current clipping style

Returns

ClipStyle

clipping style

Inherited from

LogPointSet.getClipStyle


getContentsTransform

getContentsTransform(): Transformation

Retrieves the world transformation of the spatial

Returns

Transformation

Inherited from

LogPointSet.getContentsTransform


getCss

getCss(): CssStyle

Return CSS style

Returns

CssStyle

Inherited from

LogPointSet.getCss


getCssClass

getCssClass(): string

Returns css class name to be used to apply CSS style

Returns

string

the css class name

Inherited from

LogPointSet.getCssClass


getCssClasses

getCssClasses(): string[]

Gets list of css class names which applied to this node

Returns

string[]

Inherited from

LogPointSet.getCssClasses


getCssTransform

getCssTransform(): string

Returns CSS transformation

Returns

string

Inherited from

LogPointSet.getCssTransform


getCurve1

getCurve1(): LogCurve | LogReferenceLine

Returns a point set to fill from

Returns

LogCurve | LogReferenceLine


getCurve2

getCurve2(): LogCurve | LogReferenceLine

Returns a point set to fill to

Returns

LogCurve | LogReferenceLine


getDataLimits

getDataLimits(fullLimits?): Rect

return meaning data limits

Parameters

Name Type Description
Optional fullLimitsbooleandefault value is false

Returns

Rect

Overrides

LogPointSet.getDataLimits


getDescription

getDescription(): string

Gets the description

Returns

string

The description

Inherited from

LogPointSet.getDescription


getFillStyle

getFillStyle(): FillStyle

Return fill style

Returns

FillStyle


getFillType

getFillType(): FillType

Gets the fill type

Returns

FillType


getHeader

getHeader(name): LogVisualHeader<Node>

Return the header registered by the name

Parameters

Name Type Description
namestringheader name

Returns

LogVisualHeader<Node>

header

Inherited from

LogPointSet.getHeader


getHeaders

getHeaders(): Record<string, LogVisualHeader<Node>>

Return an object that contains all headers registered with the visual

Returns

Record<string, LogVisualHeader<Node>>

headers

Inherited from

LogPointSet.getHeaders


getId

getId(): string | number

Returns the associated identifier of the node

Returns

string | number

The node's id

Inherited from

LogPointSet.getId


getInvalidateMethod

Protected getInvalidateMethod(): AttributeCallback<EventDispatcher>

Gets invalidate method

Returns

AttributeCallback<EventDispatcher>

method to invalidate this object

Inherited from

LogPointSet.getInvalidateMethod


getLeftFillStyle

getLeftFillStyle(): FillStyle

Returns fill style to be used to fill left (positive) areas

Returns

FillStyle


getLineStyle

getLineStyle(): LineStyle

Returns line style

Returns

LineStyle

Inherited from

LogPointSet.getLineStyle


getLocalTransform

getLocalTransform(): Transformation

Retrieves the transformation of bounds to parent

Returns

Transformation

transform the local transform.

Inherited from

LogPointSet.getLocalTransform


getMarginsStyle

getMarginsStyle(): SpaceStyle<string | number>

Return margins style

Returns

SpaceStyle<string | number>

Inherited from

LogPointSet.getMarginsStyle


getMicroPositionLeft

getMicroPositionLeft(): number

Returns micro position left

Returns

number

Inherited from

LogPointSet.getMicroPositionLeft


getMicroPositionRight

getMicroPositionRight(): number

Returns micro position right

Returns

number

Inherited from

LogPointSet.getMicroPositionRight


getMicroPositionTransformation

Protected getMicroPositionTransformation(): Transformation

Returns micro position transformation

Returns

Transformation

micro position transformation

Inherited from

LogPointSet.getMicroPositionTransformation


getModelLimits

getModelLimits(): Rect

Returns null

Returns

Rect

Inherited from

LogPointSet.getModelLimits


getName

getName(): string

Returns the node name

Returns

string

The node name

Inherited from

LogPointSet.getName


getNegativeFillStyle

getNegativeFillStyle(): FillStyle

Returns fill style to be used to fill negative areas

Returns

FillStyle


getOpacity

getOpacity(): number

Returns current node opacity

Returns

number

opacity

Inherited from

LogPointSet.getOpacity


getOpacityBlendMode

getOpacityBlendMode(): BlendMode

Returns current node opacity

Returns

BlendMode

opacity blend mode

Inherited from

LogPointSet.getOpacityBlendMode


getParent

getParent(): Node

Return parent node

Returns

Node

parent node

Inherited from

LogPointSet.getParent


getPositiveFillStyle

getPositiveFillStyle(): FillStyle

Returns fill style to be used to fill positive areas

Returns

FillStyle


getProperties

getProperties(): OptionsOut

Gets all the properties pertaining to this object

Returns

OptionsOut

properties object

Overrides

LogPointSet.getProperties


getProperty

getProperty(name): any

Gets dynamic property by name. These properties can be used as a property bags

Parameters

Name Type Description
namestringproperty name

Returns

any

Inherited from

LogPointSet.getProperty


getPropertyKeys

getPropertyKeys(): string[]

Returns known properties keys

Returns

string[]

Inherited from

LogPointSet.getPropertyKeys


getRenderingFilter

getRenderingFilter(): IFilter

Return filter to be used for rendering and picking

Returns

IFilter

current filter

Inherited from

LogPointSet.getRenderingFilter


getResponsiveStyle

getResponsiveStyle(): ResponsiveStyle

Return responsive style

Returns

ResponsiveStyle

Inherited from

LogPointSet.getResponsiveStyle


getRightFillStyle

getRightFillStyle(): FillStyle

Returns fill style to be used to fill right (negative) areas

Returns

FillStyle


getRoot

getRoot(): Node

Returns root node.
If node doesn't have parent then it returns itself.

Returns

Node

the root node

Inherited from

LogPointSet.getRoot


getScaleScrollStrategy

getScaleScrollStrategy(): Delegate

Gets scale scroll strategy

Returns

Delegate

scale scroll strategy

Inherited from

LogPointSet.getScaleScrollStrategy


getScaledData

getScaledData(): AbstractScaledData

Gets the visual's scaled data

Returns

AbstractScaledData

(the implementation returns null).

Inherited from

LogPointSet.getScaledData


getSceneTransform

getSceneTransform(): Transformation

Returns transformation from node to root scene

Returns

Transformation

a transformation from node to root scene

Inherited from

LogPointSet.getSceneTransform


getTag

getTag(): any

Returns the object associated with the node by user.

Returns

any

The node's user-object

Inherited from

LogPointSet.getTag


getTrack

getTrack(): ITrack

Returns parent track if LogTrack

Returns

ITrack

Inherited from

LogPointSet.getTrack


getVisible

getVisible(): boolean

Return visibility of the node

Returns

boolean

true if node is visible

Inherited from

LogPointSet.getVisible


getWorldTransform

getWorldTransform(): Transformation

Retrieves the local transformation of the node which represents multiplication of parent to bounds and contents transformations.

Returns

Transformation

Inherited from

LogPointSet.getWorldTransform


getZIndex

getZIndex(): number

Returns node z-index (null if not set)

Returns

number

Inherited from

LogPointSet.getZIndex


hasCssClass

hasCssClass(cssClass): boolean

Check if node has specified css class

Parameters

Name Type Description
cssClassstringcss class name

Returns

boolean

Inherited from

LogPointSet.hasCssClass


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

LogPointSet.hasEventListener


invalidate

invalidate(bounds?, force?): LogFill

Invalidate area of the shape. This method invalidates parent by default. invalidated from parent to root node.

Parameters

Name Type Description
Optional boundsRectbounds of the invalid rectangle in the inner node coordinates
Optional forcebooleantrue if parent should be invalidated immediately if null is provided then cache (if any will be completely refreshed) otherwise only specified rect or node.bounds will be refreshed

Returns

LogFill

this

Inherited from

LogPointSet.invalidate


invalidateParent

invalidateParent(bounds?, force?): LogFill

Invalidate bounds

Parameters

Name Type Description
Optional boundsRectmodel bounds
Optional forcebooleanforce if null is provided then cache (if any will be completely refreshed) otherwise only specified rect or node.bounds will be refreshed

Returns

LogFill

this

Inherited from

LogPointSet.invalidateParent


isAutoBounds

isAutoBounds(): boolean

Enable automatic bounds. If auto bounds is enabled then it equals to parent model limits

Returns

boolean

Inherited from

LogPointSet.isAutoBounds


isDisposed

isDisposed(): boolean

Returns whether this object has been disposed

Returns

boolean

Inherited from

LogPointSet.isDisposed


isEventPropagationEnabled

isEventPropagationEnabled(): boolean

Return true if event propagation is enabled from child to parent

Returns

boolean

Inherited from

LogPointSet.isEventPropagationEnabled


isHorizontalFlip

isHorizontalFlip(): boolean

Return true if the representation is flipped horizontally

Returns

boolean

horizontal flip

Inherited from

LogPointSet.isHorizontalFlip


isNotificationEnabled

isNotificationEnabled(): boolean

return state of notification

Returns

boolean

current notification state

Inherited from

LogPointSet.isNotificationEnabled


isSelectable

isSelectable(): boolean

Returns true if node can be picked/selected.

Returns

boolean

The selectable flag

Inherited from

LogPointSet.isSelectable


isSilent

isSilent(): boolean

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

Returns

boolean

Inherited from

LogPointSet.isSilent


notify

notify<E>(type, source, args?): LogFill

Notify listeners of the Node

Type parameters

NameType
Eextends string

Parameters

Name Type Description
typeEtype of event
sourceLogAbstractVisualsource who called the event
Optional argsEventMap[E]event arguments

Returns

LogFill

this

Inherited from

LogPointSet.notify


off

off<E>(type?, callback?): LogFill

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.

Type parameters

NameType
Eextends string

Parameters

Name Type Description
Optional typeEtype of the event
Optional callback(eventType: E, sender: LogFill, args: EventMap[E]) => voidfunction to be called

Returns

LogFill

this

Inherited from

LogPointSet.off


on

on<E>(type, callback): LogFill

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.

Type parameters

NameType
Eextends string

Parameters

Name Type Description
typeEtype of event or property
callback(eventType: E, sender: LogFill, args: EventMap[E]) => voidto be called

Returns

LogFill

this

Inherited from

LogPointSet.on


onHeaderSet

Protected onHeaderSet(name, headerInstance, silent?): void

This method is called if header is set. Send event Events.HeaderSet

Parameters

Name Type Description
namestringof the container. The 'header' and 'footer' is used.
headerInstanceLogVisualHeader<Node>the header instance
Optional silentbooleansilent node to avoid sending events that header is created

Returns

void

Inherited from

LogPointSet.onHeaderSet


onMicroPositionChanged

Protected onMicroPositionChanged(): LogFill

calls when microPosition has been changed

Returns

LogFill

this

Inherited from

LogPointSet.onMicroPositionChanged


onParentChanged

Protected onParentChanged(node): LogFill

This method is called when parent changes. Do not call it directly.

Parameters

Name Type Description
nodeNodenode to change parent

Returns

LogFill

this

Inherited from

LogPointSet.onParentChanged


onVisibilityChanged

Protected onVisibilityChanged(): void

This method is called if visibility is changed. Send event Events.VisibilityChanged

Returns

void

Inherited from

LogPointSet.onVisibilityChanged


postRendering

Protected postRendering(context): void

To be called after rendering. Call this method if you override method render

Parameters

Name Type Description
contextRenderingContextRendering Context

Returns

void

Inherited from

LogPointSet.postRendering


preRendering

Protected preRendering(context): void

Occurs before rendering this method sets clipping by default. Call this method if you override method render

Parameters

Name Type Description
contextRenderingContextRendering Context

Returns

void

Inherited from

LogPointSet.preRendering


registerAnimationStyle

registerAnimationStyle(root): void

Register animation style.

Parameters

Name Type Description
rootNoderoot node for node

Returns

void

Inherited from

LogPointSet.registerAnimationStyle


removeCssClass

removeCssClass(cssclass): LogFill

Removes css class from node

Parameters

Name Type Description
cssclassstring | string[]css class name('s)

Returns

LogFill

this

Inherited from

LogPointSet.removeCssClass


removeInvalidateHandler

removeInvalidateHandler(handler): LogFill

Remove invalidate handler

Deprecated

since 4.0, use Node.off instead

Parameters

Name Type Description
handlerFunctionhandler to be notified about invalidation

Returns

LogFill

this

Inherited from

LogPointSet.removeInvalidateHandler


render

render(context): void

Renders node

Parameters

Name Type Description
contextRenderingContextThe rendering context to be used to draw the node

Returns

void

Inherited from

LogPointSet.render


renderAsync

renderAsync(context, callback): void

Render node in asynchronous mode. Default implementation creates call method "render" inside

Parameters

Name Type Description
contextRenderingContextThe rendering context to be used to draw the node
callback() => voidcallback function

Returns

void

Inherited from

LogPointSet.renderAsync


renderContent

Protected renderContent(context): void

Renders node content

Parameters

Name Type Description
contextRenderingContextThe rendering context to be used to draw the node

Returns

void

Inherited from

LogPointSet.renderContent


renderDepthRange

Protected renderDepthRange(context, fromDepth, toDepth, clipByDepth?): void

Render depth range

Parameters

Name Type Description
contextRenderingContextcontext
fromDepthnumberfrom
toDepthnumberto
Optional clipByDepthboolean

Returns

void


renderInternal

Protected renderInternal(localContext): LogFill

Render internal

Parameters

Name Type Description
localContextRenderingContextlocal context

Returns

LogFill

this


rotate

rotate(theta, x, y): LogFill

Rotate bounds around a given coordinate

Parameters

Name Type Description
thetanumberangle to rotate node, in radians
xnumberx coordinate to rotate around
ynumbery coordinate to rotate around

Returns

LogFill

this

Inherited from

LogPointSet.rotate


scale

scale(xx, yy): LogFill

Scale node

Parameters

Name Type Description
xxnumberx scale factor
yynumbery scale factor

Returns

LogFill

this

Inherited from

LogPointSet.scale


setAnimationStyle

setAnimationStyle(animationStyle): LogFill

Sets animation style

Parameters

Name Type Description
animationStyleTypeanimation style

Returns

LogFill

Inherited from

LogPointSet.setAnimationStyle


setAutoBounds

setAutoBounds(enable): LogFill

Enable or disable auto bounds If auto bounds is enabled then it equals to parent model limits

Parameters

Name Type Description
enablebooleanEnable or disable auto bounds

Returns

LogFill

this

Inherited from

LogPointSet.setAutoBounds


setBaseName

setBaseName(name): LogFill

Sets base name of the visual

Parameters

Name Type Description
namestringThe base name

Returns

LogFill

this

Inherited from

LogPointSet.setBaseName


setBounds

setBounds(bounds): LogFill

Sets bounds of the point set in the parent coordinates false

Parameters

Name Type Description
boundsRectbounds of the point set

Returns

LogFill

this

Inherited from

LogPointSet.setBounds


setClipStyle

setClipStyle(style): LogFill

Sets a new clipping style

Parameters

Name Type Description
styleGraphicsPath | ClipStyle | Optionsa new clipping style

Returns

LogFill

this

Inherited from

LogPointSet.setClipStyle


setCss

setCss(style, merge?): LogFill

Sets CSS style. This style will be applied for all inserted elements

Parameters

Name Type Description
styleTypeCSS style to be applied to inserted elements
Optional mergebooleanmerge flag

Returns

LogFill

this

Inherited from

LogPointSet.setCss


setCssClass

setCssClass(name): LogFill

Sets css class name of the node to be used to apply CSS style

Parameters

Name Type Description
namestringcss class name of the node

Returns

LogFill

this

Inherited from

LogPointSet.setCssClass


setCssTransform

setCssTransform(transform): LogFill

Set CSS transformation

Parameters

Name Type Description
transformstring | Transformationtransformation css transformation instruction or Transformation instance

Returns

LogFill

this

Inherited from

LogPointSet.setCssTransform


setCurve1

setCurve1(curve): LogFill

Sets point set to fill from

Parameters

Name Type Description
curvenumber | LogCurve | LogReferenceLinea point set or number to fill from

Returns

LogFill

this


setCurve2

setCurve2(curve): LogFill

Sets point set to fill to

Parameters

Name Type Description
curvenumber | LogCurve | LogReferenceLinea point set or number to fill to

Returns

LogFill

this


setDescription

setDescription(description): LogFill

Sets the description

Parameters

Name Type Description
descriptionstringThe visual description

Returns

LogFill

this

Inherited from

LogPointSet.setDescription


setFillStyle

setFillStyle(fillStyle, merge?): LogFill

Sets fill style

Parameters

Name Type Description
fillStyleTypea new fill style
Optional mergebooleantrue if you want to merge fillStyle with existing attribute, false by default

Returns

LogFill


setFillType

setFillType(fillType): LogFill

Sets the fill type

Parameters

Name Type Description
fillTypeFillTypeenum of filltype

Returns

LogFill


setHeader

setHeader(name, headerInstance, silent?): LogFill

Sets header instance with specified name. This name usually defines header or footer.

Throws

if header name is null

Parameters

Name Type Description
namestringof the container. The 'header' and 'footer' is used.
headerInstanceLogVisualHeader<Node>the header instance
Optional silentbooleansilent node to avoid sending events that header is created

Returns

LogFill

this

Inherited from

LogPointSet.setHeader


setId

setId(id): LogFill

Allows the user to associate any identifier

Parameters

Name Type Description
idstring | numberobject id

Returns

LogFill

this

Inherited from

LogPointSet.setId


setLeftFillStyle

setLeftFillStyle(fillStyle, merge?): LogFill

Sets left (positive) fill style

Parameters

Name Type Description
fillStyleTypea new fill style
Optional mergebooleantrue if you want to merge fillStyle with existing attribute, false by default

Returns

LogFill


setLineStyle

setLineStyle(lineStyle, merge?): LogFill

Sets line style

Parameters

Name Type Description
lineStyleTypeThe style in which the line is displayed object can be in format of constructor of LineStyle
Optional mergebooleantrue if you want to merge lineStyle with existing attribute, false by default

Returns

LogFill

this

Inherited from

LogPointSet.setLineStyle


setLocalTransform

setLocalTransform(localTransform, force?): LogFill

Sets local transformation to be used to transform from local to parent coordinate

Parameters

Name Type Description
localTransformTransformationlocal transformation for this node
Optional forcebooleanboolean flag to force update event if transformations are equal, false by default

Returns

LogFill

this

Inherited from

LogPointSet.setLocalTransform


setMarginsStyle

setMarginsStyle(margins, merge?): LogFill

Sets margins style

Parameters

Name Type Description
marginsType<string | number>margins style
Optional mergebooleantrue if you want to merge marginsStyle with existing attribute, false by default

Returns

LogFill

this

Inherited from

LogPointSet.setMarginsStyle


setMicroPosition

setMicroPosition(left, right): LogFill

Sets micro position (0 - 1). It allows application code to display the visual in a subarea of the track.
By default log visuals uses all space of the trace in the horizontal direction, but micro position allows to place log visual in the specified position of the track in horizontal direction. See example below

Example

// The following code places curve 20% from left and 20% from right.
curve.setMicroPosition(0.2,0.8);

Parameters

Name Type Description
leftnumberleft position
rightnumberright position

Returns

LogFill

this

Inherited from

LogPointSet.setMicroPosition


setName

setName(name): LogFill

Sets name of the node

Parameters

Name Type Description
namestringThe node name

Returns

LogFill

this

Inherited from

LogPointSet.setName


setNegativeFillStyle

setNegativeFillStyle(fillStyle, merge?): LogFill

Sets negative fill style

Parameters

Name Type Description
fillStyleTypea new fill style
Optional mergebooleantrue if you want to merge fillStyle with existing attribute, false by default

Returns

LogFill


setNotification

setNotification(notify, force?): LogFill

set notification state

Parameters

Name Type Description
notifybooleanflag set to invalidate parent or not
Optional forcebooleantrue if parent should be invalidated immediately

Returns

LogFill

this

Inherited from

LogPointSet.setNotification


setOpacity

setOpacity(opacity, blendMode?): LogFill

Sets node opacity

Parameters

Name Type Description
opacitynumbernode opacity from 0 to 1
Optional blendModeBlendModeopacity blend mode. If it is normal, opacity will be replaced.

Returns

LogFill

this

Inherited from

LogPointSet.setOpacity


setPositiveFillStyle

setPositiveFillStyle(fillStyle, merge?): LogFill

Sets positive fill style

Parameters

Name Type Description
fillStyleTypea new fill style
Optional mergebooleantrue if you want to merge fillStyle with existing attribute, false by default

Returns

LogFill


setProperties

setProperties(properties?): LogFill

Sets all the properties pertaining to this object

Parameters

Name Type Description
Optional propertiesOptionsAn object containing the properties to set

Returns

LogFill

this

Overrides

LogPointSet.setProperties


setProperty

setProperty(name, value): LogFill

Sets dynamic property by name

Parameters

Name Type Description
namestringproperty name
valueanyproperty value

Returns

LogFill

this

Inherited from

LogPointSet.setProperty


setRenderingFilter

setRenderingFilter(filter): LogFill

Sets filter to be applied before rendering and picking

Parameters

Name Type Description
filterIFilterfilter to set

Returns

LogFill

this

Inherited from

LogPointSet.setRenderingFilter


setResponsiveStyle

setResponsiveStyle(style): LogFill

Sets responsive style.

Parameters

Name Type Description
styleOptions | ResponsiveStyleresponsive style

Returns

LogFill

this

Inherited from

LogPointSet.setResponsiveStyle


setRightFillStyle

setRightFillStyle(fillStyle, merge?): LogFill

Sets right (negative) fill style

Parameters

Name Type Description
fillStyleTypea new fill style
Optional mergebooleantrue if you want to merge fillStyle with existing attribute, false by default

Returns

LogFill


setScaleScrollStrategy

setScaleScrollStrategy(strategy?): LogFill

Sets scale scroll strategy

Parameters

Name Type Description
Optional strategyDelegatescale scroll strategy

Returns

LogFill

this

Inherited from

LogPointSet.setScaleScrollStrategy


setSelectable

setSelectable(selectable): LogFill

Allows to select node. If node is not selectable then child node is not selectable.

Parameters

Name Type Description
selectablebooleanflag to allow node selection

Returns

LogFill

this

Inherited from

LogPointSet.setSelectable


setSilent

setSilent(bool): LogFill

Set silent mode

Parameters

Name Type Description
boolbooleanflag to enable silent mode

Returns

LogFill

this

Inherited from

LogPointSet.setSilent


setTag

setTag(tag): LogFill

Allows the user to associate any arbitrary object with the node.

Parameters

Name Type Description
taganyThe object to be associated with the node.

Returns

LogFill

this

Inherited from

LogPointSet.setTag


setVisible

setVisible(value): LogFill

Sets visibility of the node. Send event Events.VisibilityChanged

Parameters

Name Type Description
valuebooleanflag specifying visibility of the node

Returns

LogFill

this

Inherited from

LogPointSet.setVisible


setZIndex

setZIndex(value): LogFill

Sets z-index for node (set null for default)

Parameters

Name Type Description
valuenumberindex determining node z-position

Returns

LogFill

this

Inherited from

LogPointSet.setZIndex


shear

shear(shx, shy): LogFill

Shear this node's bounds

Parameters

Name Type Description
shxnumberx-axis shear
shynumbery-axis shear

Returns

LogFill

this

Inherited from

LogPointSet.shear


toString

toString(): string

Returns a string representation of this object (generally the classname)

Returns

string

A string representation

Inherited from

LogPointSet.toString


translate

translate(tx, ty): LogFill

Translate bounds

Parameters

Name Type Description
txnumberx translation
tynumbery translation

Returns

LogFill

this

Inherited from

LogPointSet.translate


unregisterAnimationStyle

unregisterAnimationStyle(root): void

Unregister animation style.

Parameters

Name Type Description
rootNoderoot node for node

Returns

void

Inherited from

LogPointSet.unregisterAnimationStyle


updateSceneTransformation

updateSceneTransformation(): LogFill

Update scene transformation

Returns

LogFill

this

Inherited from

LogPointSet.updateSceneTransformation


updateState

updateState(regions?, changes?): LogFill

Update state. These methods reset node state and update state for children. this method is useful to refresh a scene graph

Parameters

Name Type Description
Optional regionsRect[]optional array to return invalid rectangles in the parent coordinates
Optional changesStateChangesoptional parameter to specify a reason of changes

Returns

LogFill

this

Inherited from

LogPointSet.updateState


updateTimeStamp

Protected updateTimeStamp(): LogFill

Update time stamp to indicate that Node or Children has been changed.

Returns

LogFill

this

Inherited from

LogPointSet.updateTimeStamp


enableSceneGraphNotification

Static enableSceneGraphNotification(enabled): void

Enable / disable all notifications

Parameters

Name Type Description
enabledbooleansets if this object sends notifications

Returns

void

Inherited from

LogPointSet.enableSceneGraphNotification


findParent

Static findParent<T>(node, classType, filter?): InstanceType<T>

Find root of the node with specified type

Type parameters

NameType
Textends Constructor<any>

Parameters

Name Type Description
nodeNodenode to start search
classTypeTtype of the class to search for
Optional filter(node: Node) => booleanadditional filter to apply

Returns

InstanceType<T>

Inherited from

LogPointSet.findParent

Static findParent(node, classType, filter?): Node

Find root of the node with specified type

Parameters

Name Type Description
nodeNodenode to start search
classTypestringinterface name to search for
Optional filter(node: Node) => booleanadditional filter to apply

Returns

Node

Inherited from

LogPointSet.findParent


getClassName

Static getClassName(): string

Returns

string

Inherited from

LogPointSet.getClassName


getShortFillType

Static getShortFillType(filltype): FillType

manipulator for filltype aliases

Parameters

Name Type Description
filltypestringfilltype

Returns

FillType


isSceneGraphNotificationEnabled

Static isSceneGraphNotificationEnabled(): boolean

Return status of the global notification for all nodes.

Returns

boolean

Inherited from

LogPointSet.isSceneGraphNotificationEnabled