API / geotoolkit / welllog / widgets / WellLogWidget / WellLogWidget
widgets.WellLogWidget.WellLogWidget
The WellLog widget is a widget that is specialized for well related data. It uses classes from the WellLog toolkit internally.<br> The main way to configure and customize the default look and feel of the widget is by using the different setProperties() function in the constructor.<br> The widget content can be manipulated through add/remove/get-Track() and the Track content can be controlled through track.add/remove/get-Child() as shown in example below.<br> Similarly all supported well data (track, index track, log curves, log fills, log2d, markers etc) can be manipulated.<br> Widget has header, footer containers to display tracks and visuals headers and track container to display tracks. The widget provides built-in support for Time/Depth modes, Resizing headers and footers, Selection and highlighting, Track resizing.
The Default tools include: <ul> <li> Horizontal scrollbar </li> <li> Vertical scrollbars (header, tracks, footer) </li> <li> Panning </li> <li> Zoom </li> <li> Pinching </li> <li> Crosshair </li> <li> Header/Footer splitters (for resizing) </li> <li> Track splitters (for resizing) </li> <li> Rubberband (for rubberband Zoom) </li> <li> Selection </li> <li> drag-and-drop (for drag'n drop track or curve) </li> </ul>
Example
// Create the Widget
import {WellLogWidget} from '@int/geotoolkit/welllog/widgets/WellLogWidget';
import {TrackType} from '@int/geotoolkit/welllog/TrackType';
const widget = new WellLogWidget({
'horizontalscrollable': false,
'verticalscrollable': true,
'trackcontainer': {
'border': {'visible': false}
},
'border': {'visible': false}
})
widget.addTrack(TrackType.IndexTrack);Example
// Adding a curve to the widget.
import {LogCurve} from '@int/geotoolkit/welllog/LogCurve';
widget.addTrack(TrackType.LinearTrack)
.addChild([
new LogCurve(curveData)
.setLineStyle('green', 1))
]);Example
import {Events as AbstractScrollEvents} from '@int/geotoolkit/controls/tools/scroll/AbstractScroll';
import {Events as PanningEvents} from '@int/geotoolkit/controls/tools/Panning';
// Capture a scroll event when the user uses the scroll tab or mouse wheel.
widget.getToolByName('TrackPanning')
.on(PanningEvents.onPanning, (evt, sender, eventArgs) => {
...
});
widget.getToolByName('HorizontalPlotScroll')
.on(AbstractScrollEvents.onScroll, (evt, sender, eventArgs) => {
...
});Example
// Resizing WellLogWidget.
// It has two parts. The first one is resizing of the plot, which is a container of any widget and shapes and the second step is resizing of widgets inside of container.
// To change the size of the widget you need to call 'setBounds' method of the widget. The method of the plot 'setSize' will change a plot size.
// It is better to use automatic way to change size of the widget based on plot. The following steps will describe this approach:
// step2: When you create a plot you specify canvas and widget like this:
import {Plot} from '@int/geotoolkit/plot/Plot';
import {Group} from '@int/geotoolkit/scene/Group';
import {CssLayout} from '@int/geotoolkit/layout/CssLayout';
// step1: After you create a widget you specify location inside the plot using layout style like this:
const widget = new WellLogWidget({
'horizontalscrollable': false,
'verticalscrollable': true,
'trackcontainer': {
'border': {'visible': false}
},
'border': {'visible': false}
'track' : {
'header' : {
'visibletracktitle' : true,
'titlefirst' : true,
'firsttolast' : false,
'toptobottom' : false,
'holdtitle' : HoldTitle.Top
},
'footer' : {
'visibletracktitle' : true,
'titlefirst' : true,
'firsttolast' : false,
'toptobottom' : true,
'holdtitle' : HoldTitle.None
}
},
})
.setLayoutStyle({
'left': 0,
'top': 0,
'right': 0,
'bottom': 0
});
// This setLayoutStyle tells that widgets will occupy whole plot area.
const widgetPlot = new Plot({
'canvasElement': canvas,
'root': new Group()
.setAutoModelLimitsMode(true)
.setLayout(new CssLayout()) // plot will resize children using CssLayout.
.addChild(widget),
'autoSize': false,
'autoRootBounds': true
});
// Now if you change a plot size then the size of widget will be changed automatically, so to resize widget you need just to call:
plot.setSize(width, height);Example
// To modify the height of headers container simply do the following while initializing the widget.
const widget = new WellLogWidget({
'header': {
'height': 200
}
})Example
// ..or If you are using CSS then
import {CssStyle} from '@int/geotoolkit/css/CssStyle';
const css = [
'.WellLogWidget {',
' header-height: 200;',
'}',
].join('\n');
widget.setCss(new CssStyle({'css': css}));
// CSS styles can be used to change other properties also. Please refer to the CSS properties section to see which properties can be changed.Example
// To add widget header:
import {Text} from '@int/geotoolkit/scene/shapes/Text';
const widget = new WellLogWidget({
'annotations': {
'north': [
new Text({'text': 'Title'}).setLayoutStyle({ 'height': 20 })
]
},
'annotationssizes': {
'north': 100
}
});Example
// To change tracks' size manually use method WellLogWidget.setTrackWidth:
wellLogWidget.setTrackWidth(150, track); // 150 is the width, if track is null then width will be applied to all tracks.Example
// To set CSS style to hover and highlight
// specify cssclass name
const widget = new WellLogWidget({
'highlight': {
'cssclass': 'highlight'
});
// sets CSS properties for highlighting and hover for curve
widget.setCss(new CssStyle(
{
'css': [
'.geotoolkit.welllog.LogCurve:hover {',
' linestyle-width: 3;',
'}',
'.geotoolkit.welllog.LogCurve:highlight {',
' linestyle-width: 3;',
'}'
].join('')
}));Example
// If you need to change style of visual checks and remove 'hover' and 'highlight' CSS class from it like this:
import {PseudoClass} from '@int/geotoolkit/css/CssStyle';
...
var hasHover = selectedVisual.hasCssClass(PseudoClass.Hover);
var hasHighlight = selectedVisual.hasCssClass(PseudoClass.Highlight);
// Remove class to restore original styles
if (hasHover || hasHighlight) {
selectedVisual.removeCssClass([PseudoClass.Hover, PseudoClass.Highlight]);
}
selectedVisual.setLineStyle(newStyle);
if (hasHover) {
selectedVisual.addCssClass(PseudoClass.Hover);
}
if (hasHighlight) {
selectedVisual.addCssClass(PseudoClass.Highlight);
}↳
WellLogWidget
Constructors
- [new WellLogWidget(options)](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit.welllog.widgets-4.welllogwidget.welllogwidget.md#new welllogwidget(options))
Methods
Css Properties
| Name | Type | Description |
|---|---|---|
border | BorderOptions | Defines properties for widget outer border |
border-borders | Visible | Borders visibility option |
border-borders-bottom | boolean | Visibility of bottom part |
border-borders-left | boolean | Visibility of left part |
border-borders-right | boolean | Visibility of right part |
border-borders-top | boolean | Visibility of top part |
border-color | string | Color of border |
border-linestyle | string | Border line style |
border-linestyle | LineStyle | Border line style |
border-linestyle-color | string | Color in CSS form |
border-linestyle-fill | string | Optional fill style to be used to fill lines generated with this style |
border-linestyle-fill | FillStyle | Optional fill style to be used to fill lines generated with this style |
border-linestyle-fill-color | string | Color in CSS form |
border-linestyle-fill-evenoddmode | boolean | Even-odd fill mode |
border-linestyle-fill-fillpattern | Pattern | Pattern |
border-linestyle-fill-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 |
border-linestyle-fill-fillpattern-patternname | string | Name of this pattern for indexing |
border-linestyle-fill-fillpattern-scalable | boolean | Flag that sets scalability of the pattern coordinates, or relative to the shape it is filling (It is not supported) |
border-linestyle-fill-foreground | string | Foreground color |
border-linestyle-fill-pattern | Pattern | Pattern |
border-linestyle-linecap | CapStyle | The line cap style |
border-linestyle-linedashoffset | number | Line dash offset of dashed line |
border-linestyle-linejoin | JoinStyle | The line join style |
border-linestyle-pixelsnapmode | boolean | Pixel Snap Mode, default( |
border-linestyle-scalable | boolean | True if width should depend on transformation |
border-linestyle-unit | string | Optional unit for the width |
border-linestyle-width | number | string | The line thickness |
border-visible | boolean | Visibility of the border |
depthlimitsoptions | DepthLimitsOptions | Depth limits options |
depthlimitsoptions-neatlimits | boolean | Auto neat depth limits |
depthlimitsoptions-type | DepthLimitsTypes | Depth limits type |
deviceunit | string | Primary device unit |
direction | TrackRenderDirection | Set track render direction |
gridlinestyle | string | Grid line style |
gridlinestyle | LineStyle | Grid line style |
horizontalscrollable | boolean | Defines if plot displays horizontal scrollbars |
indent | number | Indent between tracks |
indextype | IndexType | Primary index types |
indexunit | string | Primary index unit |
marker | MarkerOptions | Marker options |
marker-datetimeformat | Options | Date time format in case if track container scale unit belongs to 'time' |
marker-datetimeformat-format | string | Date time format |
marker-datetimeformat-timezone | TimeZone | Time zone |
marker-enabledinterpolatedvalues | boolean | Display symbol for interpolated values |
marker-fillstyle | string | Marker shape fill style |
marker-fillstyle | FillStyle | Marker shape fill style |
marker-indexvisible | boolean | Visibility of the marker index value label |
marker-labelvisible | boolean | Visibility of the marker shape label |
marker-linestyle | string | Marker shape line style |
marker-linestyle | LineStyle | Marker shape line style |
marker-symbol | SymbolShape | Symbol to use as depth index marker |
marker-symbol-alignment | AnchorType | Alignment according to the anchor point |
marker-symbol-alignment | AnchorType | Anchor type of symbol |
marker-symbol-ax | number | Anchor x position |
marker-symbol-ay | number | Anchor y position |
marker-symbol-cache | boolean | Set it to true if you want to cache complex geometry to raster |
marker-symbol-clipstyle | ClipStyle | Clipping style |
marker-symbol-clipstyle-evenodd | boolean | True if evenodd mode is on ('nonzero' mode otherwise) |
marker-symbol-clipstyle-geometry | GraphicsPath | Clipping geometry |
marker-symbol-clipstyle-geometry-bounds | Rect | Bounds |
marker-symbol-clipstyle-geometry-bounds-height | number | Height |
marker-symbol-clipstyle-geometry-bounds-readonly | boolean | Readonly |
marker-symbol-clipstyle-geometry-bounds-width | number | Width |
marker-symbol-clipstyle-geometry-bounds-x | number | Left |
marker-symbol-clipstyle-geometry-bounds-y | number | Top |
marker-symbol-clipstyle | GraphicsPath | Clipping style |
marker-symbol-cssclass | string | The css class name of this node |
marker-symbol-csscursor | string | CSS cursor associated with node |
marker-symbol-cssstyle | string | CSS style to be applied to inserted elements |
marker-symbol-fillstyle | string | Style applied on fill |
marker-symbol-fillstyle | FillStyle | Style applied on fill |
marker-symbol-height | number | Shape height |
marker-symbol-id | string | number | Id of the node, its a unique identifier |
marker-symbol-ispointingup | boolean | Defines whether the shape is always pointing up |
marker-symbol-layoutstyle | LayoutStyle | Layout style to specify how to lay out shape |
marker-symbol-layoutstyle-constraint | SizeConstraint | Layout constrains |
marker-symbol-layoutstyle-flexgrow | number | Number specifying how much the item will grow relative to the rest of the items inside the same container |
marker-symbol-layoutstyle-flexshrink | number | Number specifying how much the item will shrink relative to the rest of the items inside the same container |
marker-symbol-layoutstyle-float | string | Float position |
marker-symbol-layoutstyle-position | string | Layout position |
marker-symbol-layoutstyle-size | number | string | Layout size |
marker-symbol-linestyle | string | Style applied on outline |
marker-symbol-linestyle | LineStyle | Style applied on outline |
marker-symbol-localtransform | Transformation | Local transformation |
marker-symbol-localtransform-dx | number | X axis translation |
marker-symbol-localtransform-dy | number | Y axis translation |
marker-symbol-localtransform-xx | number | X scale |
marker-symbol-localtransform-xy | number | Xy skew |
marker-symbol-localtransform-yx | number | Yx skew |
marker-symbol-localtransform-yy | number | Y scale |
marker-symbol-margins | number | string | It has properties for specifying the margins for each side |
marker-symbol-maxdimension | Dimension | Maximum size for rendering |
marker-symbol-maxdimension-height | number | Height of dimension |
marker-symbol-maxdimension-width | number | Width of dimension or properties |
marker-symbol-mindimension | Dimension | Minimum size for rendering |
marker-symbol-name | string | Name of the node. It is often used for debugging purposes or to simplify queries |
marker-symbol-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 |
marker-symbol-opacityblendmode | BlendMode | Node opacity mode to blend it |
marker-symbol-painter | string | A function with has parameters: symbol, box, context |
marker-symbol-painterproperties | any | Symbol's painter's properties |
marker-symbol-preserveaspectratio | boolean | Preserve aspect ratio of the anchored shape |
marker-symbol-preservereadingorientation | boolean | Preserve reading orientation for local transform |
marker-symbol-preserverightangle | boolean | Preserve right angle for local transformation |
marker-symbol-rotationangle | number | Rotation angle at anchor |
marker-symbol-scalescrollstrategy | ScaleScrollStrategy | Scale scroll strategy |
marker-symbol-scalescrollstrategy-enabled | boolean | Enable flag |
marker-symbol-selectable | boolean | Selectable node, a boolean to determine if selection should consider this node |
marker-symbol-sizeisindevicespace | boolean | Is coordinate in device space |
marker-symbol-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 |
marker-symbol-transform | string | Additional CSS transformation applied to node or 'none' |
marker-symbol-transform | Transformation | Additional CSS transformation applied to node or 'none' |
marker-symbol-useminmaxdimensions | boolean | Use the min max dimensions to limit visual size |
marker-symbol-visible | boolean | Visibility of the node, a boolean to determine if the node should be rendered or not |
marker-symbol-width | number | Shape width |
marker-symbol-z-index | number | Define node z-index |
orientation | Orientation | Set orientation of the well log widget |
range | Range | Min and max depth range |
range-high | number | Upper range boundary |
range-low | number | Lower range boundary |
range-max | number | |
range-min | number | |
timezone | TimeZone | Time zone for time axis |
timezoneoffset | number | Time zone offset for date time axis |
verticalscrollable | boolean | |
verticalscrollable | boolean | Defines if plot displays vertical scrollbars |
viewcache | boolean | Define view cache for tracks |
Constructors
• new WellLogWidget(options?)
Create WellLogWidget
| Name | Type | Description |
|---|---|---|
Optional options | Options | options to pass |
BaseWidget.constructor
Methods
▸ addBaseLayer(baseLayer): WellLogWidget
Add baseLayer to container
this
▸ addChild(node): WellLogWidget
Add a child node
this
▸ addCssClass(cssclass): WellLogWidget
Adds new css class to node
| Name | Type | Description |
|---|---|---|
cssclass | string | string[] | css class name('s) |
this
▸ addInvalidateHandler(handler): WellLogWidget
Add invalidate handler
Deprecated
since 4.0, use Node.on instead
| Name | Type | Description |
|---|---|---|
handler | Function | handler to be notified about invalidation |
this
BaseWidget.addInvalidateHandler
▸ addOverlay(overlay): WellLogWidget
Add overlay to container
this
▸ addTrack(track): StackedTrack
Add a track
| Name | Type | Description |
|---|---|---|
track | StackedTrack | track type |
▸ addTrack(track): LogTrack
Add a track
Example
import {TrackType} from '@int/geotoolkit/welllog/TrackType';
widget.addTrack(TrackType.LinearTrack);Example
// index tracks has 'INDEX_TRACK' css class defined, so it can be used to modify style with css:
widget.getTrackContainer().setCss('*[cssclass="INDEX_TRACK"] { visible: false; }');
// or differ it from another tracks:
if (track.getCssClass() === 'INDEX_TRACK') {
// do smth
}| Name | Type | Description |
|---|---|---|
track | InsertTrack | track or tracks to insert |
track to be added. if multiple tracks wree passed to this method, only the fisrt one will be returnes
▸ adjustPosition(area?, vAlign?, hAlign?): WellLogWidget
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): WellLogWidget
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
BaseWidget.applyResponsiveStyle
▸ beginExport(): WellLogWidget
Prepares object before exporting and saving state
this
▸ changeBaseLayerOrder(overlay, order, anchor?): WellLogWidget
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
BaseWidget.changeBaseLayerOrder
▸ changeChildOrder(node, order, anchor?): WellLogWidget
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?): WellLogWidget
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
▸ changeTrackOrder(track, order, anchor?): WellLogWidget
changes the layout order of the tracks being rendered.
| Name | Type | Description |
|---|---|---|
track | LogTrack | child track in the WellLogWidget |
order | NodeOrder | position to be added |
Optional anchor | LogTrack | anchor track to specify changeOrder with respect to this track |
this
▸ 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?): WellLogWidget
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(): WellLogWidget
Clear cache
this
▸ clearChildren(disposeChildren?): WellLogWidget
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
▸ clearOverlays(disposeOverlays?): WellLogWidget
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
▸ clearTracks(disposeTracks?): WellLogWidget
Remove all tracks from this widget
| Name | Type | Description |
|---|---|---|
Optional disposeTracks | boolean | automatically dispose tracks. If it is true then method dispose is called for each track. |
this
All subclasses should override copyConstructor or provide custom implementation for this method
clone
▸ connect(object, orientation?): WellLogWidget
Synchronizes axis or group with a track container model
| Name | Type | Description |
|---|---|---|
object | Axis | Group<Node> | object to connect to the central component |
Optional orientation | Orientation | model orientation |
▸ connectStyle(style, type, callback): WellLogWidget
Connects style.<br> <br> This convenience method subscribes a listener to given style for the specified type.<br> 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
▸ connectTool(tool): WellLogWidget
Connect a new tool with a toolname to the widget
| Name | Type | Description |
|---|---|---|
tool | AbstractTool | AbstractTool[] | tool associated with the widget |
this
▸ Protected copyConstructor(src, deepCopy?): WellLogWidget
Copy constructor function.<br> Function used as part of the cloning mechanism.<br> Implementations should copy the given instance state to this instance.<br>
this
▸ disconnectStyle(style, type, callback): WellLogWidget
Disconnect style <br> This convenience method un-subscribes a listener to given style for the specified type.<br>
| Name | Type | Description |
|---|---|---|
style | EventDispatcher | connect style |
type | string | type of event or property |
callback | AttributeCallback<EventDispatcher> | function to be called |
this
▸ disconnectTool(tool): WellLogWidget
Disconnect the tool from the widget
| Name | Type | Description |
|---|---|---|
tool | AbstractTool | AbstractTool[] | tool to disconnect |
this
▸ dispose(): void
Dispose node. Clear all listeners and disconnect style to avoid memory leaks
void
▸ Protected drawBorder(localContext, bounds?): WellLogWidget
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): WellLogWidget
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): WellLogWidget
Enable event propagation from the node hierarchy from bottom to top <p> 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. </p>
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
BaseWidget.enableEventPropagation
▸ enablePickingChildren(enable): WellLogWidget
Enables or disables picking children
| Name | Type | Description |
|---|---|---|
enable | boolean | enable picking children |
this
BaseWidget.enablePickingChildren
▸ endExport(): void
Used to restore object's state after exporting
void
▸ 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): WellLogWidget
Executes delegate and return the result. It allows us to keep all initialization calls in one place, <br> 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: WellLogWidget) => void | Function to execute |
The result if any or this
▸ execute<T>(delegate): T
| Name |
|---|
T |
| Name | Type |
|---|---|
delegate | (this: WellLogWidget) => T |
T
▸ exportToPdf(options?): Promise<IWritable>
Exports the widget content as a PDF file, user has option to select the scale of track in pdf.
| Name | Type | Description |
|---|---|---|
Optional options | ExportToPdfOptions | option to specify paper parameters and header and footer |
Promise<IWritable>
promise with output stream
▸ Protected filter(context): boolean
Filter node
| Name | Type | Description |
|---|---|---|
context | RenderingContext | Rendering Context |
boolean
flag filter flag ("true" to render node; "false" otherwise)
▸ fitToHeight(height?): WellLogWidget
Display the whole scene graph. Resets the zoom level/scale to fit the whole tracks height in the visible area
| Name | Type | Description |
|---|---|---|
Optional height | number | optional height to fit to |
this
▸ fitToWidth(width?): WellLogWidget
Resize widget width to fit it in visible area
Example
widget.addTrack(TrackType.IndexTrack)
// declare width constraints for particular track
.setLayoutStyle({
'minwidth': 50,
'maxwidth': 50
});
widget.addTrack(TrackType.LinearTrack);
...
widget.fitToWidth();| Name | Type | Description |
|---|---|---|
Optional width | number | optional width to fit to |
this
▸ forEachVisual(callback): void
Enumerate each visual in track container
| Name | Type | Description |
|---|---|---|
callback | (item: Node) => void | callback method |
void
▸ getAnimationStyle(): AnimationStyle
Return animation style
animationStyle current animation style
▸ getAnnotation(location): Group<Node>
Gets annotation at specified location
| Name | Type | Description |
|---|---|---|
location | string | Enum of annotation locations used to specify direction to insert |
▸ 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
BaseWidget.getAutoModelLimitsMode
▸ getAutoModelLimitsStrategy(): ModelLimitsStrategy
Get Model Limits Logics Strategy
strategy
BaseWidget.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
▸ getBounds(): Rect
Get the bounds in the parents model space. If bounds are not set, then parent model limits are used.
current bounds
▸ 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
▸ getContentOrientation(): Orientation
Return content orientation
content orientation
BaseWidget.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
<code>getContentsTransform()</code> retrieves the world transformation of the node.
transformation from model coordinates to bounds of the group
BaseWidget.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
▸ getData(): AbstractDataTable | DataSource
returns data source
AbstractDataTable | DataSource
▸ getDataBinding(): DataBinding | DataBindingRegistry
Return the data binding
DataBinding | DataBindingRegistry
▸ getDepthLimits(): Range
Returns depth range.
Example
// In order to get difference between depths in px, you can get depth scale (or it can be time scale) from widget. Specify your depth unit and device unit 'px'. Then divide
// your depth range by scale and you get depth distance in pixels. See the following code:
const scale = widget.getDepthScale('m', 'px'); // meter to pixel
const size = widget.getDepthLimits().getSize() / scale;▸ getDepthLimitsOptions(): DepthLimitsOptionsOut
Returns depth limits options
depth limits options
▸ getDepthMarkers(): DepthMarkersOut
Return Depth Marker settings
depth markers
▸ getDepthScale(scaleUnit?, deviceUnit?): number
Return scale to device. How many scale units in one device unit.
Example
// to get the current depth scale of welllog widget.
import {UnitFactory} from '@int/geotoolkit/util/UnitFactory';
const uf = UnitFactory.getInstance();
widget.getDepthScale(uf.getUnit('cm'), uf.getUnit('cm'));| Name | Type | Description |
|---|---|---|
Optional scaleUnit | string | AbstractUnit | scale unit of the display. if it is not specified then it takes from track container |
Optional deviceUnit | string | AbstractUnit | device unit of the display. if it is not specified then it takes from track container |
number
a index scale to device or NaN if scale if not available
▸ 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)
▸ getDeviceLimits(): Rect
Return device limits
▸ getDeviceUnit(): AbstractUnit
Gets device unit
unit
▸ getExportElement(options?): AbstractDocumentElement
Returns exportable element
| Name | Type | Description |
|---|---|---|
Optional options | ExportToPdfOptions | export options |
return exportable element
▸ getFillStyle(): FillStyle
Return fill style
fillStyle current fill style
▸ getFooterContainer(): HeaderContainer<Node>
Returns footer container. Note that container's bounds are not necessary match with its visible limits as it can reside in other container. To get/set device footer size, use get/set FooterHeight() method
HeaderContainer<Node>
▸ getFooterHeight(options?): number
Returns actual footer height or model height whenever 'auto' is specified
| Name | Type | Description |
|---|---|---|
Optional options | string | header options, |
number
▸ getFooterScrollVisible(): boolean
Gets visibility flag for the footer header scroll bar
boolean
▸ getHeaderContainer(): HeaderContainer<Node>
Returns header container. Note that container's bounds are not necessary match with its visible limits as it can reside in other container. To get/set device header size, use get/set HeaderHeight() method
HeaderContainer<Node>
▸ getHeaderHeight(options?): number
Returns actual header height or model height whenever 'auto' is specified
| Name | Type | Description |
|---|---|---|
Optional options | string | header options |
number
▸ getHeaderScrollVisible(): boolean
Gets visibility flag for the header scroll bar
boolean
▸ getHighlightFillStyle(): FillStyle
get track highlight fillstyle
track background highlight fillstyle
▸ getHighlightLineStyle(): LineStyle
get border highlight line style
border line style for the track in 'highlighted' mode
▸ getHighligtedVisuals(track?): LogAbstractVisual[]
Return higlighted node for specified track
| Name | Type | Description |
|---|---|---|
Optional track | LogTrack | track to check higlighthed visuals otherwise will retun all highlighted visuals in widget |
▸ getId(): string | number
Returns the associated identifier of the node
string | number
The node's id
▸ getIndexType(): "time" | "depth" | IndexType
Gets index type
"time" | "depth" | IndexType
type
▸ getIndexUnit(): AbstractUnit
Returns unit of the measure to be used to display scale in the header
▸ getInfiniteMode(): boolean
Return infinity mode flag
boolean
flag
▸ Protected getInvalidateMethod(): AttributeCallback<EventDispatcher>
Gets invalidate method
AttributeCallback<EventDispatcher>
method to invalidate this object
BaseWidget.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.
▸ getMarginsStyle(): SpaceStyle<string | number>
Return margins style
SpaceStyle<string | number>
▸ getMarkerFillStyle(): FillStyle
Return marker fill style
current fill style
▸ getMarkerLineStyle(): LineStyle
Return marker line style
current marker line style
▸ getMarkerSymbol(): SymbolShape
Returns symbol to be used to draw depth index markers
▸ 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
BaseWidget.getOpacityBlendMode
▸ getOptions(): OptionsOut
Returns widget options It is a same as getProperties
▸ getOrientation(): Orientation
Returns widget orientation
widget orientation
▸ 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
▸ getOverlayLayer(): Layer<Node>
Returns manipulator overlay to draw shapes that should move with the model
▸ 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
properties object
▸ 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
▸ getResponsiveStyle(): ResponsiveStyle
Return responsive style
▸ getRoot(): Node
Returns root node. <br> If node doesn't have parent then it returns itself.
the root node
▸ getScaleScrollStrategy(): Delegate
Gets ScaleScrollStrategy ("undefined" by default)
ScaleScrollStrategy (see "setScaleScrollStrategy" description for more info)
BaseWidget.getScaleScrollStrategy
▸ getScaleUnit(): AbstractUnit
Returns unit of the measure to be used to display scale in the header
Deprecated
since 4.1 Use getIndexUnit instead
▸ getSceneTransform(): Transformation
Returns transformation from node to root scene
a transformation from node to root scene
▸ getSelectedTracks(): LogTrack[]
return selected track collection
LogTrack[]
▸ getSelectedVisuals(track?): Node[]
Return an array of the selected visuals for the specified track. if track is not specified then all selected visuals are returned. This method is a helper method and uses selected visuals from 'pick' tool. The code below shows how to get access to all selected tracks and visuals instead
| Name | Type | Description |
|---|---|---|
Optional track | LogTrack | track to return selected visuals specified by node filter |
Node[]
▸ getTag(): any
Returns the object associated with the node by user.
any
The node's user-object
▸ getTool(): CompositeTool
Returns root tool associated to this widget
▸ getToolByName<T>(toolName): Tools[T]
Returns the tool matching the given name.<br> This function also accepts tool 'path' instead of absolute name.<br> For example:<br> getToolByName("compositeTool.panningTools.trackPanning.TrackPanning")<br> Would return the same tool as <br> getToolByName("TrackPanning")<br> As long as there is only one tool named "TrackPanning" in this composite<br> See listToolsNames()<br>
| Name | Type |
|---|---|
T | extends string |
| Name | Type | Description |
|---|---|---|
toolName | T | The tool name or path |
Tools[T]
▸ getToolByType(toolType): AbstractTool
Returns the tool matching the given type. or null if nothing is matching the tool type<br> For example:<br> getToolByType(geotoolkit.controls.tools.Selection)<br> Would return the same tool as<br> getToolByName("pick")<br>
| Name | Type | Description |
|---|---|---|
toolType | ClassType<any> | toolType of the tool |
▸ getTrack(index): LogTrack
Returns LogTrack at specified index
| Name | Type | Description |
|---|---|---|
index | number | index to return track at |
▸ getTrackAt(index): LogTrack
Returns LogTrack at specified index
Deprecated
since 4.2 use getTrack instead
| Name | Type | Description |
|---|---|---|
index | number | index to return track at |
▸ getTrackAtPosition(x, y): LogTrack
Returns track at specified position in plot coordinate
| Name | Type | Description |
|---|---|---|
x | number | x coordinate position |
y | number | y coordinate position |
▸ getTrackAtPosition(point): LogTrack
| Name | Type |
|---|---|
point | Point |
▸ getTrackContainer(): LogTrackContainer
▸ getTrackFactory(): TrackFactory
Returns track factory
track factory
▸ getTrackFooter(track): LogTrackHeader
Returns the track footer if it exists
| Name | Type | Description |
|---|---|---|
track | LogTrack | current welllog track |
▸ getTrackHeader(track): LogTrackHeader
Returns the track header if it exists
| Name | Type | Description |
|---|---|---|
track | LogTrack | current welllog track |
▸ getTrackIndex(track): number
Return index of track
Deprecated
since 4.2 use indexOfTrack instead
| Name | Type | Description |
|---|---|---|
track | LogTrack | to get index |
number
index of the track
▸ getTrackManipulatorLayer(): Layer<Node>
Returns manipulator overlay to draw temporary shapes on top of the track container
▸ getTrackOptions(track): TrackOptionsOut
Returns track options
| Name | Type | Description |
|---|---|---|
track | LogTrack | track to get options |
track options
▸ getTrackRenderDirection(): TrackRenderDirection
Get track render direction
▸ getTracks(filter?, modify?): Iterator<LogTrack>
Return iterator by child tracks
| Name | Type | Description |
|---|---|---|
Optional filter | (node: LogTrack) => boolean | a filter function. Returns all tracks if null |
Optional modify | boolean | An option to specify if the iterator supports adding/removing items from the collection. false by default. |
▸ getTracksCount(): number
Returns amount of tracks
number
amount of tracks
▸ getTracksSize(): number
Calculate a real size of tracks
number
total width of the tracks
▸ getVisible(): boolean
Return visibility of the node
boolean
true if node is visible
▸ getVisibleDepthLimits(): Range
Return a depth range, which is visible now
▸ getVisibleDeviceLimits(ignoreModelLimits?): Rect
Return visible device limits
| Name | Type | Description |
|---|---|---|
Optional ignoreModelLimits | boolean | flag defines whether to ignore ModelLimits or not |
BaseWidget.getVisibleDeviceLimits
▸ getVisibleModelLimits(ignoreModelLimits?): Rect
Return visible model limits
| Name | Type | Description |
|---|---|---|
Optional ignoreModelLimits | boolean | flag defines whether to ignore ModelLimits or not |
BaseWidget.getVisibleModelLimits
▸ getWorldTransform(): Transformation
Retrieves the local transformation of the node which represents multiplication of parent to bounds and contents transformations.
▸ 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
▸ highlightVisual(visual, highlight): WellLogWidget
Highlights a visual or track. Called whenever a visual is selected to highlight it. <br> If user selects a curve and the track, the curve,track and header are highlighted. Programmatically deselecting a track doesn't automatically deselect curves.<br> Deselect all selected tracks and visuals using the example shown below.
Example
const selector = widget.getToolByName('pick');
const currentSelection = selector.getSelection();
currentSelection.forEach((visual) => {
widget.highlightVisual(visual, false);
});| Name | Type | Description |
|---|---|---|
visual | Node | The visual to highlight |
highlight | boolean | the status of the highlight |
this
▸ Protected highlightVisualHeader(visual, highlight): void
Highlights header for the specified visual (if header exists)
| Name | Type | Description |
|---|---|---|
visual | Node | a reference visual |
highlight | boolean | boolean value that indicating whether the header must be highlighted or de-highlighted |
void
▸ 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
▸ indexOfTrack(track): number
Return index of track
| Name | Type | Description |
|---|---|---|
track | LogTrack | to get index |
number
index of the track
▸ Protected initializeTools(options?): WellLogWidget
Function call in the constructor to initialize tools in the widget
| Name | Type | Description |
|---|---|---|
Optional options | Object | tools options |
Optional options.crosshair | &quot;none&quot; | Options | JSON which defines crosshair cursor |
Optional options.cursortracking | Object | cursor tracking options |
Optional options.cursortracking.crosshair | Options | JSON which defines crosshair cursor. |
Optional options.cursortracking.enabled | boolean | enabled state |
Optional options.cursortracking.multitooltip | Options | JSON which defines multi visual tooltip tool. |
Optional options.cursortracking.tooltip | Options | JSON which defines single visual tooltip tool. |
Optional options.cursortracking.tooltipregistry | LogToolTipRegistry | Default registry for tool tip formatters, can be overridden by tooltip settings |
Optional options.horizontal-splitter | &quot;none&quot; | { enabled: boolean } | horizontal splitter options |
Optional options.tracksplitter | Options | tracks splitter options |
this
▸ insertBaseLayer(index, baseLayer): WellLogWidget
Insert child baseLayer at specified index
| Name | Type | Description |
|---|---|---|
index | number | specified index |
baseLayer | Node | a baseLayer to add |
this
▸ insertChild(index, node): WellLogWidget
Insert child node at specified index
| Name | Type | Description |
|---|---|---|
index | number | specified index |
node | Node | a child node to add |
this
▸ insertOverlay(index, overlay): WellLogWidget
Insert child overlay at specified index
| Name | Type | Description |
|---|---|---|
index | number | specified index |
overlay | Node | a overlay to add |
this
▸ insertTrack(index, track): StackedTrack
Insert track to the container at specified index
| Name | Type | Description |
|---|---|---|
index | number | index of the track |
track | StackedTrack | track type |
▸ insertTrack(index, track): LogTrack
Insert track to the container at specified index
| Name | Type | Description |
|---|---|---|
index | number | index of the track |
track | InsertTrack | track or tracks to be inserted |
▸ invalidate(bounds?, force?): WellLogWidget
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?): WellLogWidget
Notify that layout is invalidated. Send event Events.LayoutInvalidated
| Name | Type | Description |
|---|---|---|
Optional propagate | boolean | propagate invalidate layout to parent |
this
▸ invalidateParent(bounds?, force?): WellLogWidget
Invalidate parent area
| Name | Type | Description |
|---|---|---|
Optional bounds | Rect | area to invalidate |
Optional force | boolean | force |
this
▸ isAttachedHeaders(): boolean
Return true if headers and footers are attached to track
boolean
▸ isClippingEnabled(): boolean
Returns if clipping is enabled or not for this node.
boolean
▸ isDisposed(): boolean
Returns whether this object has been disposed
boolean
▸ isEventPropagationEnabled(): boolean
Return true if event propagation is enabled from child to parent
boolean
BaseWidget.isEventPropagationEnabled
▸ isHorizontalFlip(): boolean
Return true if the representation is flipped horizontally
boolean
flip
▸ isLayoutInvalidated(): boolean
Return true if layout is invalid
boolean
BaseWidget.isLayoutInvalidated
▸ isNotificationEnabled(): boolean
return state of notification
boolean
current notification state
BaseWidget.isNotificationEnabled
▸ isPickingChildrenEnabled(): boolean
Returns if picking children is enabled or not for this node.
boolean
pickingChildren
BaseWidget.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
▸ isVisialHighlighted(visual): boolean
Retrun hightlighed state
| Name | Type | Description |
|---|---|---|
visual | LogAbstractVisual | The visual to check the state |
boolean
highlighted state
▸ listToolsNames(): string[]
List all the tools contained in this composite. Prepend their parent tools parent using a '.'.
string[]
▸ loadTemplate(template, registry?): WellLogWidget
Load template
Throws
when template not supported
| Name | Type | Description |
|---|---|---|
template | string | template to be applied to the widget |
Optional registry | Registry | registry |
this
▸ moveTo(area, vAlign?, hAlign?): WellLogWidget
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>(event, source, args?): WellLogWidget
Notify listeners of the Node
| Name | Type |
|---|---|
E | extends string |
| Name | Type | Description |
|---|---|---|
event | E | type of event |
source | Node | 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?): WellLogWidget
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: WellLogWidget, args: EventMap[E]) => void | function to be called |
this
▸ on<E>(type, callback): WellLogWidget
Attach listener on event that will be called whenever the specified event is delivered to the target <p> If the callback function is already in the list of event listeners for this target, the function is not added a second time. </p> <p> 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. </p>
| Name | Type |
|---|---|
E | extends string |
| Name | Type | Description |
|---|---|---|
type | E | type of event or property |
callback | (eventType: E, sender: WellLogWidget, args: EventMap[E]) => void | to be called |
this
▸ Protected onBoundsChanged(bounds): WellLogWidget
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): WellLogWidget
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
BaseWidget.onVisibilityChanged
▸ panToTrack(track?, index?, alignment?): WellLogWidget
Pans view to track with specified alignment and option depth. If depth is not specified, the middle of the track is used
| Name | Type | Description |
|---|---|---|
Optional track | LogTrack | track to scroll |
Optional index | number | depth or time of the specified track. if it is null it doesn't move in this direction. |
Optional alignment | string | alignment of specified point according to container visible limits. |
▸ 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?): WellLogWidget
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
BaseWidget.registerAnimationStyle
▸ removeBaseLayer(baseLayer): WellLogWidget
Remove child baseLayer
this
▸ removeChild(node, disposeChildren?): WellLogWidget
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): WellLogWidget
Removes css class from node
| Name | Type | Description |
|---|---|---|
cssclass | string | string[] | css class name('s) |
this
▸ removeInvalidateHandler(handler): WellLogWidget
Remove invalidate handler
Deprecated
since 4.0, use Node.off instead
| Name | Type | Description |
|---|---|---|
handler | Function | handler to be notified about invalidation |
this
BaseWidget.removeInvalidateHandler
▸ removeOverlay(overlay): WellLogWidget
Remove child overlay
this
▸ removeTrack(track, disposeTrack?): WellLogWidget
Remove the track with headers and footers
| Name | Type | Description |
|---|---|---|
track | LogTrack | track to remove |
Optional disposeTrack | boolean | automatically dispose track. If it is true then method dispose is called for track. |
▸ 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): WellLogWidget
Render background
| Name | Type | Description |
|---|---|---|
context | RenderingContext | context to render background |
bounds | Rect | group bounds |
this
▸ Protected renderBaseLayers(context): WellLogWidget
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
BaseWidget.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
BaseWidget.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
▸ Protected renderOverlays(context): WellLogWidget
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
BaseWidget.renderOverlaysAsync
▸ resumeUpdate(rebuild?, changes?): WellLogWidget
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): WellLogWidget
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
▸ saveTemplate(registry?, options?): string
Save template
string
return template as a string
▸ scale(scaleY, scaleX?): WellLogWidget
Change scale
| Name | Type | Description |
|---|---|---|
scaleY | number | scaleY |
Optional scaleX | number | scaleX |
this
▸ scrollToIndex(index, position?, enableAnimation?): WellLogWidget
Scroll to index position
| Name | Type | Description |
|---|---|---|
index | number | index to scroll to |
Optional position | ScrollToLocation | position to scroll to |
Optional enableAnimation | boolean | show animation or not |
this
▸ setAnimationStyle(animationStyle): WellLogWidget
Sets animation style
| Name | Type | Description |
|---|---|---|
animationStyle | Type | animation style |
▸ setAnnotationSize(annotationSizes): WellLogWidget
Set annotation sizes
| Name | Type | Description |
|---|---|---|
annotationSizes | AnnotationSizes | annotation sizes |
this
▸ setAttachedHeaders(enable): WellLogWidget
Attach or detach header and footer
| Name | Type | Description |
|---|---|---|
enable | boolean | enable or disable attached headers |
this
▸ setAutoModelLimitsMode(mode): WellLogWidget
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
BaseWidget.setAutoModelLimitsMode
▸ setAutoModelLimitsStrategy(strategy): WellLogWidget
Set Model Limits Logics Strategy
| Name | Type | Description |
|---|---|---|
strategy | ModelLimitsStrategy | Model Limits logic strategy to use |
this
BaseWidget.setAutoModelLimitsStrategy
▸ setAxisHeaderType(headerType, containers?): WellLogWidget
Sets the axis header type
| Name | Type | Description |
|---|---|---|
headerType | HeaderType | The axis header type enum. |
Optional containers | HeaderContainer<Node>[] | optional array of header containers. if not specified, the header and footer container is used. |
▸ setBounds(bounds): WellLogWidget
Sets bounds of the node in the parent coordinates
this
▸ setCache(cache, rebuild?): WellLogWidget
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): WellLogWidget
Replace child node by index
| Name | Type | Description |
|---|---|---|
index | number | index of the node |
node | Node | node |
this
▸ setClipStyle(style): WellLogWidget
Sets a new clipping style
| Name | Type | Description |
|---|---|---|
style | GraphicsPath | ClipStyle | Options | a new clipping style |
this
▸ setContentOrientation(orientation): WellLogWidget
Set content orientation
| Name | Type | Description |
|---|---|---|
orientation | Orientation | content orientation |
this
BaseWidget.setContentOrientation
▸ setCss(style, merge?): WellLogWidget
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): WellLogWidget
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): WellLogWidget
Set CSS transformation
| Name | Type | Description |
|---|---|---|
transform | string | Transformation | transformation css transformation instruction or Transformation instance |
this
▸ setData(data): WellLogWidget
Sets a new data model
| Name | Type | Description |
|---|---|---|
data | AbstractDataTable | DataSource | logdata |
this
▸ setDataBinding(binding, silent?): WellLogWidget
Sets the data binding
| Name | Type | Description |
|---|---|---|
binding | DataBinding | DataBindingRegistry | data binding |
Optional silent | boolean | silent mode to forbid |
this
▸ setDepthLimits(minIndex, maxIndex, keepVisibleLimits?): WellLogWidget
Sets depth limits for all tracks
Example
// full depth limits or scrollable limits of your widget can be set as follows:
widget.setDepthLimits(minDepth, maxDepth);| Name | Type | Description |
|---|---|---|
minIndex | number | min index limit |
maxIndex | number | max index limit |
Optional keepVisibleLimits | boolean | if specified and true than system will try to keep visible limits |
▸ setDepthLimits(range, keepVisibleLimits?): WellLogWidget
Sets depth limits for all tracks
| Name | Type | Description |
|---|---|---|
range | Range | depth rang |
Optional keepVisibleLimits | boolean | if specified and true than system will try to keep visible limits |
▸ setDepthLimitsOptions(options): WellLogWidget
Set depth limits options
| Name | Type | Description |
|---|---|---|
options | DepthLimitsOptions | auto depth limits options |
▸ setDepthMarkers(depths, lineStyle?, fillStyle?, symbolShape?): WellLogWidget
Set single depth marker or markers set
| Name | Type | Description |
|---|---|---|
depths | number | number[] | DepthMarkers | depths marker value or options, null to hide all markers |
Optional lineStyle | Type | line style |
Optional fillStyle | Type | fill style |
Optional symbolShape | SymbolShape | symbol shape, applicable only to single depth |
this
▸ setDepthScale(scale, scaleUnit?, deviceUnit?): WellLogWidget
Sets a depth scale factor.
Throws
Will throw an error if the current scale is NaN
Example
// To set depth scale range as a ratio, you can use units as follows
import {UnitFactory} from '@int/geotoolkit/util/UnitFactory';
const unitFactory = UnitFactory.getInstance();
widget.setDepthScale(30, unitFactory.getUnit('feet'), unitFactory.getUnit('inch')); //1 inch == 30 feet| Name | Type | Description |
|---|---|---|
scale | number | A number of depth units in device unit. |
Optional scaleUnit | string | AbstractUnit | scale unit of the display. if it is not specified then it takes from track container |
Optional deviceUnit | string | AbstractUnit | device unit of the display. if it is not specified then it takes from track container |
this
▸ setDesiredHeight(value, silent?): WellLogWidget
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?): WellLogWidget
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
▸ setDeviceUnit(unit): WellLogWidget
Sets device unit
| Name | Type | Description |
|---|---|---|
unit | string | AbstractUnit | device unit |
this
▸ setFillStyle(fillStyle, merge?): WellLogWidget
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
▸ setFooterHeight(height): WellLogWidget
Sets footer height
| Name | Type | Description |
|---|---|---|
height | number | &quot;auto&quot; | footer height in pixels or 'auto' to fit footer height |
this
▸ setFooterScrollVisible(value): WellLogWidget
Sets footer scrollbar visibility flag
| Name | Type | Description |
|---|---|---|
value | boolean | visibility flag |
this
▸ setHeaderHeight(height): WellLogWidget
Sets header height
| Name | Type | Description |
|---|---|---|
height | number | &quot;auto&quot; | header height in pixels or 'auto' to fit header height |
this
▸ setHeaderScrollVisible(value): WellLogWidget
Sets header scrollbar visibility flag
| Name | Type | Description |
|---|---|---|
value | boolean | visibility option |
this
▸ setHighlightFillStyle(fillstyle): WellLogWidget
change highlight fillstyle
| Name | Type | Description |
|---|---|---|
fillstyle | FillStyle | highlight fillstyle |
▸ setHighlightLineStyle(linestyle): WellLogWidget
change highlight linestyle
| Name | Type | Description |
|---|---|---|
linestyle | LineStyle | highlight linestyle |
▸ setHorizontalFlip(enable): WellLogWidget
Set horizontal flip of the representation
| Name | Type | Description |
|---|---|---|
enable | boolean | enable flip |
this
▸ setId(id): WellLogWidget
Allows the user to associate any identifier
| Name | Type | Description |
|---|---|---|
id | string | number | object id |
this
▸ setIndexType(type, unit?): WellLogWidget
Sets index type, user can provide index unit, otherwise specify unit with setIndexUnit method
| Name | Type | Description |
|---|---|---|
type | &quot;time&quot; | &quot;depth&quot; | IndexType | index type |
Optional unit | string | AbstractUnit | index unit |
▸ setIndexUnit(unit): WellLogWidget
Sets index unit
| Name | Type | Description |
|---|---|---|
unit | string | AbstractUnit | index unit |
this
▸ setInfiniteMode(infinityMode): WellLogWidget
Set infinity mode flag to draw composite without collision check
| Name | Type | Description |
|---|---|---|
infinityMode | boolean | infinity mode flag |
this
▸ setLayout(layout): WellLogWidget
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
BaseWidget.setLayoutInvalidated
▸ setLayoutStyle(layoutStyle, silent?, merge?): WellLogWidget
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?): WellLogWidget
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?): WellLogWidget
Sets local transformation to be used to transform from local to parent coordinate
| Name | Type | Description |
|---|---|---|
localTransform | Transformation | local transformation for this node |
Optional force | boolean | boolean flag to force update event if transformations are equal, false by default |
this
▸ setMarginsStyle(margins, merge?): WellLogWidget
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
▸ setMarkerFillStyle(fillStyle, merge?): WellLogWidget
Sets marker fill style
| Name | Type | Description |
|---|---|---|
fillStyle | Type | a new marker fill style |
Optional merge | boolean | true if you want to merge fillStyle with existing attribute, false by default |
this
▸ setMarkerLineStyle(lineStyle, merge?): WellLogWidget
Sets marker line style
| Name | Type | Description |
|---|---|---|
lineStyle | Type | marker line style or options |
Optional merge | boolean | true if you want to merge lineStyle with existing attribute, false by default |
this
▸ setMarkerSymbol(symbol): WellLogWidget
Sets symbol to be used to render depth index markers
| Name | Type | Description |
|---|---|---|
symbol | SymbolShape | symbols to be used for markers |
this
▸ setModelLimits(modelLimits): WellLogWidget
Sets the model limits of the node
| Name | Type | Description |
|---|---|---|
modelLimits | Rect | The model limits of the node |
this
▸ setName(name): WellLogWidget
Sets name of the node
| Name | Type | Description |
|---|---|---|
name | string | The node name |
this
▸ setNodeFilter(nodeFilter): WellLogWidget
Sets node filter for selection tool
| Name | Type | Description |
|---|---|---|
nodeFilter | (item: Node) => boolean | filter that allows to filter selected nodes. |
this
▸ setNotification(notify, force?): WellLogWidget
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?): WellLogWidget
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
▸ setOptions(options?): WellLogWidget
Sets widget options. The same as setProperties
Example
//call setOptions on widget after construction and change the default header size(84) as follows.
widgets.setOptions({
'header' : {
'height': 184
}
});| Name | Type | Description |
|---|---|---|
Optional options | Options | addition options |
▸ setOrientation(orientation): WellLogWidget
set widget orientation and apply rotation if needed.
| Name | Type | Description |
|---|---|---|
orientation | Orientation | widget orientation |
this
▸ setPaddingStyle(paddingStyle, merge?): WellLogWidget
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
▸ setParent(parent): WellLogWidget
Sets parent node. Don't call this method directly. It is internal method.
| Name | Type | Description |
|---|---|---|
parent | Node | a parent node |
this
▸ setProperties(properties?): WellLogWidget
Sets all the properties pertaining to this object
| Name | Type | Description |
|---|---|---|
Optional properties | Options | An object containing the properties to set |
▸ setProperty(name, value): WellLogWidget
Sets dynamic property by name
| Name | Type | Description |
|---|---|---|
name | string | property name |
value | any | property value |
this
▸ setRenderingFilter(filter): WellLogWidget
Sets filter to be applied before rendering and picking
| Name | Type | Description |
|---|---|---|
filter | IFilter | filter to set |
this
▸ setResponsiveStyle(style): WellLogWidget
Sets responsive style.
| Name | Type | Description |
|---|---|---|
style | Options | ResponsiveStyle | responsive style |
this
▸ setScaleScrollStrategy(scaleScrollStrategy, reset?): WellLogWidget
Sets scale scroll strategy.
| Name | Type | Description |
|---|---|---|
scaleScrollStrategy | Delegate | scaleScrollStrategy to set |
Optional reset | boolean | flag to reset previous transformation, true by default |
this
BaseWidget.setScaleScrollStrategy
▸ setSelectable(selectable): WellLogWidget
Allows to select node. If node is not selectable then child node is not selectable.
| Name | Type | Description |
|---|---|---|
selectable | boolean | flag to allow node selection |
this
▸ setSilent(bool): WellLogWidget
Set silent mode
| Name | Type | Description |
|---|---|---|
bool | boolean | flag to enable silent mode |
this
▸ setTag(tag): WellLogWidget
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
▸ Protected setTool(tool): WellLogWidget
Set root tool associated to this widget
| Name | Type | Description |
|---|---|---|
tool | CompositeTool | tool to be set |
▸ setTrackFactory(trackFactory): WellLogWidget
Sets track factory
| Name | Type | Description |
|---|---|---|
trackFactory | TrackFactory | track factory |
this
▸ setTrackOptions(track, options): LogTrack
Sets track options
Example
//The code to configure the gridlines in a log track, specify logdecades and generate multiple logticks
import {TrackType} from '@int/geotoolkit/welllog/TrackType';
widget.setTrackOptions(track, {
'type:': TrackType.LogTrack,
'value': {
'logstart': 0.2,
'logdecades': 4
}
});| Name | Type | Description |
|---|---|---|
track | LogTrack | log track |
options | TrackOptions | track options |
▸ setTrackRenderDirection(direction): WellLogWidget
Set track render direction
| Name | Type | Description |
|---|---|---|
direction | TrackRenderDirection | set track render direction |
▸ setTrackWidth(width, track): WellLogWidget
Set track width and layout remains track
Example
// To change tracks' size manually use:
widgets.setTrackWidth(width, track);this
▸ setVerticalFlip(flip): WellLogWidget
Set vertical flip of the representation
| Name | Type | Description |
|---|---|---|
flip | boolean | flag to set the vertical flip of the representation |
this
▸ setVisible(value): WellLogWidget
Sets visibility of the node. Send event Events.VisibilityChanged
| Name | Type | Description |
|---|---|---|
value | boolean | flag specifying visibility of the node |
this
▸ setVisibleDepthLimits(fromIndex, toIndex): WellLogWidget
Sets visible depth limits
| Name | Type | Description |
|---|---|---|
fromIndex | number | fromindex limit |
toIndex | number | toindex limit |
▸ setVisibleDepthLimits(range): WellLogWidget
| Name | Type |
|---|---|
range | Range |
▸ setVisibleModelLimits(visibleModelBounds, deviceBounds?): WellLogWidget
Set visible model limits
| Name | Type | Description |
|---|---|---|
visibleModelBounds | Rect | visible model limits or bounds |
Optional deviceBounds | Rect | device bounds |
this
BaseWidget.setVisibleModelLimits
▸ setZIndex(value): WellLogWidget
Sets z-index for node (set null for default)
| Name | Type | Description |
|---|---|---|
value | number | index determining node z-position |
this
▸ shear(shx, shy): WellLogWidget
Shear this node's bounds
| Name | Type | Description |
|---|---|---|
shx | number | x-axis shear |
shy | number | y-axis shear |
this
▸ suspendUpdate(): WellLogWidget
Suspend auto update
this
▸ toString(): string
Returns a string representation of this object (generally the classname)
string
A string representation
▸ translate(tx, ty): WellLogWidget
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
BaseWidget.unregisterAnimationStyle
▸ updateData(): WellLogWidget
Send event DataUpdating to update data.
Deprecated
since 4.0
this
▸ updateFooter(): void
Update footer
void
▸ updateHeader(): void
Update header
void
▸ updateLayout(targets?, updateScrollBarState?): WellLogWidget
Updates layout(s)
| Name | Type | Description |
|---|---|---|
Optional targets | ILayoutable[] | list of nodes to update layout |
Optional updateScrollBarState | boolean | update scroll bar flag |
this
▸ updateSceneTransformation(): WellLogWidget
Update scene transformation
this
BaseWidget.updateSceneTransformation
▸ updateScrollPositions(updateScrollBarState?, enableAnimation?): WellLogWidget
update Scroll Positions using visible limits and model limits.
| Name | Type | Description |
|---|---|---|
Optional updateScrollBarState | boolean | update Scroll Positions using visible limits and model limits or not |
Optional enableAnimation | boolean | show animation |
▸ updateState(regions?, changes?): WellLogWidget
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(): WellLogWidget
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
BaseWidget.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