API / geotoolkit / schematics / scene / LShapedWellBoreNode / LShapedWellBoreNode
scene.LShapedWellBoreNode.LShapedWellBoreNode
L-shaped WellBoreNode extension.
Example
// how to create and add data to L-Shaped Schematic
import {LShapedWellBoreNode} from '@int/geotoolkit/schematics/scene/LShapedWellBoreNode';
...
const wellBoreNode = new LShapedWellBoreNode({
'data': wellBoreData,
'trackWidth': 250,
// Setup the deviation point (compare to the "tubing" depth range above)
'deviationDepth': 8000,
'LShapeAccuracy': 16
})↳
LShapedWellBoreNode
Constructors
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 |
data | WellBoreData | Well bore data |
data-units | UnitsOptions | Units options |
data-units-depth | string | Depth units |
data-units-value | string | Value units |
deviationdepth | number | Deviation depth (if "null" then it's calculated based on the data) |
fillstyle | string | Fill style |
fillstyle | FillStyle | Fill style |
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 |
forceopenhole | boolean | Force showing open hole (even if it's not in the data) |
highlight | Highlight | Component highlight options |
highlight-boundscalculation | string | Implementation (or its type) to calculate component's area to highlight |
highlight-cssclass | string | Define component highlight class name |
highlight-fillstyle | string | Define fill style attribute for component highlight |
highlight-fillstyle | FillStyle | Define fill style attribute for component highlight |
highlight-linestyle | string | Define line style attribute for component highlight |
highlight-linestyle | LineStyle | Define line style attribute for component highlight |
highlight-linestyle-color | string | Color in CSS form |
highlight-linestyle-fill | string | Optional fill style to be used to fill lines generated with this style |
highlight-linestyle-fill | FillStyle | Optional fill style to be used to fill lines generated with this style |
highlight-linestyle-linecap | CapStyle | The line cap style |
highlight-linestyle-linedashoffset | number | Line dash offset of dashed line |
highlight-linestyle-linejoin | JoinStyle | The line join style |
highlight-linestyle-pixelsnapmode | boolean | Pixel Snap Mode, default( |
highlight-linestyle-scalable | boolean | True if width should depend on transformation |
highlight-linestyle-unit | string | Optional unit for the width |
highlight-linestyle-width | number | string | The line thickness |
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 |
layoutstyle | LayoutStyle | Layout style to be used for parent layout |
layoutstyle-constraint | SizeConstraint | Layout constrains |
layoutstyle-flexgrow | number | Number specifying how much the item will grow relative to the rest of the items inside the same container |
layoutstyle-flexshrink | number | Number specifying how much the item will shrink relative to the rest of the items inside the same container |
layoutstyle-float | string | Float position |
layoutstyle-position | string | Layout position |
layoutstyle-size | number | string | Layout size |
linestyle | string | Line style |
linestyle | LineStyle | Line style |
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 |
lshapeaccuracy | number | Accuracy (bigger number means smoother L-shape) |
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 |
pickingchildren | boolean | Enable picking children |
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 |
trackwidth | number | Track width |
transform | string | Additional CSS transformation applied to node or 'none' |
transform | Transformation | Additional CSS transformation applied to node or 'none' |
units | UnitsOptions | |
valueviewmode | ValueViewMode | Value view mode |
verticalflip | boolean | Vertical axis goes from bottom to top |
viewcache | boolean | View cache to cache child nodes |
viewmode | ViewMode | View mode type or an object containing view mode type and options |
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 LShapedWellBoreNode(options?)
| Name | Type |
|---|---|
Optional options | Options |
WellBoreNode.constructor
Methods
▸ addBaseLayer(baseLayer): LShapedWellBoreNode
Add baseLayer to container
this
▸ addChild(node): LShapedWellBoreNode
Add a child node
this
▸ addCssClass(cssclass): LShapedWellBoreNode
Adds new css class to node
| Name | Type | Description |
|---|---|---|
cssclass | string | string[] | css class name('s) |
this
▸ addInvalidateHandler(handler): LShapedWellBoreNode
Add invalidate handler
Deprecated
since 4.0, use Node.on instead
| Name | Type | Description |
|---|---|---|
handler | Function | handler to be notified about invalidation |
this
WellBoreNode.addInvalidateHandler
▸ addOverlay(overlay): LShapedWellBoreNode
Add overlay to container
this
▸ adjustPosition(area?, vAlign?, hAlign?): LShapedWellBoreNode
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". |
this
▸ Protected applyOpacity(context): LShapedWellBoreNode
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
WellBoreNode.applyResponsiveStyle
▸ changeBaseLayerOrder(overlay, order, anchor?): LShapedWellBoreNode
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 |
this
WellBoreNode.changeBaseLayerOrder
▸ changeChildOrder(node, order, anchor?): LShapedWellBoreNode
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 |
this
▸ changeOverlayOrder(overlay, order, anchor?): LShapedWellBoreNode
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 |
this
WellBoreNode.changeOverlayOrder
▸ checkCollision(context): boolean
Check culling Returns true if object is inside of renderable area
| Name | Type | Description |
|---|---|---|
context | RenderingContext | Rendering Context |
boolean
true if node is collided
▸ clearBaseLayers(disposeBaseLayers?): LShapedWellBoreNode
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 |
this
▸ clearCache(): LShapedWellBoreNode
Clear cache
this
▸ clearChildren(disposeChildren?): LShapedWellBoreNode
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. |
this
▸ Protected clearComponents(disposeComponents?): void
| Name | Type | Description |
|---|---|---|
Optional disposeComponents | boolean | automatically dispose components |
void
▸ clearOverlays(disposeOverlays?): LShapedWellBoreNode
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 |
this
All subclasses should override copyConstructor or provide custom implementation for this method
clone
▸ connectStyle(style, type, callback): LShapedWellBoreNode
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
▸ Protected copyConstructor(src, deepCopy?): LShapedWellBoreNode
Copy constructor function.
Function used as part of the cloning mechanism.
Implementations should copy the given instance state to this instance.
this
▸ disconnectStyle(style, type, callback): LShapedWellBoreNode
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
Dispose node. Clear all listeners and disconnect style to avoid memory leaks
void
▸ Protected drawBorder(localContext, bounds?): LShapedWellBoreNode
Draws a rectangle at the bounding box (in parent coordinates)
| Name | Type | Description |
|---|---|---|
localContext | RenderingContext | The local rendering context |
Optional bounds | Rect | group bounds |
this
▸ enableClipping(doClip): LShapedWellBoreNode
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 |
this
▸ enableEventPropagation(enable): LShapedWellBoreNode
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
WellBoreNode.enableEventPropagation
▸ enablePickingChildren(enable): LShapedWellBoreNode
Enables or disables picking children
| Name | Type | Description |
|---|---|---|
enable | boolean | enable picking children |
this
WellBoreNode.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
▸ execute(delegate): LShapedWellBoreNode
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: LShapedWellBoreNode) => void | Function to execute |
The result if any or this
▸ execute<T>(delegate): T
| Name |
|---|
T |
| Name | Type |
|---|---|
delegate | (this: LShapedWellBoreNode) => 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
WellBoreNode.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
WellBoreNode.getAutoModelLimitsMode
▸ getAutoModelLimitsStrategy(): ModelLimitsStrategy
Get Model Limits Logics Strategy
strategy
WellBoreNode.getAutoModelLimitsStrategy
▸ getBaseLayer(index): Node
Return baseLayer at specified index
| Name | Type | Description |
|---|---|---|
index | number | index at which to get the baseLayer for |
track
▸ 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. |
▸ 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.
▸ getBaseLayersCount(): number
Returns amount of baseLayers
number
WellBoreNode.getBaseLayersCount
▸ getBounds(): Rect
Get the bounds in the parents model space. If bounds are not set, then parent model limits are used.
current bounds
▸ getBuilder(viewMode): IViewModeBuilder
Gets the view mode's builder
| Name | Type | Description |
|---|---|---|
viewMode | ViewMode | view mode |
the mode builder if found
▸ 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>
▸ 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.
▸ getChildrenCount(): number
Return number of child nodes
number
▸ getClassName(): string
string
▸ getClipStyle(): ClipStyle
Gets the current clipping style
clipping style
▸ getComponentNodeProxy(componentNode): ComponentNodeProxy
| Name | Type | Description |
|---|---|---|
componentNode | ComponentNode | component node |
WellBoreNode.getComponentNodeProxy
▸ getComponents(filter?): Iterator<ComponentNode>
Gets iterator over its ComponentNode components
| Name | Type | Description |
|---|---|---|
Optional filter | (node: Node) => boolean | a filter function |
▸ getComponentsVisibility(): ComponentsVisibility
Gets visibility settings (see "setComponentsVisibility" for detailed format)
WellBoreNode.getComponentsVisibility
▸ getContentOrientation(): Orientation
Return content orientation
content orientation
WellBoreNode.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 |
▸ getContentsTransform(): Transformation
getContentsTransform() retrieves the world transformation of the node.
transformation from model coordinates to bounds of the group
WellBoreNode.getContentsTransform
▸ 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
▸ getDepthUnit(): AbstractUnit
Gets depth unit
Deprecated
since 4.0
▸ 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)
▸ 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)
▸ getDeviationDepth(type?): number
Gets deviation depth value (or object if 'KOP' and 'EOC' values set before)
| Name | Type | Description |
|---|---|---|
Optional type | "kop" | "eoc" | deviation depth type ('KOP' or 'EOC') |
number
value or structure
▸ getDeviationDepth(): Object
Object
| Name | Type |
|---|---|
eoc | number |
kop | number |
▸ getDeviceLimits(): Rect
Return device limits
▸ getFactoryRegistry(): ComponentNodeFactoryRegistry
Gets factory registry associated with the node.
registry
WellBoreNode.getFactoryRegistry
▸ getFillStyle(): FillStyle
Return fill style
fillStyle current fill style
▸ getForceOpenHole(): boolean
Gets forced open hole state
boolean
▸ Protected getHighlightBoundsCalculator(): BoundsCalculation
WellBoreNode.getHighlightBoundsCalculator
▸ Protected getHighlightLayersIterator(func?): Iterator<Layer<Path>>
| Name | Type |
|---|---|
Optional func | (item: Node) => boolean |
WellBoreNode.getHighlightLayersIterator
▸ Protected getHighlightShapes(nodeId, type): Path[]
| Name | Type |
|---|---|
nodeId | string |
type | "selection" | "highlight" |
Path[]
WellBoreNode.getHighlightShapes
▸ getId(): string | number
Returns the associated identifier of the node
string | number
The node's id
▸ getInfiniteMode(): boolean
Return infinity mode flag
boolean
flag
▸ Protected getInvalidateMethod(): AttributeCallback<EventDispatcher>
Gets invalidate method
AttributeCallback<EventDispatcher>
method to invalidate this object
WellBoreNode.getInvalidateMethod
▸ getLayout(): Layout
Returns layout associated with the group
layout
▸ getLayoutStyle(): LayoutStyle<string | number>
return desired layout style
LayoutStyle<string | number>
▸ getLineStyle(): LineStyle
Return border style
▸ getLocalTransform(): Transformation
Retrieves the transformation of bounds to parent
transform the local transform.
WellBoreNode.getLocalTransform
▸ getMarginsStyle(): SpaceStyle<string | number>
Return margins style
SpaceStyle<string | number>
▸ getModelLimits(): Rect
Gets model limits, the limits of this groups inside space
the current model limits
▸ 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
WellBoreNode.getOpacityBlendMode
▸ getOverlay(index): Node
Return overlay at specified index
| Name | Type | Description |
|---|---|---|
index | number | index at which to get the overlay for |
track
▸ 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
▸ 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. |
▸ 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.
▸ getOverlaysCount(): number
Returns amount of overlays
number
▸ getPaddingStyle(): SpaceStyle<string | number>
Return padding style
SpaceStyle<string | number>
padding
▸ getParent(): Node
Return parent node
parent node
▸ getPreferredSize(): Rect
Return preferred size to layout children
▸ getProperties(): OptionsOut
Gets all the properties pertaining to this object
An object containing the properties to set
▸ 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[]
▸ getRenderingFilter(): IFilter
Return filter to be used for rendering and picking
current filter
WellBoreNode.getRenderingFilter
▸ getRenderingHints(): RenderingHints
Gets rendering hints for various component types (if any)
rendering hints
WellBoreNode.getRenderingHints
▸ getResponsiveStyle(): ResponsiveStyle
Return responsive style
WellBoreNode.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
WellBoreNode.getScaleScrollStrategy
▸ getSceneTransform(): Transformation
Returns transformation from node to root scene
a transformation from node to root scene
WellBoreNode.getSceneTransform
▸ getSelectedComponentNodes(): ComponentNode[]
Gets selected component nodes
WellBoreNode.getSelectedComponentNodes
▸ getTag(): any
Returns the object associated with the node by user.
any
The node's user-object
▸ getUnitsOptions(): UnitsOptions
Gets units options (see "setUnitsOptions" API for the options format)
Deprecated
since 4.0
object containing units options
▸ getValueUnit(): AbstractUnit
Gets value unit
Deprecated
since 4.0
▸ getValueViewMode(): ValueViewMode
Gets well bore value view mode
▸ getViewMode(): ViewMode
Gets well bore view mode.
▸ getVisible(componentName?): boolean
Gets visibility (convenience method)
| Name | Type | Description |
|---|---|---|
Optional componentName | string | component name |
boolean
▸ getVisibleDeviceLimits(ignoreModelLimits?): Rect
Return visible device limits
| Name | Type | Description |
|---|---|---|
Optional ignoreModelLimits | boolean | flag defines whether to ignore ModelLimits or not |
WellBoreNode.getVisibleDeviceLimits
▸ getVisibleModelLimits(ignoreModelLimits?): Rect
Return visible model limits
| Name | Type | Description |
|---|---|---|
Optional ignoreModelLimits | boolean | flag defines whether to ignore ModelLimits or not |
WellBoreNode.getVisibleModelLimits
▸ getWellBoreData(): WellBoreData
Gets well bore data the node is built on.
data
▸ getWorldTransform(): Transformation
Retrieves the local transformation of the node which represents multiplication of parent to bounds and contents transformations.
WellBoreNode.getWorldTransform
▸ 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
▸ highlightComponentNode(node, on): void
Draws specified component node as highlighted or non-highlighted
| Name | Type | Description |
|---|---|---|
node | ComponentNode | node to highlight |
on | boolean | highlight flag |
void
WellBoreNode.highlightComponentNode
▸ 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
▸ 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
▸ 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
▸ insertBaseLayer(index, baseLayer): LShapedWellBoreNode
Insert child baseLayer at specified index
| Name | Type | Description |
|---|---|---|
index | number | specified index |
baseLayer | Node | a baseLayer to add |
this
▸ insertChild(index, node): LShapedWellBoreNode
Insert child node at specified index
| Name | Type | Description |
|---|---|---|
index | number | specified index |
node | Node | a child node to add |
this
▸ insertOverlay(index, overlay): LShapedWellBoreNode
Insert child overlay at specified index
| Name | Type | Description |
|---|---|---|
index | number | specified index |
overlay | Node | a overlay to add |
this
▸ invalidate(bounds?, force?): LShapedWellBoreNode
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 |
this
▸ invalidateLayout(propagate?): LShapedWellBoreNode
Notify that layout is invalidated. Send event Events.LayoutInvalidated
| Name | Type | Description |
|---|---|---|
Optional propagate | boolean | propagate invalidate layout to parent |
this
▸ invalidateParent(bounds?, force?): LShapedWellBoreNode
Invalidate parent area
| Name | Type | Description |
|---|---|---|
Optional bounds | Rect | area to invalidate |
Optional force | boolean | force |
this
▸ isClippingEnabled(): boolean
Returns if clipping is enabled or not for this node.
boolean
WellBoreNode.isClippingEnabled
▸ isDisposed(): boolean
Returns whether this object has been disposed
boolean
▸ isEventPropagationEnabled(): boolean
Return true if event propagation is enabled from child to parent
boolean
WellBoreNode.isEventPropagationEnabled
▸ isHorizontalFlip(): boolean
Return true if the representation is flipped horizontally
boolean
flip
▸ isLayoutInvalidated(): boolean
Return true if layout is invalid
boolean
WellBoreNode.isLayoutInvalidated
▸ isNotificationEnabled(): boolean
return state of notification
boolean
current notification state
WellBoreNode.isNotificationEnabled
▸ isPickingChildrenEnabled(): boolean
Returns if picking children is enabled or not for this node.
boolean
pickingChildren
WellBoreNode.isPickingChildrenEnabled
▸ 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
▸ isVerticalFlip(): boolean
Return true if the representation is flipped vertically
boolean
flip
▸ moveTo(area, vAlign?, hAlign?): LShapedWellBoreNode
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". |
this
▸ notify<E>(type, source, args?): LShapedWellBoreNode
Notify listeners of the Node
| Name | Type |
|---|---|
E | extends string |
| Name | Type | Description |
|---|---|---|
type | E | type of event |
source | WellBoreNode | source who called the event |
Optional args | EventMap[E] | event arguments |
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
▸ off<E>(type?, callback?): LShapedWellBoreNode
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: LShapedWellBoreNode, args: EventMap[E]) => void | function to be called |
this
▸ on<E>(type, callback): LShapedWellBoreNode
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: LShapedWellBoreNode, args: EventMap[E]) => void | to be called |
this
▸ Protected onBoundsChanged(bounds): LShapedWellBoreNode
Occurs when bounds has been changed
| Name | Type | Description |
|---|---|---|
bounds | Rect | bound of the node in the parent coordinates |
this
▸ Protected onChildAdded(child): void
This method is called it child or children are added
void
▸ Protected onChildRemoved(child): void
This method is called it child or children are removed
| Name | Type | Description |
|---|---|---|
child | Node | removed child |
void
▸ Protected onParentChanged(node): LShapedWellBoreNode
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
WellBoreNode.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
▸ 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
▸ rebuild(force?, changes?): LShapedWellBoreNode
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 |
this
▸ registerAnimationStyle(root): void
Register animation style.
| Name | Type | Description |
|---|---|---|
root | Node | root node for node |
void
WellBoreNode.registerAnimationStyle
▸ removeBaseLayer(baseLayer): LShapedWellBoreNode
Remove child baseLayer
this
▸ removeChild(node, disposeChildren?): LShapedWellBoreNode
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. |
this
▸ removeCssClass(cssclass): LShapedWellBoreNode
Removes css class from node
| Name | Type | Description |
|---|---|---|
cssclass | string | string[] | css class name('s) |
this
▸ removeInvalidateHandler(handler): LShapedWellBoreNode
Remove invalidate handler
Deprecated
since 4.0, use Node.off instead
| Name | Type | Description |
|---|---|---|
handler | Function | handler to be notified about invalidation |
this
WellBoreNode.removeInvalidateHandler
▸ removeOverlay(overlay): LShapedWellBoreNode
Remove child overlay
this
▸ 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
▸ Protected renderBackground(context, bounds): LShapedWellBoreNode
Render background
| Name | Type | Description |
|---|---|---|
context | RenderingContext | context to render background |
bounds | Rect | group bounds |
this
▸ Protected renderBaseLayers(context): LShapedWellBoreNode
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 |
this
▸ 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
WellBoreNode.renderBaseLayersAsync
▸ Protected renderChildren(context): void
Render children
| Name | Type | Description |
|---|---|---|
context | RenderingContext | Rendering Context |
void
▸ 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
WellBoreNode.renderChildrenAsync
▸ Protected renderContent(context): void
render to specified context. This method calls preRendering, renderChildren, postRendering
| Name | Type | Description |
|---|---|---|
context | RenderingContext | Rendering Context |
void
▸ 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
WellBoreNode.renderContentAsync
▸ Protected renderOverlays(context): LShapedWellBoreNode
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 |
this
▸ 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
WellBoreNode.renderOverlaysAsync
▸ replaceComponent(componentName): LShapedWellBoreNode
Rebuilds all components with a given "componentName"
Throws
when the node is not in sync with its WellBoreData.
| Name | Type | Description |
|---|---|---|
componentName | string | component name |
this
▸ resumeUpdate(rebuild?, changes?): LShapedWellBoreNode
Resume auto update
| Name | Type | Description |
|---|---|---|
Optional rebuild | boolean | force rebuild |
Optional changes | StateChanges | optional parameter to specify a reason of changes |
this
▸ rotate(theta, x, y): LShapedWellBoreNode
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): LShapedWellBoreNode
Scale node
| Name | Type | Description |
|---|---|---|
xx | number | x scale factor |
yy | number | y scale factor |
this
▸ setAnimationStyle(animationStyle): LShapedWellBoreNode
Sets animation style
| Name | Type | Description |
|---|---|---|
animationStyle | Type | animation style |
WellBoreNode.setAnimationStyle
▸ setAutoModelLimitsMode(mode): LShapedWellBoreNode
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 |
this
WellBoreNode.setAutoModelLimitsMode
▸ setAutoModelLimitsStrategy(strategy): LShapedWellBoreNode
Set Model Limits Logics Strategy
| Name | Type | Description |
|---|---|---|
strategy | ModelLimitsStrategy | Model Limits logic strategy to use |
this
WellBoreNode.setAutoModelLimitsStrategy
▸ setBounds(bounds): LShapedWellBoreNode
Sets bounds of the node in the parent coordinates
| Name | Type | Description |
|---|---|---|
bounds | Type | bound of the node in the parent coordinates |
this
▸ setBuilder(builder, builderViewMode): LShapedWellBoreNode
Sets builder for the view mode passed
| Name | Type | Description |
|---|---|---|
builder | IViewModeBuilder | the mode builder to set |
builderViewMode | ViewMode | view mode |
this
▸ setCache(cache, rebuild?): LShapedWellBoreNode
Sets cache to be used to cache
| Name | Type | Description |
|---|---|---|
cache | Cache | cache to be used |
Optional rebuild | boolean | rebuild cache |
this
▸ setChild(index, node): LShapedWellBoreNode
Replace child node by index
| Name | Type | Description |
|---|---|---|
index | number | index of the node |
node | Node | node |
this
▸ setClipStyle(style): LShapedWellBoreNode
Sets a new clipping style
| Name | Type | Description |
|---|---|---|
style | GraphicsPath | ClipStyle | Options | a new clipping style |
this
▸ setComponentsVisibility(parameter): LShapedWellBoreNode
Sets component visibility according to the component names/ID-s passed (convenience method).
| Name | Type | Description |
|---|---|---|
parameter | ComponentsVisibility | visibility options |
this
WellBoreNode.setComponentsVisibility
▸ setContentOrientation(orientation): LShapedWellBoreNode
Set content orientation
| Name | Type | Description |
|---|---|---|
orientation | Orientation | content orientation |
this
WellBoreNode.setContentOrientation
▸ setCss(style, merge?): LShapedWellBoreNode
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): LShapedWellBoreNode
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): LShapedWellBoreNode
Set CSS transformation
| Name | Type | Description |
|---|---|---|
transform | string | Transformation | transformation css transformation instruction or Transformation instance |
this
▸ setDesiredHeight(value, silent?): LShapedWellBoreNode
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 |
this
▸ setDesiredWidth(value, silent?): LShapedWellBoreNode
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 |
this
▸ setDeviationDepth(deviationDepth): LShapedWellBoreNode
Sets deviation depth value
| Name | Type | Description |
|---|---|---|
deviationDepth | number | { eoc: number ; kop: number } | deviation depth value |
this
▸ setFactoryRegistry(factoryRegistry): LShapedWellBoreNode
Associates the factory registry with the node.
| Name | Type | Description |
|---|---|---|
factoryRegistry | ComponentNodeFactoryRegistry | factory registry to be associated with the node |
this
WellBoreNode.setFactoryRegistry
▸ setFillStyle(fillStyle, merge?): LShapedWellBoreNode
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
▸ setForceOpenHole(force): LShapedWellBoreNode
Sets forced open hole mode
| Name | Type | Description |
|---|---|---|
force | boolean | mode state |
this
▸ setHorizontalFlip(enable): LShapedWellBoreNode
Set horizontal flip of the representation
| Name | Type | Description |
|---|---|---|
enable | boolean | enable flip |
this
WellBoreNode.setHorizontalFlip
▸ setId(id): LShapedWellBoreNode
Allows the user to associate any identifier
| Name | Type | Description |
|---|---|---|
id | string | number | object id |
this
▸ setInfiniteMode(infinityMode): LShapedWellBoreNode
Set infinity mode flag to draw composite without collision check
| Name | Type | Description |
|---|---|---|
infinityMode | boolean | infinity mode flag |
this
▸ setLayout(layout): LShapedWellBoreNode
Associate layout with a group.
| Name | Type | Description |
|---|---|---|
layout | Record<string, any> | Layout | layout instance to be set or layout properties to apply |
this
▸ Protected setLayoutInvalidated(invalidated): void
Set invalidation status
| Name | Type | Description |
|---|---|---|
invalidated | boolean | invalidated layout |
void
WellBoreNode.setLayoutInvalidated
▸ setLayoutStyle(layoutStyle, silent?, merge?): LShapedWellBoreNode
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 |
this
▸ setLineStyle(lineStyle, merge?): LShapedWellBoreNode
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 |
this
▸ setLocalTransform(localTransform, force?): LShapedWellBoreNode
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
WellBoreNode.setLocalTransform
▸ setMarginsStyle(margins, merge?): LShapedWellBoreNode
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
▸ setModelLimits(limits): LShapedWellBoreNode
Sets inner model limits
| Name | Type | Description |
|---|---|---|
limits | Type | inner limits |
this
▸ setName(name): LShapedWellBoreNode
Sets name of the node
| Name | Type | Description |
|---|---|---|
name | string | The node name |
this
▸ setNotification(notify, force?): LShapedWellBoreNode
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?): LShapedWellBoreNode
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
▸ setPaddingStyle(paddingStyle, merge?): LShapedWellBoreNode
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 |
this
▸ setProperties(properties?): LShapedWellBoreNode
Sets all the properties pertaining to this object
| Name | Type | Description |
|---|---|---|
Optional properties | Options | An object containing the properties to set |
this
▸ setProperty(name, value): LShapedWellBoreNode
Sets dynamic property by name
| Name | Type | Description |
|---|---|---|
name | string | property name |
value | any | property value |
this
▸ setRenderingFilter(filter): LShapedWellBoreNode
Sets filter to be applied before rendering and picking
| Name | Type | Description |
|---|---|---|
filter | IFilter | filter to set |
this
WellBoreNode.setRenderingFilter
▸ setRenderingHints(hints): LShapedWellBoreNode
Sets rendering hints for various component types (if any)
Example
// Customizing 'fluid' component's subsets:
const renderingHints = {
'fluid': {
'Mud': { 'fillstyle': { 'color': 'rgb(191,127,127)' } },
'Spacer Fluid': { 'fillstyle': { 'color': 'rgb(113,244,151)' } },
'Head Slurry': { 'fillstyle': { 'color': 'rgb(127,127,127)' } },
'Tail Slurry': { 'fillstyle': { 'color': 'rgb(80,80,80)' } }
}
};
// The call tells wellbore node to render fluid's subsets: 'Mud', 'Spacer Fluid', 'Head Slurry' and 'Tail Slurry'
// with their corresponding fill colors:
wellBoreNode.setRenderingHints(renderingHints);Example
// Customizing casing shoe painter, proportions and styles:
import {FillStyle} from '@int/geotoolkit/attributes/FillStyle';
import {LineStyle} from '@int/geotoolkit/attributes/LineStyle';
const renderingHints = {
'casing': {
'shoe': {
'painter': (symbol, bbox, context) => { // Replace default shoe painter
const x = [bbox.x, bbox.x + bbox.width, bbox.x + bbox.width, bbox.x + bbox.width, bbox.x];
const y = [bbox.y, bbox.y, bbox.y + bbox.height / 2, bbox.y + bbox.height, bbox.y + bbox.height];
context.drawPolygon(x, y);
},
'height': 10,
'width': 10,
'linestyle': new LineStyle('red'),
'fillstyle': new FillStyle('blue')
}
}
};
wellBoreNode.setRenderingHints(renderingHints);Example
// Add a color gradient
import {Point} from '@int/geotoolkit/util/Point';
import {LinearGradientStyle} from '@int/geotoolkit/attributes/LinearGradientStyle';
const gradStyleMud = new LinearGradientStyle( {
'startPoint': new Point(0, 0), 'endPoint': new Point(1, 1), 'startColor': 'red', 'endColor': 'blue'
});
const renderingHints = {
'casing':
{'shoe': {'fillstyle': gradStyleMud}}
};
wellBoreNode.setRenderingHints(renderingHints);| Name | Type | Description |
|---|---|---|
hints | RenderingHints | rendering hints |
this
WellBoreNode.setRenderingHints
▸ setResponsiveStyle(style): LShapedWellBoreNode
Sets responsive style.
| Name | Type | Description |
|---|---|---|
style | Options | ResponsiveStyle | responsive style |
this
WellBoreNode.setResponsiveStyle
▸ setScaleScrollStrategy(strategy?): LShapedWellBoreNode
Sets scale scroll strategy
| Name | Type | Description |
|---|---|---|
Optional strategy | Delegate | scale scroll strategy |
this
WellBoreNode.setScaleScrollStrategy
▸ setSelectable(selectable): LShapedWellBoreNode
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
▸ setSelectedComponentNodes(selectedComponentNodes): LShapedWellBoreNode
Sets selected component nodes
| Name | Type | Description |
|---|---|---|
selectedComponentNodes | ComponentNode[] | selected component nodes |
this
WellBoreNode.setSelectedComponentNodes
▸ setSilent(bool): LShapedWellBoreNode
Set silent mode
| Name | Type | Description |
|---|---|---|
bool | boolean | flag to enable silent mode |
this
▸ setTag(tag): LShapedWellBoreNode
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
▸ setUnitsOptions(unitOptions): LShapedWellBoreNode
Sets units options
Deprecated
since 4.0
Throws
TypeError
| Name | Type | Description |
|---|---|---|
unitOptions | UnitsOptions | An object containing the properties to set |
this
▸ setValueViewMode(mode?): LShapedWellBoreNode
Sets well bore value view mode
| Name | Type | Description |
|---|---|---|
Optional mode | ValueViewMode | value view mode |
this
▸ setVerticalFlip(flip): LShapedWellBoreNode
Set vertical flip of the representation
| Name | Type | Description |
|---|---|---|
flip | boolean | flag to set the vertical flip of the representation |
this
▸ setViewMode(viewMode?): Object
Sets well bore view mode.
| Name | Type | Description |
|---|---|---|
Optional viewMode | ViewMode | ViewModeInfo | view mode type or an object containing view mode type and options |
Object
"model limits to bounds" depths mapping
| Name | Type | Description |
|---|---|---|
boundsdepths | number[] | bounds depths |
modellimitsdepths | number[] | model limits depths |
▸ setVisible(visible, value?): LShapedWellBoreNode
Sets visibility for all components, or just the components with specified name or ID
| Name | Type | Description |
|---|---|---|
visible | boolean | visibility state |
Optional value | string | component name or ID |
this
▸ setVisibleModelLimits(visibleModelBounds, deviceBounds?): LShapedWellBoreNode
Set visible model limits
| Name | Type | Description |
|---|---|---|
visibleModelBounds | Rect | visible model limits or bounds |
Optional deviceBounds | Rect | device bounds |
this
WellBoreNode.setVisibleModelLimits
▸ setWellBoreData(wellBoreData): LShapedWellBoreNode
Sets well bore data to build the node on.
| Name | Type | Description |
|---|---|---|
wellBoreData | WellBoreData | well bore data the node is built on |
this
▸ setZIndex(value): LShapedWellBoreNode
Sets z-index for node (set null for default)
| Name | Type | Description |
|---|---|---|
value | number | index determining node z-position |
this
▸ shear(shx, shy): LShapedWellBoreNode
Shear this node's bounds
| Name | Type | Description |
|---|---|---|
shx | number | x-axis shear |
shy | number | y-axis shear |
this
▸ suspendUpdate(): LShapedWellBoreNode
Suspend auto update
this
▸ toString(): string
Returns a string representation of this object (generally the classname)
string
A string representation
▸ translate(tx, ty): LShapedWellBoreNode
Translate bounds
| Name | Type | Description |
|---|---|---|
tx | number | x translation |
ty | number | y translation |
this
▸ unregisterAnimationStyle(root): void
Unregister animation style.
| Name | Type | Description |
|---|---|---|
root | AnimatedNode | root node for node |
void
WellBoreNode.unregisterAnimationStyle
▸ updateLayout(targets?): LShapedWellBoreNode
Updates layout(s)
Fires
| Name | Type | Description |
|---|---|---|
Optional targets | ILayoutable[] | optional parameter about which element to layout |
this
▸ updateSceneTransformation(): LShapedWellBoreNode
Update scene transformation
this
WellBoreNode.updateSceneTransformation
▸ updateState(regions?, changes?): LShapedWellBoreNode
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
▸ updateSuspended(): boolean
Return state of suspend state
boolean
state of update
▸ Protected updateTimeStamp(): LShapedWellBoreNode
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
WellBoreNode.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 isSceneGraphNotificationEnabled(): boolean
Return status of the global notification for all nodes.
boolean