API / geotoolkit / schematics / widgets / compatibility / CompositeSchematicsWidget

Module: CompositeSchematicsWidget

Table of contents

Enumerations
Classes
Type Aliases

Contents

Type Aliases

CompositeSchematicsWidgetOptionsType

Ƭ CompositeSchematicsWidgetOptionsType: Object

options

Type declaration

NameTypeDescription
data?WellBoreData | { elements?: WellBoreData ; trajectory?: Trajectory2d }wellbore data or object encapsulating data
deviated?anydeviated display mode options See DeviatedSchematicsWidget.setOptions for details
displaymode?DisplayModedisplay mode
options?any-
vertical?anyvertical display mode options See SchematicsWidget.setOptions for details

GetDataReturnType

Ƭ GetDataReturnType: null | { elements: WellBoreData ; trajectory: Trajectory2d }


GetPropertiesReturnType

Ƭ GetPropertiesReturnType: { data?: WellBoreData | { elements?: WellBoreData ; trajectory?: Trajectory2d } ; deviated?: any ; displaymode?: DisplayMode ; vertical?: any } | any

properties


SetDataType

Ƭ SetDataType: WellBoreData | { elements?: WellBoreData ; trajectory?: Trajectory2d }

wellbore data or object encapsulating data


SetOptionsType

Ƭ SetOptionsType: Object

widget options
The top-most options may include settings common for both display modes.
If an option defined in the top-most section is also defined in specific display mode, then the specific value overrides common one.

Type declaration

NameTypeDescription
deviated?anydeviated display mode options See DeviatedSchematicsWidget.setOptions for details
displaymode?DisplayModedisplay mode
vertical?anyvertical display mode options See SchematicsWidget.setOptions for details

SetPropertiesType

Ƭ SetPropertiesType: { data?: WellBoreData | { elements?: WellBoreData ; trajectory?: Trajectory2d } ; deviated?: any ; displaymode?: DisplayMode ; vertical?: any } | any

properties