seisplotjs.fdsnevent 2.0.0

seisplotjs.fdsnevent

2.0.0

USGS_HOST
SERVICE_VERSION
SERVICE_NAME
FAKE_EMPTY_XML
EventQuery ▸
- Instance members
- #specVersion
- #protocol
- #host
- #port
- #nodata
- #eventId
- #startTime
- #endTime
- #timeWindow
- #updatedAfter
- #minMag
- #maxMag
- #magnitudeType
- #minDepth
- #maxDepth
- #minLat
- #maxLat
- #minLon
- #maxLon
- #latitude
- #longitude
- #minRadius
- #maxRadius
- #includeArrivals
- #includeAllOrigins
- #includeAllMagnitudes
- #format
- #limit
- #offset
- #orderBy
- #catalog
- #contributor
- #timeout
- #isSomeParameterSet
- #query
- #queryRawXml
- #formBaseURL
- #formCatalogsURL
- #queryCatalogs
- #formContributorsURL
- #queryContributors
- #formVersionURL
- #queryVersion
- #formURL

Need help reading this?

USGS_HOST

src/fdsnevent.js

USGS_HOST

SERVICE_VERSION

src/fdsnevent.js

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

SERVICE_VERSION

Type: number

SERVICE_NAME

src/fdsnevent.js

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

SERVICE_NAME

FAKE_EMPTY_XML

src/fdsnevent.js

FAKE_EMPTY_XML

Type: string

EventQuery

src/fdsnevent.js

Query to a FDSN Event web service.

new EventQuery(host: string?)

Parameters

host (string?) optional host to connect to, defaults to USGS

Instance Members

▸ specVersion(value?)

src/fdsnevent.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 | EventQuery)

Parameters

value (number?) optional new value if setting

Returns

(number | EventQuery): new value if getting, this if setting

▸ protocol(value?)

src/fdsnevent.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 | EventQuery)

Parameters

value (string?) optional new value if setting

Returns

(string | EventQuery): new value if getting, this if setting

▸ host(value?)

src/fdsnevent.js

Gets/Sets the remote host to connect to.

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

Parameters

value (string?) optional new value if setting

Returns

(string | EventQuery): new value if getting, this if setting

▸ port(value?)

src/fdsnevent.js

Gets/Sets the remote port to connect to.

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

Parameters

value (number?) optional new value if setting

Returns

(number | EventQuery): new value if getting, this if setting

▸ nodata(value?)

src/fdsnevent.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 | EventQuery)

Parameters

value (number?) optional new value if setting

Returns

(number | EventQuery): new value if getting, this if setting

▸ eventId(value?)

src/fdsnevent.js

Get/Set the eventid query parameter.

eventId(value: string?): (string | EventQuery)

Parameters

value (string?) optional new value if setting

Returns

(string | EventQuery): new value if getting, this if setting

▸ startTime(value?)

src/fdsnevent.js

Get/Set the starttime query parameter.

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

Parameters

value (moment?) optional new value if setting

Returns

(moment | EventQuery): new value if getting, this if setting

▸ endTime(value?)

src/fdsnevent.js

Get/Set the endtime query parameter.

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

Parameters

value (moment?) optional new value if setting

Returns

(moment | EventQuery): new value if getting, this if setting

▸ timeWindow(se)

src/fdsnevent.js

Sets startTime and endTime using the given time window

timeWindow(se: StartEndDuration): any

Parameters

se (StartEndDuration) time window

Returns

any: this

▸ updatedAfter(value?)

src/fdsnevent.js

Get/Set the updatedafter query parameter.

updatedAfter(value: moment?): (moment | EventQuery)

Parameters

value (moment?) optional new value if setting

Returns

(moment | EventQuery): new value if getting, this if setting

▸ minMag(value?)

src/fdsnevent.js

Get/Set the minmag query parameter.

minMag(value: number?): (number | EventQuery)

Parameters

value (number?) optional new value if setting

Returns

(number | EventQuery): new value if getting, this if setting

▸ maxMag(value?)

src/fdsnevent.js

Get/Set the maxmag query parameter.

maxMag(value: number?): (number | EventQuery)

Parameters

value (number?) optional new value if setting

Returns

(number | EventQuery): new value if getting, this if setting

▸ magnitudeType(value?)

src/fdsnevent.js

Get/Set the magnitudetype query parameter.

magnitudeType(value: string?): (string | EventQuery)

Parameters

value (string?) optional new value if setting

Returns

(string | EventQuery): new value if getting, this if setting

▸ minDepth(value?)

src/fdsnevent.js

Get/Set the mindepth query parameter.

minDepth(value: number?): (number | EventQuery)

Parameters

value (number?) optional new value if setting

Returns

(number | EventQuery): new value if getting, this if setting

▸ maxDepth(value?)

src/fdsnevent.js

Get/Set the maxdepth query parameter.

maxDepth(value: number?): (number | EventQuery)

Parameters

value (number?) optional new value if setting

Returns

(number | EventQuery): new value if getting, this if setting

▸ minLat(value?)

src/fdsnevent.js

Get/Set the minlat query parameter.

minLat(value: number?): (number | EventQuery)

Parameters

value (number?) optional new value if setting

Returns

(number | EventQuery): new value if getting, this if setting

▸ maxLat(value?)

src/fdsnevent.js

Get/Set the maxlat query parameter.

maxLat(value: number?): (number | EventQuery)

Parameters

value (number?) optional new value if setting

Returns

(number | EventQuery): new value if getting, this if setting

▸ minLon(value?)

src/fdsnevent.js

Get/Set the minlon query parameter.

minLon(value: number?): (number | EventQuery)

Parameters

value (number?) optional new value if setting

Returns

(number | EventQuery): new value if getting, this if setting

▸ maxLon(value?)

src/fdsnevent.js

Get/Set the maxlon query parameter.

maxLon(value: number?): (number | EventQuery)

Parameters

value (number?) optional new value if setting

Returns

(number | EventQuery): new value if getting, this if setting

▸ latitude(value?)

src/fdsnevent.js

Get/Set the latitude query parameter.

latitude(value: number?): (number | EventQuery)

Parameters

value (number?) optional new value if setting

Returns

(number | EventQuery): new value if getting, this if setting

▸ longitude(value?)

src/fdsnevent.js

Get/Set the longitude query parameter.

longitude(value: number?): (number | EventQuery)

Parameters

value (number?) optional new value if setting

Returns

(number | EventQuery): new value if getting, this if setting

▸ minRadius(value?)

src/fdsnevent.js

Get/Set the minradius query parameter.

minRadius(value: number?): (number | EventQuery)

Parameters

value (number?) optional new value if setting

Returns

(number | EventQuery): new value if getting, this if setting

▸ maxRadius(value?)

src/fdsnevent.js

Get/Set the maxradius query parameter.

maxRadius(value: number?): (number | EventQuery)

Parameters

value (number?) optional new value if setting

Returns

(number | EventQuery): new value if getting, this if setting

▸ includeArrivals(value?)

src/fdsnevent.js

Get/Set the includearrivals query parameter.

includeArrivals(value: boolean?): (boolean | EventQuery)

Parameters

value (boolean?) optional new value if setting

Returns

(boolean | EventQuery): new value if getting, this if setting

▸ includeAllOrigins(value?)

src/fdsnevent.js

Get/Set the includeallorigins query parameter.

includeAllOrigins(value: boolean?): (boolean | EventQuery)

Parameters

value (boolean?) optional new value if setting

Returns

(boolean | EventQuery): new value if getting, this if setting

▸ includeAllMagnitudes(value?)

src/fdsnevent.js

Get/Set the includeallmagnitudes query parameter.

includeAllMagnitudes(value: boolean?): (boolean | EventQuery)

Parameters

value (boolean?) optional new value if setting

Returns

(boolean | EventQuery): new value if getting, this if setting

▸ format(value?)

src/fdsnevent.js

Get/Set the format query parameter.

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

Parameters

value (string?) optional new value if setting

Returns

(string | EventQuery): new value if getting, this if setting

▸ limit(value?)

src/fdsnevent.js

Get/Set the limit query parameter.

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

Parameters

value (number?) optional new value if setting

Returns

(number | EventQuery): new value if getting, this if setting

▸ offset(value?)

src/fdsnevent.js

Get/Set the offset query parameter.

offset(value: number?): (number | EventQuery)

Parameters

value (number?) optional new value if setting

Returns

(number | EventQuery): new value if getting, this if setting

▸ orderBy(value?)

src/fdsnevent.js

Get/Set the orderby query parameter.

orderBy(value: string?): (string | EventQuery)

Parameters

value (string?) optional new value if setting

Returns

(string | EventQuery): new value if getting, this if setting

▸ catalog(value?)

src/fdsnevent.js

Get/Set the catalog query parameter.

catalog(value: string?): (string | EventQuery)

Parameters

value (string?) optional new value if setting

Returns

(string | EventQuery): new value if getting, this if setting

▸ contributor(value?)

src/fdsnevent.js

Get/Set the contributor query parameter.

contributor(value: string?): (string | EventQuery)

Parameters

value (string?) optional new value if setting

Returns

(string | EventQuery): new value if getting, this if setting

▸ timeout(value?)

src/fdsnevent.js

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

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

Parameters

value (number?) optional new value if setting

Returns

(number | EventQuery): new value if getting, this if setting

▸ isSomeParameterSet()

src/fdsnevent.js

Checks to see if any parameter that would limit the data returned is set. This is a crude, coarse check to make sure the client doesn't ask for EVERYTHING the server has.

isSomeParameterSet(): boolean

Returns

boolean: true is some parameter is set

▸ query()

src/fdsnevent.js

Queries the remote service and parses the returned xml.

query(): Promise<Array<Quake>>

Returns

Promise<Array<Quake>>: Promise to an Array of Quake objects.

▸ queryRawXml()

src/fdsnevent.js

Queries the remote server, to get QuakeML xml.