seisplotjs 3.1.1 | Documentation

seisplotjs

3.1.1

MarginType
DEFAULT_TITLE
SeismographConfigCache ▸
SeismographConfig ▸
- Static members
- ._lastID
- .fromJSON
SeismographConfigJsonType
numberFormatWrapper
formatCount
formatExp
formatCountOrAmp
formatMillisecond
formatSecond
formatMinute
formatHour
formatDay
formatMonth
formatYear
multiFormatHour

Need help reading this?

MarginType

Type: {top: number, right: number, bottom: number, left: number, toString: function (): string?}

Properties

top (number)

right (number)

bottom (number)

left (number)

toString (function (): string?)

DEFAULT_TITLE

Type: string

SeismographConfigCache

new SeismographConfigCache()

Instance Members

▸ titleHandlebarsCompiled

titleHandlebarsCompiled

Type: (null | function (arg0: object, arg1: object): string)

▸ xLabelHandlebarsCompiled

xLabelHandlebarsCompiled

Type: (null | function (arg0: object, arg1: object): string)

▸ xSublabelHandlebarsCompiled

xSublabelHandlebarsCompiled

Type: (null | function (arg0: object, arg1: object): string)

▸ yLabelHandlebarsCompiled

yLabelHandlebarsCompiled

Type: (null | function (arg0: object, arg1: object): string)

▸ yLabelRightHandlebarsCompiled

yLabelRightHandlebarsCompiled

Type: (null | function (arg0: object, arg1: object): string)

▸ ySublabelHandlebarsCompiled

ySublabelHandlebarsCompiled

Type: (null | function (arg0: object, arg1: object): string)

SeismographConfig

Configuration object for Seismograph display.

new SeismographConfig()

Static Members

▸ _lastID

_lastID

Type: number

▸ fromJSON(json)

fromJSON(json: SeismographConfigJsonType): SeismographConfig

Parameters

json (SeismographConfigJsonType)

Returns

SeismographConfig

Instance Members

▸ configId

configId

Type: number

▸ timeFormat

timeFormat

Type: function (date: Date): string

▸ relativeTimeFormat

relativeTimeFormat

Type: function (value: number): string

▸ amplitudeFormat

amplitudeFormat

Type: function (value: number): string

▸ showTitle

showTitle

Type: boolean

▸ isXAxisTop

isXAxisTop

Type: boolean

▸ _xLabel

_xLabel

Type: string

▸ xLabelOrientation

xLabelOrientation

Type: string

▸ _xSublabel

_xSublabel

Type: string

▸ xSublabelIsUnits

xSublabelIsUnits

Type: boolean

▸ isYAxis

isYAxis

Type: boolean

▸ isYAxisRight

isYAxisRight

Type: boolean

▸ isYAxisNice

isYAxisNice

Type: boolean

▸ _yLabel

_yLabel

Type: string

▸ _yLabelRight

_yLabelRight

Type: string

▸ yLabelOrientation

yLabelOrientation

Type: string

▸ _ySublabel

_ySublabel

Type: string

▸ ySublabelTrans

ySublabelTrans

Type: number

▸ ySublabelIsUnits

ySublabelIsUnits

Type: boolean

▸ doMarkers

doMarkers

Type: boolean

▸ markerTextOffset

markerTextOffset

Type: number

▸ markerTextAngle

markerTextAngle

Type: number

▸ markerFlagpoleBase

markerFlagpoleBase

Type: string

▸ minHeight

minHeight

Type: number

▸ maxHeight

maxHeight

Type: (null | number)

▸ minWidth

minWidth

Type: number

▸ maxWidth

maxWidth

Type: (null | number)

▸ margin

margin

Type: MarginType

▸ segmentDrawCompressedCutoff

segmentDrawCompressedCutoff

Type: number

▸ maxZoomPixelPerSample

maxZoomPixelPerSample

Type: number

▸ connectSegments

connectSegments

Type: boolean

▸ lineColors

lineColors

Type: Array<string>

▸ lineWidth

lineWidth

Type: number

▸ wheelZoom

wheelZoom

Type: boolean

▸ amplitudeMode

amplitudeMode

Type: AMPLITUDE_MODE

▸ doGain

doGain

Type: boolean

▸ windowAmp

windowAmp

Type: boolean

▸ isRelativeTime

isRelativeTime

Type: boolean

▸ asJSON()

asJSON(): SeismographConfigJsonType

Returns

SeismographConfigJsonType

▸ fixedAmplitudeScale

fixedAmplitudeScale

Type: (null | Array<number>)

Returns

(null | Array<number>)

▸ fixedAmplitudeScale

fixedAmplitudeScale

Type: (null | Array<number>)

Parameters

ts ((null | Array<number>))

▸ linkedAmplitudeScale

linkedAmplitudeScale

Type: (null | LinkedAmplitudeScale)

Returns

(null | LinkedAmplitudeScale)

▸ linkedAmplitudeScale

linkedAmplitudeScale

Type: (null | LinkedAmplitudeScale)

Parameters

ts ((null | LinkedAmplitudeScale))

▸ enableLinkedAmplitude()

Enable linked amplitude scales across seismographs.

enableLinkedAmplitude()

▸ amplitudeRaw()

amplitudeRaw()

▸ amplitudeMinMax()

amplitudeMinMax()

▸ amplitudeMean()

amplitudeMean()

▸ amplitudeWithZero()

amplitudeWithZero()

▸ isCenteredAmp()

True if the amplitude is "centered".

Both MinMax and Mean center the amplitude, Raw and Zero do not.

isCenteredAmp(): any

Returns

any: if centered

▸ fixedTimeScale

fixedTimeScale

Type: (null | Interval)

Returns

(null | Interval)

▸ fixedTimeScale

fixedTimeScale

Type: (null | Interval)

Parameters

ts ((null | Interval))

▸ linkedTimeScale

linkedTimeScale

Type: (null | LinkedTimeScale)

Returns

(null | LinkedTimeScale)

▸ linkedTimeScale

linkedTimeScale

Type: (null | LinkedTimeScale)

Parameters

ts ((null | LinkedTimeScale))

▸ title

gets the current title

title

Type: Array<string>

Returns

Array<string>: title as an array of strings

▸ title

Sets the title as simple string or array of strings or a handlebars template. If an array then each item will be in a separate tspan for easier formatting.

title

Type: (null | string | Array<string>)

Parameters

value ((null | string | Array<string>)) string or array of strings to be the title

▸ handlebarsTitle(context, runtimeOptions)

handlebarsTitle(context: object, runtimeOptions: object): string

Parameters

context (object)

runtimeOptions (object)

Returns

string

▸ xLabel

gets the current x label

xLabel

Type: string

Returns

string: x label

▸ xLabel

Sets the xLabel as simple string or a handlebars template.

xLabel

Type: (null | string)

Parameters

value ((null | string)) string to be the x label

▸ xSublabel

gets the current x sublabel

xSublabel

Type: string

Returns

string: x sublabel

▸ xSublabel

Sets the xSublabel as simple string or a handlebars template.

xSublabel

Type: (null | string)

Parameters

value ((null | string)) string to be the x sublabel

▸ handlebarsXLabel(context, runtimeOptions)

handlebarsXLabel(context: object, runtimeOptions: object): string

Parameters

context (object)

runtimeOptions (object)

Returns

string

▸ handlebarsXSublabel(context, runtimeOptions)

handlebarsXSublabel(context: object, runtimeOptions: object): string

Parameters

context (object)

runtimeOptions (object)

Returns

string

▸ yLabel

gets the current y label

yLabel

Type: string

Returns

string: yLabel

▸ yLabel

Sets the ylabel as simple string or a handlebars template.

yLabel

Type: (null | string)

Parameters

value ((null | string)) string to be the y label

▸ ySublabel

gets the current y sublabel

ySublabel

Type: string

Returns

string: ySublabel

▸ ySublabel

Sets the y sublabel as simple string or a handlebars template.

ySublabel

Type: (null | string)

Parameters

value ((null | string)) string to be the y sublabel

▸ handlebarsYLabel(context, runtimeOptions)

handlebarsYLabel(context: object, runtimeOptions: object): string

Parameters

context (object)

runtimeOptions (object)

Returns

string

▸ handlebarsYSublabel(context, runtimeOptions)

handlebarsYSublabel(context: object, runtimeOptions: object): string

Parameters

context (object)

runtimeOptions (object)

Returns

string

▸ yLabelRight

gets the current title

yLabelRight

Type: string

Returns

string: yLabel

▸ yLabelRight

Sets the ylabel as simple string or a handlebars template.

yLabelRight

Type: (null | string)

Parameters

value ((null | string)) string to be the y label

▸ handlebarsYLabelRight(context, runtimeOptions)

handlebarsYLabelRight(context: object, runtimeOptions: object): string

Parameters

context (object)

runtimeOptions (object)

Returns

string

▸ createAlignmentData(timeRange, min, max)

Fake data to use to test alignment of seismograph axis and between canvas and svg drawing.

createAlignmentData(timeRange: Interval, min: any, max: any): SeismogramDisplayData

Parameters

timeRange (Interval) start and end of fake data

min

(any
            = -100)

min amplitude for fake data, default is -100

max

(any
            = 100)

max amplitude for fake data, default is 100

Returns

SeismogramDisplayData: fake data

▸ getColorForIndex(i)

getColorForIndex(i: number): string

Parameters

i (number)

Returns

string

▸ createCSSForLineColors(svgClass?)

createCSSForLineColors(svgClass: string?): string

Parameters

svgClass (string?)

Returns

string

▸ clone()

clone(): SeismographConfig

Returns

SeismographConfig

▸ toString()

toString(): string

Returns

string

SeismographConfigJsonType

Type: {configId: number, showTitle: boolean, title: Array<string>, isXAxis: boolean, isXAxisTop: boolean, xLabel: string, xLabelOrientation: string, xSublabel: string, xSublabelIsUnits: boolean, isYAxis: boolean, isYAxisRight: boolean, isYAxisNice: boolean, yLabel: string, yLabelRight: string, yLabelOrientation: string, ySublabel: string, ySublabelTrans: number, ySublabelIsUnits: boolean, doMarkers: boolean, markerTextOffset: number, markerTextAngle: number, markerFlagpoleBase: string, minHeight: number, maxHeight: (null | number), minWidth: number, maxWidth: (null | number), margin: MarginType, segmentDrawCompressedCutoff: number, maxZoomPixelPerSample: number, connectSegments: boolean, lineColors: Array<string>, lineWidth: number, wheelZoom: boolean, amplitudeMode: AMPLITUDE_MODE, doGain: boolean, windowAmp: boolean, fixedAmplitudeScale: (null | Array<number>), fixedTimeScale: (null | Interval), isLinkedAmplitudeScale: boolean, isLinkedTimeScale: boolean, isRelativeTime: boolean}

Properties

configId (number)

showTitle (boolean)

title (Array<string>)

isXAxis (boolean)

isXAxisTop (boolean)

xLabel (string)

xLabelOrientation (string)

xSublabel (string)

xSublabelIsUnits (boolean)

isYAxis (boolean)

isYAxisRight (boolean)

isYAxisNice (boolean)

yLabel (string)

yLabelRight (string)

yLabelOrientation (string)

ySublabel (string)

ySublabelTrans (number)

ySublabelIsUnits (boolean)

doMarkers (boolean)

markerTextOffset (number)

markerTextAngle (number)

markerFlagpoleBase (string)

minHeight (number)

maxHeight ((null | number))

minWidth (number)

maxWidth ((null | number))

margin (MarginType)

segmentDrawCompressedCutoff (number)

maxZoomPixelPerSample (number)

connectSegments (boolean)

lineColors (Array<string>)

lineWidth (number)

wheelZoom (boolean)

amplitudeMode (AMPLITUDE_MODE)

doGain (boolean)

windowAmp (boolean)

fixedAmplitudeScale ((null | Array<number>))

fixedTimeScale ((null | Interval))

isLinkedAmplitudeScale (boolean)

isLinkedTimeScale (boolean)

isRelativeTime (boolean)

numberFormatWrapper

numberFormatWrapper(formater: function (arg0: number): string): function (domainValue: AxisDomain): string

Parameters

formater (function (arg0: number): string)

Returns

function (domainValue: AxisDomain): string

formatCount

Type: function (arg0: number): string

formatExp

Type: function (arg0: number): string

formatCountOrAmp

Parameters

v (number)

Returns

string