seisplotjs 3.1.4 | Documentation

seisplotjs

3.1.4

AMPLITUDE_MODE
MinMaxable ▸
- Static members
- .fromArray
- .fromMiddleHalfWidth
- Instance members
- #min
- #max
- #middle
- #halfWidth
- #fullWidth
- #union
- #expandPercentage
- #asArray
- #toString
AmplitudeScalable ▸
- Instance members
- #minMax
- #notifyAmplitudeChange
- #middle
- #halfWidth
- #fullWidth
- #min
- #max
- #toString
TimeScalable ▸
- Instance members
- #alignmentTimeOffset
- #duration
- #notifyTimeRangeChange
LinkedAmplitudeScale ▸
- Instance members
- #_halfWidth
- #_recalcTimeoutID
- #_scaleId
- #halfWidth
- #halfWidth
- #linkAll
- #link
- #unlink
- #recalculate
- #_internalNotifyAll
- #notifyAll
- #graphList
IndividualAmplitudeScale ▸
- Instance members
- #recalculate
- #notifyAll
FixedHalfWidthAmplitudeScale ▸
- Instance members
- #recalculate
- #notifyAll
LinkedTimeScale ▸
- Instance members
- #_originalDuration
- #_originalOffset
- #_zoomedDuration
- #_zoomedOffset
- #_scaleId
- #link
- #linkAll
- #unlink
- #zoom
- #unzoom
- #offset
- #offset
- #duration
- #duration
- #origOffset
- #origDuration
- #recalculate
- #notifyAll
- #graphList
AlignmentLinkedTimeScale ▸
- Instance members
- #recalculate
- #notifyAll

Need help reading this?

AMPLITUDE_MODE

src/scale.ts

enum for amplitude modes, RAW, ZERO, MINMAX, MEAN

AMPLITUDE_MODE

MinMaxable

src/scale.ts

new MinMaxable(min: number, max: number)

Parameters

min (number)

max (number)

Static Members

▸ fromArray(minmax)

src/scale.ts

Create MinMaxable from a d3 style two element array.

fromArray(minmax: Array<number>): MinMaxable

Parameters

minmax (Array<number>) array of min then max

Returns

MinMaxable: new MinMaxable

▸ fromMiddleHalfWidth(mid, halfWidth)

src/scale.ts

fromMiddleHalfWidth(mid: number, halfWidth: number): MinMaxable

Parameters

mid (number)

halfWidth (number)

Returns

MinMaxable

Instance Members

▸ min

src/scale.ts

min

Type: number

▸ max

src/scale.ts

max

Type: number

▸ middle

src/scale.ts

middle

Type: number

Returns

number

▸ halfWidth

src/scale.ts

halfWidth

Type: number

Returns

number

▸ fullWidth

src/scale.ts

fullWidth

Type: number

Returns

number

▸ union(omm?)

src/scale.ts

union(omm: MinMaxable?): MinMaxable

Parameters

omm (MinMaxable?)

Returns

MinMaxable

▸ expandPercentage(percent)

src/scale.ts

expandPercentage(percent: number): MinMaxable

Parameters

percent (number)

Returns

MinMaxable

▸ asArray()

src/scale.ts

This as a d3 style 2 element array.

asArray(): [number, number]

Returns

[number, number]: length 2 array of min then max

▸ toString()

src/scale.ts

toString(): string

Returns

string

AmplitudeScalable

src/scale.ts

new AmplitudeScalable(minMax: MinMaxable?)

Parameters

minMax (MinMaxable?)

Instance Members

▸ minMax

src/scale.ts

minMax

Type: MinMaxable

▸ notifyAmplitudeChange(_middle, _halfWidth)

src/scale.ts

notifyAmplitudeChange(_middle: number, _halfWidth: number)

Parameters

_middle (number)

_halfWidth (number)

▸ middle

src/scale.ts

middle

Type: number

Returns

number

▸ halfWidth

src/scale.ts

halfWidth

Type: number

Returns

number

▸ fullWidth

src/scale.ts

fullWidth

Type: number

Returns

number

▸ min

src/scale.ts

min

Type: number

Returns

number

▸ max

src/scale.ts

max

Type: number

Returns

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(): Promise<Array<AmplitudeScalable>>

Returns

Promise<Array<AmplitudeScalable>>: array of promise of best amp scales

▸ _internalNotifyAll()

src/scale.ts

_internalNotifyAll(): Promise<Array<AmplitudeScalable>>

Returns

Promise<Array<AmplitudeScalable>>

▸ notifyAll()

src/scale.ts

notifyAll(): Promise<Array<AmplitudeScalable>>

Returns

Promise<Array<AmplitudeScalable>>

▸ 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(): Promise<Array<AmplitudeScalable>>

Returns

Promise<Array<AmplitudeScalable>>

▸ notifyAll()

src/scale.ts

notifyAll(): Promise<Array<AmplitudeScalable>>

Returns

Promise<Array<AmplitudeScalable>>

FixedHalfWidthAmplitudeScale

src/scale.ts

new FixedHalfWidthAmplitudeScale(halfWidth: number, graphList: Array<AmplitudeScalable>?)

Extends LinkedAmplitudeScale

Parameters

halfWidth (number)

graphList (Array<AmplitudeScalable>?)

Instance Members

▸ recalculate()

src/scale.ts

recalculate(): Promise<Array<AmplitudeScalable>>

Returns

Promise<Array<AmplitudeScalable>>

▸ notifyAll()

src/scale.ts

notifyAll(): Promise<Array<AmplitudeScalable>>

Returns

Promise<Array<AmplitudeScalable>>

LinkedTimeScale

src/scale.ts

Links time scales across multiple seismographs.

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

Parameters

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

originalDuration (Duration?)

originalOffset (Duration?)

scaleId (number?)

Instance Members

▸ _originalDuration

src/scale.ts

_originalDuration

Type: Duration

▸ _originalOffset

src/scale.ts

_originalOffset

Type: Duration

▸ _zoomedDuration

src/scale.ts

_zoomedDuration

Type: (null | Duration)

▸ _zoomedOffset

src/scale.ts

_zoomedOffset

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(): Promise<Array<TimeScalable>>

Returns

Promise<Array<TimeScalable>>: promise to array of all linked items

▸ notifyAll()

src/scale.ts

notifyAll(): Promise<Array<TimeScalable>>

Returns

Promise<Array<TimeScalable>>

▸ graphList

src/scale.ts

graphList

AlignmentLinkedTimeScale

src/scale.ts

Linked Time Scale that only modifies the alignment via the offset. The duration of the linked TimeScalable is reused.

new AlignmentLinkedTimeScale(graphList: Array<TimeScalable>?, originalDuration: Duration?, originalOffset: Duration?, scaleId: number?)

Extends LinkedTimeScale

Parameters

graphList (Array<TimeScalable>?) [description]

originalDuration (Duration?) [description]

originalOffset (Duration?) [description]

scaleId (number?) [description]

Instance Members

▸ recalculate()

src/scale.ts

Does no calculation, just causes a redraw.

recalculate(): Promise<Array<TimeScalable>>

Returns

Promise<Array<TimeScalable>>: promise to all linked items

▸ notifyAll()

src/scale.ts

notifyAll(): Promise<Array<TimeScalable>>

Returns

Promise<Array<TimeScalable>>