Last updated

API / geotoolkit / welllog / widgets / RestrictDepthScaleStrategy / RestrictDepthScaleStrategy

Class: RestrictDepthScaleStrategy

widgets.RestrictDepthScaleStrategy.RestrictDepthScaleStrategy

RestrictVisibleDepthLimitsStrategy input transformation adjustment is restricted based on the options supplied.

RestrictVisibleDepthLimitsStrategy adjust transformation the way data model's visible model limits do not go beyond entire model limits. When either of the options is set to "true" on the strategy, additional corresponding (horizontal or vertical) transformation suppression is performed.

Hierarchy

Table of contents

Constructors
Methods
Css Properties
Name Type Description
deviceunitstringDevice unit
enabledbooleanEnable flag
indexunitstringScale unit
scalenumberScale restriction

Contents

Constructors

new RestrictDepthScaleStrategy(options)

new RestrictDepthScaleStrategy(options?)

Parameters

Name Type
Optional optionsOptions

Overrides

ScaleScrollStrategy.constructor

Methods

adjustTransformation

adjustTransformation(trackContainer, newTr): Transformation

Adjusts input transformation

Parameters

Name Type Description
trackContainerTrackContainermodel
newTrTransformationtransformation to adjust

Returns

Transformation

adjusted transformation

Overrides

ScaleScrollStrategy.adjustTransformation


getClassName

getClassName(): string

Returns

string

Inherited from

ScaleScrollStrategy.getClassName


getDepthScale

getDepthScale(): ScaleOptionsOut

Returns

ScaleOptionsOut


getProperties

getProperties(): OptionsOut

Gets properties

Returns

OptionsOut

properties

Overrides

ScaleScrollStrategy.getProperties


isEnabled

isEnabled(): boolean

Returns enable state

Returns

boolean

enable state

Inherited from

ScaleScrollStrategy.isEnabled


setDepthScale

setDepthScale(scale): RestrictDepthScaleStrategy

Parameters

Name Type
scaleOptions

Returns

RestrictDepthScaleStrategy

setDepthScale(scale, scaleUnit?, deviceUnit?): RestrictDepthScaleStrategy

Parameters

Name Type
scalenumber
Optional scaleUnitstring | AbstractUnit
Optional deviceUnitstring | AbstractUnit

Returns

RestrictDepthScaleStrategy


setEnabled

setEnabled(enabled): RestrictDepthScaleStrategy

Set enable state

Parameters

Name Type Description
enabledbooleansets the enabled state

Returns

RestrictDepthScaleStrategy

this

Inherited from

ScaleScrollStrategy.setEnabled


setProperties

setProperties(properties): RestrictDepthScaleStrategy

Sets the projection properties

Parameters

Name Type Description
propertiesOptionsproperties

Returns

RestrictDepthScaleStrategy

this

Overrides

ScaleScrollStrategy.setProperties


getClassName

Static getClassName(): string

Returns

string

Inherited from

ScaleScrollStrategy.getClassName