API / geotoolkit / flowcharts / shapes / connectors / LinkVisual / LinkVisual
connectors.LinkVisual.LinkVisual
A simple polygonal link that connects two shapes together.
↳
LinkVisual
Constructors
Methods
Css Properties
| Name | Type | Description |
|---|---|---|
clipstyle | ClipStyle | Clipping style |
clipstyle-evenodd | boolean | True if evenodd mode is on ('nonzero' mode otherwise) |
clipstyle-geometry | GraphicsPath | Clipping geometry |
clipstyle-geometry-bounds | Rect | Bounds |
clipstyle-geometry-bounds-height | number | Height |
clipstyle-geometry-bounds-readonly | boolean | Readonly |
clipstyle-geometry-bounds-width | number | Width |
clipstyle-geometry-bounds-x | number | Left |
clipstyle-geometry-bounds-y | number | Top |
clipstyle | GraphicsPath | Clipping style |
cssclass | string | The css class name of this node |
csscursor | string | CSS cursor associated with node |
cssstyle | string | CSS style to be applied to inserted elements |
fillstyle | string | Style applied on fill |
fillstyle | FillStyle | Style applied on fill |
fillstyle-color | string | Color in CSS form |
fillstyle-evenoddmode | boolean | Even-odd fill mode |
fillstyle-fillpattern | Pattern | Pattern |
fillstyle-fillpattern-containername | string | An 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 |
fillstyle-fillpattern-patternname | string | Name of this pattern for indexing |
fillstyle-fillpattern-scalable | boolean | Flag that sets scalability of the pattern coordinates, or relative to the shape it is filling (It is not supported) |
fillstyle-foreground | string | Foreground color |
fillstyle-pattern | Pattern | Pattern |
id | string | number | Id of the node, its a unique identifier |
linestyle | string | Style applied on outline |
linestyle | LineStyle | Style applied on outline |
linestyle-color | string | Color in CSS form |
linestyle-fill | string | Optional fill style to be used to fill lines generated with this style |
linestyle-fill | FillStyle | Optional fill style to be used to fill lines generated with this style |
linestyle-linecap | CapStyle | The line cap style |
linestyle-linedashoffset | number | Line dash offset of dashed line |
linestyle-linejoin | JoinStyle | The line join style |
linestyle-pixelsnapmode | boolean | Pixel Snap Mode, default( |
linestyle-scalable | boolean | True if width should depend on transformation |
linestyle-unit | string | Optional unit for the width |
linestyle-width | number | string | The line thickness |
localtransform | Transformation | Local transformation |
localtransform-dx | number | X axis translation |
localtransform-dy | number | Y axis translation |
localtransform-xx | number | X scale |
localtransform-xy | number | Xy skew |
localtransform-yx | number | Yx skew |
localtransform-yy | number | Y scale |
margins | number | string | It has properties for specifying the margins for each side |
name | string | Name of the node. It is often used for debugging purposes or to simplify queries |
opacity | number | Node opacity (from 0 to 1). If it is undefined or null it inherits property from the parent. It changes globalAlpha on the rendering context |
opacityblendmode | BlendMode | Node opacity mode to blend it |
optimization | boolean | Optimization type boolean || ['none' | 'rdp' | 'closepoints'] |
scalescrollstrategy | ScaleScrollStrategy | Scale scroll strategy |
scalescrollstrategy-enabled | boolean | Enable flag |
selectable | boolean | Selectable node, a boolean to determine if selection should consider this node |
tag | any | Custom 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 |
transform | string | Additional CSS transformation applied to node or 'none' |
transform | Transformation | Additional CSS transformation applied to node or 'none' |
visible | boolean | Visibility of the node, a boolean to determine if the node should be rendered or not |
z-index | number | Define node z-index |
Constructors
• new LinkVisual(options?)
Create link visual
| Name | Type | Description |
|---|---|---|
Optional options | Options | visual properties |
Polyline.constructor
Methods
▸ addCssClass(cssclass): LinkVisual
Adds new css class to node
| Name | Type | Description |
|---|---|---|
cssclass | string | string[] | css class name('s) |
this
▸ addInvalidateHandler(handler): LinkVisual
Add invalidate handler
Deprecated
since 4.0, use Node.on instead
| Name | Type | Description |
|---|---|---|
handler | Function | handler to be notified about invalidation |
this
▸ Protected applyOpacity(context): LinkVisual
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
| Name | Type | Description |
|---|---|---|
context | RenderingContext | Rendering Context |
this
▸ Protected applyResponsiveStyle(): void
Apply a responsive style rules it is exists
void
▸ canConnect(component, modelPoint, minDistance): Point
Checks if the link visual can connect to a component at the given model point (in parent's coordinate system)
| Name | Type | Description |
|---|---|---|
component | Node | a component to check if the link visual can connect to |
modelPoint | Point | a point in model space |
minDistance | number | minimum distance in device units (pixels) for snapping |
model link point or null if can not connect
▸ checkCollision(context): boolean
Check collision
| Name | Type | Description |
|---|---|---|
context | RenderingContext | Rendering Context |
boolean
true if object is inside of rendering area
▸ clone(): LinkVisual
All subclasses should override copyConstructor or provide custom implementation for this method
clone
▸ connectStyle(style, type, callback): LinkVisual
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
| Name | Type | Description |
|---|---|---|
style | EventDispatcher | connect style |
type | string | type of event or property |
callback | AttributeCallback<EventDispatcher> | function to be called |
this
▸ connectTo(visual, linkSide, visualModelPoint): boolean
Connects self to the given visual, using the given linkside to the model point (in coordinates of visual)
| Name | Type | Description |
|---|---|---|
visual | Component | a visual to connect to |
linkSide | LinkSide | link side (begin or end) |
visualModelPoint | Point | model coordinates (in visual model space) |
boolean
true on success, false on fail
▸ Protected copyConstructor(src, deepCopy?): LinkVisual
copy constructor
| Name | Type | Description |
|---|---|---|
src | Polyline | Source to copy from |
Optional deepCopy | boolean |
this
▸ disconnectFrom(linkSide): void
Checks if the link visual was previously connected and disconnects if so. If devicePoint coordinates are specified, then a point with index pointIndex will be set to model position, calculated from devicePoint value. The devicePoint X Y values are used to provide "sticky" behavior for hot points.
| Name | Type | Description |
|---|---|---|
linkSide | LinkSide | defines side of the link |
void
▸ disconnectStyle(style, type, callback): LinkVisual
Disconnect style
This convenience method un-subscribes a listener to given style for the specified type.
| Name | Type | Description |
|---|---|---|
style | EventDispatcher | connect style |
type | string | type of event or property |
callback | AttributeCallback<EventDispatcher> | function to be called |
this
▸ 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
▸ enableEventPropagation(enable): LinkVisual
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();| Name | Type | Description |
|---|---|---|
enable | boolean | enable |
this
Polyline.enableEventPropagation
▸ execute(delegate): LinkVisual
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");
});| Name | Type | Description |
|---|---|---|
delegate | (this: LinkVisual) => void | Function to execute |
The result if any or this
▸ execute<T>(delegate): T
| Name |
|---|
T |
| Name | Type |
|---|---|
delegate | (this: LinkVisual) => T |
T
▸ Protected filter(context): boolean
Filter node
| Name | Type | Description |
|---|---|---|
context | RenderingContext | Rendering Context |
boolean
flag filter flag ("true" to render node; "false" otherwise)
▸ getAnimationStyle(): AnimationStyle
Return animation style
animationStyle current animation style
▸ getBounds(): Rect
Gets current bounds
current bounds
▸ getCategory(): string
Gets component category
string
string instance representing component catetory
▸ getClassName(): string
string
▸ getClipStyle(): ClipStyle
Gets the current clipping style
clipping style
▸ getConnectedIndexes(visual): number[]
checks if the visual connected to the link and returns all link point indexes. If not connected, an empty array returns
| Name | Type | Description |
|---|---|---|
visual | Node | a visual to get connection points. |
number[]
▸ getConnections(): Record<LinkSide, LinkConnection>
Gets array of connections
Record<LinkSide, LinkConnection>
an array of connections
▸ getCss(): CssStyle
Return CSS style
▸ getCssClass(): string
Returns css class name to be used to apply CSS style
string
the css class name
▸ getCssClasses(): string[]
Gets list of css class names which applied to this node
string[]
▸ getCssTransform(): string
Returns CSS transformation
string
▸ getDefaultIconSize(): Dimension
Gets the default icon size for UI representation
▸ getDefaultSize(): Dimension
Gets default size of the link visual
▸ getFillStyle(): FillStyle
Return fill style
fillStyle current fill style
▸ getGeometry(): Node
Gets geometry for the current link visual
▸ getId(): string | number
Returns the associated identifier of the node
string | number
The node's id
▸ Protected getInvalidateMethod(): AttributeCallback<EventDispatcher>
Gets invalidate method
AttributeCallback<EventDispatcher>
method to invalidate this object
▸ getLineStyle(): LineStyle
Return line style
lineStyle current line style
▸ getLinkPoints(): Point[]
Returns an array of link points: begin and end
Point[]
an array of linking points
▸ getLinkType(): LinkType
Get link type
a type of the link
▸ getLinkingMode(): LinkingMode
Gets linking mode. This mode defines logic of the link as well as its appearance.
current linking mode
▸ getLocalTransform(): Transformation
Retrieves the transformation of bounds to parent
transform the local transform.
▸ getMarginsStyle(): SpaceStyle<string | number>
Return margins style
SpaceStyle<string | number>
▸ getName(): string
Returns the node name
string
The node name
▸ getOpacity(): number
Returns current node opacity
number
opacity
▸ getOpacityBlendMode(): BlendMode
Returns current node opacity
opacity blend mode
▸ getOptimization(): boolean
Returns current optimization state
boolean
optimization state
▸ getOptimizationType(): OptimizationType
Returns optimization type
optimization type
▸ getOutline(): GraphicsPath
Gets outline (path) for the Link Visual
▸ getParent(): Node
Return parent node
parent node
▸ getPoint(index): Point
Returns polyline point at specified index (null if no point found)
| Name | Type | Description |
|---|---|---|
index | number | the point index |
▸ getPointsX(): number[]
Gets x-coords of points
number[]
▸ getPointsY(): number[]
Gets y-coords of points
number[]
▸ getProperties(): OptionsOut
Gets all the properties pertaining to this object
properties
▸ getProperty(name): any
Gets dynamic property by name. These properties can be used as a property bags
| Name | Type | Description |
|---|---|---|
name | string | property name |
any
▸ getPropertyKeys(): string[]
Returns known properties keys
string[]
▸ getPrototypeId(): string
Returns component class, string value
string
string instance representing component class
▸ getPrototypeName(): string
Gets component name
string
string instance representing component name
▸ getRenderingFilter(): IFilter
Return filter to be used for rendering and picking
current filter
▸ getResponsiveStyle(): ResponsiveStyle
Return responsive style
▸ getRoot(): Node
Returns root node.
If node doesn't have parent then it returns itself.
the root node
▸ getScaleScrollStrategy(): Delegate
Gets scale scroll strategy
scale scroll strategy
Polyline.getScaleScrollStrategy
▸ getSceneTransform(): Transformation
Returns transformation from node to root scene
a transformation from node to root scene
▸ getSearchKeywords(): string[]
Gets an array of keywords for better search
string[]
an array of search keywords
▸ getSize(): number
number
a number of the points
▸ getSymbolSize(): Object
Gets symbol size
Object
symbol width and height
| Name | Type |
|---|---|
height | number |
width | number |
▸ getTag(): any
Returns the object associated with the node by user.
any
The node's user-object
▸ getTubingWidth(): number
Gets tubing width, if set to Schematics/skin mode
number
a tubing width
▸ getUrl(): string
Gets url for icon
string
▸ getVisible(): boolean
Return visibility of the node
boolean
true if node is visible
▸ getWorldTransform(): Transformation
Retrieves the local transformation of the node which represents multiplication of parent to bounds and contents transformations.
transform the world transform.
▸ getZIndex(): number
Returns node z-index (null if not set)
number
▸ hasCssClass(cssClass): boolean
Check if node has specified css class
| Name | Type | Description |
|---|---|---|
cssClass | string | css class name |
boolean
▸ hasEventListener(type, callback?): boolean
Check if a list of event listeners for this type contains this listener
| Name | Type | Description |
|---|---|---|
type | string | type of event or property |
Optional callback | Function | to be called, if null, check if any callback is registered |
boolean
▸ insert(index, point): LinkVisual
Inserts point into array at specified index.
| Name | Type | Description |
|---|---|---|
index | number | the point position index |
point | Point | Point |
this
▸ insert(index, x, y): LinkVisual
Inserts point into array at specified index.
| Name | Type | Description |
|---|---|---|
index | number | the point position index |
x | number | x-coordinate |
y | number | y-coordinate |
this
▸ invalidate(bounds?, force?): LinkVisual
Invalidate area of the shape. This method invalidates parent by default. invalidated from parent to root node.
| Name | Type | Description |
|---|---|---|
Optional bounds | Rect | bounds of the invalid rectangle in the inner node coordinates |
Optional force | boolean | true 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 |
this
▸ invalidateParent(bounds?, force?): LinkVisual
Invalidate bounds
| Name | Type | Description |
|---|---|---|
Optional bounds | Rect | if null is provided then cache (if any will be completely refreshed) otherwise only specified rect or node.bounds will be refreshed |
Optional force | boolean | flag indicating if the parent must be forcibly invalidated |
this
▸ isDisposed(): boolean
Returns whether this object has been disposed
boolean
▸ isEventPropagationEnabled(): boolean
Return true if event propagation is enabled from child to parent
boolean
Polyline.isEventPropagationEnabled
▸ isNotificationEnabled(): boolean
return state of notification
boolean
current notification state
Polyline.isNotificationEnabled
▸ isSelectable(): boolean
Returns true if node can be picked/selected.
boolean
The selectable flag
▸ isSilent(): boolean
Return true if the event dispatcher doesn't notify any events
boolean
▸ moveLinkHandle(linkSide, modelPoint): void
Moves link handle to the given device coordinates
| Name | Type | Description |
|---|---|---|
linkSide | LinkSide | a link side to move (begin or end) |
modelPoint | Point | new position for the link handle in parent's model coordinates |
void
▸ notify<E>(type, source, args?): LinkVisual
Notify listeners of the Node
| Name | Type |
|---|---|
E | extends string |
| Name | Type | Description |
|---|---|---|
type | E | type of event |
source | LinkVisual | source who called the event |
Optional args | EventMap[E] | event arguments |
this
▸ off<E>(type?, callback?): LinkVisual
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.
| Name | Type |
|---|---|
E | extends string |
| Name | Type | Description |
|---|---|---|
Optional type | E | type of the event |
Optional callback | (eventType: E, sender: LinkVisual, args: EventMap[E]) => void | function to be called |
this
▸ on<E>(type, callback): LinkVisual
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.
| Name | Type |
|---|---|
E | extends string |
| Name | Type | Description |
|---|---|---|
type | E | type of event or property |
callback | (eventType: E, sender: LinkVisual, args: EventMap[E]) => void | to be called |
this
▸ Protected onParentChanged(node): LinkVisual
This method is called when parent changes. Do not call it directly.
| Name | Type | Description |
|---|---|---|
node | Node | node to change parent |
this
▸ Protected onVisibilityChanged(): void
This method is called if visibility is changed. Send event Events.VisibilityChanged
void
▸ Protected postRendering(context): void
To be called after rendering. Call this method if you override method render
| Name | Type | Description |
|---|---|---|
context | RenderingContext | Rendering Context |
void
▸ Protected preRendering(context): void
Occurs before rendering this method sets clipping by default. Call this method if you override method render
| Name | Type | Description |
|---|---|---|
context | RenderingContext | Rendering Context |
void
▸ push(x, y): LinkVisual
Adds point to array of points.
| Name | Type | Description |
|---|---|---|
x | number | x-coordinate |
y | number | y coordinate |
this
▸ push(point): LinkVisual
Adds point to array of points.
| Name | Type | Description |
|---|---|---|
point | Point | Point |
this
▸ registerAnimationStyle(root): void
Register animation style.
| Name | Type | Description |
|---|---|---|
root | Node | root node for node |
void
Polyline.registerAnimationStyle
▸ remove(start, count?): XYCoords
Removes point(s) from the polygon.
| Name | Type | Description |
|---|---|---|
start | number | index of the first removing point |
Optional count | number | the number of points to be removed |
an object containing the deleted points
▸ removeCssClass(cssclass): LinkVisual
Removes css class from node
| Name | Type | Description |
|---|---|---|
cssclass | string | string[] | css class name('s) |
this
▸ removeInvalidateHandler(handler): LinkVisual
Remove invalidate handler
Deprecated
since 4.0, use Node.off instead
| Name | Type | Description |
|---|---|---|
handler | Function | handler to be notified about invalidation |
this
Polyline.removeInvalidateHandler
▸ render(context): void
Renders node
| Name | Type | Description |
|---|---|---|
context | RenderingContext | The rendering context to be used to draw the node |
void
▸ renderAsync(context, callback): void
Render node in asynchronous mode. Default implementation creates call method "render" inside
| Name | Type | Description |
|---|---|---|
context | RenderingContext | The rendering context to be used to draw the node |
callback | () => void | callback function |
void
▸ rotate(theta, x, y): LinkVisual
Rotate bounds around a given coordinate
| Name | Type | Description |
|---|---|---|
theta | number | angle to rotate node, in radians |
x | number | x coordinate to rotate around |
y | number | y coordinate to rotate around |
this
▸ scale(xx, yy): LinkVisual
Scale node
| Name | Type | Description |
|---|---|---|
xx | number | x scale factor |
yy | number | y scale factor |
this
▸ setAnimationStyle(animationStyle): LinkVisual
Sets animation style
| Name | Type | Description |
|---|---|---|
animationStyle | Type | animation style |
▸ setClipStyle(style): LinkVisual
Sets a new clipping style
| Name | Type | Description |
|---|---|---|
style | GraphicsPath | ClipStyle | Options | a new clipping style |
this
▸ setCoordinates(x, y): LinkVisual
Sets arrays of points
| Name | Type | Description |
|---|---|---|
x | number[] | an array of x coordinates |
y | number[] | an array of y coordinates |
this
▸ setCss(style, merge?): LinkVisual
Sets CSS style. This style will be applied for all inserted elements
| Name | Type | Description |
|---|---|---|
style | Type | CSS style to be applied to inserted elements |
Optional merge | boolean | merge flag |
this
▸ setCssClass(name): LinkVisual
Sets css class name of the node to be used to apply CSS style
| Name | Type | Description |
|---|---|---|
name | string | css class name of the node |
this
▸ setCssTransform(transform): LinkVisual
Set CSS transformation
| Name | Type | Description |
|---|---|---|
transform | string | Transformation | transformation css transformation instruction or Transformation instance |
this
▸ setDefaultSize(dimension): LinkVisual
This method does nothing for the link visual
| Name | Type | Description |
|---|---|---|
dimension | Dimension | new default dimension |
this
▸ setFillStyle(fillStyle, merge?): LinkVisual
Sets fill style
| Name | Type | Description |
|---|---|---|
fillStyle | Type | a new fill style |
Optional merge | boolean | true if you want to merge fillStyle with existing attribute, false by default |
this
▸ setId(id): LinkVisual
Allows the user to associate any identifier
| Name | Type | Description |
|---|---|---|
id | string | number | object id |
this
▸ setLineStyle(lineStyle, merge?): LinkVisual
Sets line style
| Name | Type | Description |
|---|---|---|
lineStyle | Type | line style or options |
Optional merge | boolean | true if you want to merge lineStyle with existing attribute, false by default |
this
▸ setLinkPoints(ignored): LinkVisual
LinkVisual does not let setting alternative linking points, only begin and end
| Name | Type | Description |
|---|---|---|
ignored | Point[] | ignored parameter |
this
▸ setLinkType(value): LinkVisual
Sets link type
| Name | Type | Description |
|---|---|---|
value | LinkType | desired link type |
this
▸ setLinkingMode(mode): LinkVisual
Sets linking mode. This mode defines logic of the link as well as its appearance.
| Name | Type | Description |
|---|---|---|
mode | LinkingMode | a new linking mode to set |
this
▸ setLocalTransform(localTransform, force?): LinkVisual
Sets local transformation to be used to transform from local to parent coordinate
| Name | Type | Description |
|---|---|---|
localTransform | Transformation | local transformation for this node |
Optional force | boolean | boolean flag to force update event if transformations are equal, false by default |
this
▸ setMarginsStyle(margins, merge?): LinkVisual
Sets margins style
| Name | Type | Description |
|---|---|---|
margins | Type<string | number> | margins style |
Optional merge | boolean | true if you want to merge marginsStyle with existing attribute, false by default |
this
▸ setName(name): LinkVisual
Sets name of the node
| Name | Type | Description |
|---|---|---|
name | string | The node name |
this
▸ setNotification(notify, force?): LinkVisual
set notification state
| Name | Type | Description |
|---|---|---|
notify | boolean | flag set to invalidate parent or not |
Optional force | boolean | true if parent should be invalidated immediately |
this
▸ setOpacity(opacity, blendMode?): LinkVisual
Sets node opacity
| Name | Type | Description |
|---|---|---|
opacity | number | node opacity from 0 to 1 |
Optional blendMode | BlendMode | opacity blend mode. If it is normal, opacity will be replaced. |
this
▸ setOptimization(needOptimization?): LinkVisual
Turns on/off optimization for line
| Name | Type | Description |
|---|---|---|
Optional needOptimization | boolean | Is optimization for line on |
this
▸ setOptimizationType(optimizationType): LinkVisual
Sets optimization type
| Name | Type | Description |
|---|---|---|
optimizationType | OptimizationType | optimization type which used with current line |
this
▸ setPoint(index, point): LinkVisual
Sets new coordinates for the polyline point at specified index
| Name | Type | Description |
|---|---|---|
index | number | the point index |
point | Point | Point |
this
▸ setPoint(index, x, y): LinkVisual
Sets new coordinates for the polyline point at specified index
| Name | Type | Description |
|---|---|---|
index | number | the point index |
x | number | point x-coordinate |
y | number | point y-coordinate |
this
▸ setProperties(properties?): LinkVisual
Sets all the properties pertaining to this object
| Name | Type | Description |
|---|---|---|
Optional properties | Options | object containing the properties to set |
▸ setProperty(name, value): LinkVisual
Sets dynamic property by name
| Name | Type | Description |
|---|---|---|
name | string | property name |
value | any | property value |
this
▸ setRenderingFilter(filter): LinkVisual
Sets filter to be applied before rendering and picking
| Name | Type | Description |
|---|---|---|
filter | IFilter | filter to set |
this
▸ setResponsiveStyle(style): LinkVisual
Sets responsive style.
| Name | Type | Description |
|---|---|---|
style | Options | ResponsiveStyle | responsive style |
this
▸ setScaleScrollStrategy(strategy?): LinkVisual
Sets scale scroll strategy
| Name | Type | Description |
|---|---|---|
Optional strategy | Delegate | scale scroll strategy |
this
Polyline.setScaleScrollStrategy
▸ setSelectable(selectable): LinkVisual
Allows to select node. If node is not selectable then child node is not selectable.
| Name | Type | Description |
|---|---|---|
selectable | boolean | flag to allow node selection |
this
▸ setSilent(bool): LinkVisual
Set silent mode
| Name | Type | Description |
|---|---|---|
bool | boolean | flag to enable silent mode |
this
▸ setTag(tag): LinkVisual
Allows the user to associate any arbitrary object with the node.
| Name | Type | Description |
|---|---|---|
tag | any | The object to be associated with the node. |
this
▸ setText(textOptions): LinkVisual
Sets text and its options
| Name | Type | Description |
|---|---|---|
textOptions | Text | text and/or its options |
this
▸ setTubingWidth(value): LinkVisual
Ses tubing width for schematic/skin mode
| Name | Type | Description |
|---|---|---|
value | number | a width for the "tubing" |
this
▸ setUrl(value): LinkVisual
Sets url for icon
| Name | Type | Description |
|---|---|---|
value | string | url for icon |
this
▸ setVisible(value): LinkVisual
Sets visibility of the node. Send event Events.VisibilityChanged
| Name | Type | Description |
|---|---|---|
value | boolean | flag specifying visibility of the node |
this
▸ setZIndex(value): LinkVisual
Sets z-index for node (set null for default)
| Name | Type | Description |
|---|---|---|
value | number | index determining node z-position |
this
▸ shear(shx, shy): LinkVisual
Shear this node's bounds
| Name | Type | Description |
|---|---|---|
shx | number | x-axis shear |
shy | number | y-axis shear |
this
▸ toString(): string
Returns a string representation of this object (generally the classname)
string
A string representation
▸ translate(tx, ty): LinkVisual
Translate bounds
| Name | Type | Description |
|---|---|---|
tx | number | x translation |
ty | number | y translation |
this
▸ unregisterAnimationStyle(root): void
Unregister animation style.
| Name | Type | Description |
|---|---|---|
root | Node | root node for node |
void
Polyline.unregisterAnimationStyle
▸ updateBounds(): LinkVisual
Update shape bounds
▸ updateLinks(force?): void
Performs links update, using previously set up connections. It takes connected shapes and updates self begin and end points depending on connected points
| Name | Type | Description |
|---|---|---|
Optional force | boolean | force |
void
▸ updateSceneTransformation(): LinkVisual
Update scene transformation
this
Polyline.updateSceneTransformation
▸ updateState(regions?, changes?): LinkVisual
Update state. These methods reset node state and update state for children. this method is useful to refresh a scene graph
| Name | Type | Description |
|---|---|---|
Optional regions | Rect[] | optional array to return invalid rectangles in the parent coordinates |
Optional changes | StateChanges | optional parameter to specify a reason of changes |
this
▸ Protected updateTimeStamp(): LinkVisual
Update time stamp to indicate that Node or Children has been changed.
this
▸ Static enableSceneGraphNotification(enabled): void
Enable / disable all notifications
| Name | Type | Description |
|---|---|---|
enabled | boolean | sets if this object sends notifications |
void
Polyline.enableSceneGraphNotification
▸ Static findParent<T>(node, classType, filter?): InstanceType<T>
Find root of the node with specified type
| Name | Type |
|---|---|
T | extends Constructor<any> |
| Name | Type | Description |
|---|---|---|
node | Node | node to start search |
classType | T | type of the class to search for |
Optional filter | (node: Node) => boolean | additional filter to apply |
InstanceType<T>
▸ Static findParent(node, classType, filter?): Node
Find root of the node with specified type
| Name | Type | Description |
|---|---|---|
node | Node | node to start search |
classType | string | interface name to search for |
Optional filter | (node: Node) => boolean | additional filter to apply |
▸ Static getClassName(): string
string
▸ Static intersectsBounds(bounds, localTransformation, parentInvalidArea, expand?): boolean
Check collision of the shape bounds with parent invalid area
| Name | Type | Description |
|---|---|---|
bounds | Rect | shape bounds |
localTransformation | Transformation | local transformation of the bounds |
parentInvalidArea | Rect | invalid parent area |
Optional expand | Dimension | optional expand the bounds in model coordinate |
boolean
true if bounds intersect the invalid area
▸ Static isSceneGraphNotificationEnabled(): boolean
Return status of the global notification for all nodes.
boolean