seisplotjs 3.2.7 | Documentation

seisplotjs

3.2.7

AMPLITUDE_MODE
PHI
SQRT_PHI
MinMaxable ▸
- Static members
- .fromArray
- .fromMiddleHalfWidth
- Instance members
- #middle
- #halfWidth
- #fullWidth
- #union
- #expandPercentage
- #asArray
- #toString
AmplitudeScalable ▸
- Instance members
- #notifyAmplitudeChange
- #middle
- #halfWidth
- #fullWidth
- #min
- #max
- #toString
TimeScalable ▸
- Instance members
- #notifyTimeRangeChange
LinkedAmplitudeScale ▸
- Instance members
- #halfWidth
- #halfWidth
- #linkAll
- #link
- #unlink
- #recalculate
- #_internalNotifyAll
- #notifyAll
- #graphList
IndividualAmplitudeScale ▸
- Instance members
- #recalculate
- #notifyAll
FixedHalfWidthAmplitudeScale ▸
- Instance members
- #recalculate
- #notifyAll
LinkedTimeScale ▸
- Instance members
- #link
- #linkAll
- #unlink
- #zoom
- #unzoom
- #offset
- #offset
- #duration
- #duration
- #origOffset
- #origDuration
- #recalculate
- #notifyAll
- #graphList
AlignmentLinkedTimeScale ▸
- Instance members
- #recalculate
- #notifyAll
PanZoomer ▸
- Instance members
- #target
- #target
- #transitionZoom
- #doZoom

Need help reading this?

AMPLITUDE_MODE

dist/scale.mjs

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

AMPLITUDE_MODE

PHI

dist/scale.mjs

The Golden ratio.

PHI

SQRT_PHI

dist/scale.mjs

SQRT_PHI

MinMaxable

dist/scale.mjs

new MinMaxable(min: any, max: any)

Parameters

min (any)

max (any)

Static Members

▸ fromArray(minmax)

dist/scale.mjs

Create MinMaxable from a d3 style two element array.

fromArray(minmax: any): any

Parameters

minmax (any) array of min then max

Returns

any: new MinMaxable

▸ fromMiddleHalfWidth(mid, halfWidth)

dist/scale.mjs

fromMiddleHalfWidth(mid: any, halfWidth: any)

Parameters

mid (any)

halfWidth (any)

Instance Members

▸ middle

dist/scale.mjs

middle

▸ halfWidth

dist/scale.mjs

halfWidth

▸ fullWidth

dist/scale.mjs

fullWidth

▸ union(omm)

dist/scale.mjs

union(omm: any)

Parameters

omm (any)

▸ expandPercentage(percent)

dist/scale.mjs

expandPercentage(percent: any)

Parameters

percent (any)

▸ asArray()

dist/scale.mjs

This as a d3 style 2 element array.

asArray(): any

Returns

any: length 2 array of min then max

▸ toString()

dist/scale.mjs

toString()

AmplitudeScalable

dist/scale.mjs

new AmplitudeScalable(minMax: any)

Parameters

minMax (any)

Instance Members

▸ notifyAmplitudeChange(_middle, _halfWidth)

dist/scale.mjs

notifyAmplitudeChange(_middle: any, _halfWidth: any)

Parameters

_middle (any)

_halfWidth (any)

▸ middle

dist/scale.mjs

middle

▸ halfWidth

dist/scale.mjs

halfWidth

▸ fullWidth

dist/scale.mjs

fullWidth

▸ min

dist/scale.mjs

min

▸ max

dist/scale.mjs

max

▸ toString()

dist/scale.mjs

toString()

TimeScalable

dist/scale.mjs

new TimeScalable(alignmentTimeOffset: any, duration: any)

Parameters

alignmentTimeOffset (any)

duration (any)

Instance Members

▸ notifyTimeRangeChange(_alignmentTimeOffset, _duration)

dist/scale.mjs

notifyTimeRangeChange(_alignmentTimeOffset: any, _duration: any)

Parameters

_alignmentTimeOffset (any)

_duration (any)

LinkedAmplitudeScale

dist/scale.mjs

Links amplitude scales across multiple seismographs, respecting doRmean.

new LinkedAmplitudeScale(graphList: any)

Parameters

graphList (any) optional list of AmplitudeScalable to link

Instance Members

▸ halfWidth

dist/scale.mjs

halfWidth

▸ halfWidth

dist/scale.mjs

halfWidth

Parameters

val (any)

▸ linkAll(graphList)

dist/scale.mjs

Links new Seismograph with this amplitude scale.

linkAll(graphList: any)

Parameters

graphList (any) Array of AmplitudeScalable to link

▸ link(graph)

dist/scale.mjs

Link new Seismograph with this amplitude scale.

link(graph: any)

Parameters

graph (any) AmplitudeScalable to link

▸ unlink(graph)

dist/scale.mjs

Unlink Seismograph with this amplitude scale.

unlink(graph: any)

Parameters

graph (any) AmplitudeScalable to unlink

▸ recalculate()

dist/scale.mjs

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

recalculate(): any

Returns

any: array of promise of best amp scales

▸ _internalNotifyAll()

dist/scale.mjs

_internalNotifyAll()

▸ notifyAll()

dist/scale.mjs

notifyAll()

▸ graphList

dist/scale.mjs

graphList

IndividualAmplitudeScale

dist/scale.mjs

new IndividualAmplitudeScale(graphList: any)

Extends LinkedAmplitudeScale

Parameters

graphList (any)

Instance Members

▸ recalculate()

dist/scale.mjs

recalculate()

▸ notifyAll()

dist/scale.mjs

notifyAll()

FixedHalfWidthAmplitudeScale

dist/scale.mjs

new FixedHalfWidthAmplitudeScale(halfWidth: any, graphList: any)

Extends LinkedAmplitudeScale

Parameters

halfWidth (any)

graphList (any)

Instance Members

▸ recalculate()

dist/scale.mjs

recalculate()

▸ notifyAll()

dist/scale.mjs

notifyAll()

LinkedTimeScale

dist/scale.mjs

Links time scales across multiple seismographs.

new LinkedTimeScale(graphList: any, originalDuration: any, originalOffset: any, scaleId: any)

Parameters

graphList (any) optional list of TimeScalables to link

originalDuration (any)

originalOffset (any)

scaleId (any)

Instance Members

▸ link(graph)

dist/scale.mjs

Link new TimeScalable with this time scale.

link(graph: any)

Parameters

graph (any) TimeScalable to link

▸ linkAll(graphList)

dist/scale.mjs

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: any)

Parameters

graphList (any) Array of TimeScalable to link

▸ unlink(graph)

dist/scale.mjs

Unlink TimeScalable with this amplitude scale.

unlink(graph: any)

Parameters

graph (any) TimeScalable to unlink

▸ zoom(startOffset, duration)

dist/scale.mjs

zoom(startOffset: any, duration: any)

Parameters

startOffset (any)

duration (any)

▸ unzoom()

dist/scale.mjs

Return to original no-zoom zoom level

unzoom()

▸ offset

dist/scale.mjs

offset

▸ offset

dist/scale.mjs

offset

Parameters

offset (any)

▸ duration

dist/scale.mjs

duration

▸ duration

dist/scale.mjs

duration

Parameters

duration (any)

▸ origOffset

dist/scale.mjs

origOffset

▸ origDuration

dist/scale.mjs

origDuration

▸ recalculate()

dist/scale.mjs

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

recalculate(): any

Returns

any: promise to array of all linked items

▸ notifyAll()

dist/scale.mjs

notifyAll()

▸ graphList

dist/scale.mjs

graphList

AlignmentLinkedTimeScale

dist/scale.mjs

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

new AlignmentLinkedTimeScale(graphList: any, originalDuration: any, originalOffset: any, scaleId: any)

Extends LinkedTimeScale

Parameters

graphList (any) [description]

originalDuration (any) [description]

originalOffset (any) [description]

scaleId (any) [description]

Instance Members

▸ recalculate()

dist/scale.mjs

Does no calculation, just causes a redraw.

recalculate(): any

Returns

any: promise to all linked items

▸ notifyAll()

dist/scale.mjs

notifyAll()

PanZoomer

dist/scale.mjs

new PanZoomer(target: any, linkedTimeScale: any, wheelZoom: any)

Parameters

target (any)

linkedTimeScale (any)

wheelZoom (any)

Instance Members

▸ target

dist/scale.mjs

target

Parameters

target (any)

▸ target

dist/scale.mjs

target

▸ transitionZoom(factor, offsetX, duration)

dist/scale.mjs

transitionZoom(factor: any, offsetX: any, duration: any)

Parameters

factor (any)

offsetX (any)

duration

(any
            = 250)

▸ doZoom(k, x, width)

dist/scale.mjs

doZoom(k: any, x: any, width: any)

Parameters

k (any)

x (any)

width (any)