API / geotoolkit / welllog / multiwell / MultiWellWidget / MultiWellWidget
multiwell.MultiWellWidget.MultiWellWidget
Type Aliases
Type Aliases
Ƭ EventMap<T>: EventMap<T> & { onDoubleClick: SelectionEventArgs ; onTracksSizeChanged: TrackEventArgs ; updating: { end: number ; scale: number ; start: number } ; visualsSelected: Node[] }
Ƭ ExportToPdfOptions: Object
option to specify paper parameters and header and footer
| Name | Type | Description |
|---|---|---|
deviceunit? | string | Unit | device unit |
documentfooter? | FooterComponent | an optional docuement PDF footer |
documentheader? | HeaderComponent | an optional document PDF footer |
embeddedfonts? | EmbeddedFont[] | array of embedded fonts |
footer? | FooterComponent | an optional PDF footer |
header? | HeaderComponent | an optional PDF header |
imagecompression? | { mode?: ImageCompression ; quality?: number ; speed?: SpeedCompression } | options to specify the image compression |
imagecompression.mode? | ImageCompression | image compression method used to exporting pdf. |
imagecompression.quality? | number | quality range from 0 to 1 that will express the jpeg image compression quality, available for jpeg mode only. |
imagecompression.speed? | SpeedCompression | speed referring to the png compression speed, available for png mode only. |
imagescalefactor? | number | options to specify the image scale factor, right now 8 is maximum, Math.floor(600 / 72) |
limits? | { x1?: number ; x2?: number ; y1?: number ; y2?: number } | Rect | export model limits |
output? | string | define optional output filename |
pdfstream? | IWritable | optional user-customized Stream object |
printsettings? | DocumentExportSettings | define optional paper and export parameters |
progress? | (currentPage: number, totalPages: number) => void | Callback to show export progress |
save? | boolean | flag to save the pdf directly to file or open dialog |
scalex? | number | scale by x from model units to pixels |
scaley? | number | scale by y from model units to pixels |
streamcompression? | boolean | enable or disable pdf output compression |
truescale? | boolean | true scale flag |
Ƭ Options: Options & OptionsBase
addition options
Ƭ OptionsBase: Object
| Name | Type | Description |
|---|---|---|
annotations? | { east?: Node[] ; north?: Node[] ; south?: Node[] ; west?: Node[] } | annotations properties for axes, titles |
annotations.east? | Node[] | an array of items to be inserted as annotations to east |
annotations.north? | Node[] | an array of items to be inserted as annotations to north |
annotations.south? | Node[] | an array of items to be inserted as annotations to south |
annotations.west? | Node[] | an array of items to be inserted as annotations to west |
annotationssizes? | { east?: number ; north?: number ; south?: number ; west?: number } | Properties to hold (width or height) of the annotations |
annotationssizes.east? | number | a size of east annotation |
annotationssizes.north? | number | a size of north annotation (if size is null it will be equal to header height if it is visible) |
annotationssizes.south? | number | a size of south annotation (if size is null it will be equal to footer height if it is visible) |
annotationssizes.west? | number | a size of west annotation |
attachedheaders? | boolean | attached well headers and footers |
autotrackslimits? | boolean | calculates content model limits based on tracks position as union |
autowellsoncorrelationtrack? | boolean | automatically sets left and right well for correlation track |
deviceunit? | AbstractUnit | string | device unit for content to apply scale |
footer? | { border?: { color?: string ; visible?: boolean } ; connected?: boolean ; height?: number | "auto" ; viewcache?: boolean ; viewcachesize?: { height?: number ; width?: number } ; visible?: boolean | "none" } | footer options |
footer.border? | { color?: string ; visible?: boolean } | defines properties for footer outer border |
footer.border.color? | string | color of border border |
footer.border.visible? | boolean | visibility of the border |
footer.connected? | boolean | Footers are connected to track (are part of the track) and zoomed and scrolled as a whole. The header must be created with a visible flag other than "none" in order to be activated later. |
footer.height? | number | "auto" | footer height |
footer.viewcache? | boolean | enable tiled cache. It increases rendering performance for historical data |
footer.viewcachesize? | { height?: number ; width?: number } | define view cache parameters |
footer.viewcachesize.height? | number | set tiled cache size. |
footer.viewcachesize.width? | number | set tiled cache size. |
footer.visible? | boolean | "none" | visibility of the footer. If it is 'none' then it is not created and cannot be switch to true or false later |
header? | { border?: { color?: string ; visible?: boolean } ; connected?: boolean ; height?: number | "auto" ; restrictmaxheadersize?: boolean ; viewcache?: boolean ; viewcachesize?: { height?: number ; width?: number } ; visible?: boolean | "none" } | header options |
header.border? | { color?: string ; visible?: boolean } | defines properties for header outer border |
header.border.color? | string | color of border border |
header.border.visible? | boolean | visibility of the border |
header.connected? | boolean | Headers are connected to track (are part of the track) and zoomed and scrolled as a whole. The header must be created with a visible flag other than "none" in order to be activated later. |
header.height? | number | "auto" | header height |
header.restrictmaxheadersize? | boolean | forbid the resizing of header container bigger than accumulated size of the track header. |
header.viewcache? | boolean | enable tiled cache. It increases rendering performance for historical data |
header.viewcachesize? | { height?: number ; width?: number } | define view cache parameters |
header.viewcachesize.height? | number | set tiled cache size. |
header.viewcachesize.width? | number | set tiled cache size. |
header.visible? | boolean | "none" | visibility of the headers. If it is 'none' then it is not created and cannot be switch to true or false later |
highlight? | { cssclass?: string ; fillstyle?: Type ; linestyle?: Type } | define highlight properties |
highlight.cssclass? | string | define highlight class name, see cssstyle.html tutorial |
highlight.fillstyle? | Type | define fill style attribute for visual highlight |
highlight.linestyle? | Type | define line style attribute for visual highlight |
horizontalscrollable? | boolean | "auto" | "floating" | defines if plot displays horizontal scrollbars |
indent? | number | indent between tracks |
indexunit? | AbstractUnit | string | model limits' unit in vertical direction |
nodefilter? | (item: Node) => boolean | node filter |
offscreentrackpanning? | number | a percent of how much track should remain in the visible space when panning a track |
orientation? | Orientation | orientation |
scroll? | { direction?: ScrollDirection | string ; footerverticalscroll?: { options?: Options ; size?: number ; type?: string ; visible?: boolean } ; headerverticalscroll?: { options?: Options ; size?: number ; type?: string ; visible?: boolean } ; trackhorizontalscroll?: { options?: Options ; size?: number ; type?: string ; visible?: boolean } ; trackverticalscroll?: { options?: Options ; size?: number ; type?: string ; visible?: boolean } } | optional scroll options |
scroll.direction? | ScrollDirection | string | scroll direction when using scroll wheel to scroll |
scroll.footerverticalscroll? | { options?: Options ; size?: number ; type?: string ; visible?: boolean } | footer container scroll option |
scroll.footerverticalscroll.options? | Options | scroll bar additional options |
scroll.footerverticalscroll.size? | number | scroll bar size |
scroll.footerverticalscroll.type? | string | scroll bar class type |
scroll.footerverticalscroll.visible? | boolean | scroll bar visibility flag |
scroll.headerverticalscroll? | { options?: Options ; size?: number ; type?: string ; visible?: boolean } | header container scroll option |
scroll.headerverticalscroll.options? | Options | scroll bar additional options |
scroll.headerverticalscroll.size? | number | scroll bar size |
scroll.headerverticalscroll.type? | string | scroll bar class type |
scroll.headerverticalscroll.visible? | boolean | scroll bar visibility flag |
scroll.trackhorizontalscroll? | { options?: Options ; size?: number ; type?: string ; visible?: boolean } | track container scroll option |
scroll.trackhorizontalscroll.options? | Options | scroll bar additional options |
scroll.trackhorizontalscroll.size? | number | scroll bar size |
scroll.trackhorizontalscroll.type? | string | scroll bar class type |
scroll.trackhorizontalscroll.visible? | boolean | scroll bar visibility flag |
scroll.trackverticalscroll? | { options?: Options ; size?: number ; type?: string ; visible?: boolean } | Track vertiacl scroll options |
scroll.trackverticalscroll.options? | Options | scroll bar additional options |
scroll.trackverticalscroll.size? | number | scroll bar size |
scroll.trackverticalscroll.type? | string | scroll bar class type |
scroll.trackverticalscroll.visible? | boolean | scroll bar visibility flag |
tools? | { cursortracking?: { enabled?: boolean ; tooltip?: Options ; tooltipregistry?: LogToolTipRegistry } ; ghost?: Options & { autoscroll?: { area?: number ; horizontal?: boolean ; vertical?: boolean } } ; tracksplitter?: SplitterOptions } | tools options |
tools.cursortracking? | { enabled?: boolean ; tooltip?: Options ; tooltipregistry?: LogToolTipRegistry } | cursor tracking options |
tools.cursortracking.enabled? | boolean | enabled state, false by default |
tools.cursortracking.tooltip? | Options | JSON which defines single visual tooltip tool. |
tools.cursortracking.tooltipregistry? | LogToolTipRegistry | Default registry for tool tip formatters, can be overridden by tooltip settings |
tools.ghost? | Options & { autoscroll?: { area?: number ; horizontal?: boolean ; vertical?: boolean } } | Ghost tool options |
tools.tracksplitter? | SplitterOptions | tracks splitter options See AbstractTool.setProperties for details |
tops? | { alignment?: AnchorType ; autoscroll?: boolean ; visible?: boolean } | define tops overlay properties |
tops.alignment? | AnchorType | tops alignment |
tops.autoscroll? | boolean | tops are always on visible limits if true |
tops.visible? | boolean | tops overlay visibility |
track? | { fixedwidth?: boolean ; header?: { border?: { color?: string ; visible?: boolean ; width?: number } } } | optional track options |
track.fixedwidth? | boolean | fixed width of tracks for horizontal scale |
track.header? | { border?: { color?: string ; visible?: boolean ; width?: number } } | optional track header properties |
track.header.border? | { color?: string ; visible?: boolean ; width?: number } | optional track header properties |
track.header.border.color? | string | color of track header border |
track.header.border.visible? | boolean | visibility of the track header border |
track.header.border.width? | number | line width of track header border |
trackcontainer? | { border?: { color?: string ; visible?: boolean } ; verticalflip?: boolean } | defines properties for track container |
trackcontainer.border? | { color?: string ; visible?: boolean } | defines properties for track container outer border |
trackcontainer.border.color? | string | border color |
trackcontainer.border.visible? | boolean | visibility of the border |
trackcontainer.verticalflip? | boolean | horizontal axis goes from right to left |
verticalscrollable? | boolean | "auto" | "floating" | { footer?: boolean | "auto" | "floating" ; header?: boolean | "auto" | "floating" ; plot?: boolean | "auto" | "floating" } | defines if plot displays vertical scrollbars | object containing specific settings for all three containers |
viewcache? | boolean | enable tiled cache. It increases rendering performance for historical data |
viewcachesize? | { height?: number ; width?: number } | define view cache parameters |
viewcachesize.height? | number | set tiled cache size. |
viewcachesize.width? | number | set tiled cache size. |
visiblelimits? | Rect | define visible content limits in model coordinates |
well? | { behavior?: WellBehaviorRegistry ; factory?: AbstractWellTrackFactory ; marker?: MarkerOptions } | optional track options |
well.behavior? | WellBehaviorRegistry | well track behavior registry |
well.factory? | AbstractWellTrackFactory | well track factory |
well.marker? | MarkerOptions | - |
Ƭ OptionsBaseOut: Object
| Name | Type | Description |
|---|---|---|
footer | { height: number ; visible: boolean | "none" } | - |
footer.height | number | - |
footer.visible | boolean | "none" | - |
header | { height: number ; visible: boolean | "none" } | - |
header.height | number | - |
header.visible | boolean | "none" | - |
scroll | ScrollOptions | Scroll options |
tools | { tracksplitter: OptionsOut } | Toolse options |
tools.tracksplitter | OptionsOut | - |
tops | { alignment: AnchorType ; autoscroll: boolean ; widget: BaseWidget } | - |
tops.alignment | AnchorType | alignment |
tops.autoscroll | boolean | if true, names will be drawn only on visible limits of track container |
tops.widget | BaseWidget | widget |
Ƭ OptionsOut: OptionsOut & { annotations?: { east?: Group ; north?: Group ; south?: Group ; west?: Group } ; annotationssizes?: { north?: number ; south?: number } ; attachedheaders?: boolean ; autotrackslimits?: boolean ; autowellsoncorrelationtrack?: boolean ; deviceunit?: AbstractUnit ; footer?: { border?: { color?: string ; visible?: boolean | "none" } ; connected?: boolean ; height?: number | "auto" ; viewcache?: boolean ; viewcachesize?: { height?: number ; width?: number } ; visible?: boolean | "none" } ; header?: { border?: { color?: string ; visible?: boolean | "none" } ; connected?: boolean ; height?: number | "auto" ; restrictmaxheadersize?: boolean ; viewcache?: boolean ; viewcachesize?: { height?: number ; width?: number } ; visible?: boolean | "none" } ; highlight?: { cssclass?: string ; fillstyle?: Type ; linestyle?: Type } ; horizontalscrollable?: boolean | string ; indent?: number ; indexunit?: AbstractUnit ; offscreentrackpanning?: number ; orientation?: Orientation ; scroll: ScrollOptions ; tools?: { cursortracking: { enabled: boolean ; tooltip: Options ; tooltipregistry: LogToolTipRegistry } ; tracksplitter: SplitterOptions } ; tops?: { alignment?: AnchorType ; autoscroll?: boolean ; visible?: boolean } ; track?: { fixedwidth?: boolean ; header?: { border?: { color?: string ; visible?: boolean ; width?: number } } } ; trackcontainer?: { border?: { color?: string ; visible?: boolean } ; verticalflip?: boolean } ; verticalscrollable?: boolean | string | { footer?: boolean | string ; header?: boolean | string ; plot?: boolean | string } ; viewcache?: boolean ; viewcachesize?: { height?: number ; width?: number } ; visiblelimits?: Rect }
properties
Ƭ ScrollOptions: Object
Scroll options
| Name | Type | Description |
|---|---|---|
direction | ScrollDirection | string | scroll direction when using scroll wheel to scroll |
footerverticalscroll | { options: Options ; size: number ; type: string ; visible: boolean } | footer container scroll option |
footerverticalscroll.options | Options | scroll bar additional options |
footerverticalscroll.size | number | scroll bar size |
footerverticalscroll.type | string | scroll bar class type |
footerverticalscroll.visible | boolean | scroll bar visibility flag |
headerverticalscroll | { options: Options ; size: number ; type: string ; visible: boolean } | header container scroll option |
headerverticalscroll.options | Options | scroll bar additional options |
headerverticalscroll.size | number | scroll bar size |
headerverticalscroll.type | string | scroll bar class type |
headerverticalscroll.visible | boolean | scroll bar visibility flag |
trackhorizontalscroll | { options: Options ; size: number ; type: string ; visible: boolean } | track container scroll option |
trackhorizontalscroll.options | Options | scroll bar additional options |
trackhorizontalscroll.size | number | scroll bar size |
trackhorizontalscroll.type | string | scroll bar class type |
trackhorizontalscroll.visible | boolean | scroll bar visibility flag |
trackverticalscroll | { options: Options ; size: number ; type: string ; visible: boolean } | Track vertical scroll |
trackverticalscroll.options | Options | scroll bar additional options |
trackverticalscroll.size | number | scroll bar size |
trackverticalscroll.type | string | scroll bar class type |
trackverticalscroll.visible | boolean | scroll bar visibility flag |
Ƭ SplitterOptions: Options & { multitrackmodel?: Group ; welltrackcontainer?: Group }
Ƭ Tools: { FooterPanning: Panning ; HeaderPanning: Panning ; HorizontalPlotScroll: ScrollTool ; TrackPanning: Panning ; TrackPlotVerticalScroll: ScrollTool ; TrackZoom: Zoom ; correlation-cursor: CorrelationCursor ; cross-hair: CrossHair ; drag-and-drop: DragAndDrop ; footer-tools: CompositeTool ; ghost: GhostTool ; header-tools: CompositeTool ; horizontal-splitter: Splitter ; multiwell-splitter: Splitter ; panningTools: CompositeTool ; pick: Selection ; well-tools: CompositeTool } & Tools
Ƭ Track: { type?: WellTrack } & Options | { type?: ProxyTrack } & Options | { type?: CorrelationTrack } & Options
Track options
Ƭ TrackOptions: Object
options