seisplotjs 3.1.4 | Documentation

seisplotjs

3.1.4

USGS_HOST
SERVICE_VERSION
SERVICE_NAME
EventQuery ▸
- Instance members
- #specVersion
- #getSpecVersion
- #protocol
- #getProtocol
- #host
- #getHost
- #port
- #getPort
- #nodata
- #getNodata
- #timeout
- #getTimeout
- #eventId
- #getEventId
- #startTime
- #getStartTime
- #endTime
- #getEndTime
- #timeRange
- #updatedAfter
- #getUpdatedAfter
- #minMag
- #getMinMag
- #maxMag
- #getMaxMag
- #magnitudeType
- #getMagnitudeType
- #minDepth
- #getMinDepth
- #maxDepth
- #getMaxDepth
- #minLat
- #getMinLat
- #maxLat
- #getMaxLat
- #minLon
- #getMinLon
- #maxLon
- #getMaxLon
- #latitude
- #getLatitude
- #longitude
- #getLongitude
- #minRadius
- #getMinRadius
- #maxRadius
- #getMaxRadius
- #includeArrivals
- #getIncludeArrivals
- #includeAllOrigins
- #getIncludeAllOrigins
- #includeAllMagnitudes
- #getIncludeAllMagnitudes
- #format
- #getFormat
- #limit
- #getLimit
- #offset
- #getOffset
- #orderBy
- #getOrderBy
- #catalog
- #getCatalog
- #contributor
- #getContributor
- #latLonRegion
- #isSomeParameterSet
- #query
- #queryEventParameters
- #queryRawXml
- #formBaseURL
- #formCatalogsURL
- #queryCatalogs
- #formContributorsURL
- #queryContributors
- #formVersionURL
- #queryVersion
- #formURL

Need help reading this?

USGS_HOST

src/fdsnevent.ts

USGS_HOST

SERVICE_VERSION

src/fdsnevent.ts

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

SERVICE_VERSION

Type: number

SERVICE_NAME

src/fdsnevent.ts

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

SERVICE_NAME

EventQuery

src/fdsnevent.ts

Query to a FDSN Event web service.

new EventQuery(host: string?)

Extends FDSNCommon

Parameters

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

https://www.fdsn.org/webservices/

Instance Members

▸ specVersion(value?)

src/fdsnevent.ts

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: string?): EventQuery

Parameters

value (string?) optional new value if setting

Returns

EventQuery: new value if getting, this if setting

▸ getSpecVersion()

src/fdsnevent.ts

getSpecVersion(): string

Returns

string

▸ protocol(value?)

src/fdsnevent.ts

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

Parameters

value (string?) optional new value if setting

Returns

EventQuery: new value if getting, this if setting

▸ getProtocol()

src/fdsnevent.ts

getProtocol(): (string | undefined)

Returns

(string | undefined)

▸ host(value?)

src/fdsnevent.ts

Gets/Sets the remote host to connect to.

host(value: string?): EventQuery

Parameters

value (string?) optional new value if setting

Returns

EventQuery: new value if getting, this if setting

▸ getHost()

src/fdsnevent.ts

getHost(): string

Returns

string

▸ port(value?)

src/fdsnevent.ts

Gets/Sets the remote port to connect to.

port(value: number?): EventQuery

Parameters

value (number?) optional new value if setting

Returns

EventQuery: new value if getting, this if setting

▸ getPort()

src/fdsnevent.ts

getPort(): (number | undefined)

Returns

(number | undefined)

▸ nodata(value?)

src/fdsnevent.ts

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

Parameters

value (number?) optional new value if setting

Returns

EventQuery: new value if getting, this if setting

▸ getNodata()

src/fdsnevent.ts

getNodata(): (number | undefined)

Returns

(number | undefined)

▸ timeout(value?)

src/fdsnevent.ts

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

timeout(value: number?): EventQuery

Parameters

value (number?) optional new value if setting

Returns

EventQuery: new value if getting, this if setting

▸ getTimeout()

src/fdsnevent.ts

getTimeout(): (number | undefined)

Returns

(number | undefined)

▸ eventId(value?)

src/fdsnevent.ts

Get/Set the eventid query parameter.

eventId(value: string?): EventQuery

Parameters

value (string?) optional new value if setting

Returns

EventQuery: new value if getting, this if setting

▸ getEventId()

src/fdsnevent.ts

getEventId(): (string | undefined)

Returns

(string | undefined)

▸ startTime(value?)

src/fdsnevent.ts

Get/Set the starttime query parameter.

startTime(value: DateTime?): EventQuery

Parameters

value (DateTime?) optional new value if setting

Returns

EventQuery: new value if getting, this if setting

▸ getStartTime()

src/fdsnevent.ts

getStartTime(): (DateTime | undefined)

Returns

(DateTime | undefined)

▸ endTime(value?)

src/fdsnevent.ts

Get/Set the endtime query parameter.

endTime(value: DateTime?): EventQuery

Parameters

value (DateTime?) optional new value if setting

Returns

EventQuery: new value if getting, this if setting

▸ getEndTime()

src/fdsnevent.ts

getEndTime(): (DateTime | undefined)

Returns

(DateTime | undefined)

▸ timeRange(se)

src/fdsnevent.ts

Sets startTime and endTime using the given time window

timeRange(se: Interval): EventQuery

Parameters

se (Interval) time window

Returns

EventQuery: this

▸ updatedAfter(value?)

src/fdsnevent.ts

Get/Set the updatedafter query parameter.

updatedAfter(value: DateTime?): EventQuery

Parameters

value (DateTime?) optional new value if setting

Returns

EventQuery: new value if getting, this if setting

▸ getUpdatedAfter()

src/fdsnevent.ts

getUpdatedAfter(): (DateTime | undefined)

Returns

(DateTime | undefined)

▸ minMag(value?)

src/fdsnevent.ts

Get/Set the minmag query parameter.

minMag(value: number?): EventQuery

Parameters

value (number?) optional new value if setting

Returns

EventQuery: new value if getting, this if setting

▸ getMinMag()

src/fdsnevent.ts

getMinMag(): (number | undefined)

Returns

(number | undefined)

▸ maxMag(value?)

src/fdsnevent.ts

Get/Set the maxmag query parameter.

maxMag(value: number?): EventQuery

Parameters

value (number?) optional new value if setting

Returns

EventQuery: new value if getting, this if setting

▸ getMaxMag()

src/fdsnevent.ts

getMaxMag(): (number | undefined)

Returns

(number | undefined)

▸ magnitudeType(value?)

src/fdsnevent.ts

Get/Set the magnitudetype query parameter.

magnitudeType(value: string?): EventQuery

Parameters

value (string?) optional new value if setting

Returns

EventQuery: new value if getting, this if setting

▸ getMagnitudeType()

src/fdsnevent.ts

getMagnitudeType(): (string | undefined)

Returns

(string | undefined)

▸ minDepth(value?)

src/fdsnevent.ts

Get/Set the mindepth query parameter.

minDepth(value: number?): EventQuery

Parameters

value (number?) optional new value if setting

Returns

EventQuery: new value if getting, this if setting

▸ getMinDepth()

src/fdsnevent.ts

getMinDepth(): (number | undefined)

Returns

(number | undefined)

▸ maxDepth(value?)

src/fdsnevent.ts

Get/Set the maxdepth query parameter.

maxDepth(value: number?): EventQuery

Parameters

value (number?) optional new value if setting

Returns

EventQuery: new value if getting, this if setting

▸ getMaxDepth()

src/fdsnevent.ts

getMaxDepth(): (number | undefined)

Returns

(number | undefined)

▸ minLat(value?)

src/fdsnevent.ts

Get/Set the minlat query parameter.

minLat(value: number?): EventQuery

Parameters

value (number?) optional new value if setting

Returns

EventQuery: new value if getting, this if setting

▸ getMinLat()

src/fdsnevent.ts

getMinLat(): (number | undefined)

Returns

(number | undefined)

▸ maxLat(value?)

src/fdsnevent.ts

Get/Set the maxlat query parameter.

maxLat(value: number?): EventQuery

Parameters

value (number?) optional new value if setting

Returns

EventQuery: new value if getting, this if setting

▸ getMaxLat()

src/fdsnevent.ts

getMaxLat(): (number | undefined)

Returns

(number | undefined)

▸ minLon(value?)

src/fdsnevent.ts

Get/Set the minlon query parameter.

minLon(value: number?): EventQuery

Parameters

value (number?) optional new value if setting

Returns

EventQuery: new value if getting, this if setting

▸ getMinLon()

src/fdsnevent.ts

getMinLon(): (number | undefined)

Returns

(number | undefined)

▸ maxLon(value?)

src/fdsnevent.ts

Get/Set the maxlon query parameter.

maxLon(value: number?): EventQuery

Parameters

value (number?) optional new value if setting

Returns

EventQuery: new value if getting, this if setting

▸ getMaxLon()

src/fdsnevent.ts

getMaxLon(): (number | undefined)

Returns

(number | undefined)

▸ latitude(value?)

src/fdsnevent.ts

Get/Set the latitude query parameter.

latitude(value: number?): EventQuery

Parameters

value (number?) optional new value if setting

Returns

EventQuery: new value if getting, this if setting

▸ getLatitude()

src/fdsnevent.ts

getLatitude(): (number | undefined)

Returns

(number | undefined)

▸ longitude(value?)

src/fdsnevent.ts

Get/Set the longitude query parameter.

longitude(value: number?): EventQuery

Parameters

value (number?) optional new value if setting

Returns

EventQuery: new value if getting, this if setting

▸ getLongitude()

src/fdsnevent.ts

getLongitude(): (number | undefined)

Returns

(number | undefined)

▸ minRadius(value?)

src/fdsnevent.ts

Get/Set the minradius query parameter.

minRadius(value: number?): EventQuery

Parameters

value (number?) optional new value if setting

Returns

EventQuery: new value if getting, this if setting

▸ getMinRadius()

src/fdsnevent.ts

getMinRadius(): (number | undefined)

Returns

(number | undefined)

▸ maxRadius(value?)

src/fdsnevent.ts

Get/Set the maxradius query parameter.

maxRadius(value: number?): EventQuery

Parameters

value (number?) optional new value if setting

Returns

EventQuery: new value if getting, this if setting

▸ getMaxRadius()

src/fdsnevent.ts

getMaxRadius(): (number | undefined)

Returns

(number | undefined)

▸ includeArrivals(value?)

src/fdsnevent.ts

Get/Set the includearrivals query parameter.

includeArrivals(value: boolean?): EventQuery

Parameters

value (boolean?) optional new value if setting

Returns

EventQuery: new value if getting, this if setting

▸ getIncludeArrivals()

src/fdsnevent.ts

getIncludeArrivals(): (boolean | undefined)

Returns

(boolean | undefined)

▸ includeAllOrigins(value?)

src/fdsnevent.ts

Get/Set the includeallorigins query parameter.

includeAllOrigins(value: boolean?): EventQuery

Parameters

value (boolean?) optional new value if setting

Returns

EventQuery: new value if getting, this if setting

▸ getIncludeAllOrigins()

src/fdsnevent.ts

getIncludeAllOrigins(): (boolean | undefined)

Returns

(boolean | undefined)

▸ includeAllMagnitudes(value?)

src/fdsnevent.ts

Get/Set the includeallmagnitudes query parameter.

includeAllMagnitudes(value: boolean?): EventQuery

Parameters

value (boolean?) optional new value if setting

Returns

EventQuery: new value if getting, this if setting

▸ getIncludeAllMagnitudes()

src/fdsnevent.ts

getIncludeAllMagnitudes(): (boolean | undefined)

Returns

(boolean | undefined)

▸ format(value?)

src/fdsnevent.ts

Get/Set the format query parameter.

format(value: string?): EventQuery

Parameters

value (string?) optional new value if setting

Returns

EventQuery: new value if getting, this if setting

▸ getFormat()

src/fdsnevent.ts

getFormat(): (string | undefined)

Returns

(string | undefined)

▸ limit(value?)

src/fdsnevent.ts

Get/Set the limit query parameter.

limit(value: number?): EventQuery

Parameters

value (number?) optional new value if setting

Returns

EventQuery: new value if getting, this if setting

▸ getLimit()

src/fdsnevent.ts

getLimit(): (number | undefined)

Returns

(number | undefined)

▸ offset(value?)

src/fdsnevent.ts

Get/Set the offset query parameter.

offset(value: number?): EventQuery

Parameters

value (number?) optional new value if setting

Returns

EventQuery: new value if getting, this if setting

▸ getOffset()

src/fdsnevent.ts

getOffset(): (number | undefined)

Returns

(number | undefined)

▸ orderBy(value?)

src/fdsnevent.ts

Get/Set the orderby query parameter.

orderBy(value: string?): EventQuery

Parameters

value (string?) optional new value if setting

Returns

EventQuery: new value if getting, this if setting

▸ getOrderBy()

src/fdsnevent.ts

getOrderBy(): (string | undefined)

Returns

(string | undefined)

▸ catalog(value?)

src/fdsnevent.ts

Get/Set the catalog query parameter.

catalog(value: string?): EventQuery

Parameters

value (string?) optional new value if setting

Returns

EventQuery: new value if getting, this if setting

▸ getCatalog()

src/fdsnevent.ts

getCatalog(): (string | undefined)

Returns

(string | undefined)

▸ contributor(value?)

src/fdsnevent.ts

Get/Set the contributor query parameter.

contributor(value: string?): EventQuery

Parameters

value (string?) optional new value if setting

Returns

EventQuery: new value if getting, this if setting

▸ getContributor()

src/fdsnevent.ts

getContributor(): (string | undefined)

Returns

(string | undefined)

▸ latLonRegion(value)

src/fdsnevent.ts

latLonRegion(value: (LatLonRegion | null)): EventQuery

Parameters

value ((LatLonRegion | null))

Returns

EventQuery

▸ isSomeParameterSet()

src/fdsnevent.ts

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.ts

Queries the remote service and parses the returned xml.

query(): Promise<Array<Quake>>

Returns

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

▸ queryEventParameters()

src/fdsnevent.ts

queryEventParameters(): Promise<EventParameters>