Last updated

API / geotoolkit / schematics / widgets / ISchematicsWidget / ISchematicsWidget

Class: ISchematicsWidget

widgets.ISchematicsWidget.ISchematicsWidget

Defines base interface for all schematics widgets

Interface

Implemented by

Table of contents

Constructors
Methods

Contents

Constructors

new ISchematicsWidget()

new ISchematicsWidget()

Methods

getCenterModelLimits

Abstract getCenterModelLimits(): Rect

Gets WellBoreNode's model limits

Returns

Rect


getClassName

getClassName(): string

Returns

string


getLabelingStrategy

Abstract getLabelingStrategy(): LabelingStrategy

Gets labeling strategy (if any)

Returns

LabelingStrategy


getOptions

Abstract getOptions(): Record<string, any>

Gets widget options

Returns

Record<string, any>

widget options


getViewMode

Abstract getViewMode(): ViewMode

Gets well bore view mode

Returns

ViewMode

viewMode


setData

Abstract setData(data): ISchematicsWidget

Sets data

Parameters

Name Type Description
dataanywellbore data to set

Returns

ISchematicsWidget

this


setOptions

Abstract setOptions(options): ISchematicsWidget

Sets widget options

Parameters

Name Type Description
optionsRecord<string, any>widget options

Returns

ISchematicsWidget

this


setViewMode

Abstract setViewMode(viewMode): Object

Sets well bore view mode

Parameters

Name Type Description
viewModeViewMode | ViewModeInfowell bore view mode

Returns

Object

"model limits to bounds" depths mapping

NameTypeDescription
boundsdepthsnumber[]bounds depths
modellimitsdepthsnumber[]model limits depths

getClassName

Static getClassName(): string

Returns

string