Class: AbstractScroll

• new AbstractScroll(options)

• Protected new AbstractScroll(options?)

Group.constructor

▸ addBaseLayer(baseLayer): AbstractScroll

Add baseLayer to container

AbstractScroll

this

Group.addBaseLayer

▸ addChild(node): AbstractScroll

Add a child node

AbstractScroll

this

Group.addChild

▸ addCssClass(cssclass): AbstractScroll

Adds new css class to node

AbstractScroll

this

Group.addCssClass

▸ addInvalidateHandler(handler): AbstractScroll

Add invalidate handler

Deprecated

since 4.0, use Node.on instead

AbstractScroll

this

Group.addInvalidateHandler

▸ addListener(event, callback): AbstractScroll

Add Listener

Deprecated

since 4.0 use scrollBar.on() instead

AbstractScroll

▸ addOverlay(overlay): AbstractScroll

Add overlay to container

AbstractScroll

this

Group.addOverlay

▸ adjustPosition(area?, vAlign?, hAlign?): AbstractScroll

Adjust position of node to specified area

AbstractScroll

this

Group.adjustPosition

▸ Protected applyOpacity(context): AbstractScroll

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

AbstractScroll

this

Group.applyOpacity

▸ Protected applyResponsiveStyle(): void

Apply a responsive style rules it is exists

void

Group.applyResponsiveStyle

▸ changeBaseLayerOrder(overlay, order, anchor?): AbstractScroll

Changes the z-order of the baseLayer.

AbstractScroll

this

Group.changeBaseLayerOrder

▸ changeChildOrder(node, order, anchor?): AbstractScroll

changes the z-order of the nodes being rendered.

AbstractScroll

this

Group.changeChildOrder

▸ changeOverlayOrder(overlay, order, anchor?): AbstractScroll

Changes the z-order of the overlay.

AbstractScroll

this

Group.changeOverlayOrder

▸ checkCollision(context): boolean

Check culling Returns true if object is inside of renderable area

boolean

true if node is collided

Group.checkCollision

▸ clearBaseLayers(disposeBaseLayers?): AbstractScroll

Remove all child baseLayers from group

AbstractScroll

this

Group.clearBaseLayers

▸ clearCache(): AbstractScroll

Clear cache

AbstractScroll

this

Group.clearCache

▸ clearChildren(disposeChildren?): AbstractScroll

Remove all child nodes from this composite group

AbstractScroll

this

Group.clearChildren

▸ clearOverlays(disposeOverlays?): AbstractScroll

Remove all child overlays from group

AbstractScroll

this

Group.clearOverlays

▸ clone(): Group<Node>

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

Group<Node>

clone

Group.clone

▸ connectStyle(style, type, callback): AbstractScroll

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

AbstractScroll

this

Group.connectStyle

▸ Protected copyConstructor(src, deepCopy?): AbstractScroll

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

AbstractScroll

this

Group.copyConstructor

▸ disconnectStyle(style, type, callback): AbstractScroll

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

AbstractScroll

this

Group.disconnectStyle

▸ dispose(): void

Dispose node. Clear all listeners and disconnect style to avoid memory leaks

void

Group.dispose

▸ Protected drawBorder(localContext, bounds?): AbstractScroll

Draws a rectangle at the bounding box (in parent coordinates)

AbstractScroll

this

Group.drawBorder

▸ enableClipping(doClip): AbstractScroll

Enables or disables clipping of this node. If enabled, shapes will not be rendered outside of its bounds.

AbstractScroll

this

Group.enableClipping

▸ enableEventPropagation(enable): AbstractScroll

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();

AbstractScroll

this

Group.enableEventPropagation

▸ enablePickingChildren(enable): AbstractScroll

Enables or disables picking children

AbstractScroll

this

Group.enablePickingChildren

▸ enumerateNodes(callback, target?): void

Executes a provided function once for each child node

void

Group.enumerateNodes

▸ execute(delegate): AbstractScroll

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");
});

AbstractScroll

The result if any or this

Group.execute

▸ execute<T>(delegate): T

T

Group.execute

▸ Protected filter(context): boolean

Filter node

boolean

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

Group.filter

▸ getAnimationStyle(): AnimationStyle

Return animation style

AnimationStyle

animationStyle current animation style

Group.getAnimationStyle

▸ getAutoModelLimitsMode(): boolean

Get Model Limits Logics to use when no Model Limits have been set set to true: will use parents width and height, starting at 0 set to false: will use parents bounds

boolean

mode

Group.getAutoModelLimitsMode

▸ getAutoModelLimitsStrategy(): ModelLimitsStrategy

Get Model Limits Logics Strategy

ModelLimitsStrategy

strategy

Group.getAutoModelLimitsStrategy

▸ getBaseLayer(index): Node

Return baseLayer at specified index

Node

track

Group.getBaseLayer

▸ getBaseLayers<S>(predicate, modify?): Iterator<Node>

Return iterator by baseLayers nodes

Iterator<Node>

Group.getBaseLayers

▸ getBaseLayers(filter?, modify?): Iterator<Node>

Returns an iterator for child baseLayers. The iterator does not support adding or deleting items from overlays by default. If it is necessary to modify a collection of overlays, pass true as the last parameter.

Example

// Gets a writable iterator
const it = node.getOverlays(null, true);

Iterator<Node>

An iterator for child overlays.

Group.getBaseLayers

▸ getBaseLayersCount(): number

Returns amount of baseLayers

number

Group.getBaseLayersCount

▸ getBounds(): Rect

Get the bounds in the parents model space. If bounds are not set, then parent model limits are used.

Rect

current bounds

Group.getBounds

▸ getCache(): Cache

Return cache strategy to be used to cache children nodes

Cache

cache

Group.getCache

▸ getChild(i): Node

Return node by index

Node

Group.getChild

▸ getChildren<S>(predicate, modify?): Iterator<S>

Return iterator by child nodes

Iterator<S>

Group.getChildren

▸ getChildren(filter?, modify?): Iterator<Node>

Returns an iterator for child nodes. The iterator does not support adding or deleting items from children by default. If it is necessary to modify a collection of children, pass true as the last parameter.

Example

// Gets a writable iterator
const it = node.getChildren(null, true);

Iterator<Node>

An iterator for child nodes.

Group.getChildren

▸ getChildrenCount(): number

Return number of child nodes

number

Group.getChildrenCount

▸ getClassName(): string

string

Group.getClassName

▸ getClipStyle(): ClipStyle

Gets the current clipping style

ClipStyle

clipping style

Group.getClipStyle

▸ getContentOrientation(): Orientation

Return content orientation

Orientation

content orientation

Group.getContentOrientation

▸ getContentsArea(transformation?): Rect

Return area without paddings. Model limits are mapped to content area, where children are layout.

Rect

Group.getContentsArea

▸ getContentsTransform(): Transformation

getContentsTransform() retrieves the world transformation of the node.

Transformation

transformation from model coordinates to bounds of the group

Group.getContentsTransform

▸ getCss(): CssStyle

Return CSS style

CssStyle

Group.getCss

▸ getCssClass(): string

Returns css class name to be used to apply CSS style

string

the css class name

Group.getCssClass

▸ getCssClasses(): string[]

Gets list of css class names which applied to this node

string[]

Group.getCssClasses

▸ getCssTransform(): string

Returns CSS transformation

string

Group.getCssTransform

▸ getDesiredHeight(): string | number

Returns desired height of the group as a layoutable object This method is a helper method to get access to getLayoutStyle()

string | number

desired height ("undefined" by default)

Group.getDesiredHeight

▸ getDesiredSize(): number

Returns optimal size for scroll bar

number

size

▸ getDesiredWidth(): string | number

Returns desired width of the group as a layoutable object. This method is a helper method to get access to getLayoutStyle()

string | number

desired width ("undefined" by default)

Group.getDesiredWidth

▸ getDeviceLimits(): Rect

Return device limits

Rect

Group.getDeviceLimits

▸ getFillStyle(): FillStyle

Return fill style

FillStyle

fillStyle current fill style

Group.getFillStyle

▸ getFloatingMode(): boolean

Returns floating mode

boolean

▸ getId(): string | number

Returns the associated identifier of the node

string | number

The node's id

Group.getId

▸ getInfiniteMode(): boolean

Return infinity mode flag

boolean

flag

Group.getInfiniteMode

▸ Protected getInvalidateMethod(): AttributeCallback<EventDispatcher>

Gets invalidate method

AttributeCallback<EventDispatcher>

method to invalidate this object

Group.getInvalidateMethod

▸ getLayout(): Layout

Returns layout associated with the group

Layout

layout

Group.getLayout

▸ getLayoutStyle(): LayoutStyle<string | number>

return desired layout style

LayoutStyle<string | number>

Group.getLayoutStyle

▸ getLineStyle(): LineStyle

Return border style

LineStyle

Group.getLineStyle

▸ getLocalTransform(): Transformation

Retrieves the transformation of bounds to parent

Transformation

transform the local transform.

Group.getLocalTransform

▸ getMarginsStyle(): SpaceStyle<string | number>

Return margins style

SpaceStyle<string | number>

Group.getMarginsStyle

▸ getModelLimits(): Rect

Gets model limits, the limits of this groups inside space

Rect

the current model limits

Group.getModelLimits

▸ Abstract getModelRange(): Range

Gets the scrolls Model Limits Range

Range

▸ getName(): string

Returns the node name

string

The node name

Group.getName

▸ getOpacity(): number

Returns current node opacity

number

opacity

Group.getOpacity

▸ getOpacityBlendMode(): BlendMode

Returns current node opacity

BlendMode

opacity blend mode

Group.getOpacityBlendMode

▸ getOptions(): any

Get scrollbar options

any

▸ getOverlay(index): Node

Return overlay at specified index

Node

track

Group.getOverlay

▸ getOverlayAt(index): Node

Return overlay at specified index

Deprecated

since 4.2 use getOverlay instead

Node

track

Group.getOverlayAt

▸ getOverlays<S>(predicate, modify?): Iterator<Node>

Return iterator by overlays nodes

Iterator<Node>

Group.getOverlays

▸ getOverlays(filter?, modify?): Iterator<Node>

Returns an iterator for child overlays. The iterator does not support adding or deleting items from overlays by default. If it is necessary to modify a collection of overlays, pass true as the last parameter.

Example

// Gets a writable iterator
const it = node.getOverlays(null, true);

Iterator<Node>

An iterator for child overlays.

Group.getOverlays

▸ getOverlaysCount(): number

Returns amount of overlays

number

Group.getOverlaysCount

▸ getPaddingStyle(): SpaceStyle<string | number>

Return padding style

SpaceStyle<string | number>

padding

Group.getPaddingStyle

▸ getParent(): Node

Return parent node

Node

parent node

Group.getParent

▸ getPreferredSize(): Rect

Return preferred size to layout children

Rect

Group.getPreferredSize

▸ getProperties(context?): OptionsOut

Gets all the properties pertaining to this object

OptionsOut

properties object

Group.getProperties

▸ getProperty(name): any

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

any

Group.getProperty

▸ getPropertyKeys(): string[]

Returns known properties keys

string[]

Group.getPropertyKeys

▸ getRenderingFilter(): IFilter

Return filter to be used for rendering and picking

IFilter

current filter

Group.getRenderingFilter

▸ getResponsiveStyle(): ResponsiveStyle

Return responsive style

ResponsiveStyle

Group.getResponsiveStyle

▸ getRoot(): Node

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

Node

the root node

Group.getRoot

▸ getScaleScrollStrategy(): Delegate

Gets scale scroll strategy

Delegate

scale scroll strategy

Group.getScaleScrollStrategy

▸ getSceneTransform(): Transformation

Returns transformation from node to root scene

Transformation

a transformation from node to root scene

Group.getSceneTransform

▸ getTag(): any

Returns the object associated with the node by user.

any

The node's user-object

Group.getTag

▸ getTool(): ScrollTool

Get the scroll tool

ScrollTool

▸ getVisible(): boolean

Return visibility of the node

boolean

true if node is visible

Group.getVisible

▸ getVisibleDeviceLimits(ignoreModelLimits?): Rect

Return visible device limits

Rect

Group.getVisibleDeviceLimits

▸ getVisibleModelLimits(ignoreModelLimits?): Rect

Return visible model limits

Rect

Group.getVisibleModelLimits

▸ Abstract getVisibleModelRange(): Range

Gets the scroll visible Model Range

Range

▸ getWorldTransform(): Transformation

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

Transformation

Group.getWorldTransform

▸ getZIndex(): number

Returns node z-index (null if not set)

number

Group.getZIndex

▸ hasCssClass(cssClass): boolean

Check if node has specified css class

boolean

Group.hasCssClass

▸ hasEventListener(type, callback?): boolean

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

boolean

Group.hasEventListener

▸ indexOfBaseLayer(baseLayer): number

Return index of overlay ( index of the specified child or -1 if baseLayer is not found)

number

Group.indexOfBaseLayer

▸ indexOfChild(node): number

Return index of child ( index of the specified child or -1 if node is not found)

number

Group.indexOfChild

▸ indexOfOverlay(overlay): number

Return index of overlay ( index of the specified child or -1 if overlay is not found)

number

Group.indexOfOverlay

▸ insertBaseLayer(index, baseLayer): AbstractScroll

Insert child baseLayer at specified index

AbstractScroll

this

Group.insertBaseLayer

▸ insertChild(index, node): AbstractScroll

Insert child node at specified index

AbstractScroll

this

Group.insertChild

▸ insertOverlay(index, overlay): AbstractScroll

Insert child overlay at specified index

AbstractScroll

this

Group.insertOverlay

▸ invalidate(bounds?, force?): AbstractScroll

Invalidate node

AbstractScroll

this

Group.invalidate

▸ invalidateLayout(propagate?): AbstractScroll

Notify that layout is invalidated. Send event Events.LayoutInvalidated

AbstractScroll

this

Group.invalidateLayout

▸ invalidateParent(bounds?, force?): AbstractScroll

Invalidate parent area

AbstractScroll

this

Group.invalidateParent

▸ Protected isActive(): boolean

boolean

is active

▸ isClippingEnabled(): boolean

Returns if clipping is enabled or not for this node.

boolean

Group.isClippingEnabled

▸ isDisposed(): boolean

Returns whether this object has been disposed

boolean

Group.isDisposed

▸ isEventPropagationEnabled(): boolean

Return true if event propagation is enabled from child to parent

boolean

Group.isEventPropagationEnabled

▸ isHorizontalFlip(): boolean

Return true if the representation is flipped horizontally

boolean

flip

Group.isHorizontalFlip

▸ isLayoutInvalidated(): boolean

Return true if layout is invalid

boolean

Group.isLayoutInvalidated

▸ isNotificationEnabled(): boolean

return state of notification

boolean

current notification state

Group.isNotificationEnabled

▸ isPickingChildrenEnabled(): boolean

Returns if picking children is enabled or not for this node.

boolean

pickingChildren

Group.isPickingChildrenEnabled

▸ isSelectable(): boolean

Returns true if node can be picked/selected.

boolean

The selectable flag

Group.isSelectable

▸ isSilent(): boolean

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

boolean

Group.isSilent

▸ isVerticalFlip(): boolean

Return true if the representation is flipped vertically

boolean

flip

Group.isVerticalFlip

▸ moveTo(area, vAlign?, hAlign?): AbstractScroll

MoveTo position of node to specified area

AbstractScroll

this

Group.moveTo

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

Notify listeners of the Node

AbstractScroll

this

Group.notify

▸ Protected notifyRoot(event, source, args?): Node

Notify an even to root node

Node

this

Group.notifyRoot

▸ Protected notifyTool<E>(type, args?): AbstractScroll

Notify tool

AbstractScroll

this

▸ off<E>(type?, callback?): AbstractScroll

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.

AbstractScroll

this

Group.off

▸ on<E>(type, callback): AbstractScroll

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.

AbstractScroll

this

Group.on

▸ Protected onBoundsChanged(bounds): AbstractScroll

Occurs when bounds has been changed

AbstractScroll

this

Group.onBoundsChanged

▸ Protected onChildAdded(child): void

This method is called it child or children are added

void

Group.onChildAdded

▸ Protected onChildRemoved(child): void

This method is called it child or children are removed

void

Group.onChildRemoved

▸ Protected onDoubleClick(eventArgs): void

Double click handler Detects if double click happens on scrollbar and prevents propagation