API / geotoolkit / welllog / widgets / WellLogWidget / WellLogWidget
widgets.WellLogWidget.WellLogWidget
Type Aliases
Type Aliases
Ƭ AnnotationSizes: Object
annotation sizes
| Name | Type | Description |
|---|---|---|
east? | number | a size of east annotation |
north? | number | a size of north annotation (if size is null it will be equal to header height if it is visible) |
south? | number | a size of south annotation (if size is null it will be equal to footer height if it is visible) |
west? | number | a size of west annotation |
Ƭ BorderOptions: Object
| Name | Type | Description |
|---|---|---|
borders? | Visible | borders visibility option |
color? | string | color of border Deprecated since 4.1 |
linestyle? | Type | border line style |
visible? | boolean | visibility of the border |
Ƭ BorderOptionsOut: Object
| Name | Type | Description |
|---|---|---|
borders? | Visible | borders visibility option |
color? | string | color of border Deprecated since 4.1 |
linestyle? | LineStyle | border line style |
visible | boolean | visibility of the border |
Ƭ DepthLimitsOptions: Object
depth limits options
| Name | Type | Description |
|---|---|---|
neatlimits? | boolean | auto neat depth limits |
offset? | { bottom?: number | string ; top?: number | string } | auto depth limits offset |
offset.bottom? | number | string | bottom offset |
offset.top? | number | string | top offset |
type? | DepthLimitsTypes | depth limits type |
Ƭ DepthLimitsOptionsOut: Object
depth limits options
| Name | Type | Description |
|---|---|---|
neatlimits | boolean | auto neat depth limits |
offset | { bottom: number | string ; top: number | string } | auto depth limits offset |
offset.bottom | number | string | bottom offset |
offset.top | number | string | top offset |
type | DepthLimitsTypes | depth limits type |
Ƭ DepthMarkers: Object
depths marker value or options, null to hide all markers
| Name | Type | Description |
|---|---|---|
depth? | { fillstyle?: Type ; linestyle?: Type ; value?: number } | single depth marker options |
depth.fillstyle? | Type | single depth marker fill style |
depth.linestyle? | Type | single depth marker line style |
depth.value? | number | single depth marker value |
depths? | { fillstyle?: Type ; linestyle?: Type ; values?: number[] } | depth marker set options |
depths.fillstyle? | Type | depth marker set fill style |
depths.linestyle? | Type | depth marker set line style |
depths.values? | number[] | depth marker set values |
Ƭ DepthMarkersOut: Object
depth markers
| Name | Type | Description |
|---|---|---|
depth? | null | { linestyle?: LineStyle ; value?: number } | single depth marker |
depths? | null | { fillstyle?: FillStyle ; linestyle?: LineStyle ; values?: number[] } | depth marker set |
Ƭ EventMap: EventMap & { depthrangechanged: void ; onDoubleClick: SelectionEventArgs ; onTracksSizeChanged: TrackEventArgs ; orientationChanged: void ; updating: { end: number ; start: number } ; visibleDepthLimitsChanged: { new: Range ; old: Range } ; visualsSelected: Node[] }
Ƭ ExportToPdfOptions: Object
option to specify paper parameters and header and footer
| Name | Type | Description |
|---|---|---|
beginexport? | (widget: WellLogWidget) => void | begin export callback, applyes before export |
deviceunit? | AbstractUnit | string | define how many depth units in one device unit. |
documentfooter? | FooterComponent | an optional document PDF footer |
documentheader? | HeaderComponent | an optional document PDF header |
embeddedfonts? | EmbeddedFont[] | array of embedded fonts |
embededfonts? | EmbededFont[] | array of embedded fonts Deprecated since 5.0 use ['embeddedfonts'] instead |
endexport? | (widget: WellLogWidget) => void | end export callback, applyes after export |
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) |
indexunit? | AbstractUnit | string | - |
isfootervisible? | isVisiblePageElementCallback | an optional function to return if footer should be printed |
isheadervisible? | isVisiblePageElementCallback | an optional function to return if header should be printed |
limits? | { end?: number ; start?: number } | Range | Rect | export depth or time 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 |
scale? | null | number | export scale from model index unit to device unit by default as is |
streamcompression? | boolean | enable or disable pdf output compression |
truescale? | boolean | true scale |
usedeepcopy? | boolean | use deep copy, in case of true it make a clone for all object except overlays use it only in case if you need to continue to work with your scene during PDF export |
Ƭ MarkerOptions: Object
| Name | Type | Description |
|---|---|---|
datetimeformat? | Options | date time format in case if track container scale unit belongs to 'time' |
enabledinterpolatedvalues? | boolean | display symbol for interpolated values |
fillstyle? | Type | marker shape fill style |
indexformatter? | Options["depthformatter"] | depth index format that accept number |
indexvisible? | boolean | visibility of the marker index value label |
labelvisible? | boolean | visibility of the marker shape label |
linestyle? | Type | marker shape line style |
symbol? | SymbolShape | symbol to use as depth index marker |
valueformatter? | Options["valueformatter"] | value format |
Ƭ Options: Options & OptionsBase & { annotations?: { enable?: boolean } & Partial<Record<Exclude<AnnotationLocation, Center>, Node[]>> ; annotationssizes?: Partial<Record<Exclude<AnnotationLocation, Center>, number>> ; border?: BorderOptions ; depthlimitsoptions?: DepthLimitsOptions ; deviceunit?: AbstractUnit | string ; direction?: TrackRenderDirection ; gridlinestyle?: Type ; highlight?: { cssclass?: string ; fillstyle?: Type ; header?: { fillstyle?: Type ; highlight?: boolean ; linestyle?: Type } ; linestyle?: Type ; strategy?: TrackHighlightStrategy ; track?: { fillstyle?: Type ; linestyle?: Type } } ; horizontalscrollable?: boolean | "auto" | "floating" ; indextrack?: { axis?: { locale?: string ; name?: string } ; labelformat?: LabelFormatHandler ; styles?: { label?: { edge?: Type ; major?: Type ; minor?: Type } ; tick?: { edge?: Type ; major?: Type ; minor?: Type } } } ; indextype?: IndexType | "time" | "depth" ; indexunit?: AbstractUnit | string ; marker?: MarkerOptions ; nodefilter?: (item: Node) => boolean ; orientation?: Orientation ; range?: Range ; timezone?: TimeZone | string ; timezoneoffset?: number ; tools?: { crosshair?: Options | "none" ; cursortracking?: { crosshair?: Options ; enabled?: boolean ; multitooltip?: Options ; tooltip?: Options ; tooltipregistry?: LogToolTipRegistry } ; horizontal-splitter?: "none" | { enabled: boolean } ; tracksplitter?: Options } ; trackcontainer?: { border?: BorderOptions ; track?: { borderstrategy?: BorderStrategy ; highlightstrategy?: TrackHighlightStrategy } ; verticalflip?: boolean } ; verticalscrollable?: boolean | "auto" | "floating" | { footer?: boolean | "auto" | "floating" ; header?: boolean | "auto" | "floating" ; plot?: boolean | "auto" | "floating" } ; viewcache?: boolean | Cache }
addition options
Ƭ OptionsBase: Object
addition options
| Name | Type | Description |
|---|---|---|
collapsed? | { intervals?: CollapsedInterval[] ; marker?: CollapsedIntervalMarker } | collapsed intervals settings |
collapsed.intervals? | CollapsedInterval[] | collapsed intervals |
collapsed.marker? | CollapsedIntervalMarker | collapsed marker styles |
footer? | { border?: BorderOptions ; displaytype?: DisplayType ; headerprovider?: LogVisualHeaderProvider ; height?: number | string ; margin?: number ; padding?: number ; restrictmaxfootersize?: boolean ; roundedboxradius?: number ; viewcache?: boolean | Cache ; visible?: boolean | "none" } | footer options |
footer.border? | BorderOptions | defines properties for footer outer border |
footer.displaytype? | DisplayType | display type |
footer.headerprovider? | LogVisualHeaderProvider | Header provider. If a custom header provider is specified, sets setHeaderType to HeaderType.Footer |
footer.height? | number | string | footer height |
footer.margin? | number | margin between footer components |
footer.padding? | number | padding inside footer components |
footer.restrictmaxfootersize? | boolean | forbid the resizing of footer container bigger than accumulated size of the track header. |
footer.roundedboxradius? | number | radius of the rounded box |
footer.viewcache? | boolean | Cache | enable tiled cache. It increases rendering performance for historical data |
footer.visible? | boolean | "none" | visibility of the footer, if it is 'none' then footer is not created |
header? | { border?: BorderOptions ; displaytype?: DisplayType ; headerprovider?: LogVisualHeaderProvider ; height?: number | string ; margin?: number ; padding?: number ; restrictmaxheadersize?: boolean ; roundedboxradius?: number ; viewcache?: boolean | Cache ; visible?: boolean | "none" } | header options |
header.border? | BorderOptions | defines properties for header outer border |
header.displaytype? | DisplayType | display type |
header.headerprovider? | LogVisualHeaderProvider | Header provider. If a custom header provider is specified, sets setHeaderType to HeaderType.Header |
header.height? | number | string | header height |
header.margin? | number | margin between header components |
header.padding? | number | padding inside header components |
header.restrictmaxheadersize? | boolean | forbid the resizing of header container bigger than accumulated size of the track header. |
header.roundedboxradius? | number | radius of the rounded box |
header.viewcache? | boolean | Cache | enable tiled cache. It increases rendering performance for historical data |
header.visible? | boolean | "none" | visibility of the headers, if it is 'none' then header is not created |
highlight? | { cssclass?: string ; fillstyle?: Type ; header?: { fillstyle?: Type ; linestyle?: Type } ; linestyle?: Type ; strategy?: TrackHighlightStrategy ; track?: { 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, in case if undefined is specified, no highlight will be applied |
highlight.header? | { fillstyle?: Type ; linestyle?: Type } | define header highlight options to override defaults |
highlight.header.fillstyle? | Type | define fill style attribute for visual highlight, in case if undefined is specified, no highlight will be applied |
highlight.header.linestyle? | Type | define line style attribute for visual highlight, in case if undefined is specified, no highlight will be applied |
highlight.linestyle? | Type | define line style attribute for visual highlight, in case if undefined is specified, no highlight will be applied |
highlight.strategy? | TrackHighlightStrategy | define highlight strategy |
highlight.track? | { fillstyle?: Type ; linestyle?: Type } | define track highlight options to override defaults |
highlight.track.fillstyle? | Type | define fill style attribute for visual highlight, in case if undefined is specified, no highlight will be applied |
highlight.track.linestyle? | Type | define line style attribute for visual highlight, in case if undefined is specified, no highlight will be applied |
indent? | number | indent between tracks |
scroll? | { direction?: ScrollDirection | string ; fittocontent?: boolean ; footerverticalscroll?: { options?: Options ; size?: number ; type?: string ; visible?: boolean | "none" } ; headerverticalscroll?: { options?: Options ; size?: number ; type?: string ; visible?: boolean | "none" } ; trackhorizontalscroll?: { options?: Options ; size?: number ; type?: string ; visible?: boolean | "none" } ; trackverticalscroll?: { options?: Options ; size?: number ; type?: string ; visible?: boolean | "none" } } | scroll option |
scroll.direction? | ScrollDirection | string | scroll direction when using scroll wheel to scroll |
scroll.fittocontent? | boolean | Defines fit border and scrollbar strategy, in case of true (false by default), border and scrollbars fit to content in case if content smaller than widget bounds. |
scroll.footerverticalscroll? | { options?: Options ; size?: number ; type?: string ; visible?: boolean | "none" } | 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 | "none" | scroll bar visibility flag |
scroll.headerverticalscroll? | { options?: Options ; size?: number ; type?: string ; visible?: boolean | "none" } | 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 | "none" | scroll bar visibility flag |
scroll.trackhorizontalscroll? | { options?: Options ; size?: number ; type?: string ; visible?: boolean | "none" } | track container scroll option for horizontal scrollbar |
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 | "none" | scroll bar visibility flag |
scroll.trackverticalscroll? | { options?: Options ; size?: number ; type?: string ; visible?: boolean | "none" } | track container scroll option for vertical scrollbar |
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 | "none" | scroll bar visibility flag |
track? | { background?: Type ; border?: BorderOptions ; footer?: Options & { border?: { background?: Type ; color?: string ; visible?: boolean ; width?: number } } ; header?: Options & { border?: { background?: Type ; color?: string ; visible?: boolean ; width?: number } } } | defines properties for track |
track.background? | Type | defines properties for track background |
track.border? | BorderOptions | defines properties for track border |
track.footer? | Options & { border?: { background?: Type ; color?: string ; visible?: boolean ; width?: number } } | optional track footer properties |
track.header? | Options & { border?: { background?: Type ; color?: string ; visible?: boolean ; width?: number } } | optional track header properties LogTrackHeaderParamsType |
verticalscrollable? | boolean | "auto" | "floating" | { footer?: boolean | "auto" | "floating" ; header?: boolean | "auto" | "floating" ; plot?: boolean | "auto" | "floating" } | - |
Ƭ OptionsBaseOut: Object
| Name | Type | Description |
|---|---|---|
deviceunit | AbstractUnit | primary device unit |
direction | TrackRenderDirection | track render direction |
footer | { height: number | string ; visible: boolean | "none" } | footer options |
footer.height | number | string | footer height in pixels |
footer.visible | boolean | "none" | footer visibility |
header | { height: number | string ; visible: boolean | "none" } | header options |
header.height | number | string | header height in pixels |
header.visible | boolean | "none" | header visibility |
highlight | { cssclass: string | null ; fillstyle: FillStyle | null ; header: { fillstyle?: Type ; highlight?: boolean ; linestyle?: Type } ; linestyle: LineStyle | null ; track: { fillstyle?: Type ; linestyle?: Type } } | define highlight properties |
highlight.cssclass | string | null | define highlight class name, see cssstyle.html tutorial |
highlight.fillstyle | FillStyle | null | define fill style attribute for visual highlight |
highlight.header | { fillstyle?: Type ; highlight?: boolean ; linestyle?: Type } | define header highlight overrides |
highlight.header.fillstyle? | Type | define fill style attribute for visual highlight, in case if undefined is specified, no highlight will be applied |
highlight.header.highlight? | boolean | - |
highlight.header.linestyle? | Type | define line style attribute for visual highlight, in case if undefined is specified, no highlight will be applied |
highlight.linestyle | LineStyle | null | define line style attribute for visual highlight |
highlight.track | { fillstyle?: Type ; linestyle?: Type } | define track highlight overrides |
highlight.track.fillstyle? | Type | define fill style attribute for visual highlight, in case if undefined is specified, no highlight will be applied |
highlight.track.linestyle? | Type | define line style attribute for visual highlight, in case if undefined is specified, no highlight will be applied |
indent | number | indent between tracks |
indextype | string | primary index types |
indexunit | string | primary index unit |
orientation | Orientation | orientation of the well log widget |
scroll | { direction: ScrollDirection | string ; fittocontent: boolean } | scroll option |
scroll.direction | ScrollDirection | string | scroll direction when using scroll wheel to scroll |
scroll.fittocontent | boolean | Defines fit border and scrollbar strategy, in case of true (false by default), border and scrollbars fit to content in case if content smaller than widget bounds. |
Ƭ OptionsOut: OptionsOut & { annotations?: { east: Group ; north: Group ; south: Group ; west: Group } ; annotationssizes?: { east: number ; north: number ; south: number ; west: number } ; border?: BorderOptionsOut ; collapsed?: { intervals?: CollapsedInterval[] ; marker?: { collapsed?: { line?: { color?: string ; decoration?: LineDecoration ; width?: number } ; symbol?: Options | SymbolShape } ; uncollapsed?: { line?: { color?: string ; decoration?: LineDecoration ; width?: number } ; symbol?: Options | SymbolShape } } } ; depthlimitsoptions?: DepthLimitsOptionsOut ; deviceunit?: AbstractUnit | string ; direction?: TrackRenderDirection ; footer?: { border?: BorderOptionsOut ; displaytype?: DisplayType ; height?: number ; margin?: number ; padding?: number ; restrictmaxfootersize?: boolean ; roundedboxradius?: number ; viewcache?: boolean ; visible?: boolean | string } ; gridlinestyle?: Type ; header?: { border?: BorderOptionsOut ; displaytype?: DisplayType ; height?: number ; margin?: number ; padding?: number ; restrictmaxheadersize?: boolean ; roundedboxradius?: number ; viewcache?: boolean ; visible?: boolean | string } ; highlight?: { cssclass: string ; fillstyle: Type ; header: { fillstyle?: Type ; linestyle?: Type } ; linestyle: LineStyle ; strategy: TrackHighlightStrategy ; track: { fillstyle?: Type ; linestyle?: Type } } ; horizontalscrollable?: boolean | string ; indent?: number ; indextrack?: { axis?: { locale?: string ; name?: string } ; labelformat?: LabelFormatHandler ; styles?: { label?: { edge?: Type ; major?: Type ; minor?: Type } ; tick?: { edge?: Type ; major?: Type ; minor?: Type } } } ; indextype?: AbstractUnit | string ; indexunit?: AbstractUnit | string ; marker?: { datetimeformat: Options ; enabledinterpolatedvalues: boolean ; fillstyle: FillStyle ; indexformatter: Options["depthformatter"] ; indexvisible: boolean ; labelvisible: boolean ; linestyle: LineStyle ; symbol: SymbolShape ; valueformatter: Options["valueformatter"] } ; nodefilter?: (item: Node) => boolean ; orientation?: Orientation ; range?: Range ; scroll?: { direction?: ScrollDirection | string ; fittocontent?: boolean } ; timezone?: TimeZone | string ; timezoneoffset?: number ; tools?: { crosshair: OptionsOut ; cursortracking: { crosshair: OptionsOut ; enabled: boolean ; multitooltip?: Options ; tooltip?: Options } ; horizontal-splitter?: "none" | { enabled: boolean } ; tracksplitter: OptionsOut } ; track?: { background?: Type ; border?: BorderOptions ; footer?: { border?: BorderOptions ; firsttolast?: boolean ; holdtitle?: HoldTitle ; titlefirst?: boolean ; toptobottom?: boolean ; visibletracktitle?: boolean } ; header?: { border?: BorderOptions ; firsttolast?: boolean ; holdtitle?: HoldTitle ; titlefirst?: boolean ; toptobottom?: boolean ; visibletracktitle?: boolean } } ; trackcontainer?: { border?: BorderOptions ; track?: { borderstrategy?: BorderStrategy ; highlightstrategy?: TrackHighlightStrategy } ; verticalflip?: boolean } ; verticalscrollable?: boolean | string | { footer?: boolean | string ; header?: boolean | string ; plot?: boolean | string } ; viewcache?: boolean }
properties object
Ƭ Tools: { FooterPanning: Panning ; HeaderPanning: Panning ; TrackPanning: Panning ; TrackZoom: Zoom ; cross-hair: CrossHair ; cursor-tracking: CompositeTool ; drag-and-drop: DragAndDrop ; horizontal-splitter: Splitter ; index-cross-hair: CrossHair ; multi-tooltip: ToolTipTool ; overlay: CompositeTool ; pick: Selection ; rubberband: RubberBand ; splitter: Splitter ; tooltip: ToolTipTool } & Tools
Ƭ TrackOptions: Object
track options
| Name | Type | Description |
|---|---|---|
autolabelrotation? | boolean | enable or disable automatic label rotation for index track |
axis? | { labels?: { edge?: { style?: Type ; visible?: boolean } ; major?: { style?: Type ; visible?: boolean } ; minor?: { style?: Type ; visible?: boolean } } ; locale?: string ; name?: string ; secondaryspace?: { labeldecimation?: boolean ; mapping?: LogAbstractData | { primary: number[] ; secondary: number[] } ; step?: number } ; ticks?: { edge?: { style?: Options ; visible?: boolean } ; major?: { style?: Options ; visible?: boolean } ; minor?: { style?: Options ; visible?: boolean } } ; timezone?: TimeZone ; timezoneoffset?: number } | axis settings |
axis.labels? | { edge?: { style?: Type ; visible?: boolean } ; major?: { style?: Type ; visible?: boolean } ; minor?: { style?: Type ; visible?: boolean } } | track index axis labels settings |
axis.labels.edge? | { style?: Type ; visible?: boolean } | track index axis edge labels settings |
axis.labels.edge.style? | Type | track index axis edge labels style. |
axis.labels.edge.visible? | boolean | track index axis edge labels visibility |
axis.labels.major? | { style?: Type ; visible?: boolean } | track index axis major labels settings |
axis.labels.major.style? | Type | track index axis major labels style. |
axis.labels.major.visible? | boolean | track index axis major labels visibility |
axis.labels.minor? | { style?: Type ; visible?: boolean } | track index axis minor labels settings |
axis.labels.minor.style? | Type | track index axis minor labels style. |
axis.labels.minor.visible? | boolean | track index axis minor labels visibility |
axis.locale? | string | locale for tickgenerator of axis |
axis.name? | string | name of axis |
axis.secondaryspace? | { labeldecimation?: boolean ; mapping?: LogAbstractData | { primary: number[] ; secondary: number[] } ; step?: number } | secondary space options (if index track has ticks and labels in different space then well log data); for example data ara in MD space, but index track should display TVD |
axis.secondaryspace.labeldecimation? | boolean | label decimation |
axis.secondaryspace.mapping? | LogAbstractData | { primary: number[] ; secondary: number[] } | primary-to-secondary space mapping |
axis.secondaryspace.step? | number | tick step for major ticks (in secondary space) |
axis.ticks? | { edge?: { style?: Options ; visible?: boolean } ; major?: { style?: Options ; visible?: boolean } ; minor?: { style?: Options ; visible?: boolean } } | track index axis ticks settings |
axis.ticks.edge? | { style?: Options ; visible?: boolean } | track index axis edge ticks settings |
axis.ticks.edge.style? | Options | track index axis edge ticks style. |
axis.ticks.edge.visible? | boolean | track index axis edge ticks visibility |
axis.ticks.major? | { style?: Options ; visible?: boolean } | track index axis major ticks settings |
axis.ticks.major.style? | Options | track index axis major ticks style. |
axis.ticks.major.visible? | boolean | track index axis major ticks visibility |
axis.ticks.minor? | { style?: Options ; visible?: boolean } | track index axis minor ticks settings |
axis.ticks.minor.style? | Options | track index axis minor ticks style. |
axis.ticks.minor.visible? | boolean | track index axis minor ticks visibility |
axis.timezone? | TimeZone | time zone for time axis |
axis.timezoneoffset? | number | time zone offset for date time axis |
block? | { position?: Position ; visible?: boolean } | block settings |
block.position? | Position | block position |
block.visible? | boolean | block visibility |
index? | { major?: { style?: Options ; visible?: boolean } ; minor?: { style?: Options ; visible?: boolean } } | track index grid settings, only available when track type is NOT IndexTrack |
index.major? | { style?: Options ; visible?: boolean } | track index grid major settings |
index.major.style? | Options | track index grid major line style |
index.major.visible? | boolean | track index grid major visibility |
index.minor? | { style?: Options ; visible?: boolean } | track index grid minor settings |
index.minor.style? | Options | track index grid minor line style |
index.minor.visible? | boolean | track index grid minor visibility |
name? | string | track name |
type? | TrackType | track type |
value? | { logdecades?: number ; logscale?: number ; logstart?: number ; logstop?: number ; major?: { increment?: number ; style?: Options ; visible?: boolean } ; minor?: { increment?: number ; style?: Options ; visible?: boolean } } | track value grid settings, only available when track type is NOT IndexTrack |
value.logdecades? | number | log decades, only available when track type is LogTrack |
value.logscale? | number | log scale, only available when track type is LogTrack |
value.logstart? | number | log start, only available when track type is LogTrack |
value.logstop? | number | log stop, only available when track type is LogTrack |
value.major? | { increment?: number ; style?: Options ; visible?: boolean } | track value grid major settings |
value.major.increment? | number | major increment, only available when track type is LinearTrack |
value.major.style? | Options | track value grid major line style |
value.major.visible? | boolean | track value grid major visibility |
value.minor? | { increment?: number ; style?: Options ; visible?: boolean } | track value grid minor settings |
value.minor.increment? | number | minor increment, only available when track type is LinearTrack |
value.minor.style? | Options | track value grid minor line style |
value.minor.visible? | boolean | track value grid minor visibility |
Ƭ TrackOptionsOut: Object
track options
| Name | Type | Description |
|---|---|---|
autolabelrotation? | boolean | enable or disable automatic label rotation for index track |
axis? | { labels?: { edge?: { style?: Type ; visible?: boolean } ; major?: { style?: Type ; visible?: boolean } ; minor?: { style?: Type ; visible?: boolean } } ; locale?: string | Locale ; name?: string ; ticks?: { edge?: { style?: Type ; visible?: boolean } ; major?: { style?: Type ; visible?: boolean } ; minor?: { style?: Type ; visible?: boolean } } ; timezone?: string | TimeZone ; timezoneoffset?: number } | axis settings |
axis.labels? | { edge?: { style?: Type ; visible?: boolean } ; major?: { style?: Type ; visible?: boolean } ; minor?: { style?: Type ; visible?: boolean } } | track index axis labels settings |
axis.labels.edge? | { style?: Type ; visible?: boolean } | track index axis edge settings |
axis.labels.edge.style? | Type | track index axis edge labels style. |
axis.labels.edge.visible? | boolean | track index axis edge labels visibility |
axis.labels.major? | { style?: Type ; visible?: boolean } | track index axis major settings |
axis.labels.major.style? | Type | track index axis major labels style. |
axis.labels.major.visible? | boolean | track index axis major labels visibility |
axis.labels.minor? | { style?: Type ; visible?: boolean } | track index axis minor labels settings |
axis.labels.minor.style? | Type | track index axis minor labels style. |
axis.labels.minor.visible? | boolean | track index axis minor labels visibility |
axis.locale? | string | Locale | locale for tickgenerator of axis |
axis.name? | string | name of axis |
axis.ticks? | { edge?: { style?: Type ; visible?: boolean } ; major?: { style?: Type ; visible?: boolean } ; minor?: { style?: Type ; visible?: boolean } } | track index axis ticks settings |
axis.ticks.edge? | { style?: Type ; visible?: boolean } | track index axis edge ticks settings |
axis.ticks.edge.style? | Type | track index axis edge ticks style. |
axis.ticks.edge.visible? | boolean | track index axis edge ticks visibility |
axis.ticks.major? | { style?: Type ; visible?: boolean } | track index axis major ticks settings |
axis.ticks.major.style? | Type | track index axis major ticks style. |
axis.ticks.major.visible? | boolean | track index axis major ticks visibility |
axis.ticks.minor? | { style?: Type ; visible?: boolean } | track index axis minor ticks settings |
axis.ticks.minor.style? | Type | track index axis minor ticks style. |
axis.ticks.minor.visible? | boolean | track index axis minor ticks visibility |
axis.timezone? | string | TimeZone | time zone for time axis |
axis.timezoneoffset? | number | time zone offset for date time axis |
block? | { position?: Position ; visible?: boolean } | block settings |
block.position? | Position | block position |
block.visible? | boolean | block visibility |
index? | { major?: { style?: Type ; visible?: boolean } ; minor?: { style?: Type ; visible?: boolean } } | track index grid settings, only available when track type is NOT IndexTrack |
index.major? | { style?: Type ; visible?: boolean } | track index grid major settings |
index.major.style? | Type | track index grid major line style. |
index.major.visible? | boolean | track index grid major visibility |
index.minor? | { style?: Type ; visible?: boolean } | track index grid minor settings |
index.minor.style? | Type | track index grid minor line style. |
index.minor.visible? | boolean | track index grid minor visibility |
name? | string | track name |
type? | TrackType | track type |
value? | { logdecades?: number ; logscale?: number ; logstart?: number ; logstop?: number ; major?: { increment?: number ; style?: Type ; visible?: boolean } ; minor?: { increment?: number ; style?: Type ; visible?: boolean } } | track value grid settings, only available when track type is NOT IndexTrack |
value.logdecades? | number | log decades, only available when track type is LogTrack |
value.logscale? | number | log scale, only available when track type is LogTrack |
value.logstart? | number | log start, only available when track type is LogTrack |
value.logstop? | number | log stop, only available when track type is LogTrack |
value.major? | { increment?: number ; style?: Type ; visible?: boolean } | track value grid major settings |
value.major.increment? | number | major increment, only available when track type is LinearTrack |
value.major.style? | Type | track value grid major line style |
value.major.visible? | boolean | track value grid major visibility |
value.minor? | { increment?: number ; style?: Type ; visible?: boolean } | track value grid minor settings |
value.minor.increment? | number | minor increment, only available when track type is LinearTrack |
value.minor.style? | Type | track value grid minor line style. |
value.minor.visible? | boolean | track value grid minor visibility |