seisplotjs 3.0.0-alpha.1

seisplotjs

3.0.0-alpha.1

MarginType
DRAW_SVG
DRAW_CANVAS
DRAW_BOTH
DRAW_BOTH_ALIGN
DEFAULT_TITLE
SeismographConfig ▸
- Static members
- ._lastID
- .fromJSON
numberFormatWrapper
formatCount
formatExp
formatCountOrAmp
formatMillisecond
formatSecond
formatMinute
formatHour
formatDay
formatMonth
formatYear
multiFormatHour

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?)

DRAW_SVG

src/seismographconfig.ts

Constant for drawing seismogram using svg.

DRAW_SVG

Type: string

DRAW_CANVAS

src/seismographconfig.ts

Constant for drawing seismogram using canvas, axies are still svg.

DRAW_CANVAS

Type: string

DRAW_BOTH

src/seismographconfig.ts

Constant for drawing seismogram using both canvas and svg, for testing.

DRAW_BOTH

Type: string

DRAW_BOTH_ALIGN

src/seismographconfig.ts

Constant for drawing seismogram using both canvas and svg plus alignment markers, for testing.

DRAW_BOTH_ALIGN

Type: string

DEFAULT_TITLE

src/seismographconfig.ts

DEFAULT_TITLE

Type: string

SeismographConfig

src/seismographconfig.ts

Configuration object for Seismograph display.

new SeismographConfig()

Static Members

▸ _lastID

src/seismographconfig.ts

_lastID

Type: number

▸ fromJSON(json)

src/seismographconfig.ts

fromJSON(json: any): SeismographConfig

Parameters

json (any)

Returns

SeismographConfig

Instance Members

▸ configId

src/seismographconfig.ts

configId

Type: number

▸ drawingType

src/seismographconfig.ts

drawingType

Type: string

▸ timeFormat

src/seismographconfig.ts

timeFormat

Type: 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

▸ isXAxis

src/seismographconfig.ts

isXAxis

Type: boolean

▸ isXAxisTop

src/seismographconfig.ts

isXAxisTop

Type: boolean

▸ _xLabel

src/seismographconfig.ts

_xLabel

Type: string

▸ xLabelOrientation

src/seismographconfig.ts

xLabelOrientation

Type: string

▸ _xSublabel

src/seismographconfig.ts

_xSublabel

Type: string

▸ xSublabelIsUnits

src/seismographconfig.ts

xSublabelIsUnits

Type: boolean

▸ isYAxis

src/seismographconfig.ts

isYAxis

Type: boolean

▸ isYAxisRight

src/seismographconfig.ts

isYAxisRight

Type: boolean

▸ isYAxisNice

src/seismographconfig.ts

isYAxisNice

Type: boolean

▸ _yLabel

src/seismographconfig.ts

_yLabel

Type: string

▸ _yLabelRight

src/seismographconfig.ts

_yLabelRight

Type: string

▸ yLabelOrientation

src/seismographconfig.ts

yLabelOrientation

Type: string

▸ _ySublabel

src/seismographconfig.ts

_ySublabel

Type: string

▸ ySublabelTrans

src/seismographconfig.ts

ySublabelTrans

Type: number

▸ ySublabelIsUnits

src/seismographconfig.ts

ySublabelIsUnits

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

▸ wheelZoom

src/seismographconfig.ts

wheelZoom

Type: boolean

▸ centeredAmp

src/seismographconfig.ts

centeredAmp

Type: boolean

▸ doGain

src/seismographconfig.ts

doGain

Type: boolean

▸ windowAmp

src/seismographconfig.ts

windowAmp

Type: boolean

▸ isRelativeTime

src/seismographconfig.ts

isRelativeTime

Type: boolean

▸ asJSON()

src/seismographconfig.ts

asJSON(): any

Returns

any

▸ 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))

▸ 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))

▸ 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: {}, runtimeOptions: {}): string

Parameters

context ({})

runtimeOptions ({})

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: {}, runtimeOptions: {}): string

Parameters

context ({})

runtimeOptions ({})

Returns

string

▸ handlebarsXSublabel(context, runtimeOptions)

src/seismographconfig.ts

handlebarsXSublabel(context: {}, runtimeOptions: {}): string

Parameters

context ({})

runtimeOptions ({})

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: {}, runtimeOptions: {}): string

Parameters

context ({})

runtimeOptions ({})

Returns

string

▸ handlebarsYSublabel(context, runtimeOptions)

src/seismographconfig.ts

handlebarsYSublabel(context: {}, runtimeOptions: {}): string

Parameters

context ({})

runtimeOptions ({})

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: {}, runtimeOptions: {}): string

Parameters

context ({})

runtimeOptions ({})

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

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