Class: Border

• new Border(options, fillstyle)

• new Border(options?, fillstyle?)

ScaledShape.constructor

▸ addCssClass(cssclass): Border

Adds new css class to node

Border

this

ScaledShape.addCssClass

▸ addInvalidateHandler(handler): Border

Add invalidate handler

Deprecated

since 4.0, use Node.on instead

Border

this

ScaledShape.addInvalidateHandler

▸ Protected applyOpacity(context): Border

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

Border

this

ScaledShape.applyOpacity

▸ Protected applyResponsiveStyle(): void

Apply a responsive style rules it is exists

void

ScaledShape.applyResponsiveStyle

▸ checkCollision(context): boolean

Check collision

boolean

true if object is inside of rendering area

ScaledShape.checkCollision

▸ clone(): Border

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

Border

clone

ScaledShape.clone

▸ connectStyle(style, type, callback): Border

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

Border

this

ScaledShape.connectStyle

▸ Protected copyConstructor(src, deepCopy?): Border

copy constructor

Border

ScaledShape.copyConstructor

▸ disconnectStyle(style, type, callback): Border

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

Border

this

ScaledShape.disconnectStyle

▸ 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.

void

ScaledShape.dispose

▸ enableEventPropagation(enable): Border

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

Border

this

ScaledShape.enableEventPropagation

▸ execute(delegate): Border

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

Border

The result if any or this

ScaledShape.execute

▸ execute<T>(delegate): T

T

ScaledShape.execute

▸ Protected filter(context): boolean

Filter node

boolean

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

ScaledShape.filter

▸ getAnimationStyle(): AnimationStyle

Return animation style

AnimationStyle

animationStyle current animation style

ScaledShape.getAnimationStyle

▸ getBorderStyle(): BorderStyle

Returns the border style

BorderStyle

▸ getBorders(): Visible

Returns borders visibility

Visible

JSON which defines border settings

▸ getBounds(): Rect

Returns bounds

Rect

bounds

ScaledShape.getBounds

▸ getClassName(): string

string

ScaledShape.getClassName

▸ getClipStyle(): ClipStyle

Gets the current clipping style

ClipStyle

clipping style

ScaledShape.getClipStyle

▸ getCss(): CssStyle

Return CSS style

CssStyle

ScaledShape.getCss

▸ getCssClass(): string

Returns css class name to be used to apply CSS style

string

the css class name

ScaledShape.getCssClass

▸ getCssClasses(): string[]

Gets list of css class names which applied to this node

string[]

ScaledShape.getCssClasses

▸ getCssTransform(): string

Returns CSS transformation

string

ScaledShape.getCssTransform

▸ getFillStyle(): FillStyle

Return fill style

FillStyle

fillStyle current fill style

ScaledShape.getFillStyle

▸ getId(): string | number

Returns the associated identifier of the node

string | number

The node's id

ScaledShape.getId

▸ Protected getInvalidateMethod(): AttributeCallback<EventDispatcher>

Gets invalidate method

AttributeCallback<EventDispatcher>

method to invalidate this object

ScaledShape.getInvalidateMethod

▸ getLineStyle(): LineStyle

Return line style

LineStyle

lineStyle current line style

ScaledShape.getLineStyle

▸ getLineStyles(): StylesOut

Gets line styles

StylesOut

line styles

▸ getLocalTransform(): Transformation

Retrieves the transformation of bounds to parent

Transformation

transform the local transform.

ScaledShape.getLocalTransform

▸ getMarginsStyle(): SpaceStyle<string | number>

Return margins style

SpaceStyle<string | number>

ScaledShape.getMarginsStyle

▸ getName(): string

Returns the node name

string

The node name

ScaledShape.getName

▸ getOpacity(): number

Returns current node opacity

number

opacity

ScaledShape.getOpacity

▸ getOpacityBlendMode(): BlendMode

Returns current node opacity

BlendMode

opacity blend mode

ScaledShape.getOpacityBlendMode

▸ getParent(): Node

Return parent node

Node

parent node

ScaledShape.getParent

▸ getProperties(): OptionsOut

Gets all the properties pertaining to this object

OptionsOut

properties

ScaledShape.getProperties

▸ getProperty(name): any

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

any

ScaledShape.getProperty

▸ getPropertyKeys(): string[]

Returns known properties keys

string[]

ScaledShape.getPropertyKeys

▸ getRenderingFilter(): IFilter

Return filter to be used for rendering and picking

IFilter

current filter

ScaledShape.getRenderingFilter

▸ getResponsiveStyle(): ResponsiveStyle

Return responsive style

ResponsiveStyle

ScaledShape.getResponsiveStyle

▸ getRoot(): Node

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

Node

the root node

ScaledShape.getRoot

▸ getScaleScrollStrategy(): Delegate

Gets scale scroll strategy

Delegate

scale scroll strategy

ScaledShape.getScaleScrollStrategy

▸ getSceneTransform(): Transformation

Returns transformation from node to root scene

Transformation

a transformation from node to root scene

ScaledShape.getSceneTransform

▸ getTag(): any

Returns the object associated with the node by user.

any

The node's user-object

ScaledShape.getTag

▸ getVisible(): boolean

Return visibility of the node

boolean

true if node is visible

ScaledShape.getVisible

▸ getWorldTransform(): Transformation

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

Transformation

transform the world transform.

ScaledShape.getWorldTransform

▸ getZIndex(): number

Returns node z-index (null if not set)

number

ScaledShape.getZIndex

▸ hasCssClass(cssClass): boolean

Check if node has specified css class

boolean

ScaledShape.hasCssClass

▸ hasEventListener(type, callback?): boolean

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

boolean

ScaledShape.hasEventListener

▸ invalidate(bounds?, force?): Border

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

Border

this

ScaledShape.invalidate

▸ invalidateParent(bounds?, force?): Border

Invalidate bounds

Border

this

ScaledShape.invalidateParent

▸ isDisposed(): boolean

Returns whether this object has been disposed

boolean

ScaledShape.isDisposed

▸ isEventPropagationEnabled(): boolean

Return true if event propagation is enabled from child to parent

boolean

ScaledShape.isEventPropagationEnabled

▸ isNotificationEnabled(): boolean

return state of notification

boolean

current notification state

ScaledShape.isNotificationEnabled

▸ isSelectable(): boolean

Returns true if node can be picked/selected.

boolean

The selectable flag

ScaledShape.isSelectable

▸ isSilent(): boolean

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

boolean

ScaledShape.isSilent

▸ notify<E>(event, source, args?): Border

Notify listeners of the Node

Border

this

ScaledShape.notify

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

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.

Border

this

ScaledShape.off

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

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.

Border

this

ScaledShape.on

▸ Protected onParentChanged(node): Border

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

Border

this

ScaledShape.onParentChanged

▸ Protected onVisibilityChanged(): void

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

void

ScaledShape.onVisibilityChanged

▸ Protected postRendering(context): void

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

void

ScaledShape.postRendering

▸ Protected preRendering(context): void

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

void

ScaledShape.preRendering

▸ registerAnimationStyle(root): void

Register animation style.

void

ScaledShape.registerAnimationStyle

▸ removeCssClass(cssclass): Border

Removes css class from node

Border

this

ScaledShape.removeCssClass

▸ removeInvalidateHandler(handler): Border

Remove invalidate handler

Deprecated

since 4.0, use Node.off instead

Border

this

ScaledShape.removeInvalidateHandler

▸ render(context): void

Renders node

void

ScaledShape.render

▸ renderAsync(context, callback): void

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

void

ScaledShape.renderAsync

▸ rotate(theta, x, y): Border

Rotate bounds around a given coordinate

Border

this

ScaledShape.rotate

▸ scale(xx, yy): Border

Scale node

Border

this

ScaledShape.scale

▸ setAnimationStyle(animationStyle): Border

Sets animation style

Border

ScaledShape.setAnimationStyle

▸ setBorderStyle(style): Border

Sets the border style

Border

▸ setBorders(borders): Border

Sets borders state

Border

this

▸ setBounds(bounds): Border

Sets bounds

Border

this

▸ setClipStyle(style): Border

Sets a new clipping style

Border

this

ScaledShape.setClipStyle

▸ setCss(style, merge?): Border

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

Border

this

ScaledShape.setCss

▸ setCssClass(name): Border

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

Border

this

ScaledShape.setCssClass

▸ setCssTransform(transform): Border

Set CSS transformation

Border

this

ScaledShape.setCssTransform

▸ setFillStyle(fillStyle, merge?): Border

Sets fill style

Border

this

ScaledShape.setFillStyle

▸ setId(id): Border

Allows the user to associate any identifier

Border

this

ScaledShape.setId

▸ setLineStyle(lineStyle, merge?): Border

Sets line style

Border

this

ScaledShape.setLineStyle

▸ setLineStyles(styles, merge?): Border

Sets line styles

Border

this

▸ setLocalTransform(localTransform, force?): Border

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

Border

this

ScaledShape.setLocalTransform

▸ setMarginsStyle(margins, merge?): Border

Sets margins style

Border

this

ScaledShape.setMarginsStyle

▸ setName(name): Border

Sets name of the node

Border

this

ScaledShape.setName

▸ setNotification(notify, force?): Border

set notification state

Border

this

ScaledShape.setNotification

▸ setOpacity(opacity, blendMode?): Border

Sets node opacity

Border

this

ScaledShape.setOpacity

▸ setProperties(properties?): Border

Sets all the properties pertaining to this object

Border

ScaledShape.setProperties

▸ setProperty(name, value): Border

Sets dynamic property by name

Border

this

ScaledShape.setProperty

▸ setRenderingFilter(filter): Border

Sets filter to be applied before rendering and picking

Border

this

ScaledShape.setRenderingFilter

▸ setResponsiveStyle(style): Border

Sets responsive style.

Border

this

ScaledShape.setResponsiveStyle

▸ setScaleScrollStrategy(strategy?): Border

Sets scale scroll strategy

Border

this

ScaledShape.setScaleScrollStrategy

▸ setSelectable(selectable): Border

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

Border

this

ScaledShape.setSelectable

▸ setSilent(bool): Border

Set silent mode

Border

this

ScaledShape.setSilent

▸ setTag(tag): Border

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

Border

this

ScaledShape.setTag

▸ setVisible(value): Border

Sets visibility of the node. Send event Events.VisibilityChanged

Border

this

ScaledShape.setVisible

▸ setZIndex(value): Border

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

Border

this

ScaledShape.setZIndex

▸ shear(shx, shy): Border

Shear this node's bounds

Border

this

ScaledShape.shear

▸ toString(): string

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

string

A string representation

ScaledShape.toString

▸ translate(tx, ty): Border

Translate bounds

Border

this

ScaledShape.translate

▸ unregisterAnimationStyle(root): void

Unregister animation style.

void

ScaledShape.unregisterAnimationStyle

▸ updateSceneTransformation(): Border

Update scene transformation

Border

this

ScaledShape.updateSceneTransformation

▸ updateState(regions?, changes?): Border

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

Border

this

ScaledShape.updateState

▸ Protected updateTimeStamp(): Border

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

Border

this

ScaledShape.updateTimeStamp

▸ Static enableSceneGraphNotification(enabled): void

Enable / disable all notifications

void

ScaledShape.enableSceneGraphNotification

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

Find root of the node with specified type

InstanceType<T>

ScaledShape.findParent

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

Find root of the node with specified type

Node

ScaledShape.findParent

▸ Static getClassName(): string

string

ScaledShape.getClassName

▸ Static intersectsBounds(bounds, localTransformation, parentInvalidArea, expand?): boolean

Check collision of the shape bounds with parent invalid area

boolean

true if bounds intersect the invalid area

ScaledShape.intersectsBounds

▸ Static isSceneGraphNotificationEnabled(): boolean

Return status of the global notification for all nodes.

boolean

ScaledShape.isSceneGraphNotificationEnabled