seisplotjs.fdsnavailability 2.0.0-alpha.4

seisplotjs.fdsnavailability

2.0.0-alpha.4

FORMAT_JSON
FORMAT_TEXT
FORMAT_GEOCSV
FORMAT_REQUEST
EMPTY_JSON
SERVICE_VERSION
SERVICE_NAME
IRIS_HOST
AvailabilityQuery ▸
- Instance members
- #specVersion
- #protocol
- #host
- #nodata
- #port
- #networkCode
- #stationCode
- #locationCode
- #channelCode
- #startTime
- #endTime
- #timeWindow
- #quality
- #merge
- #mergeGaps
- #show
- #limit
- #orderby
- #includeRestricted
- #format
- #timeout
- #query
- #queryJson
- #extent
- #extentJson
- #postQuery
- #postExtent
- #postExtentJson
- #postQueryJson
- #postJson
- #postRaw
- #extractFromJson
- #createPostBody
- #formBaseURL
- #formVersionURL
- #queryVersion
- #makeParam
- #makePostParm
- #formURL

Need help reading this?

FORMAT_JSON

src/fdsnavailability.js

const for json format, json

FORMAT_JSON

Type: string

FORMAT_TEXT

src/fdsnavailability.js

const for text format, text

FORMAT_TEXT

Type: string

FORMAT_GEOCSV

src/fdsnavailability.js

const for geocsv format, geocsv

FORMAT_GEOCSV

Type: string

FORMAT_REQUEST

src/fdsnavailability.js

const for request format, request

FORMAT_REQUEST

Type: string

EMPTY_JSON

src/fdsnavailability.js

const of completely empty json, {}

EMPTY_JSON

SERVICE_VERSION

src/fdsnavailability.js

Major version of the FDSN spec supported here. Currently is 1.

SERVICE_VERSION

Type: number

SERVICE_NAME

src/fdsnavailability.js

Service name as used in the FDSN DataCenters registry, http://www.fdsn.org/datacenters

SERVICE_NAME

IRIS_HOST

src/fdsnavailability.js

IRIS_HOST

Type: string

AvailabilityQuery

src/fdsnavailability.js

Query to a FDSN Availability web service.

new AvailabilityQuery(host: string?)

Parameters

host (string?)

Instance Members

▸ specVersion(value?)

src/fdsnavailability.js

Gets/Sets the version of the fdsnws spec, 1 is currently the only value. Setting this is probably a bad idea as the code may not be compatible with the web service.

specVersion(value: number?): (number | AvailabilityQuery)

Parameters

value (number?)

Returns

(number | AvailabilityQuery)

▸ protocol(value?)

src/fdsnavailability.js

Gets/Sets the protocol, http or https. This should match the protocol of the page loaded, but is autocalculated and generally need not be set.

protocol(value: string?): (string | AvailabilityQuery)

Parameters

value (string?)

Returns

(string | AvailabilityQuery)

▸ host(value?)

src/fdsnavailability.js

Gets/Sets the remote host to connect to.

host(value: string?): (string | AvailabilityQuery)

Parameters

value (string?)

Returns

(string | AvailabilityQuery)

▸ nodata(value?)

src/fdsnavailability.js

Gets/Sets the nodata parameter, usually 404 or 204 (default), controlling the status code when no matching data is found by the service.

nodata(value: number?): (number | AvailabilityQuery)

Parameters

value (number?)

Returns

(number | AvailabilityQuery)

▸ port(value?)

src/fdsnavailability.js

port(value: number?): (number | AvailabilityQuery)

Parameters

value (number?)

Returns

(number | AvailabilityQuery)

▸ networkCode(value?)

src/fdsnavailability.js

networkCode(value: string?): (string | AvailabilityQuery)

Parameters

value (string?)

Returns

(string | AvailabilityQuery)

▸ stationCode(value?)

src/fdsnavailability.js

stationCode(value: string?): (string | AvailabilityQuery)

Parameters

value (string?)

Returns

(string | AvailabilityQuery)

▸ locationCode(value?)

src/fdsnavailability.js

locationCode(value: string?): (string | AvailabilityQuery)

Parameters

value (string?)

Returns

(string | AvailabilityQuery)

▸ channelCode(value?)

src/fdsnavailability.js

channelCode(value: string?): (string | AvailabilityQuery)

Parameters

value (string?)

Returns

(string | AvailabilityQuery)

▸ startTime(value?)

src/fdsnavailability.js

startTime(value: moment?): (moment | AvailabilityQuery)

Parameters

value (moment?)

Returns

(moment | AvailabilityQuery)

▸ endTime(value?)

src/fdsnavailability.js

endTime(value: moment?): (moment | AvailabilityQuery)

Parameters

value (moment?)

Returns

(moment | AvailabilityQuery)

▸ timeWindow(se)

src/fdsnavailability.js

Sets startTime and endTime using the given time window

timeWindow(se: StartEndDuration): any

Parameters

se (StartEndDuration) time window

Returns

any: this

▸ quality(value?)

src/fdsnavailability.js

quality(value: string?): (string | AvailabilityQuery)

Parameters

value (string?)

Returns

(string | AvailabilityQuery)

▸ merge(value?)

src/fdsnavailability.js

merge(value: string?): (string | AvailabilityQuery)

Parameters

value (string?)

Returns

(string | AvailabilityQuery)

▸ mergeGaps(value?)

src/fdsnavailability.js

mergeGaps(value: number?): (number | AvailabilityQuery)

Parameters

value (number?)

Returns

(number | AvailabilityQuery)

▸ show(value?)

src/fdsnavailability.js

show(value: string?): (string | AvailabilityQuery)

Parameters

value (string?)

Returns

(string | AvailabilityQuery)

▸ limit(value?)

src/fdsnavailability.js

limit(value: number?): (number | AvailabilityQuery)

Parameters

value (number?)

Returns

(number | AvailabilityQuery)

▸ orderby(value?)

src/fdsnavailability.js

orderby(value: string?): (string | AvailabilityQuery)

Parameters

value (string?)

Returns

(string | AvailabilityQuery)

▸ includeRestricted(value?)

src/fdsnavailability.js

includeRestricted(value: boolean?): (boolean | AvailabilityQuery)

Parameters

value (boolean?)

Returns

(boolean | AvailabilityQuery)

▸ format(value?)

src/fdsnavailability.js

format(value: string?): (string | AvailabilityQuery)

Parameters

value (string?)

Returns

(string | AvailabilityQuery)

▸ timeout(value?)

src/fdsnavailability.js

Get/Set the timeout in seconds for the request. Default is 30.

timeout(value: number?): (number | AvailabilityQuery)

Parameters

value (number?)

Returns

(number | AvailabilityQuery)

▸ query()

src/fdsnavailability.js

query(): Promise<Array<SeismogramDisplayData>>

Returns

Promise<Array<SeismogramDisplayData>>

▸ queryJson()

src/fdsnavailability.js

queryJson()

▸ extent()

src/fdsnavailability.js

extent(): Promise<Array<SeismogramDisplayData>>

Returns

Promise<Array<SeismogramDisplayData>>

▸ extentJson()

src/fdsnavailability.js

extentJson()

▸ postQuery(channelTimeList)

src/fdsnavailability.js

postQuery(channelTimeList: Array<SeismogramDisplayData>): Promise<Array<SeismogramDisplayData>>

Parameters

channelTimeList (Array<SeismogramDisplayData>)

Returns

Promise<Array<SeismogramDisplayData>>

▸ postExtent(channelTimeList)

src/fdsnavailability.js

postExtent(channelTimeList: Array<SeismogramDisplayData>): Promise<Array<SeismogramDisplayData>>

Parameters

channelTimeList (Array<SeismogramDisplayData>)

Returns

Promise<Array<SeismogramDisplayData>>

▸ postExtentJson(channelTimeList)

src/fdsnavailability.js

postExtentJson(channelTimeList: Array<SeismogramDisplayData>): Promise<RootType>

Parameters

channelTimeList (Array<SeismogramDisplayData>)

Returns

Promise<RootType>

▸ postQueryJson(channelTimeList)

src/fdsnavailability.js

postQueryJson(channelTimeList: Array<SeismogramDisplayData>): Promise<RootType>

Parameters

channelTimeList (Array<SeismogramDisplayData>)

Returns

Promise<RootType>

▸ postJson(channelTimeList, method)

src/fdsnavailability.js

postJson(channelTimeList: Array<SeismogramDisplayData>, method: string): Promise<RootType>

Parameters

channelTimeList (Array<SeismogramDisplayData>)

method (string)

Returns

Promise<RootType>

▸ postRaw(channelTimeList, method)

src/fdsnavailability.js

postRaw(channelTimeList: Array<SeismogramDisplayData>, method: string): Promise<Response>

Parameters

channelTimeList (Array<SeismogramDisplayData>)

method (string)

Returns

Promise<Response>

▸ extractFromJson(jsonChanTimes)

src/fdsnavailability.js

extractFromJson(jsonChanTimes: RootType): Array<SeismogramDisplayData>

Parameters

jsonChanTimes (RootType)

Returns

Array<SeismogramDisplayData>

▸ createPostBody(channelTimeList)

src/fdsnavailability.js

createPostBody(channelTimeList: Array<SeismogramDisplayData>): string

Parameters

channelTimeList (Array<SeismogramDisplayData>)

Returns

string

▸ formBaseURL()

src/fdsnavailability.js

formBaseURL(): string

Returns

string

▸ formVersionURL()

src/fdsnavailability.js

formVersionURL(): string

Returns

string

▸ queryVersion()

src/fdsnavailability.js

Queries the remote web service to get its version

queryVersion(): Promise<string>

Returns

Promise<string>: Promise to version string

▸ makeParam(name, val)

src/fdsnavailability.js

makeParam(name: string, val: any): string

Parameters

name (string)

val (any)

Returns

string

▸ makePostParm(name, val)

src/fdsnavailability.js

makePostParm(name: string, val: any): string

Parameters

name (string)

val (any)

Returns

string

▸ formURL(method)

src/fdsnavailability.js

formURL(method: string): string

Parameters

method (string)

Returns

string