seisplotjs.seismographconfig 2.0.0

seisplotjs.seismographconfig

2.0.0

MarginType
DRAW_SVG
DRAW_CANVAS
DRAW_BOTH
DRAW_BOTH_ALIGN
SeismographConfig ▸
- Instance members
- #drawingType
- #xScaleFormat
- #yScaleFormat
- #_title
- #isXAxis
- #isXAxisTop
- #xLabel
- #xLabelOrientation
- #xSublabel
- #isYAxis
- #isYAxisRight
- #isYAxisNice
- #yLabel
- #yLabelRight
- #yLabelOrientation
- #ySublabel
- #ySublabelTrans
- #ySublabelIsUnits
- #doMarkers
- #markerTextOffset
- #markerTextAngle
- #markerFlagpoleBase
- #minHeight
- #maxHeight
- #margin
- #segmentDrawCompressedCutoff
- #maxZoomPixelPerSample
- #connectSegments
- #lineColors
- #lineWidth
- #wheelZoom
- #doRMean
- #doGain
- #windowAmp
- #fixedYScale
- #fixedTimeScale
- #title
- #title
- #createAlignmentData
- #getColorForIndex
- #clone
- #toString
formatCount
formatExp
formatCountOrAmp
formatMillisecond
formatSecond
formatMinute
formatHour
formatDay
formatMonth
formatYear
multiFormatHour

Need help reading this?

MarginType

src/seismographconfig.js

MarginType

Type: {top: number, right: number, bottom: number, left: number}

Properties

top (number)

right (number)

bottom (number)

left (number)

DRAW_SVG

src/seismographconfig.js

Constant for drawing seismogram using svg.

DRAW_SVG

Type: string

DRAW_CANVAS

src/seismographconfig.js

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

DRAW_CANVAS

Type: string

DRAW_BOTH

src/seismographconfig.js

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

DRAW_BOTH

Type: string

DRAW_BOTH_ALIGN

src/seismographconfig.js

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

DRAW_BOTH_ALIGN

Type: string

SeismographConfig

src/seismographconfig.js

Configuration object for Seismograph display.

new SeismographConfig()

Instance Members

▸ drawingType

src/seismographconfig.js

drawingType

Type: string

▸ xScaleFormat

src/seismographconfig.js

xScaleFormat

Type: function (date: Date): string

▸ yScaleFormat

src/seismographconfig.js

yScaleFormat

Type: (string | function (value: number): string)

▸ _title

src/seismographconfig.js

_title

Type: Array<string>

▸ isXAxis

src/seismographconfig.js

isXAxis

Type: boolean

▸ isXAxisTop

src/seismographconfig.js

isXAxisTop

Type: boolean

▸ xLabel

src/seismographconfig.js

xLabel

Type: string

▸ xLabelOrientation

src/seismographconfig.js

xLabelOrientation

Type: string

▸ xSublabel

src/seismographconfig.js

xSublabel

Type: string

▸ isYAxis

src/seismographconfig.js

isYAxis

Type: boolean

▸ isYAxisRight

src/seismographconfig.js

isYAxisRight

Type: boolean

▸ isYAxisNice

src/seismographconfig.js

isYAxisNice

Type: boolean

▸ yLabel

src/seismographconfig.js

yLabel

Type: string

▸ yLabelRight

src/seismographconfig.js

yLabelRight

Type: string

▸ yLabelOrientation

src/seismographconfig.js

yLabelOrientation

Type: string

▸ ySublabel

src/seismographconfig.js

ySublabel

Type: string

▸ ySublabelTrans

src/seismographconfig.js

ySublabelTrans

Type: number

▸ ySublabelIsUnits

src/seismographconfig.js

ySublabelIsUnits

Type: boolean

▸ doMarkers

src/seismographconfig.js

doMarkers

Type: boolean

▸ markerTextOffset

src/seismographconfig.js

markerTextOffset

Type: number

▸ markerTextAngle

src/seismographconfig.js

markerTextAngle

Type: number

▸ markerFlagpoleBase

src/seismographconfig.js

markerFlagpoleBase

Type: string

▸ minHeight

src/seismographconfig.js

minHeight

Type: number

▸ maxHeight

src/seismographconfig.js

maxHeight

Type: number

▸ margin

src/seismographconfig.js

margin

Type: MarginType

▸ segmentDrawCompressedCutoff

src/seismographconfig.js

segmentDrawCompressedCutoff

Type: number

▸ maxZoomPixelPerSample

src/seismographconfig.js

maxZoomPixelPerSample

Type: number

▸ connectSegments

src/seismographconfig.js

connectSegments

Type: boolean

▸ lineColors

src/seismographconfig.js

lineColors

Type: Array<string>

▸ lineWidth

src/seismographconfig.js

lineWidth

Type: number

▸ wheelZoom

src/seismographconfig.js

wheelZoom

Type: boolean

▸ doRMean

src/seismographconfig.js

doRMean

Type: boolean

▸ doGain

src/seismographconfig.js

doGain

Type: boolean

▸ windowAmp

src/seismographconfig.js

windowAmp

Type: boolean

▸ fixedYScale

src/seismographconfig.js

fixedYScale

Type: (null | Array<number>)

▸ fixedTimeScale

src/seismographconfig.js

fixedTimeScale

Type: (null | StartEndDuration)

▸ title

src/seismographconfig.js

gets the current title

title

Type: Array<string>

Returns

Array<string>: title as an array of strings

▸ title

src/seismographconfig.js

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

title

Type: (string | Array<string>)

Parameters

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

▸ createAlignmentData(timeWindow, min, max)

src/seismographconfig.js

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

createAlignmentData(timeWindow: StartEndDuration, min: number, max: number): SeismogramDisplayData

Parameters

timeWindow (StartEndDuration) start and end of fake data

min

(number
            = -100)

min amplitude for fake data, default is -100

max

(number
            = 100)

max amplitude for fake data, default is 100

Returns

SeismogramDisplayData: fake data

▸ getColorForIndex(i)

src/seismographconfig.js

getColorForIndex(i: number): string

Parameters

i (number)

Returns

string

▸ clone()

src/seismographconfig.js

clone(): SeismographConfig

Returns

SeismographConfig

▸ toString()

src/seismographconfig.js

toString()

formatCount

src/seismographconfig.js

formatCount

formatExp

src/seismographconfig.js

formatExp

formatCountOrAmp

src/seismographconfig.js

formatCountOrAmp

Parameters

v (number)

Returns

string

formatMillisecond

src/seismographconfig.js

formatMillisecond

formatSecond

src/seismographconfig.js

formatSecond

formatMinute

src/seismographconfig.js

formatMinute

formatHour

src/seismographconfig.js

formatHour

formatDay

src/seismographconfig.js

formatDay

formatMonth

src/seismographconfig.js

formatMonth

formatYear

src/seismographconfig.js

formatYear

multiFormatHour

src/seismographconfig.js

multiFormatHour

Parameters

date (Date)

Returns

string