API / geotoolkit / schematics / scene / ExternalGeometryFlippedComponentNode / ExternalGeometryFlippedComponentNode
scene.ExternalGeometryFlippedComponentNode.ExternalGeometryFlippedComponentNode
External geometry-based reusable component node extension.
↳
ExternalGeometryFlippedComponentNode
Methods
Css Properties
| Name | Type | Description |
|---|---|---|
automodellimitsmode | boolean | Auto model limits mode |
bounds | Rect | Define position of the group in the parent |
bounds-height | number | Height |
bounds-readonly | boolean | Readonly |
bounds-width | number | Width |
bounds-x | number | Left |
bounds-y | number | Top |
clipping | boolean | Enable clipping, this does not consider the clipstyle, it is related to bounds-clipping |
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 | GraphicsPath | Clipping style |
contentorientation | Orientation | Content orientation |
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 |
description | string | Element description |
externalgeometry | Group | Or externalGeometry geometry to define the component |
externalgeometry-automodellimitsmode | boolean | Auto model limits mode |
externalgeometry-bounds | Rect | Define position of the group in the parent |
externalgeometry-clipping | boolean | Enable clipping, this does not consider the clipstyle, it is related to bounds-clipping |
externalgeometry-clipstyle | ClipStyle | Clipping style |
externalgeometry-clipstyle | GraphicsPath | Clipping style |
externalgeometry-contentorientation | Orientation | Content orientation |
externalgeometry-cssclass | string | The css class name of this node |
externalgeometry-csscursor | string | CSS cursor associated with node |
externalgeometry-cssstyle | string | CSS style to be applied to inserted elements |
externalgeometry-fillstyle | string | Fill style |
externalgeometry-fillstyle | FillStyle | Fill style |
externalgeometry-fillstyle-color | string | Color in CSS form |
externalgeometry-fillstyle-evenoddmode | boolean | Even-odd fill mode |
externalgeometry-fillstyle-fillpattern | Pattern | Pattern |
externalgeometry-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 |
externalgeometry-fillstyle-fillpattern-patternname | string | Name of this pattern for indexing |
externalgeometry-fillstyle-fillpattern-scalable | boolean | Flag that sets scalability of the pattern coordinates, or relative to the shape it is filling (It is not supported) |
externalgeometry-fillstyle-foreground | string | Foreground color |
externalgeometry-fillstyle-pattern | Pattern | Pattern |
externalgeometry-horizontalflip | boolean | Horizontal axis goes from right to left |
externalgeometry-id | string | number | Id of the node, its a unique identifier |
externalgeometry-infinity | boolean | Mode to render outside the model limits |
externalgeometry-layoutstyle | LayoutStyle | Layout style to be used for parent layout |
externalgeometry-layoutstyle-constraint | SizeConstraint | Layout constrains |
externalgeometry-layoutstyle-flexgrow | number | Number specifying how much the item will grow relative to the rest of the items inside the same container |
externalgeometry-layoutstyle-flexshrink | number | Number specifying how much the item will shrink relative to the rest of the items inside the same container |
externalgeometry-layoutstyle-float | string | Float position |
externalgeometry-layoutstyle-position | string | Layout position |
externalgeometry-layoutstyle-size | number | string | Layout size |
externalgeometry-linestyle | string | Line style |
externalgeometry-linestyle | LineStyle | Line style |
externalgeometry-linestyle-color | string | Color in CSS form |
externalgeometry-linestyle-fill | string | Optional fill style to be used to fill lines generated with this style |
externalgeometry-linestyle-fill | FillStyle | Optional fill style to be used to fill lines generated with this style |
externalgeometry-linestyle-linecap | CapStyle | The line cap style |
externalgeometry-linestyle-linedashoffset | number | Line dash offset of dashed line |
externalgeometry-linestyle-linejoin | JoinStyle | The line join style |
externalgeometry-linestyle-pixelsnapmode | boolean | Pixel Snap Mode, default( |
externalgeometry-linestyle-scalable | boolean | True if width should depend on transformation |
externalgeometry-linestyle-unit | string | Optional unit for the width |
externalgeometry-linestyle-width | number | string | The line thickness |
externalgeometry-localtransform | Transformation | Local transformation |
externalgeometry-localtransform-dx | number | X axis translation |
externalgeometry-localtransform-dy | number | Y axis translation |
externalgeometry-localtransform-xx | number | X scale |
externalgeometry-localtransform-xy | number | Xy skew |
externalgeometry-localtransform-yx | number | Yx skew |
externalgeometry-localtransform-yy | number | Y scale |
externalgeometry-margins | number | string | It has properties for specifying the margins for each side |
externalgeometry-modellimits | Rect | Define inner model coordinates of the group |
externalgeometry-name | string | Name of the node. It is often used for debugging purposes or to simplify queries |
externalgeometry-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 |
externalgeometry-opacityblendmode | BlendMode | Node opacity mode to blend it |
externalgeometry-padding | number | string | It has properties for specifying the padding for each side |
externalgeometry-pickingchildren | boolean | Enable picking children |
externalgeometry-scalescrollstrategy | ScaleScrollStrategy | Scale scroll strategy |
externalgeometry-scalescrollstrategy-enabled | boolean | Enable flag |
externalgeometry-selectable | boolean | Selectable node, a boolean to determine if selection should consider this node |
externalgeometry-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 |
externalgeometry-transform | string | Additional CSS transformation applied to node or 'none' |
externalgeometry-transform | Transformation | Additional CSS transformation applied to node or 'none' |
externalgeometry-verticalflip | boolean | Vertical axis goes from bottom to top |
externalgeometry-viewcache | boolean | View cache to cache child nodes |
externalgeometry-visible | boolean | Visibility of the node, a boolean to determine if the node should be rendered or not |
externalgeometry-z-index | number | Define node z-index |
fillstyle | string | Fill style |
fillstyle | FillStyle | Fill style |
horizontalflip | boolean | Horizontal axis goes from right to left |
id | string | number | Id of the node, its a unique identifier |
infinity | boolean | Mode to render outside the model limits |
isleft | boolean | IsLeft is "left" part of shape flag |
layoutstyle | LayoutStyle | Layout style to be used for parent layout |
linestyle | string | Line style |
linestyle | LineStyle | Line style |
localtransform | Transformation | Local transformation |
margins | number | string | It has properties for specifying the margins for each side |
modellimits | Rect | Define inner model coordinates of the group |
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 |
padding | number | string | It has properties for specifying the padding for each side |
parentproxy | ComponentNode | Parent proxy |
parentproxy-automodellimitsmode | boolean | Auto model limits mode |
parentproxy-bounds | Rect | Define position of the group in the parent |
parentproxy-clipping | boolean | Enable clipping, this does not consider the clipstyle, it is related to bounds-clipping |
parentproxy-clipstyle | ClipStyle | Clipping style |
parentproxy-clipstyle | GraphicsPath | Clipping style |
parentproxy-contentorientation | Orientation | Content orientation |
parentproxy-cssclass | string | The css class name of this node |
parentproxy-csscursor | string | CSS cursor associated with node |
parentproxy-cssstyle | string | CSS style to be applied to inserted elements |
parentproxy-description | string | Element description |
parentproxy-fillstyle | string | Fill style |
parentproxy-fillstyle | FillStyle | Fill style |
parentproxy-horizontalflip | boolean | Horizontal axis goes from right to left |
parentproxy-id | string | number | Id of the node, its a unique identifier |
parentproxy-infinity | boolean | Mode to render outside the model limits |
parentproxy-layoutstyle | LayoutStyle | Layout style to be used for parent layout |
parentproxy-linestyle | string | Line style |
parentproxy-linestyle | LineStyle | Line style |
parentproxy-localtransform | Transformation | Local transformation |
parentproxy-margins | number | string | It has properties for specifying the margins for each side |
parentproxy-modellimits | Rect | Define inner model coordinates of the group |
parentproxy-name | string | Name of the node. It is often used for debugging purposes or to simplify queries |
parentproxy-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 |
parentproxy-opacityblendmode | BlendMode | Node opacity mode to blend it |
parentproxy-padding | number | string | It has properties for specifying the padding for each side |
parentproxy-pickingchildren | boolean | Enable picking children |
parentproxy-rectbounds | Rect | Geometry bounds |
parentproxy-scalescrollstrategy | ScaleScrollStrategy | Scale scroll strategy |
parentproxy-selectable | boolean | Selectable node, a boolean to determine if selection should consider this node |
parentproxy-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 |
parentproxy-transform | string | Additional CSS transformation applied to node or 'none' |
parentproxy-transform | Transformation | Additional CSS transformation applied to node or 'none' |
parentproxy-verticalflip | boolean | Vertical axis goes from bottom to top |
parentproxy-viewcache | boolean | View cache to cache child nodes |
parentproxy-visible | boolean | Visibility of the node, a boolean to determine if the node should be rendered or not |
parentproxy-z-index | number | Define node z-index |
pickingchildren | boolean | Enable picking children |
rectbounds | Rect | Geometry bounds |
scalescrollstrategy | ScaleScrollStrategy | Scale scroll strategy |
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' |
verticalflip | boolean | Vertical axis goes from bottom to top |
viewcache | boolean | View cache to cache child nodes |
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 ExternalGeometryFlippedComponentNode(options?, data?)
| Name | Type | Description |
|---|---|---|
Optional options | Group<Node> | Options | or externalGeometry geometry to define the component |
Optional data | Data | JSON-data to define component |
FlippedComponentNode.constructor
Methods
▸ addBaseLayer(baseLayer): ExternalGeometryFlippedComponentNode
Add baseLayer to container
ExternalGeometryFlippedComponentNode
this
FlippedComponentNode.addBaseLayer
▸ addChild(node): ExternalGeometryFlippedComponentNode
Add a child node
ExternalGeometryFlippedComponentNode
this
▸ addCssClass(cssclass): ExternalGeometryFlippedComponentNode
Adds new css class to node
| Name | Type | Description |
|---|---|---|
cssclass | string | string[] | css class name('s) |
ExternalGeometryFlippedComponentNode
this
FlippedComponentNode.addCssClass
▸ addInvalidateHandler(handler): ExternalGeometryFlippedComponentNode
Add invalidate handler
Deprecated
since 4.0, use Node.on instead
| Name | Type | Description |
|---|---|---|
handler | Function | handler to be notified about invalidation |
ExternalGeometryFlippedComponentNode
this
FlippedComponentNode.addInvalidateHandler
▸ addOverlay(overlay): ExternalGeometryFlippedComponentNode
Add overlay to container
ExternalGeometryFlippedComponentNode
this
FlippedComponentNode.addOverlay
▸ adjustPosition(area?, vAlign?, hAlign?): ExternalGeometryFlippedComponentNode
Adjust position of node to specified area
| Name | Type | Description |
|---|---|---|
Optional area | Rect | specified area. Default to Parent Model Limits |
Optional vAlign | string | vertical alignment. It can be "top", "bottom", "center". Defaults to "top". |
Optional hAlign | string | horizontal alignment It can be "left", "right", "center". Defaults to "left". |
ExternalGeometryFlippedComponentNode
this
FlippedComponentNode.adjustPosition
▸ Protected applyOpacity(context): ExternalGeometryFlippedComponentNode
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 |
ExternalGeometryFlippedComponentNode
this
FlippedComponentNode.applyOpacity
▸ Protected applyResponsiveStyle(): void
Apply a responsive style rules it is exists
void
FlippedComponentNode.applyResponsiveStyle
▸ changeBaseLayerOrder(overlay, order, anchor?): ExternalGeometryFlippedComponentNode
Changes the z-order of the baseLayer.
| Name | Type | Description |
|---|---|---|
overlay | Node | |
order | NodeOrder | position to be added |
Optional anchor | Node | anchor node to specify changeOrder with respect to this node |
ExternalGeometryFlippedComponentNode
this
FlippedComponentNode.changeBaseLayerOrder
▸ changeChildOrder(node, order, anchor?): ExternalGeometryFlippedComponentNode
changes the z-order of the nodes being rendered.
| Name | Type | Description |
|---|---|---|
node | Node | any child added in the Composite node |
order | NodeOrder | position to be added |
Optional anchor | Node | anchor node to specify changeOrder with respect to this node |
ExternalGeometryFlippedComponentNode
this
FlippedComponentNode.changeChildOrder
▸ changeOverlayOrder(overlay, order, anchor?): ExternalGeometryFlippedComponentNode
Changes the z-order of the overlay.
| Name | Type | Description |
|---|---|---|
overlay | Node | child overlay |
order | NodeOrder | position to be added |
Optional anchor | Node | anchor node to specify changeOrder with respect to this node |
ExternalGeometryFlippedComponentNode
this
FlippedComponentNode.changeOverlayOrder
▸ checkCollision(context): boolean
Checks collision
| Name | Type | Description |
|---|---|---|
context | RenderingContext | Rendering Context |
boolean
true if object is inside of renderable area
FlippedComponentNode.checkCollision
▸ clearBaseLayers(disposeBaseLayers?): ExternalGeometryFlippedComponentNode
Remove all child baseLayers from group
| Name | Type | Description |
|---|---|---|
Optional disposeBaseLayers | boolean | automatically dispose baseLayers. If it is true then method dispose is called for each baseLayer, false by default |
ExternalGeometryFlippedComponentNode
this
FlippedComponentNode.clearBaseLayers
▸ clearCache(): ExternalGeometryFlippedComponentNode
Clear cache
ExternalGeometryFlippedComponentNode
this
FlippedComponentNode.clearCache
▸ clearChildren(disposeChildren?): ExternalGeometryFlippedComponentNode
Remove all child nodes from this composite group
| Name | Type | Description |
|---|---|---|
Optional disposeChildren | boolean | automatically dispose children. If it is true then method dispose is called for each child. |
ExternalGeometryFlippedComponentNode
this
FlippedComponentNode.clearChildren
▸ clearOverlays(disposeOverlays?): ExternalGeometryFlippedComponentNode
Remove all child overlays from group
| Name | Type | Description |
|---|---|---|
Optional disposeOverlays | boolean | automatically dispose overlays. If it is true then method dispose is called for each overlay, false by default |
ExternalGeometryFlippedComponentNode
this
FlippedComponentNode.clearOverlays
All subclasses should override copyConstructor or provide custom implementation for this method
clone
▸ connectStyle(style, type, callback): ExternalGeometryFlippedComponentNode
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 |
ExternalGeometryFlippedComponentNode
this
FlippedComponentNode.connectStyle
▸ Protected copyConstructor(src, deepCopy?): ExternalGeometryFlippedComponentNode
Copy constructor function.
Function used as part of the cloning mechanism.
Implementations should copy the given instance state to this instance.
ExternalGeometryFlippedComponentNode
this
FlippedComponentNode.copyConstructor
▸ disconnectStyle(style, type, callback): ExternalGeometryFlippedComponentNode
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 |
ExternalGeometryFlippedComponentNode
this
FlippedComponentNode.disconnectStyle
▸ dispose(): void
Dispose node. Clear all listeners and disconnect style to avoid memory leaks
void
▸ Protected drawBorder(localContext, bounds?): ExternalGeometryFlippedComponentNode
Draws a rectangle at the bounding box (in parent coordinates)
| Name | Type | Description |
|---|---|---|
localContext | RenderingContext | The local rendering context |
Optional bounds | Rect | group bounds |
ExternalGeometryFlippedComponentNode
this
FlippedComponentNode.drawBorder
▸ enableClipping(doClip): ExternalGeometryFlippedComponentNode
Enables or disables clipping of this node. If enabled, shapes will not be rendered outside of its bounds.
| Name | Type | Description |
|---|---|---|
doClip | boolean | enable clipping on this node |
ExternalGeometryFlippedComponentNode
this
FlippedComponentNode.enableClipping
▸ enableEventPropagation(enable): ExternalGeometryFlippedComponentNode
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 |
ExternalGeometryFlippedComponentNode
this
FlippedComponentNode.enableEventPropagation
▸ enablePickingChildren(enable): ExternalGeometryFlippedComponentNode
Enables or disables picking children
| Name | Type | Description |
|---|---|---|
enable | boolean | enable picking children |
ExternalGeometryFlippedComponentNode
this
FlippedComponentNode.enablePickingChildren
▸ enumerateNodes(callback, target?): void
Executes a provided function once for each child node
| Name | Type | Description |
|---|---|---|
callback | Callback<Node> | provided function |
Optional target | QueryBuilder<any> | target to pass to callback as a second parameter |
void
FlippedComponentNode.enumerateNodes
▸ execute(delegate): ExternalGeometryFlippedComponentNode
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: ExternalGeometryFlippedComponentNode) => void | Function to execute |
ExternalGeometryFlippedComponentNode
The result if any or this
▸ execute<T>(delegate): T
| Name |
|---|
T |
| Name | Type |
|---|---|
delegate | (this: ExternalGeometryFlippedComponentNode) => 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
FlippedComponentNode.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
FlippedComponentNode.getAutoModelLimitsMode
▸ getAutoModelLimitsStrategy(): ModelLimitsStrategy
Get Model Limits Logics Strategy
strategy
FlippedComponentNode.getAutoModelLimitsStrategy
▸ getBaseLayer(index): Node
Return baseLayer at specified index
| Name | Type | Description |
|---|---|---|
index | number | index at which to get the baseLayer for |
track
FlippedComponentNode.getBaseLayer
▸ getBaseLayers<S>(predicate, modify?): Iterator<Node>
Return iterator by baseLayers nodes
| Name | Type |
|---|---|
S | extends Node<S> |
| Name | Type | Description |
|---|---|---|
predicate | (value: Node) => value is S | a filter function |
Optional modify | boolean | An option to specify if the iterator supports adding/removing items from the collection. false by default. |
FlippedComponentNode.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);| Name | Type | Description |
|---|---|---|
Optional filter | (node: Node) => boolean | A filter function. Returns all overlays if null. |
Optional modify | boolean | An option to specify if the iterator supports adding/removing items from the collection. false by default. |
An iterator for child overlays.
FlippedComponentNode.getBaseLayers
▸ getBaseLayersCount(): number
Returns amount of baseLayers
number
FlippedComponentNode.getBaseLayersCount
▸ getBounds(): Rect
Get the node bounds.
component node bounds
FlippedComponentNode.getBounds
▸ getCache(): Cache
Return cache strategy to be used to cache children nodes
cache
▸ getChild(i): Node
Return node by index
| Name | Type | Description |
|---|---|---|
i | number | index of the node |
▸ getChildren<S>(predicate, modify?): Iterator<S>
Return iterator by child nodes
| Name | Type |
|---|---|
S | extends Node<S> |
| Name | Type | Description |
|---|---|---|
predicate | (value: Node) => value is S | a filter function |
Optional modify | boolean | An option to specify if the iterator supports adding/removing items from the collection. false by default. |
Iterator<S>
FlippedComponentNode.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);| Name | Type | Description |
|---|---|---|
Optional filter | (node: Node) => boolean | A filter function. Returns all nodes if null. |
Optional modify | boolean | An option to specify if the iterator supports adding/removing items from the collection. false by default. |
An iterator for child nodes.
FlippedComponentNode.getChildren
▸ getChildrenCount(): number
Return number of child nodes
number
FlippedComponentNode.getChildrenCount
▸ getClassName(): string
string
FlippedComponentNode.getClassName
▸ getClipStyle(): ClipStyle
Gets the current clipping style
clipping style
FlippedComponentNode.getClipStyle
▸ getContentOrientation(): Orientation
Return content orientation
content orientation
FlippedComponentNode.getContentOrientation
▸ getContentsArea(transformation?): Rect
Return area without paddings. Model limits are mapped to content area, where children are layout.
| Name | Type | Description |
|---|---|---|
Optional transformation | Transformation | scene transformation |
FlippedComponentNode.getContentsArea
▸ getContentsTransform(): Transformation
getContentsTransform() retrieves the world transformation of the node.
transformation from model coordinates to bounds of the group
FlippedComponentNode.getContentsTransform
▸ getCss(): CssStyle
Return CSS style
▸ getCssClass(): string
Returns css class name to be used to apply CSS style
string
the css class name
FlippedComponentNode.getCssClass
▸ getCssClasses(): string[]
Gets list of css class names which applied to this node
string[]
FlippedComponentNode.getCssClasses
▸ getCssTransform(): string
Returns CSS transformation
string
FlippedComponentNode.getCssTransform
▸ getData(deepCopy?): Options
Gets component data (see "setData" API for return object elements)
| Name | Type | Description |
|---|---|---|
Optional deepCopy | boolean | a flag indicating if the data should be fully copied before returning or not |
data
▸ getDescription(deepCopy?): Description
Gets description (Convenience method)
| Name | Type | Description |
|---|---|---|
Optional deepCopy | boolean | a flag indicating if the data should be fully copied before returning or not |
description
FlippedComponentNode.getDescription
▸ 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)
FlippedComponentNode.getDesiredHeight
▸ 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)
FlippedComponentNode.getDesiredWidth
▸ getDeviceLimits(): Rect
Return device limits
FlippedComponentNode.getDeviceLimits
▸ getFillStyle(): FillStyle
Return fill style
fillStyle current fill style
FlippedComponentNode.getFillStyle
▸ getGeometryBounds(): Rect
Gets model bounds
FlippedComponentNode.getGeometryBounds
▸ getGeometryData(deepCopy?): Entity
Gets geometric data to build the node on (Convenience method)
| Name | Type | Description |
|---|---|---|
Optional deepCopy | boolean | a flag indicating if the data should be fully copied before returning or not |
geometric data
FlippedComponentNode.getGeometryData
▸ getId(): string | number
Returns the associated identifier of the node
string | number
The node's id
▸ getInfiniteMode(): boolean
Return infinity mode flag
boolean
flag
FlippedComponentNode.getInfiniteMode
▸ Protected getInvalidateMethod(): AttributeCallback<EventDispatcher>
Gets invalidate method
AttributeCallback<EventDispatcher>
method to invalidate this object
FlippedComponentNode.getInvalidateMethod
▸ getLayout(): Layout
Returns layout associated with the group
layout
FlippedComponentNode.getLayout
▸ getLayoutStyle(): LayoutStyle<string | number>
return desired layout style
LayoutStyle<string | number>
FlippedComponentNode.getLayoutStyle
▸ getLineStyle(): LineStyle
Return border style
FlippedComponentNode.getLineStyle
▸ getLocalTransform(): Transformation
Retrieves the transformation of bounds to parent
transform the local transform.
FlippedComponentNode.getLocalTransform
▸ getMarginsStyle(): SpaceStyle<string | number>
Return margins style
SpaceStyle<string | number>
FlippedComponentNode.getMarginsStyle
▸ getModelLimits(): Rect
Gets model limits, the limits of this groups inside space
the current model limits
FlippedComponentNode.getModelLimits
▸ getName(): string
Returns the node name
string
The node name
▸ getOpacity(): number
Returns current node opacity
number
opacity
FlippedComponentNode.getOpacity
▸ getOpacityBlendMode(): BlendMode
Returns current node opacity
opacity blend mode
FlippedComponentNode.getOpacityBlendMode
▸ getOverlay(index): Node
Return overlay at specified index
| Name | Type | Description |
|---|---|---|
index | number | index at which to get the overlay for |
track
FlippedComponentNode.getOverlay
▸ getOverlayAt(index): Node
Return overlay at specified index
Deprecated
since 4.2 use getOverlay instead
| Name | Type | Description |
|---|---|---|
index | number | index at which to get the overlay for |
track
FlippedComponentNode.getOverlayAt
▸ getOverlays<S>(predicate, modify?): Iterator<Node>
Return iterator by overlays nodes
| Name | Type |
|---|---|
S | extends Node<S> |
| Name | Type | Description |
|---|---|---|
predicate | (value: Node) => value is S | a filter function |
Optional modify | boolean | An option to specify if the iterator supports adding/removing items from the collection. false by default. |
FlippedComponentNode.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);| Name | Type | Description |
|---|---|---|
Optional filter | (node: Node) => boolean | A filter function. Returns all overlays if null. |
Optional modify | boolean | An option to specify if the iterator supports adding/removing items from the collection. false by default. |
An iterator for child overlays.
FlippedComponentNode.getOverlays
▸ getOverlaysCount(): number
Returns amount of overlays
number
FlippedComponentNode.getOverlaysCount
▸ getPaddingStyle(): SpaceStyle<string | number>
Return padding style
SpaceStyle<string | number>
padding
FlippedComponentNode.getPaddingStyle
▸ getParent(): Node
Return parent node
parent node
FlippedComponentNode.getParent
▸ getPreferredSize(): Rect
Return preferred size to layout children
FlippedComponentNode.getPreferredSize
▸ getProperties(): OptionsOut
Returns properties
properties
FlippedComponentNode.getProperties
▸ 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
FlippedComponentNode.getProperty
▸ getPropertyKeys(): string[]
Returns known properties keys
string[]
FlippedComponentNode.getPropertyKeys
▸ getRenderingFilter(): IFilter
Return filter to be used for rendering and picking
current filter
FlippedComponentNode.getRenderingFilter
▸ getRenderingHints(deepCopy?): RenderingHintsBase | RenderingHints
Gets rendering hints
| Name | Type | Description |
|---|---|---|
Optional deepCopy | boolean | a flag indicating if the data should be fully copied before returning or not |
RenderingHintsBase | RenderingHints
rendering hints
FlippedComponentNode.getRenderingHints
▸ getResponsiveStyle(): ResponsiveStyle
Return responsive style
FlippedComponentNode.getResponsiveStyle
▸ 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
FlippedComponentNode.getScaleScrollStrategy
▸ getSceneTransform(): Transformation
Returns transformation from node to root scene
a transformation from node to root scene
FlippedComponentNode.getSceneTransform
▸ getSelected(): boolean
Gets selected state
boolean
FlippedComponentNode.getSelected
▸ getStyles(): { classname: string ; fillstyle: FillStyle ; linestyle: LineStyle }[]
Gets graphical styles associated with it.
{ classname: string ; fillstyle: FillStyle ; linestyle: LineStyle }[]
FlippedComponentNode.getStyles
▸ getTag(): any
Returns the object associated with the node by user.
any
The node's user-object
▸ getTemplateBounds(): Rect
Gets template bounds
FlippedComponentNode.getTemplateBounds
▸ getTemplateNode(): Group<Node>
Gets template node.
FlippedComponentNode.getTemplateNode
▸ getVisible(): boolean
Return visibility of the node
boolean
true if node is visible
FlippedComponentNode.getVisible
▸ getVisibleDeviceLimits(ignoreModelLimits?): Rect
Return visible device limits
| Name | Type | Description |
|---|---|---|
Optional ignoreModelLimits | boolean | flag defines whether to ignore ModelLimits or not |
FlippedComponentNode.getVisibleDeviceLimits
▸ getVisibleModelLimits(ignoreModelLimits?): Rect
Return visible model limits
| Name | Type | Description |
|---|---|---|
Optional ignoreModelLimits | boolean | flag defines whether to ignore ModelLimits or not |
FlippedComponentNode.getVisibleModelLimits
▸ getWorldTransform(): Transformation
Retrieves the local transformation of the node which represents multiplication of parent to bounds and contents transformations.
FlippedComponentNode.getWorldTransform
▸ getZIndex(): number
Returns node z-index (null if not set)
number
FlippedComponentNode.getZIndex
▸ hasCssClass(cssClass): boolean
Check if node has specified css class
| Name | Type | Description |
|---|---|---|
cssClass | string | css class name |
boolean
FlippedComponentNode.hasCssClass
▸ 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
FlippedComponentNode.hasEventListener
▸ indexOfBaseLayer(baseLayer): number
Return index of overlay ( index of the specified child or -1 if baseLayer is not found)
| Name | Type | Description |
|---|---|---|
baseLayer | Node | baseLayer to check index |
number
FlippedComponentNode.indexOfBaseLayer
▸ indexOfChild(node): number
Return index of child ( index of the specified child or -1 if node is not found)
| Name | Type | Description |
|---|---|---|
node | Node | node to check index |
number
FlippedComponentNode.indexOfChild
▸ indexOfOverlay(overlay): number
Return index of overlay ( index of the specified child or -1 if overlay is not found)
| Name | Type | Description |
|---|---|---|
overlay | Node | overlay to check index |
number
FlippedComponentNode.indexOfOverlay
▸ insertBaseLayer(index, baseLayer): ExternalGeometryFlippedComponentNode
Insert child baseLayer at specified index
| Name | Type | Description |
|---|---|---|
index | number | specified index |
baseLayer | Node | a baseLayer to add |
ExternalGeometryFlippedComponentNode
this
FlippedComponentNode.insertBaseLayer
▸ insertChild(index, node): ExternalGeometryFlippedComponentNode
Insert child node at specified index
| Name | Type | Description |
|---|---|---|
index | number | specified index |
node | Node | a child node to add |
ExternalGeometryFlippedComponentNode
this
FlippedComponentNode.insertChild
▸ insertOverlay(index, overlay): ExternalGeometryFlippedComponentNode
Insert child overlay at specified index
| Name | Type | Description |
|---|---|---|
index | number | specified index |
overlay | Node | a overlay to add |
ExternalGeometryFlippedComponentNode
this
FlippedComponentNode.insertOverlay
▸ invalidate(bounds?, force?): ExternalGeometryFlippedComponentNode
Invalidate node
| Name | Type | Description |
|---|---|---|
Optional bounds | Rect | optional rectangular area to be invalidated, or force flag if rectangle is empty |
Optional force | boolean | optional boolean parameter that can force invalidation |
ExternalGeometryFlippedComponentNode
this
FlippedComponentNode.invalidate
▸ invalidateLayout(propagate?): ExternalGeometryFlippedComponentNode
Notify that layout is invalidated. Send event Events.LayoutInvalidated
| Name | Type | Description |
|---|---|---|
Optional propagate | boolean | propagate invalidate layout to parent |
ExternalGeometryFlippedComponentNode
this
FlippedComponentNode.invalidateLayout
▸ invalidateParent(bounds?, force?): ExternalGeometryFlippedComponentNode
Invalidate parent area
| Name | Type | Description |
|---|---|---|
Optional bounds | Rect | area to invalidate |
Optional force | boolean | force |
ExternalGeometryFlippedComponentNode
this
FlippedComponentNode.invalidateParent
▸ isClippingEnabled(): boolean
Returns if clipping is enabled or not for this node.
boolean
FlippedComponentNode.isClippingEnabled
▸ isDisposed(): boolean
Returns whether this object has been disposed
boolean
FlippedComponentNode.isDisposed
▸ isEventPropagationEnabled(): boolean
Return true if event propagation is enabled from child to parent
boolean
FlippedComponentNode.isEventPropagationEnabled
▸ isHorizontalFlip(): boolean
Return true if the representation is flipped horizontally
boolean
flip
FlippedComponentNode.isHorizontalFlip
▸ Protected isInitialized(): boolean
Return initialization state
boolean
FlippedComponentNode.isInitialized
▸ isLayoutInvalidated(): boolean
Return true if layout is invalid
boolean
FlippedComponentNode.isLayoutInvalidated
▸ isLeft(): boolean
Gets if the template is "left" one.
boolean
▸ isNotificationEnabled(): boolean
return state of notification
boolean
current notification state
FlippedComponentNode.isNotificationEnabled
▸ isPickingChildrenEnabled(): boolean
Returns if picking children is enabled or not for this node.
boolean
pickingChildren
FlippedComponentNode.isPickingChildrenEnabled
▸ isResourceBased(): boolean
Gets "resource-based" status.
boolean
true
FlippedComponentNode.isResourceBased
▸ isSelectable(): boolean
Returns true if node can be picked/selected.
boolean
The selectable flag
FlippedComponentNode.isSelectable
▸ isSilent(): boolean
Return true if the event dispatcher doesn't notify any events
boolean
▸ isVerticalFlip(): boolean
Return true if the representation is flipped vertically
boolean
flip
FlippedComponentNode.isVerticalFlip
▸ moveTo(area, vAlign?, hAlign?): ExternalGeometryFlippedComponentNode
MoveTo position of node to specified area
| Name | Type | Description |
|---|---|---|
area | Rect | specified area |
Optional vAlign | string | vertical alignment. It can be "top", "bottom", "center". |
Optional hAlign | string | horizontal alignment It can be "left", "right", "center". |
ExternalGeometryFlippedComponentNode
this
▸ notify<E>(type, source, args?): ExternalGeometryFlippedComponentNode
Notify listeners of the Node
| Name | Type |
|---|---|
E | extends string |
| Name | Type | Description |
|---|---|---|
type | E | type of event |
source | Group<Node> | source who called the event |
Optional args | EventMap<Node>[E] | event arguments |
ExternalGeometryFlippedComponentNode
this
▸ Protected notifyRoot(event, source, args?): Node
Notify an even to root node
| Name | Type | Description |
|---|---|---|
event | string | type of event |
source | Node | source who called the event |
Optional args | any | event arguments |
this
FlippedComponentNode.notifyRoot
▸ off<E>(type?, callback?): ExternalGeometryFlippedComponentNode
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: ExternalGeometryFlippedComponentNode, args: EventMap<Node>[E]) => void | function to be called |
ExternalGeometryFlippedComponentNode
this
▸ on<E>(type, callback): ExternalGeometryFlippedComponentNode
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: ExternalGeometryFlippedComponentNode, args: EventMap<Node>[E]) => void | to be called |
ExternalGeometryFlippedComponentNode
this
▸ Protected onBoundsChanged(bounds): ExternalGeometryFlippedComponentNode
Occurs when bounds has been changed
| Name | Type | Description |
|---|---|---|
bounds | Rect | bound of the node in the parent coordinates |
ExternalGeometryFlippedComponentNode
this
FlippedComponentNode.onBoundsChanged
▸ Protected onChildAdded(child): void
This method is called it child or children are added
void
FlippedComponentNode.onChildAdded
▸ Protected onChildRemoved(child): void
This method is called it child or children are removed
| Name | Type | Description |
|---|---|---|
child | Node | removed child |
void
FlippedComponentNode.onChildRemoved
▸ Protected onInitialize(options?): void
OnInitialize - virtual method called from this.initialize(options) before this.setData(options)
| Name | Type | Description |
|---|---|---|
Optional options | Options | Data to set. |
void
FlippedComponentNode.onInitialize
▸ Protected onParentChanged(node): ExternalGeometryFlippedComponentNode
This method is called when parent changes. Do not call it directly.
| Name | Type | Description |
|---|---|---|
node | Node | node to change parent |
ExternalGeometryFlippedComponentNode
this
FlippedComponentNode.onParentChanged
▸ Protected onVisibilityChanged(): void
This method is called if visibility is changed. Send event Events.VisibilityChanged
void
FlippedComponentNode.onVisibilityChanged
▸ Protected postRendering(context, callback?): void
To be called after rendering, used for PDF output
| Name | Type | Description |
|---|---|---|
context | RenderingContext | Rendering Context |
Optional callback | () => void | callback to be called after rendering |
void
FlippedComponentNode.postRendering
▸ Protected preRendering(context, callback?): void
Occurs before child rendering
| Name | Type | Description |
|---|---|---|
context | RenderingContext | Rendering Context |
Optional callback | () => void | callback to be called after rendering of geometry |
void
FlippedComponentNode.preRendering
▸ rebuild(force?, changes?): ExternalGeometryFlippedComponentNode
Rebuild node. This method resets state, cache, and invalidate node.
| Name | Type | Description |
|---|---|---|
Optional force | boolean | optional boolean parameter that can force invalidation |
Optional changes | StateChanges | optional parameter to specify a reason of changes |
ExternalGeometryFlippedComponentNode
this
▸ registerAnimationStyle(root): void
Register animation style.
| Name | Type | Description |
|---|---|---|
root | Node | root node for node |
void
FlippedComponentNode.registerAnimationStyle
▸ removeBaseLayer(baseLayer): ExternalGeometryFlippedComponentNode
Remove child baseLayer
ExternalGeometryFlippedComponentNode
this
FlippedComponentNode.removeBaseLayer
▸ removeChild(node, disposeChildren?): ExternalGeometryFlippedComponentNode
Remove child node
| Name | Type | Description |
|---|---|---|
node | Node | Node[] | node or array of nodes to be removed |
Optional disposeChildren | boolean | automatically dispose children. If it is true then method dispose is called for each child. |
ExternalGeometryFlippedComponentNode
this
FlippedComponentNode.removeChild
▸ removeCssClass(cssclass): ExternalGeometryFlippedComponentNode
Removes css class from node
| Name | Type | Description |
|---|---|---|
cssclass | string | string[] | css class name('s) |
ExternalGeometryFlippedComponentNode
this
FlippedComponentNode.removeCssClass
▸ removeInvalidateHandler(handler): ExternalGeometryFlippedComponentNode
Remove invalidate handler
Deprecated
since 4.0, use Node.off instead
| Name | Type | Description |
|---|---|---|
handler | Function | handler to be notified about invalidation |
ExternalGeometryFlippedComponentNode
this
FlippedComponentNode.removeInvalidateHandler
▸ removeOverlay(overlay): ExternalGeometryFlippedComponentNode
Remove child overlay
ExternalGeometryFlippedComponentNode
this
FlippedComponentNode.removeOverlay
▸ render(context): void
Render group
| Name | Type | Description |
|---|---|---|
context | RenderingContext | context to render group |
void
▸ renderAsync(context, callback): void
Render node in asynchronous mode. This implementation doesn't support cache for now.
| Name | Type | Description |
|---|---|---|
context | RenderingContext | The rendering context to be used to draw the node |
callback | () => void | callback function |
void
FlippedComponentNode.renderAsync
▸ Protected renderBackground(context, bounds): ExternalGeometryFlippedComponentNode
Render background
| Name | Type | Description |
|---|---|---|
context | RenderingContext | context to render background |
bounds | Rect | group bounds |
ExternalGeometryFlippedComponentNode
this
FlippedComponentNode.renderBackground
▸ Protected renderBaseLayers(context): ExternalGeometryFlippedComponentNode
Render baseLayers on bottom of cache. This method does nothing, but can be implemented to render graphics on bottom of cache and between borders
| Name | Type | Description |
|---|---|---|
context | RenderingContext | context to render baseLayers |
ExternalGeometryFlippedComponentNode
this
FlippedComponentNode.renderBaseLayers
▸ Protected renderBaseLayersAsync(context, callback): void
Render baseLayers on bottom of cache in asynchronous mode. This method calls renderBaseLayers
| Name | Type | Description |
|---|---|---|
context | RenderingContext | context to render overlays |
callback | () => void | callback function |
void
FlippedComponentNode.renderBaseLayersAsync
▸ Protected renderChildren(context): void
Render children
| Name | Type | Description |
|---|---|---|
context | RenderingContext | Rendering Context |
void
FlippedComponentNode.renderChildren
▸ Protected renderChildrenAsync(context, callback): void
Render children async
| Name | Type | Description |
|---|---|---|
context | RenderingContext | Rendering Context |
callback | () => void | callback function to be called then all children are rendered |
void
FlippedComponentNode.renderChildrenAsync
▸ Protected renderContent(context): void
render to specified context. This method calls preRendering, renderChildren, postRendering
| Name | Type | Description |
|---|---|---|
context | RenderingContext | Rendering Context |
void
FlippedComponentNode.renderContent
▸ Protected renderContentAsync(context, callback): void
Render children in asynchronous mode
| Name | Type | Description |
|---|---|---|
context | RenderingContext | The rendering context to be used to draw the node |
callback | () => void | callback function to be called then all children are rendered |
void
FlippedComponentNode.renderContentAsync
▸ Protected renderOverlays(context): ExternalGeometryFlippedComponentNode
Render overlays on top of cache. This method does nothing, but can be implemented to render graphics on top of cache and between borders
| Name | Type | Description |
|---|---|---|
context | RenderingContext | context to render overlays |
ExternalGeometryFlippedComponentNode
this
FlippedComponentNode.renderOverlays
▸ Protected renderOverlaysAsync(context, callback): void
Render overlays on top of cache in asynchronous mode. This method calls renderOverlays
| Name | Type | Description |
|---|---|---|
context | RenderingContext | context to render overlays |
callback | () => void | callback function |
void
FlippedComponentNode.renderOverlaysAsync
▸ resumeUpdate(rebuild?, changes?): ExternalGeometryFlippedComponentNode
Resume auto update
| Name | Type | Description |
|---|---|---|
Optional rebuild | boolean | force rebuild |
Optional changes | StateChanges | optional parameter to specify a reason of changes |
ExternalGeometryFlippedComponentNode
this
FlippedComponentNode.resumeUpdate
▸ rotate(theta, x, y): ExternalGeometryFlippedComponentNode
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 |
ExternalGeometryFlippedComponentNode
this
▸ scale(xx, yy): ExternalGeometryFlippedComponentNode
Scale node
| Name | Type | Description |
|---|---|---|
xx | number | x scale factor |
yy | number | y scale factor |
ExternalGeometryFlippedComponentNode
this
▸ setAnimationStyle(animationStyle): ExternalGeometryFlippedComponentNode
Sets animation style
| Name | Type | Description |
|---|---|---|
animationStyle | Type | animation style |
ExternalGeometryFlippedComponentNode
FlippedComponentNode.setAnimationStyle
▸ setAutoModelLimitsMode(mode): ExternalGeometryFlippedComponentNode
Set 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. This is convenient method. It creates AutoModelLimitsStrategy
| Name | Type | Description |
|---|---|---|
mode | boolean | Model Limits Logics to be used |
ExternalGeometryFlippedComponentNode
this
FlippedComponentNode.setAutoModelLimitsMode
▸ setAutoModelLimitsStrategy(strategy): ExternalGeometryFlippedComponentNode
Set Model Limits Logics Strategy
| Name | Type | Description |
|---|---|---|
strategy | ModelLimitsStrategy | Model Limits logic strategy to use |
ExternalGeometryFlippedComponentNode
this
FlippedComponentNode.setAutoModelLimitsStrategy
▸ setBounds(bounds): ExternalGeometryFlippedComponentNode
Sets bounds of the node in the parent coordinates
| Name | Type | Description |
|---|---|---|
bounds | Type | bound of the node in the parent coordinates |
ExternalGeometryFlippedComponentNode
this
FlippedComponentNode.setBounds
▸ setCache(cache, rebuild?): ExternalGeometryFlippedComponentNode
Sets cache to be used to cache
| Name | Type | Description |
|---|---|---|
cache | Cache | cache to be used |
Optional rebuild | boolean | rebuild cache |
ExternalGeometryFlippedComponentNode
this
▸ setChild(index, node): ExternalGeometryFlippedComponentNode
Replace child node by index
| Name | Type | Description |
|---|---|---|
index | number | index of the node |
node | Node | node |
ExternalGeometryFlippedComponentNode
this
▸ setClipStyle(style): ExternalGeometryFlippedComponentNode
Sets a new clipping style
| Name | Type | Description |
|---|---|---|
style | GraphicsPath | ClipStyle | Options | a new clipping style |
ExternalGeometryFlippedComponentNode
this
FlippedComponentNode.setClipStyle
▸ setContentOrientation(orientation): ExternalGeometryFlippedComponentNode
Set content orientation
| Name | Type | Description |
|---|---|---|
orientation | Orientation | content orientation |
ExternalGeometryFlippedComponentNode
this
FlippedComponentNode.setContentOrientation
▸ setCss(style, merge?): ExternalGeometryFlippedComponentNode
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 |
ExternalGeometryFlippedComponentNode
this
▸ setCssClass(name): ExternalGeometryFlippedComponentNode
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 |
ExternalGeometryFlippedComponentNode
this
FlippedComponentNode.setCssClass
▸ setCssTransform(transform): ExternalGeometryFlippedComponentNode
Set CSS transformation
| Name | Type | Description |
|---|---|---|
transform | string | Transformation | transformation css transformation instruction or Transformation instance |
ExternalGeometryFlippedComponentNode
this
FlippedComponentNode.setCssTransform
▸ setData(data, deepCopy?): ExternalGeometryFlippedComponentNode
Sets component data
| Name | Type | Description |
|---|---|---|
data | Options | data to set |
Optional deepCopy | boolean | deep copy flag |
ExternalGeometryFlippedComponentNode
this
▸ setDescription(description, deepCopy?): ExternalGeometryFlippedComponentNode
Sets description (Convenience method)
| Name | Type | Description |
|---|---|---|
description | Description | element description |
Optional deepCopy | boolean | a flag indicating if the data should be fully copied before setting or not |
ExternalGeometryFlippedComponentNode
this
FlippedComponentNode.setDescription
▸ setDesiredHeight(value, silent?): ExternalGeometryFlippedComponentNode
Sets desired height of the group as a layoutable object
| Name | Type | Description |
|---|---|---|
value | string | number | desired height to set, use 'auto' for automatic desired height |
Optional silent | boolean | silent setting |
ExternalGeometryFlippedComponentNode
this
FlippedComponentNode.setDesiredHeight
▸ setDesiredWidth(value, silent?): ExternalGeometryFlippedComponentNode
Sets desired width of the group as a layoutable object
| Name | Type | Description |
|---|---|---|
value | string | number | desired width to set |
Optional silent | boolean | silent setting |
ExternalGeometryFlippedComponentNode
this
FlippedComponentNode.setDesiredWidth
▸ setFillStyle(fillStyle, merge?): ExternalGeometryFlippedComponentNode
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 |
ExternalGeometryFlippedComponentNode
this
FlippedComponentNode.setFillStyle
▸ Protected setGeometryBounds(rectBounds): ExternalGeometryFlippedComponentNode
Sets model bounds
| Name | Type | Description |
|---|---|---|
rectBounds | Rect | geometry bounds to set |
ExternalGeometryFlippedComponentNode
FlippedComponentNode.setGeometryBounds
▸ setGeometryData(geometryData): ExternalGeometryFlippedComponentNode
Sets geometry
| Name | Type | Description |
|---|---|---|
geometryData | Entity | Geometry data for the node |
ExternalGeometryFlippedComponentNode
FlippedComponentNode.setGeometryData
▸ setHorizontalFlip(enable): ExternalGeometryFlippedComponentNode
Set horizontal flip of the representation
| Name | Type | Description |
|---|---|---|
enable | boolean | enable flip |
ExternalGeometryFlippedComponentNode
this
FlippedComponentNode.setHorizontalFlip
▸ setId(id): ExternalGeometryFlippedComponentNode
Allows the user to associate any identifier
| Name | Type | Description |
|---|---|---|
id | string | number | object id |
ExternalGeometryFlippedComponentNode
this
▸ setInfiniteMode(infinityMode): ExternalGeometryFlippedComponentNode
Set infinity mode flag to draw composite without collision check
| Name | Type | Description |
|---|---|---|
infinityMode | boolean | infinity mode flag |
ExternalGeometryFlippedComponentNode
this
FlippedComponentNode.setInfiniteMode
▸ setLayout(layout): ExternalGeometryFlippedComponentNode
Associate layout with a group.
| Name | Type | Description |
|---|---|---|
layout | Record<string, any> | Layout | layout instance to be set or layout properties to apply |
ExternalGeometryFlippedComponentNode
this
FlippedComponentNode.setLayout
▸ Protected setLayoutInvalidated(invalidated): void
Set invalidation status
| Name | Type | Description |
|---|---|---|
invalidated | boolean | invalidated layout |
void
FlippedComponentNode.setLayoutInvalidated
▸ setLayoutStyle(layoutStyle, silent?, merge?): ExternalGeometryFlippedComponentNode
specify desired layout style
| Name | Type | Description |
|---|---|---|
layoutStyle | LayoutStyle<string | number> | Options<string | number> | desired layout style |
Optional silent | boolean | silent setting |
Optional merge | boolean | true if you want to merge layoutStyle with existing attribute, false by default |
ExternalGeometryFlippedComponentNode
this
FlippedComponentNode.setLayoutStyle
▸ setLeft(left): ExternalGeometryFlippedComponentNode
Sets the template's "left" flag
| Name | Type | Description |
|---|---|---|
left | boolean | left flag |
ExternalGeometryFlippedComponentNode
▸ setLineStyle(lineStyle, merge?): ExternalGeometryFlippedComponentNode
Sets border color Returns this
| 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 |
ExternalGeometryFlippedComponentNode
this
FlippedComponentNode.setLineStyle
▸ setLocalTransform(localTransform, force?): ExternalGeometryFlippedComponentNode
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 |
ExternalGeometryFlippedComponentNode
this
FlippedComponentNode.setLocalTransform
▸ setMarginsStyle(margins, merge?): ExternalGeometryFlippedComponentNode
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 |
ExternalGeometryFlippedComponentNode
this
FlippedComponentNode.setMarginsStyle
▸ setModelLimits(limits): ExternalGeometryFlippedComponentNode
Sets inner model limits
| Name | Type | Description |
|---|---|---|
limits | Type | inner limits |
ExternalGeometryFlippedComponentNode
this
FlippedComponentNode.setModelLimits
▸ setName(name): ExternalGeometryFlippedComponentNode
Sets name of the node
| Name | Type | Description |
|---|---|---|
name | string | The node name |
ExternalGeometryFlippedComponentNode
this
▸ setNotification(notify, force?): ExternalGeometryFlippedComponentNode
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 |
ExternalGeometryFlippedComponentNode
this
FlippedComponentNode.setNotification
▸ setOpacity(opacity, blendMode?): ExternalGeometryFlippedComponentNode
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. |
ExternalGeometryFlippedComponentNode
this
FlippedComponentNode.setOpacity
▸ setPaddingStyle(paddingStyle, merge?): ExternalGeometryFlippedComponentNode
Sets padding style
| Name | Type | Description |
|---|---|---|
paddingStyle | Type<string | number> | padding style |
Optional merge | boolean | true if you want to merge paddingStyle with existing attribute, false by default |
ExternalGeometryFlippedComponentNode
this
FlippedComponentNode.setPaddingStyle
▸ setProperties(properties?): ExternalGeometryFlippedComponentNode
Sets properties
| Name | Type | Description |
|---|---|---|
Optional properties | Options | properties |
ExternalGeometryFlippedComponentNode
this
FlippedComponentNode.setProperties
▸ setProperty(name, value): ExternalGeometryFlippedComponentNode
Sets dynamic property by name
| Name | Type | Description |
|---|---|---|
name | string | property name |
value | any | property value |
ExternalGeometryFlippedComponentNode
this
FlippedComponentNode.setProperty
▸ setRenderingFilter(filter): ExternalGeometryFlippedComponentNode
Sets filter to be applied before rendering and picking
| Name | Type | Description |
|---|---|---|
filter | IFilter | filter to set |
ExternalGeometryFlippedComponentNode
this
FlippedComponentNode.setRenderingFilter
▸ setRenderingHints(hints, deepCopy?): ExternalGeometryFlippedComponentNode
Sets rendering hints.
When overriding the method FlippedComponentNode's inheritants must call for "FlippedComponentNode.prototype.setRenderingHints" AT THE VERY END of the method's body
| Name | Type | Description |
|---|---|---|
hints | RenderingHintsBase | RenderingHints | rendering hints |
Optional deepCopy | boolean | a flag indicating if the data should be fully copied before returning or not |
ExternalGeometryFlippedComponentNode
this
FlippedComponentNode.setRenderingHints
▸ setResourceBased(resourceBased): ExternalGeometryFlippedComponentNode
Sets "resource-based" status
| Name | Type | Description |
|---|---|---|
resourceBased | boolean | "resource-based" status |
ExternalGeometryFlippedComponentNode
this
▸ setResponsiveStyle(style): ExternalGeometryFlippedComponentNode
Sets responsive style.
| Name | Type | Description |
|---|---|---|
style | Options | ResponsiveStyle | responsive style |
ExternalGeometryFlippedComponentNode
this
FlippedComponentNode.setResponsiveStyle
▸ setScaleScrollStrategy(strategy?): ExternalGeometryFlippedComponentNode
Sets scale scroll strategy
| Name | Type | Description |
|---|---|---|
Optional strategy | Delegate | scale scroll strategy |
ExternalGeometryFlippedComponentNode
this
FlippedComponentNode.setScaleScrollStrategy
▸ setSelectable(selectable): ExternalGeometryFlippedComponentNode
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 |
ExternalGeometryFlippedComponentNode
this
FlippedComponentNode.setSelectable
▸ setSelected(selected): ExternalGeometryFlippedComponentNode
Sets selected state
| Name | Type | Description |
|---|---|---|
selected | boolean | selected state |
ExternalGeometryFlippedComponentNode
this
FlippedComponentNode.setSelected
▸ setSilent(bool): ExternalGeometryFlippedComponentNode
Set silent mode
| Name | Type | Description |
|---|---|---|
bool | boolean | flag to enable silent mode |
ExternalGeometryFlippedComponentNode
this
FlippedComponentNode.setSilent
▸ setTag(tag): ExternalGeometryFlippedComponentNode
Allows the user to associate any arbitrary object with the node.
| Name | Type | Description |
|---|---|---|
tag | any | The object to be associated with the node. |
ExternalGeometryFlippedComponentNode
this
▸ setVerticalFlip(flip): ExternalGeometryFlippedComponentNode
Set vertical flip of the representation
| Name | Type | Description |
|---|---|---|
flip | boolean | flag to set the vertical flip of the representation |
ExternalGeometryFlippedComponentNode
this
FlippedComponentNode.setVerticalFlip
▸ setVisible(value): ExternalGeometryFlippedComponentNode
Sets visibility of the node. Send event Events.VisibilityChanged
| Name | Type | Description |
|---|---|---|
value | boolean | flag specifying visibility of the node |
ExternalGeometryFlippedComponentNode
this
FlippedComponentNode.setVisible
▸ setVisibleModelLimits(visibleModelBounds, deviceBounds?): ExternalGeometryFlippedComponentNode
Set visible model limits
| Name | Type | Description |
|---|---|---|
visibleModelBounds | Rect | visible model limits or bounds |
Optional deviceBounds | Rect | device bounds |
ExternalGeometryFlippedComponentNode
this
FlippedComponentNode.setVisibleModelLimits
▸ setZIndex(value): ExternalGeometryFlippedComponentNode
Sets z-index for node (set null for default)
| Name | Type | Description |
|---|---|---|
value | number | index determining node z-position |
ExternalGeometryFlippedComponentNode
this
FlippedComponentNode.setZIndex
▸ shear(shx, shy): ExternalGeometryFlippedComponentNode
Shear this node's bounds
| Name | Type | Description |
|---|---|---|
shx | number | x-axis shear |
shy | number | y-axis shear |
ExternalGeometryFlippedComponentNode
this
▸ suspendUpdate(): ExternalGeometryFlippedComponentNode
Suspend auto update
ExternalGeometryFlippedComponentNode
this
FlippedComponentNode.suspendUpdate
▸ toString(): string
Gets component's textual description.
The returned string contains description (if available, name otherwise), plus geometry information: 'depth' ('from' and 'to'), as well as 'diameter' ('outer' and 'inner')
string
▸ translate(tx, ty): ExternalGeometryFlippedComponentNode
Translate bounds
| Name | Type | Description |
|---|---|---|
tx | number | x translation |
ty | number | y translation |
ExternalGeometryFlippedComponentNode
this
FlippedComponentNode.translate
▸ unregisterAnimationStyle(root): void
Unregister animation style.
| Name | Type | Description |
|---|---|---|
root | AnimatedNode | root node for node |
void
FlippedComponentNode.unregisterAnimationStyle
▸ updateLayout(targets?): ExternalGeometryFlippedComponentNode
Updates layout(s)
Fires
| Name | Type | Description |
|---|---|---|
Optional targets | ILayoutable[] | optional parameter about which element to layout |
ExternalGeometryFlippedComponentNode
this
FlippedComponentNode.updateLayout
▸ updateSceneTransformation(): ExternalGeometryFlippedComponentNode
Update scene transformation
ExternalGeometryFlippedComponentNode
this
FlippedComponentNode.updateSceneTransformation
▸ updateShapeGeometry(context): void
Updates (if needed) shape geometry depending on rendering context state. The implementation does nothing
| Name | Type | Description |
|---|---|---|
context | RenderingContext | Rendering Context |
void
FlippedComponentNode.updateShapeGeometry
▸ updateState(regions?, changes?): ExternalGeometryFlippedComponentNode
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 |
ExternalGeometryFlippedComponentNode
this
FlippedComponentNode.updateState
▸ updateSuspended(): boolean
Return state of suspend state
boolean
state of update
FlippedComponentNode.updateSuspended
▸ Protected updateTimeStamp(): ExternalGeometryFlippedComponentNode
Update time stamp to indicate that Node or Children has been changed.
ExternalGeometryFlippedComponentNode
this
FlippedComponentNode.updateTimeStamp
▸ validGeometryData(geometryData): boolean
Validates geometry data.
| Name | Type | Description |
|---|---|---|
geometryData | Entity | Geometry data |
boolean
FlippedComponentNode.validGeometryData
▸ Static enableSceneGraphNotification(enabled): void
Enable / disable all notifications
| Name | Type | Description |
|---|---|---|
enabled | boolean | sets if this object sends notifications |
void
FlippedComponentNode.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>
FlippedComponentNode.findParent
▸ 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 |
FlippedComponentNode.findParent
▸ Static getClassName(): string
string
FlippedComponentNode.getClassName
▸ Static isSceneGraphNotificationEnabled(): boolean
Return status of the global notification for all nodes.
boolean