Class ScaleBarDimensions

Hierarchy

  • ScaleBarDimensions

Constructors

constructor

Properties

allowedSignificands lengthInPixels physicalBaseUnit physicalLength physicalSizePerPixel physicalUnit prevPhysicalSizePerPixel prevPhysicalUnit prevTargetLengthInPixels targetLengthInPixels

Methods

update

Constructors

constructor

Properties

allowedSignificands

allowedSignificands: number[] = DEFAULT_ALLOWED_SIGNIFICANDS

Allowed significand values. 1 is not included, but is always considered part of the set.

lengthInPixels

lengthInPixels: number

Length that scale bar should be drawn, in pixels.

physicalBaseUnit

physicalBaseUnit: string

Base physical unit, e.g. "m" (for meters) or "s" (for seconds).

physicalLength

physicalLength: number

Physical length with which to label the scale bar.

physicalSizePerPixel

physicalSizePerPixel: number = 0

Pixel size in base physical units.

physicalUnit

physicalUnit: string

prevPhysicalSizePerPixel

prevPhysicalSizePerPixel: number = 0

prevPhysicalUnit

prevPhysicalUnit: string = '\0'

prevTargetLengthInPixels

prevTargetLengthInPixels: number = 0

targetLengthInPixels

targetLengthInPixels: number = 0

The target length in pixels. The closest

Methods

update

  • Updates physicalLength, physicalUnit, and lengthInPixels to be the optimal values corresponding to targetLengthInPixels and physicalSizePerPixel.

    Returns

    true if the scale bar has changed, false if it is unchanged.

    Returns boolean

Settings

Member Visibility

Theme

Generated using TypeDoc