seisplotjs 3.2.0 | Documentation

seisplotjs

3.2.0

MarginType
DEFAULT_TITLE
SeismographConfigCache ▸
SeismographConfig ▸
- Static members
- .fromJSON
SeismographConfigJsonType
numberFormatWrapper
formatCount
formatExp
formatCountOrAmp
createTimeFormatterForZone

Need help reading this?

MarginType

src/seismographconfig.ts

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

src/seismographconfig.ts

DEFAULT_TITLE

Type: string

SeismographConfigCache

src/seismographconfig.ts

new SeismographConfigCache()

Instance Members

▸ titleHandlebarsCompiled

src/seismographconfig.ts

titleHandlebarsCompiled

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

▸ xLabelHandlebarsCompiled

src/seismographconfig.ts

xLabelHandlebarsCompiled

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

▸ xSublabelHandlebarsCompiled

src/seismographconfig.ts

xSublabelHandlebarsCompiled

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

▸ yLabelHandlebarsCompiled

src/seismographconfig.ts

yLabelHandlebarsCompiled

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

▸ yLabelRightHandlebarsCompiled

src/seismographconfig.ts

yLabelRightHandlebarsCompiled

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

▸ ySublabelHandlebarsCompiled

src/seismographconfig.ts

ySublabelHandlebarsCompiled

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

SeismographConfig

src/seismographconfig.ts

Configuration object for Seismograph display.

new SeismographConfig()

Static Members

▸ fromJSON(json)

src/seismographconfig.ts

fromJSON(json: SeismographConfigJsonType): SeismographConfig

Parameters

json (SeismographConfigJsonType)

Returns

SeismographConfig

Instance Members

▸ configId

src/seismographconfig.ts

configId

Type: number

▸ _timeFormat

src/seismographconfig.ts

_timeFormat

Type: (null | function (date: Date): string)

▸ relativeTimeFormat

src/seismographconfig.ts

relativeTimeFormat

Type: function (value: number): string

▸ amplitudeFormat

src/seismographconfig.ts

amplitudeFormat

Type: function (value: number): string

▸ showTitle

src/seismographconfig.ts

showTitle

Type: boolean

▸ xAxisTimeZone

src/seismographconfig.ts

xAxisTimeZone

Type: (null | string | Zone)

▸ isXAxisTop

src/seismographconfig.ts

isXAxisTop

Type: boolean

▸ xLabelOrientation

src/seismographconfig.ts

xLabelOrientation

Type: string

▸ xSublabelIsUnits

src/seismographconfig.ts

xSublabelIsUnits

Type: boolean

▸ xGridLines

src/seismographconfig.ts

Should grid lines be drawn for each tick on the x axis.

xGridLines

Type: boolean

▸ isYAxis

src/seismographconfig.ts

isYAxis

Type: boolean

▸ isYAxisRight

src/seismographconfig.ts

isYAxisRight

Type: boolean

▸ isYAxisNice

src/seismographconfig.ts

isYAxisNice

Type: boolean

▸ yAxisNumTickHint

src/seismographconfig.ts

hint for number of ticks to show on y axis. Note this is not exact as trying to put ticks on "even" numbers may result in slightly more or less.

yAxisNumTickHint

Type: number

▸ yLabelOrientation

src/seismographconfig.ts

yLabelOrientation

Type: string

▸ ySublabelTrans

src/seismographconfig.ts

ySublabelTrans

Type: number

▸ ySublabelIsUnits

src/seismographconfig.ts

ySublabelIsUnits

Type: boolean

▸ yGridLines

src/seismographconfig.ts

yGridLines

Type: boolean

▸ doMarkers

src/seismographconfig.ts

doMarkers

Type: boolean

▸ markerTextOffset

src/seismographconfig.ts

markerTextOffset

Type: number

▸ markerTextAngle

src/seismographconfig.ts

markerTextAngle

Type: number

▸ markerFlagpoleBase

src/seismographconfig.ts

markerFlagpoleBase

Type: string

▸ minHeight

src/seismographconfig.ts

minHeight

Type: number

▸ maxHeight

src/seismographconfig.ts

maxHeight

Type: (null | number)

▸ minWidth

src/seismographconfig.ts

minWidth

Type: number

▸ maxWidth

src/seismographconfig.ts

maxWidth

Type: (null | number)

▸ margin

src/seismographconfig.ts

margin

Type: MarginType

▸ segmentDrawCompressedCutoff

src/seismographconfig.ts

segmentDrawCompressedCutoff

Type: number

▸ maxZoomPixelPerSample

src/seismographconfig.ts

maxZoomPixelPerSample

Type: number

▸ connectSegments

src/seismographconfig.ts

connectSegments

Type: boolean

▸ lineColors

src/seismographconfig.ts

lineColors

Type: Array<string>

▸ lineWidth

src/seismographconfig.ts

lineWidth

Type: number

▸ gridLineColor

src/seismographconfig.ts

gridLineColor

Type: string

▸ allowZoom

src/seismographconfig.ts

allowZoom

Type: boolean

▸ wheelZoom

src/seismographconfig.ts

wheelZoom

Type: boolean

▸ amplitudeMode

src/seismographconfig.ts

amplitudeMode

Type: AMPLITUDE_MODE

▸ doGain

src/seismographconfig.ts

doGain

Type: boolean

▸ windowAmp

src/seismographconfig.ts

windowAmp

Type: boolean

▸ resolutionScale

src/seismographconfig.ts

resolutionScale

Type: number

▸ isRelativeTime

src/seismographconfig.ts

isRelativeTime

Type: boolean

▸ asJSON()

src/seismographconfig.ts

asJSON(): SeismographConfigJsonType

Returns

SeismographConfigJsonType

▸ fixedAmplitudeScale

src/seismographconfig.ts

fixedAmplitudeScale

Type: (null | Array<number>)

Returns

(null | Array<number>)

▸ fixedAmplitudeScale

src/seismographconfig.ts

fixedAmplitudeScale

Type: (null | Array<number>)

Parameters

ts ((null | Array<number>))

▸ linkedAmplitudeScale

src/seismographconfig.ts

linkedAmplitudeScale

Type: (null | LinkedAmplitudeScale)

Returns

(null | LinkedAmplitudeScale)

▸ linkedAmplitudeScale

src/seismographconfig.ts

linkedAmplitudeScale

Type: (null | LinkedAmplitudeScale)

Parameters

ts ((null | LinkedAmplitudeScale))

▸ enableLinkedAmplitude()

src/seismographconfig.ts

Enable linked amplitude scales across seismographs.

enableLinkedAmplitude()

▸ amplitudeRaw()

src/seismographconfig.ts

Set Raw amplitude mode, plot absolute and goes from minimun to maximum of data

amplitudeRaw()

▸ amplitudeMinMax()

src/seismographconfig.ts

Set MinMax amplitude mode, plot is relative and centered on (minimun + maximum)/2

amplitudeMinMax()

▸ amplitudeMean()

src/seismographconfig.ts

Set Mean amplitude mode, plot is relative and centered on mean of data

amplitudeMean()

▸ amplitudeWithZero()

src/seismographconfig.ts

Set WithZero amplitude mode, plot is absolute and centered on mean of data like Raw, but also includes zero even if all data is positive. Useful when showing data compared to zero is helpful.

amplitudeWithZero()

▸ isCenteredAmp()

src/seismographconfig.ts

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

src/seismographconfig.ts

fixedTimeScale

Type: (null | Interval)

Returns

(null | Interval)

▸ fixedTimeScale

src/seismographconfig.ts

fixedTimeScale

Type: (null | Interval)

Parameters

ts ((null | Interval))

▸ linkedTimeScale

src/seismographconfig.ts

linkedTimeScale

Type: (null | LinkedTimeScale)

Returns

(null | LinkedTimeScale)

▸ linkedTimeScale

src/seismographconfig.ts

linkedTimeScale

Type: (null | LinkedTimeScale)

Parameters

ts ((null | LinkedTimeScale))

▸ enableXAxisTimeZone(zone)

src/seismographconfig.ts

Configures the time axis to show times in the given time zone. This replaces timeFormat with createTimeFormatterForZone() and sets xSublabel to be the zone name. If zone is null, uses UTC.

enableXAxisTimeZone(zone: (null | Zone | string))

Parameters

zone ((null | Zone | string)) string like "US/Eastern" or luxon Zone

▸ timeFormat

src/seismographconfig.ts

Time formatter used by the x axis. Defaults to UTC via createTimeFormatterForZone(zone). Set xAxisTimeZone to change the time zone.

timeFormat

Returns

any: formatter for x axis time labels

▸ timeFormat

src/seismographconfig.ts

timeFormat

Type: function (arg0: Date): string

Parameters

formatter (function (arg0: Date): string)

▸ title

src/seismographconfig.ts

gets the current title

title

Type: Array<string>

Returns

Array<string>: title as an array of strings

▸ title

src/seismographconfig.ts

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)

src/seismographconfig.ts

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

Parameters

context (object)

runtimeOptions (object)

Returns

string

▸ xLabel

src/seismographconfig.ts

gets the current x label

xLabel

Type: string

Returns

string: x label

▸ xLabel

src/seismographconfig.ts

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

src/seismographconfig.ts

gets the current x sublabel

xSublabel

Type: string

Returns

string: x sublabel

▸ xSublabel

src/seismographconfig.ts

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)

src/seismographconfig.ts

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

Parameters

context (object)

runtimeOptions (object)

Returns

string

▸ handlebarsXSublabel(context, runtimeOptions)

src/seismographconfig.ts

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

Parameters

context (object)

runtimeOptions (object)

Returns

string

▸ yLabel

src/seismographconfig.ts

gets the current y label

yLabel

Type: string

Returns

string: yLabel

▸ yLabel

src/seismographconfig.ts

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

src/seismographconfig.ts

gets the current y sublabel

ySublabel

Type: string

Returns

string: ySublabel

▸ ySublabel

src/seismographconfig.ts

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)

src/seismographconfig.ts

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

Parameters

context (object)

runtimeOptions (object)

Returns

string

▸ handlebarsYSublabel(context, runtimeOptions)

src/seismographconfig.ts

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

Parameters

context (object)

runtimeOptions (object)

Returns

string

▸ yLabelRight

src/seismographconfig.ts

gets the current title

yLabelRight

Type: string

Returns

string: yLabel

▸ yLabelRight

src/seismographconfig.ts

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)

src/seismographconfig.ts

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

Parameters

context (object)

runtimeOptions (object)

Returns

string

▸ createAlignmentData(timeRange, min, max)

src/seismographconfig.ts

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)

src/seismographconfig.ts

getColorForIndex(i: number): string

Parameters

i (number)

Returns

string

▸ createCSSForLineColors(svgClass?)

src/seismographconfig.ts

createCSSForLineColors(svgClass: string?): string

Parameters

svgClass (string?)

Returns

string

▸ clone()

src/seismographconfig.ts

clone(): SeismographConfig

Returns

SeismographConfig

▸ toString()

src/seismographconfig.ts

toString(): string

Returns

string

SeismographConfigJsonType

src/seismographconfig.ts

SeismographConfigJsonType

Type: {configId: number, showTitle: boolean, title: Array<string>, isXAxis: boolean, xAxisTimeZone: string, 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)

xAxisTimeZone (string)

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

src/seismographconfig.ts

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

Parameters

formater (function (arg0: number): string)

Returns

function (domainValue: AxisDomain): string

formatCount

src/seismographconfig.ts

formatCount

Type: function (arg0: number): string

formatExp

src/seismographconfig.ts

formatExp

Type: function (arg0: number): string

formatCountOrAmp

src/seismographconfig.ts

formatCountOrAmp

Parameters

v (number)

Returns

string

createTimeFormatterForZone

src/seismographconfig.ts

createTimeFormatterForZone(timezone: Zone): function (arg0: Date): string

Parameters

timezone (Zone)

Returns

function (arg0: Date): string