API / geotoolkit / schematics / scene / WellBoreNode / WellBoreNode

Namespace: WellBoreNode

scene.WellBoreNode.WellBoreNode

Table of contents

Type Aliases

Contents

Type Aliases

ComponentRenderingHints

Ƭ ComponentRenderingHints: Object

Type declaration

NameType
casing?RenderingHintsBase & { inner?: { fillstyle: Type } ; outer?: { fillstyle?: Type ; linestyle?: Type } ; shoe?: Options }
casingmd?RenderingHintsBase & { shoe?: Options }
default?RenderingHintsBase & { close?: { bottom: boolean ; top: boolean } ; selectableinterior?: boolean }
fluid?RenderingHintsBase & Record<string, RenderingHintsBase>
openhole?RenderingHintsBase & { close?: { bottom: boolean ; top: boolean } ; sine?: { accuracy: number ; amplitude: number ; period: number } ; wiggle?: boolean }
perforation?RenderingHintsBase & { cutoff?: boolean ; height?: number ; minimalwidth?: number ; thresholdheight?: number }

ComponentsVisibility

Ƭ ComponentsVisibility: Object

visibility options

Type declaration

NameTypeDescription
invisible?string[] | string | { id?: string | string[] ; name?: string | string[] }array of invisible component names or object
visible?string[] | string | { id?: string | string[] ; name?: string | string[] }array of visible component names or object

EventMap

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


Highlight

Ƭ Highlight: Object

component highlight options

Type declaration

NameTypeDescription
boundscalculation?BoundsCalculation | stringimplementation (or its type) to calculate component's area to highlight
cssclass?stringdefine component highlight class name
fillstyle?Typedefine fill style attribute for component highlight
linestyle?Typedefine line style attribute for component highlight

Options

Ƭ Options: Options & { builder?: { compressed?: IViewModeBuilder ; keepaspectratio?: IViewModeBuilder ; regular?: IViewModeBuilder } ; data?: WellBoreData ; forceopenhole?: boolean ; highlight?: Highlight ; registry?: ComponentNodeFactoryRegistry ; renderinghints?: RenderingHints ; selection?: { cssclass?: string ; fillstyle?: Type ; linestyle?: Type } ; sortcomponents?: SortComponents ; units?: UnitsOptions ; valueviewmode?: ValueViewMode ; viewmode?: ViewModeInfo | ViewMode }


OptionsOut

Ƭ OptionsOut: OptionsOut & { data: WellBoreData ; forceopenhole: boolean ; highlight?: { boundscalculation: BoundsCalculation ; cssclass: string ; fillstyle: FillStyle | null ; linestyle: LineStyle | null } ; renderinghints: RenderingHints ; sortcomponents: SortComponents ; valueviewmode: ValueViewMode ; viewmode: ViewMode }

An object containing the properties to set


RenderingHints

Ƭ RenderingHints: ComponentRenderingHints | Record<string, RenderingHintsBase | RenderingHints>


ViewModeInfo

Ƭ ViewModeInfo: { name?: Compressed ; options?: Options } | { name?: Regular ; options?: null | {} } | { name?: KeepAspectRatio ; options?: Options }

view mode type or an object containing view mode type and options