API / geotoolkit / welllog / widgets / overlays / AnnotationOverlay / AnnotationOverlay
overlays.AnnotationOverlay.AnnotationOverlay
Creates default implementation of the welllog annotation overlay
Example
import {AnnotationOverlay, Events as OverlayEvents} from '@int/geotoolkit/widgets/overlays/AnnotationOverlay';
import {AnnotationOverlay as WellLogAnnotationOverlay} from '@int/geotoolkit/welllog/widgets/overlays/AnnotationOverlay';
import {LogTrack} from '@int/geotoolkit/welllog/LogTrack';
import {LogCurve} from '@int/geotoolkit/welllog/LogCurve';
import {Selector} from '@int/geotoolkit/selection/Selector';
const overlay = new WellLogAnnotationOverlay(widget, {
'annotationcontainer': 'geotoolkit-plot-host'
})
.on(OverlayEvents.CreateAnnotation, (event, sender, eventArgs) => {
const data = eventArgs.getAnnotation();
data['text'] = 'text';
data['symbol'] = 'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABGdBTUEAALGPC/xhBQAAAAlwSFlzAAAOwgAADsIBFShKgAAAABl0RVh0U29mdHdhcmUAcGFpbnQubmV0IDQuMC4xNkRpr/UAAAKqSURBVDhPbZNbSBNgFMc3CLJeIkENqQcpopceepAiKhFKIiWIAksXtbJ1UdEerAyym3azyFosA8W0FMrNNqcTvKBzWZuXzGreB8o0UtOMDO1iv84sszEf/vCdc/7n/33n/32fApgXB7QO/NVmAuLK2Z5hk9T8vHmTqkwbu++08mnyB1O/fhGf30VEWq2UfLk+CdV1K+EZDspa3pOiayI5y05p8yAx996yLbVSKN58ryA6vZawy41M/QRz83tO3m8i5X4LeXX9Up4mViciZ7xF/i3236hnT1YbA2NTZFe6KLT1U9/1kbrOEfQv3WSVdzP8+RtJ+Z3sOFcjLf8JaLR2wtObcPSNsy7BgnJ9DgujilgQUTADP1krN+YSrDJg6x0jVtvGrgzrjIgiKbeZDedfMvV9GlvHCJmmTswyf7Hdjf4vnsoJPJ7ctfRgbBz0NLLzVgv7shpQBMaZqWr7gL17lKvSXGIf5LG1j8L6/jnIOI8kZ5DazbIeTI0DOIQffLQMRZCmlA73ZzTZzSi35LFUbWRxrIFFgsWqkn/wk9j/sAnl1gI2p9aIV5OsTLSgiLndQIzuNa6hCUJTKlmwt5jlx8sIOmJi2ZHSGQTFmVhxzCxCBlbIhu2y4akiJ2uSK/44ufuKlcMP3jH29TtW5xAvuj/iGp7A6R4X8ji9It7iGqX6zRBf5I4v6LsIOGT0WDF3jVFpNWhynIiXXCx2ornrIMPYQfqzDpKym0jIfcW3n9PiUy+BB/80ewl4EHG2imjtGznFMCHRepSb8lCGPWRJZBFmMS65wEmw2iTUuR4vAQ88z/X0Exc9IxOckA+lzmygVcbQVblZHW8RijffK5hFxNlqGaedSTmyvGouGXpYm1AhK1+uT2IWkdeeE5JYyarECkJTqyU1Hw/Fb8Ss6LTDRVrLAAAAAElFTkSuQmCC';
data['options']['geometrytype'] = 'print-arrow';
const anchor = data['anchor'];
const target = data['target'];
if (target instanceof LogTrack) {
data['text'] = 'Track: ' + target.getName() + '<br/>' +
'Depth: ' + anchor.getY() + '<br/>';
const plotPoint = target.getSceneTransform().transformPoint(anchor);
const nodes = Selector.select(target.getRoot(), plotPoint.x, plotPoint.y, 2);
const logCurve = nodes.filter((node) => node instanceof LogCurve)[0];
if (logCurve != null) {
const rawValue = logCurve.getDataSource()
.getValueAt(anchor.getY(), 0, logCurve.getDataSource().getSize(), logCurve.getInterpolationType());
data['target'] = logCurve;
data['text'] = 'Curve: ' + logCurve.getName() + '<br/>' +
'Depth: ' + anchor.getY() + '<br/>' +
'Value: ' + rawValue.toFixed(2);
}
}
});AnnotationOverlay<WellLogWidget>↳
AnnotationOverlay
Constructors
- [new AnnotationOverlay(widget, options)](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit.welllog.widgets-4.overlays-1.annotationoverlay.annotationoverlay.md#new annotationoverlay(widget, options))
Methods
Constructors
• new AnnotationOverlay(widget, options?)
Creates annotation overlay
| Name | Type | Description |
|---|---|---|
widget | WellLogWidget | widget to create overlay |
Optional options | Options | annotation overlay options |
BaseAnnotationOverlay<WellLogWidget&gt;.constructor
Methods
▸ addAnnotation(annotation): IAnnotation
Add annotation
Throws
Error if annotation is null
| Name | Type | Description |
|---|---|---|
annotation | IAnnotation | Annotation | annotation object |
AnnotationOverlay.addAnnotation
▸ clearAnnotations(silent?): AnnotationOverlay
Clear annotations
| Name | Type | Description |
|---|---|---|
Optional silent | boolean | silent mode, default is true |
AnnotationOverlay.clearAnnotations
▸ dispose(): void
Disposes this node, once disposes a node should not be used anymore.<br> Clear all listeners, and disconnect styles to avoid memory leaks.<br> Also aggressively 'cleanup' this node by setting some of its members to null.
void
▸ editAnnotation(annotation): AnnotationOverlay
Edit annotation, by default it starts embedded TextArea editor
| Name | Type | Description |
|---|---|---|
annotation | IAnnotation | annotation to edit |
this
AnnotationOverlay.editAnnotation
▸ getActiveAnnotation(): IAnnotation
Return active annotation
annotation
AnnotationOverlay.getActiveAnnotation
▸ getAnnotations(filter?): Iterator<IAnnotation>
Return iterator by child nodes
| Name | Type | Description |
|---|---|---|
Optional filter | (item: IAnnotation) => boolean | a filter function. Returns all nodes if null |
Iterator<IAnnotation>
AnnotationOverlay.getAnnotations
▸ getClassName(): string
string
AnnotationOverlay.getClassName
▸ getCss(): CssStyle
Return CSS style
▸ getEditorContainer(): HTMLElement
Returns HTML container with inline editors
HTMLElement
HTMLElement
AnnotationOverlay.getEditorContainer
▸ getEnabled(): boolean
Return enabled state
boolean
enabled state
▸ Protected getModel(): Group<Node>
▸ getOptions(): OptionsType
Return options
object
▸ getVisible(): boolean
Return visibility state
boolean
visible state
▸ getWidget(): WellLogWidget
Returns widget
widget
▸ 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
AnnotationOverlay.hasEventListener
▸ isDisposed(): boolean
Returns whether this object has been disposed
boolean
▸ isSilent(): boolean
Return true if the event dispatcher doesn't notify any events
boolean
▸ notify<E>(type, source, args?): AnnotationOverlay
Notify listeners
| Name | Type |
|---|---|
E | extends string |
| Name | Type | Description |
|---|---|---|
type | E | event types |
source | AnnotationOverlay<WellLogWidget> | of the event |
Optional args | EventMap[E] | arguments of the event |
this
▸ off<E>(type?, callback?): AnnotationOverlay
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: AnnotationOverlay, args: EventMap[E]) => void | function to be called |
this
▸ on<E>(type, callback): AnnotationOverlay
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: AnnotationOverlay, args: EventMap[E]) => void | to be called |
this
▸ Protected onStateChanged(state): AnnotationOverlay
| Name | Type | Description |
|---|---|---|
state | &quot;Visible&quot; | &quot;Enabled&quot; | overlay state |
this
AnnotationOverlay.onStateChanged
▸ Protected onUpdateGeometry(): void
void
AnnotationOverlay.onUpdateGeometry
▸ removeAnnotation(annotation): AnnotationOverlay
Remove annotation
| Name | Type | Description |
|---|---|---|
annotation | IAnnotation | annotation to be removed |
this
AnnotationOverlay.removeAnnotation
▸ scrollToAnnotation(annotation): AnnotationOverlay
Scroll to annotation
| Name | Type | Description |
|---|---|---|
annotation | IAnnotation | annotation |
AnnotationOverlay.scrollToAnnotation
▸ setActiveAnnotation(annotation): AnnotationOverlay
Set active annotation
| Name | Type | Description |
|---|---|---|
annotation | IAnnotation | annotation |
AnnotationOverlay.setActiveAnnotation
▸ setCss(style, merge?): AnnotationOverlay
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
▸ setEnabled(enabled): AnnotationOverlay
Set enabled state
| Name | Type | Description |
|---|---|---|
enabled | boolean | enable or disable tools |
this
▸ setOptions(options): AnnotationOverlay
Set options
| Name | Type | Description |
|---|---|---|
options | OptionsType | options |
▸ setOrientation(orientation): AnnotationOverlay
Set orientation
| Name | Type | Description |
|---|---|---|
orientation | Orientation | overlay orientation |
this
AnnotationOverlay.setOrientation
▸ setSilent(bool): AnnotationOverlay
Set silent mode
| Name | Type | Description |
|---|---|---|
bool | boolean | flag to enable silent mode |
this
▸ setVisible(visible): AnnotationOverlay
Set visibility state
| Name | Type | Description |
|---|---|---|
visible | boolean | visibility of overlay |
this
▸ Static getClassName(): string
string
AnnotationOverlay.getClassName
▸ Static getGeometry(geometryName): Function
Return known geometry
| Name | Type | Description |
|---|---|---|
geometryName | string | geometry name |
Function
extension geometry extension
▸ Static registerGeometry(geometryName, extension): void
Register geometry extension
| Name | Type | Description |
|---|---|---|
geometryName | string | geometry name |
extension | Function | geometry extension |
void