API / geotoolkit / welllog / header / LogVisualHeaderProvider / LogVisualHeaderProvider
header.LogVisualHeaderProvider.LogVisualHeaderProvider
Create the standard representation of a well log header provider.
Constructors
- [new LogVisualHeaderProvider(options)](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit.welllog.header.logvisualheaderprovider.logvisualheaderprovider.md#new logvisualheaderprovider(options))
Methods
Css Properties
| Name | Type | Description |
|---|---|---|
headertype | HeaderType | Header type to be used instead of name to register header for each visual |
name | string | Name of the header provider |
roundedboxradius | number | Radius of the rounded box |
Methods
▸ changeHeaderProvider(className, callback): void
Apply changes for existing header provider and register modified provider as a new one for the current type
| Name | Type | Description |
|---|---|---|
className | string | class name for visual |
callback | (header: LogVisualHeader<Node>) => void | callback |
void
▸ clone(deepCopy?): LogVisualHeaderProvider
Returns clone
| Name | Type | Description |
|---|---|---|
Optional deepCopy | boolean | clone headers prototypes if deep is true overwise copy only references |
clone
▸ getClassName(): string
string
▸ getHeader(node): LogVisualHeader<Node>
Returns header instance associated with specified visual
| Name | Type | Description |
|---|---|---|
node | Node | specified visual |
LogVisualHeader<Node>
header
▸ getHeaderHelpers(): Record<string, LogVisualHeader<Node>>
Gets header helpers
Record<string, LogVisualHeader<Node>>
▸ getHeaderPrototype(node): LogVisualHeader<Node>
get header prototype
| Name | Type | Description |
|---|---|---|
node | Node | type of visual to return |
LogVisualHeader<Node>
▸ getHeaderProvider(className): LogVisualHeader<Node>
return default header implementation for specified class name
| Name | Type | Description |
|---|---|---|
className | string | class name for visual |
LogVisualHeader<Node>
▸ getHeaderType(): HeaderType
Return header type or null if it is not set
▸ getName(): string
return name of provider
string
▸ getProperties(): OptionsOut
Gets all the properties pertaining to this object
properties object
▸ registerHeader(node, headerInstance, silent?): LogVisualHeaderProvider
Sets header instance for specified visual
| Name | Type | Description |
|---|---|---|
node | Node | current node |
headerInstance | LogVisualHeader<Node> | prototype to create the header instance |
Optional silent | boolean | silent node to avoid sending events that header is created |
▸ registerHeaderProvider(className, headerInstance?): LogVisualHeaderProvider
Sets header implementation
| Name | Type | Description |
|---|---|---|
className | string | class name for visual |
Optional headerInstance | LogVisualHeader<Node> | prototype to create the header instance, use undefined to unregister |
▸ setHeaderType(type): LogVisualHeaderProvider
Sets header type to be used to register a header of each visual
| Name | Type | Description |
|---|---|---|
type | HeaderType | type of the header |
▸ setName(name): LogVisualHeaderProvider
set name
| Name | Type | Description |
|---|---|---|
name | string | name of the header provider |
this
▸ setProperties(properties?): LogVisualHeaderProvider
Sets all the properties pertaining to this object
Example
import {CompositeLogCurve} from '@int/geotoolkit/welllog/CompositeLogCurve';
import {LogCurve} from '@int/geotoolkit/welllog/LogCurve';
class CustomHeader extends LogVisualHeader {...};
properties = {
'headerhelpers': {
LogCurve.getClassName(): new CustomHeader()),
CompositeLogCurve.getClassName(): new CustomHeader())
}
}| Name | Type | Description |
|---|---|---|
Optional properties | Options | An object containing the properties to set |
this
▸ Static getClassName(): string
string
▸ Static getDefaultInstance(): LogVisualHeaderProvider
Return default instance of the LogVisualHeaderProvider
default instance