API / geotoolkit / schematics / widgets / LShapedSchematicsWidget / LShapedSchematicsWidget

Namespace: LShapedSchematicsWidget

widgets.LShapedSchematicsWidget.LShapedSchematicsWidget

Type Aliases

EventMap	Options	OptionsBase
OptionsOut	Tools

Type Aliases

EventMap

Ƭ EventMap: EventMap & { ComponentsLoaded: void ; ComponentsLoading: void }

Options

Ƭ Options: Options & OptionsBase & { data?: WellBoreData | Options | Elements[] ; multidiameterselectionmode?: MultiDiameterSelectionMode }

options

OptionsBase

Ƭ OptionsBase: Object

options

Type declaration

Name	Type	Description
`gap?`	{ `horizontal?`: { `left?`: `number` ; `right?`: `number` } ; `vertical?`: { `bottom?`: `number` ; `top?`: `number` } }	gap size value or object
`gap.horizontal?`	{ `left?`: `number` ; `right?`: `number` }	horizontal gap size value or object
`gap.horizontal.left?`	`number`	left gap size
`gap.horizontal.right?`	`number`	right gap size
`gap.vertical?`	{ `bottom?`: `number` ; `top?`: `number` }	vertical gap size value or object
`gap.vertical.bottom?`	`number`	bottom gap size
`gap.vertical.top?`	`number`	top gap size
`labeldevpoints?`	{ `fillstyle?`: `Type` ; `gettext?`: (`devPointType`: `string`, `devDepth`: `number`) => `string` ; `linestyle?`: `Type` ; `padding?`: `number` ; `textstyle?`: `Type` ; `visible?`: `boolean` }	dev points labels parameters
`labeldevpoints.fillstyle?`	`Type`	dev points fillstyle
`labeldevpoints.gettext?`	(`devPointType`: `string`, `devDepth`: `number`) => `string`	dev points labels text formatter
`labeldevpoints.linestyle?`	`Type`	dev points linestyle
`labeldevpoints.padding?`	`number`	text padding
`labeldevpoints.textstyle?`	`Type`	dev points textstyle
`labeldevpoints.visible?`	`boolean`	dev points visibility
`labeling?`	`DeepMerge`<`Options`[`"labeling"`], { `labelinfoprovider?`: (`node`: `ComponentNode`) => `string` ; `labelshape?`: `SymbolLabelShape` \| `Options` }>	labeling options
`labelingstrategy?`	`LabelingStrategy`	labeling strategy
`legend?`	`Options`[`"legend"`]	legend options
`legendalignmentarea?`	`AnnotationLocation`	legend alignment area.
`skips?`	{ `linestyle?`: `Type` ; `thickness?`: `number` ; `visible?`: `boolean` }	skips options
`skips.linestyle?`	`Type`	skips linestyle
`skips.thickness?`	`number`	skips thickness
`skips.visible?`	`boolean`	skips visibility
`tooltip?`	{ `autoflip?`: `boolean` ; `divelement?`: `HTMLElement` ; `gettext?`: (`node`: `ComponentNode`[]) => `string` }	tooltip settings
`tooltip.autoflip?`	`boolean`	true if need to flip the tooltip near the edge of the window to avoid cropped tooltip
`tooltip.divelement?`	`HTMLElement`	HTML div container element or it will be created with className cg-tooltip-container
`tooltip.gettext?`	(`node`: `ComponentNode`[]) => `string`	get tooltip text function (default displays top-most component's toString info)
`wellborenode?`	{ `deviationdepth?`: `number` \| { `eoc`: `number` ; `kop`: `number` } ; `lshapeaccuracy?`: `number` ; `registry?`: `ComponentNodeFactoryRegistry` ; `renderinghints?`: `RenderingHints` ; `trackwidth?`: `number` ; `viewmode?`: `ViewMode` }	wellbore node options
`wellborenode.deviationdepth?`	`number` \| { `eoc`: `number` ; `kop`: `number` }	deviation depth value or object (if "null" then it's calculated based on the data)
`wellborenode.lshapeaccuracy?`	`number`	accuracy (bigger number means smoother L-shape)
`wellborenode.registry?`	`ComponentNodeFactoryRegistry`	-
`wellborenode.renderinghints?`	`RenderingHints`	-
`wellborenode.trackwidth?`	`number`	track width
`wellborenode.viewmode?`	`ViewMode`	view mode

OptionsOut

Ƭ OptionsOut: OptionsOut & OptionsBase

properties

Tools

Ƭ Tools: { legendTool: LegendTool ; rubberband_horizontal: RubberBand ; rubberband_vertical: RubberBand ; tooltip: ToolTipTool } & Tools