API / geotoolkit / welllog / header / AdaptiveLogVisualHeader / AdaptiveLogVisualHeader
header.AdaptiveLogVisualHeader.AdaptiveLogVisualHeader
Type Aliases
Type Aliases
Ƭ CutCallback: (text: string, nRemove?: number) => string
▸ (text, nRemove?): string
Cut specified text, should return new text
| Name | Type | Description |
|---|---|---|
text | string | text to cut |
Optional nRemove | number | amount of characters to remove |
string
Ƭ DrawCallback: (header: AdaptiveLogVisualHeader, rect: Rect, context: RenderingContext, element: ElementOptionsOut) => void
▸ (header, rect, context, element): void
| Name | Type |
|---|---|
header | AdaptiveLogVisualHeader |
rect | Rect |
context | RenderingContext |
element | ElementOptionsOut |
void
Ƭ ElementOptions<T>: Object
Element options
| Name | Type |
|---|---|
T | extends LogAbstractVisual = LogAbstractVisual |
| Name | Type | Description |
|---|---|---|
anchor? | AnchorType | element anchor name |
cut? | CutType | "left-to-right" | "right-to-left" | "wrap" | null | CutCallback | Cut type or null if no cut is allowed, or callback to cut specified text |
drawmethod? | DrawCallback | callback for non-textual element's contents update |
events? | Partial<Record<Events, (eventType: string, sender?: AdaptiveLogVisualHeader, hits?: Hits, eventArgs?: DOMEventArgs) => void>> | Element events |
fillstyle? | Type | fill style for rounded box |
horizontalpos? | string | values supported: 'left', 'right', 'center' Deprecated since 4.1 use 'anchor' instead |
linestyle? | Type | line style for rounded box |
marginstyle? | Type | margins style object |
name? | string | Element name |
numberformat? | NumberFormat | number format |
options? | Record<string, any> | additional options |
paddings? | { bottom?: number ; left?: number ; right?: number ; top?: number } | padding style object Deprecated since 4.1. Use paddingstyle property instead. |
paddings.bottom? | number | bottom padding for rounded box |
paddings.left? | number | left padding for rounded box |
paddings.right? | number | right padding for rounded box |
paddings.top? | number | top padding for rounded box |
paddingstyle? | Type | paddings style object |
radius? | number | radius of the rounded box |
section? | Sections | string | section name |
size? | number | Dimension | MeasureElementDimensionCallback<T> | element size in pixels or units |
symbol? | SymbolShape | symbol shape for symbol element(s) |
text? | string | static text for textual element(s) |
textstyle? | Type | text style for textual element(s) |
updatemethod? | UpdateCallback | callback for textual element's contents update |
verticalpos? | string | values supported: 'top', 'bottom', 'center' Deprecated since 4.1 use 'section' instead |
visible? | boolean | visibility flag |
Ƭ ElementOptionsOut<T>: Object
| Name | Type |
|---|---|
T | extends LogAbstractVisual = LogAbstractVisual |
| Name | Type | Description |
|---|---|---|
anchor? | AnchorType | element anchor name |
cut? | CutType | "left-to-right" | "right-to-left" | "wrap" | null | CutCallback | Cut type, null in case if no cut is allowed |
drawmethod? | DrawCallback | callback for non-textual element's contents update |
events? | { [key: string]: AttributeCallback; } | Element Events |
fillstyle? | FillStyle | Element fill style |
horizontalpos? | string | values supported: 'left', 'right', 'center' Deprecated since 4.1 use 'anchor' instead |
linestyle? | LineStyle | Element line style |
marginstyle? | SpaceStyle | Margins style |
name? | string | Element name |
numberformat? | NumberFormat | number format |
options? | Record<string, any> | additional options |
paddings? | { bottom?: number ; left?: number ; right?: number ; top?: number } | padding object Deprecated since 4.1. Use paddingstyle property instead. |
paddings.bottom? | number | bottom padding for rounded box |
paddings.left? | number | left padding for rounded box |
paddings.right? | number | right padding for rounded box |
paddings.top? | number | top padding for rounded box |
paddingstyle? | SpaceStyle | Paddings style |
radius? | number | Element radius of the rounded box |
section? | Sections | string | section name |
size? | number | Dimension | MeasureElementDimensionCallback<T> | element size in pixels or units |
symbol? | SymbolShape | symbol shape for symbol element(s) |
text? | string | text for textual element(s) |
textstyle? | TextStyle | text style for textual element(s) |
updatemethod? | UpdateCallback | callback for textual element's contents update |
verticalpos? | string | values supported: 'top', 'bottom', 'center' Deprecated since 4.1 use 'section' instead |
visible? | boolean | visibility flag |
Ƭ HitTestArea: Rect | Point | { x?: number[] ; y?: number[] }
model area or position
Ƭ Hits: Object
| Name | Type |
|---|---|
data? | Hits[] |
element? | ElementOptionsOut |
text? | string |
Ƭ MeasureElementDimensionCallback<T>: (header: AdaptiveLogVisualHeader, visual: T, element: ElementOptions<T>, width?: number) => Dimension
| Name | Type |
|---|---|
T | extends LogAbstractVisual = LogAbstractVisual |
▸ (header, visual, element, width?): Dimension
| Name | Type |
|---|---|
header | AdaptiveLogVisualHeader |
visual | T |
element | ElementOptions<T> |
Optional width | number |
Ƭ MeasureSectionSizeCallback<T>: (header: AdaptiveLogVisualHeader, visual: T, name: string, width?: number) => number
| Name | Type |
|---|---|
T | extends LogAbstractVisual = LogAbstractVisual |
▸ (header, visual, name, width?): number
| Name | Type |
|---|---|
header | AdaptiveLogVisualHeader |
visual | T |
name | string |
Optional width | number |
number
Ƭ Options<T>: Options<T> & { element?: Record<string, ElementOptions> ; gap?: number ; order?: string[] ; orientation?: Orientation ; priority?: string[] }
visual or properties object
| Name | Type |
|---|---|
T | extends LogAbstractVisual = LogAbstractVisual |
Ƭ OptionsOut<T>: OptionsOut<T> & { [key: string]: any; gap: number ; order: string[] ; orientation: Orientation ; priority: (string | string[])[] }
header properties
| Name | Type |
|---|---|
T | extends LogAbstractVisual = LogAbstractVisual |
Ƭ SectionOptions<T>: Object
options to set
| Name | Type |
|---|---|
T | extends LogAbstractVisual = LogAbstractVisual |
| Name | Type | Description |
|---|---|---|
fillstyle? | Type | background fillstyle |
name? | string | section name |
paddingstyle? | Type | Paddings style |
size? | number | string | MeasureSectionSizeCallback<T> | section size in pixels or units |
visible? | boolean | "auto" | visibility flag |
z-index? | number | null | Define section z-index |
Ƭ Settings: Object
settings
| Name | Type | Description |
|---|---|---|
gap? | number | gap value in pixels |
order? | string[] | spatial order of textual elements: first "Left-to-right" then "top-to-bottom": |
priority? | (string | string[])[] | "least-to-most" important textual elements |
Ƭ UpdateCallback: (header: AdaptiveLogVisualHeader, numberFormat?: NumberFormat, renderingContext?: RenderingContext, options?: any) => string
▸ (header, numberFormat?, renderingContext?, options?): string
| Name | Type |
|---|---|
header | AdaptiveLogVisualHeader |
Optional numberFormat | NumberFormat |
Optional renderingContext | RenderingContext |
Optional options | any |
string