API / geotoolkit / welllog / LogMudLogSection / LogMudLogSection

Namespace: LogMudLogSection

welllog.LogMudLogSection.LogMudLogSection

Table of contents

Type Aliases

Contents

Type Aliases

Aggregation

Ƭ Aggregation: Object

symbols aggregation

Type declaration

NameTypeDescription
range?numberaggregation range
strategy?AggregationStrategy | stringaggregation strategy
symbol?SymbolShape | AggregationSymbolCallbackaggregation symbol

AggregationSymbolCallback

Ƭ AggregationSymbolCallback: (depth: number, indices: number[]) => SymbolShape

Type declaration

▸ (depth, indices): SymbolShape

Parameters
Name Type
depthnumber
indicesnumber[]
Returns

SymbolShape


FillStylesCallback

Ƭ FillStylesCallback<T>: (depth: number, value: T, index: number) => Type | null

Type parameters

Name
T

Type declaration

▸ (depth, value, index): Type | null

Callback function to define each comment section fill style manually.

Parameters
Name Type
depthnumber
valueT
indexnumber
Returns

Type | null


HitTestArea

Ƭ HitTestArea: Rect | Point | { x?: number[] ; y?: number[] }

model area or position


LineStylesCallback

Ƭ LineStylesCallback<T>: (depth: number, value: T, index: number) => Type | null

Type parameters

Name
T

Type declaration

▸ (depth, value, index): Type | null

Callback function to define each comment section line style manually.

Parameters
Name Type
depthnumber
valueT
indexnumber
Returns

Type | null


Options

Ƭ Options<T>: Options & OptionsBase<T>

Input options

Type parameters

Name
T

OptionsBase

Ƭ OptionsBase<T>: Object

properties object

Type parameters

Name
T

Type declaration

NameTypeDescription
depths?number[]an array of the depths
ellipsisstring?stringellipsis text to string (must be under 15 characters)
evenfillstyle?Typeeven fill style
evenlinestyle?TypeEvenLineStyle
evensymbol?SymbolShapeEvenSymbol
eventextstyle?TypeEvenTextStyle
fillmode?FillModemode for how to display the values
fillstyles?Type[] | FillStylesCallback<T>comments fill styles array to use one by one or a callback function to define each style manually
linestyles?Type[] | LineStylesCallback<T>linestyles
margins?Typeproperties for specifying the margins for each comment section
oddfillstyle?Typeodd fill style
oddlinestyle?TypeOddLineStyle
oddsymbol?SymbolShapeOddSymbol
oddtextstyle?TypeOddTextStyle
padding?Typeproperties for specifying the padding for each comment section
radius?numberproperties for specifying the corner radius
selectedfillstyle?Type | SelectedFillStylesCallback<T>fill style for selected segment
selectedindices?number[]array of selected indices
selectedlinestyle?Type | SelectedLineStylesCallback<T>line style for selected segment
selectedsymbol?SymbolShape | SelectedSymbolStylesCallback<T>symbol for selected segment
selectedtextstyle?Type | SelectedTextStylesCallback<T>text style for selected segment
symbolmargins?Typeproperties for specifying the margins for symbols
symbolposition?SymbolPositionsymbol position
symbols?SymbolShape | SymbolShape[] | SymbolStylesCallback<T>symbols
textalign?TextAlignVertical text alignment
textorientation?TextOrientationText orientation
textstyle?Typetext style of the displayed values
textstyles?Type[] | TextStylesCallback<T>textstyles
values?T[] | ValueCallback<T>array of the corresponding values

OptionsBaseOut

Ƭ OptionsBaseOut<T>: Object

properties

Type parameters

Name
T

Type declaration

NameTypeDescription
depthsnumber[]array of depths
ellipsisstringstringellipsis text to string under 15 characters
evenfillstyleFillStyle | nullEvenFillStyle
evenlinestyleLineStyle | nullEvenLineStyle
evensymbolSymbolShape | nullEvenSymbol
eventextstyleTextStyle | nullEvenTextStyle
fillmodeFillModemode for how to display the values
fillstylesFillStyle[] | FillStylesCallback<T>fillstyles
linestylesLineStyle[] | LineStylesCallback<T>linestyles
marginsSpaceStyle | nullmargins properties for specifying the margins for each comment section
oddfillstyleFillStyle | nullOddFillStyle
oddlinestyleLineStyle | nullOddLineStyle
oddsymbolSymbolShape | nullOddSymbol
oddtextstyleTextStyle | nullOddTextStyle
paddingSpaceStyle | nullproperties for specifying the padding for each comment section
radiusnumbercorner radius
selectedfillstyleFillStyle | SelectedFillStylesCallback<T> | nullselected segment fill style
selectedindicesnumber[]array of selected indices
selectedlinestyleLineStyle | SelectedLineStylesCallback<T> | nullselected segment line style
selectedsymbolSymbolShape | SelectedSymbolStylesCallback<T> | nullselected segment symbol
selectedtextstyleTextStyle | SelectedTextStylesCallback<T> | nullselected segment text style
symbolmarginsSpaceStyle | nullmargins properties for specifying symbol margins
symbolpositionSymbolPositionsymbol position
symbolsSymbolShape | SymbolShape[] | SymbolStylesCallback<T>symbols
textalignTextAlignText vertical alignment
textorientationTextOrientationText orientation
textstyleTextStyle | nullthe text style
textstylesTextStyle[] | TextStylesCallback<T>textstyles
valuesT[] | ValueCallback<T>array of corresponding values along the depth

OptionsOut

Ƭ OptionsOut<T>: OptionsOut & OptionsBaseOut<T>

Output options

Type parameters

Name
T

SelectedFillStylesCallback

Ƭ SelectedFillStylesCallback<T>: (depth: number, value: T, index: number, fillStyle: FillStyle | null) => Type | null

Type parameters

Name
T

Type declaration

▸ (depth, value, index, fillStyle): Type | null

Callback function to define selected comment section fill style manually.

Parameters
Name Type
depthnumber
valueT
indexnumber
fillStyleFillStyle | null
Returns

Type | null


SelectedLineStylesCallback

Ƭ SelectedLineStylesCallback<T>: (depth: number, value: T, index: number, lineStyle: LineStyle | null) => Type | null

Type parameters

Name
T

Type declaration

▸ (depth, value, index, lineStyle): Type | null

Callback function to define selected comment section line style manually.

Parameters
Name Type
depthnumber
valueT
indexnumber
lineStyleLineStyle | null
Returns

Type | null


SelectedSymbolStylesCallback

Ƭ SelectedSymbolStylesCallback<T>: (depth: number, value: T, index: number, symbolStyle: SymbolShape | null) => SymbolShape | null

Type parameters

Name
T

Type declaration

▸ (depth, value, index, symbolStyle): SymbolShape | null

Callback function to define selected comment section symbol shape manually.

Parameters
Name Type
depthnumber
valueT
indexnumber
symbolStyleSymbolShape | null
Returns

SymbolShape | null


SelectedTextStylesCallback

Ƭ SelectedTextStylesCallback<T>: (depth: number, value: T, index: number, textStyle: TextStyle | null) => Type | null

Type parameters

Name
T

Type declaration

▸ (depth, value, index, textStyle): Type | null

Callback function to define selected comment section text style manually.

Parameters
Name Type
depthnumber
valueT
indexnumber
textStyleTextStyle | null
Returns

Type | null


SymbolStylesCallback

Ƭ SymbolStylesCallback<T>: (depth: number, value: string | T, index: number) => SymbolShape | null

Type parameters

Name
T

Type declaration

▸ (depth, value, index): SymbolShape | null

Callback function to define each comment section symbol shape manually.

Parameters
Name Type
depthnumber
valuestring | T
indexnumber
Returns

SymbolShape | null


TextStylesCallback

Ƭ TextStylesCallback<T>: (depth: number, value: T, index: number) => Type | null

Type parameters

Name
T

Type declaration

▸ (depth, value, index): Type | null

Callback function to define each comment section text style manually.

Parameters
Name Type
depthnumber
valueT
indexnumber
Returns

Type | null


ValueCallback

Ƭ ValueCallback<T>: (depth: number, nearestDepthIndex: number) => T

Type parameters

Name
T

Type declaration

▸ (depth, nearestDepthIndex): T

Value callback

Parameters
Name Type
depthnumber
nearestDepthIndexnumber
Returns

T