seisplotjs.scale 3.0.0-alpha.0

seisplotjs.scale

3.0.0-alpha.0

AmplitudeScalable ▸
- Instance members
- #middle
- #halfWidth
- #getAmplitudeRange
- #notifyAmplitudeChange
- #toString
TimeScalable ▸
- Instance members
- #alignmentTimeOffset
- #duration
- #notifyTimeRangeChange
LinkedAmplitudeScale ▸
- Instance members
- #_halfWidth
- #_recalcTimeoutID
- #_scaleId
- #halfWidth
- #halfWidth
- #linkAll
- #link
- #unlink
- #recalculate
- #notifyAll
- #graphList
IndividualAmplitudeScale ▸
- Instance members
- #recalculate
- #notifyAll
LinkedTimeScale ▸
- Instance members
- #_originalDuration
- #_originalStartOffset
- #_zoomedDuration
- #_zoomedStartOffset
- #_scaleId
- #link
- #linkAll
- #unlink
- #zoom
- #unzoom
- #offset
- #offset
- #duration
- #duration
- #origOffset
- #origDuration
- #recalculate
- #notifyAll
- #graphList

Need help reading this?

AmplitudeScalable

src/scale.ts

new AmplitudeScalable(middle: number, halfWidth: number)

Parameters

middle (number)

halfWidth (number)

Instance Members

▸ middle

src/scale.ts

middle

Type: number

▸ halfWidth

src/scale.ts

halfWidth

Type: number

▸ getAmplitudeRange()

src/scale.ts

getAmplitudeRange(): Array<number>

Returns

Array<number>

▸ notifyAmplitudeChange(middle, halfWidth)

src/scale.ts

notifyAmplitudeChange(middle: number, halfWidth: number)

Parameters

middle (number)

halfWidth (number)

▸ toString()

src/scale.ts

toString(): string

Returns

string

TimeScalable

src/scale.ts

new TimeScalable(alignmentTimeOffset: Duration, duration: Duration)

Parameters

alignmentTimeOffset (Duration)

duration (Duration)

Instance Members

▸ alignmentTimeOffset

src/scale.ts

alignmentTimeOffset

Type: Duration

▸ duration

src/scale.ts

duration

Type: Duration

▸ notifyTimeRangeChange(alignmentTimeOffset, duration)

src/scale.ts

notifyTimeRangeChange(alignmentTimeOffset: Duration, duration: Duration)

Parameters

alignmentTimeOffset (Duration)

duration (Duration)

LinkedAmplitudeScale

src/scale.ts

Links amplitude scales across multiple seismographs, respecting doRmean.

new LinkedAmplitudeScale(graphList: Array<AmplitudeScalable>?)

Parameters

graphList (Array<AmplitudeScalable>?) optional list of AmplitudeScalable to link

Instance Members

▸ _halfWidth

src/scale.ts

_halfWidth

Type: number

▸ _recalcTimeoutID

src/scale.ts

_recalcTimeoutID

Type: (ReturnType<any> | null)

▸ _scaleId

src/scale.ts

_scaleId

Type: number

▸ halfWidth

src/scale.ts

halfWidth

Type: number

Returns

number

▸ halfWidth

src/scale.ts

halfWidth

Type: number

Parameters

val (number)

▸ linkAll(graphList)

src/scale.ts

Links new Seismograph with this amplitude scale.

linkAll(graphList: Array<(AmplitudeScalable | {amp_scalable: AmplitudeScalable})>)

Parameters

graphList (Array<(AmplitudeScalable | {amp_scalable: AmplitudeScalable})>) Array of AmplitudeScalable to link

▸ link(graph)

src/scale.ts

Link new Seismograph with this amplitude scale.

link(graph: (AmplitudeScalable | {amp_scalable: AmplitudeScalable}))

Parameters

graph ((AmplitudeScalable | {amp_scalable: AmplitudeScalable})) AmplitudeScalable to link

▸ unlink(graph)

src/scale.ts

Unlink Seismograph with this amplitude scale.

unlink(graph: AmplitudeScalable)

Parameters

graph (AmplitudeScalable) AmplitudeScalable to unlink

▸ recalculate()

src/scale.ts

Recalculate the best amplitude scale for all Seismographs. Causes a redraw.

recalculate()

▸ notifyAll()

src/scale.ts

notifyAll()

▸ graphList

src/scale.ts

graphList

IndividualAmplitudeScale

src/scale.ts

new IndividualAmplitudeScale(graphList: Array<AmplitudeScalable>?)

Extends LinkedAmplitudeScale

Parameters

graphList (Array<AmplitudeScalable>?)

Instance Members

▸ recalculate()

src/scale.ts

recalculate()

▸ notifyAll()

src/scale.ts

notifyAll()

LinkedTimeScale

src/scale.ts

Links time scales across multiple seismographs.

new LinkedTimeScale(graphList: Array<TimeScalable>?, originalDuration: Duration?, originalStartOffset: Duration?, scaleId: number?)

Parameters

graphList (Array<TimeScalable>?) optional list of TimeScalables to link

originalDuration (Duration?)

originalStartOffset (Duration?)

scaleId (number?)

Instance Members

▸ _originalDuration

src/scale.ts

_originalDuration

Type: Duration

▸ _originalStartOffset

src/scale.ts

_originalStartOffset

Type: Duration

▸ _zoomedDuration

src/scale.ts

_zoomedDuration

Type: (null | Duration)

▸ _zoomedStartOffset

src/scale.ts

_zoomedStartOffset

Type: (null | Duration)

▸ _scaleId

src/scale.ts

_scaleId

Type: number

▸ link(graph)

src/scale.ts

Link new TimeScalable with this time scale.

link(graph: (TimeScalable | {time_scalable: TimeScalable}))

Parameters

graph ((TimeScalable | {time_scalable: TimeScalable})) TimeScalable to link

▸ linkAll(graphList)

src/scale.ts

Links TimeScalable with this time scale. Each object in the array should either be a TimeScalable or have a time_scalable field that is a TimeScalable.

linkAll(graphList: Array<(TimeScalable | {time_scalable: TimeScalable})>)

Parameters

graphList (Array<(TimeScalable | {time_scalable: TimeScalable})>) Array of TimeScalable to link

▸ unlink(graph)

src/scale.ts

Unlink TimeScalable with this amplitude scale.

unlink(graph: TimeScalable)

Parameters

graph (TimeScalable) TimeScalable to unlink

▸ zoom(startOffset, duration)

src/scale.ts

zoom(startOffset: Duration, duration: Duration)

Parameters

startOffset (Duration)

duration (Duration)

▸ unzoom()

src/scale.ts

unzoom()

▸ offset

src/scale.ts

offset

Type: Duration

Returns

Duration

▸ offset

src/scale.ts

offset

Type: Duration

Parameters

offset (Duration)

▸ duration

src/scale.ts

duration

Type: Duration

Returns

Duration

▸ duration

src/scale.ts

duration

Type: Duration

Parameters

duration (Duration)

▸ origOffset

src/scale.ts

origOffset

Type: Duration

Returns

Duration

▸ origDuration

src/scale.ts

origDuration

Type: Duration

Returns

Duration

▸ recalculate()

src/scale.ts

Recalculate the best time scale for all Seismographs. Causes a redraw.

recalculate()

▸ notifyAll()

src/scale.ts

notifyAll()

▸ graphList

src/scale.ts

graphList