Catalogs

Catalog

class Catalog(options)

Create a catalog.

Arguments:
  • options (object) -- Options.

  • options.name (string) -- Catalog name.

  • options.attribution (string) -- Reference or copyright.

  • options.color (RGB) -- Default display color. Currently unused.

  • options.properties (Array.<string>) -- Names of catalog object properties.

  • options.propertyMask (Array.<string>) -- Property display mask: only properties with propertyMask element set to true are displayed. Defaults to all properties being displayed.

  • options.units (Array.<string>) -- Property units.

  • options.magLim (number) -- Reference magnitude limit (for scaling symbols).

  • options.magIndex (number) -- Index of the property member that stores the reference magnitude.

  • options.magScaleType ('mag'|'log'|'linear') -- Scale type for the reference "magnitude".

  • options.regionType ('box'|'cone') -- Geometry of the query region.

  • options.service (string) -- Name of the catalog web service.

  • options.className (string) -- Class name for the catalog or service logo.

  • options.serviceURL (string) -- Root web service query URL.

  • options.catalogURL (string) -- _Relative_ catalog query URL.

  • options.objectURL (string) -- _Relative_ object query URL.

  • options.authenticate (boolean) -- Catalog requires authentication?

  • options.nmax (number) -- Maximum number of sources per query.

  • options.format (string) -- Data format ('csv' or 'json')

  • options.draw (Catalog~drawCallback) -- Callback function called for drawing object. Defaults to a circle marker.

Returns:

Catalog -- Instance of a catalog.

static Catalog._csvToGeoJSON(str)

Convert CSV data to [GeoJSON]{@link https://geojson.org/}.

Arguments:
  • str (string) -- CSV data.

Returns:

object -- GeoJSON object.

static Catalog.draw(feature, latlng)

Draw a circle at the current catalog source world coordinates.

Arguments:
  • feature (object) -- Feature property of the source.

  • latlng (leaflet.LatLng) -- World coordinates of the source.

Returns:

leaflet.circleMarker -- Circle marker.

static Catalog.filter(feature)

Filter out a source based on its feature property.

Arguments:
  • feature (object) -- Feature property of the source.

Returns:

boolean -- false if filtered out, true otherwise.

static Catalog.popup(feature)

Generate HTML content for popups.

Arguments:
  • feature (object) -- Feature property of the source.

Returns:

string -- HTML content.

static Catalog.readProperty(item)
Read number in a cell from a

[Vizier]{@link https://vizier.cds.unistra.fr/} ASCII output.

Arguments:
  • item (string) -- Cell content.

Returns:

number -- Value in the cell.

static Catalog.style(feature)

Return drawing style for sources.

Arguments:
  • feature (object) -- Feature property of the source.

Returns:

leaflet.Path.options -- Drawing style options.

static Catalog.toGeoJSON(data)
Defaults to a wrapper around private method

[_csvToGeoJSON]{@link Catalog._csvToGeoJSON}.

Arguments:
  • data (string|object) -- catalog data.

Returns:

object -- GeoJSON object.

Catalog.drawCallback(feature, latlng)

Callback for drawing catalog objects.

Arguments:
  • feature (object) -- Feature property of the source.

  • latlng (leaflet.LatLng) -- World coordinates of the source.

Returns:

leaflet.Path -- Path.

Built-in catalogs

abell

type: Catalog

Abell catalog.

allWISE

type: Catalog

AllWISE catalog.

first

type: Catalog

FIRST catalog.

gaiaDR3

type: Catalog

Gaia DR3 catalog.

galexAIS

type: Catalog

GALEX AIS catalog.

gleam

type: Catalog

GLEAM catalog.

nvss

type: Catalog

NVSS catalog.

panstarrs1

type: Catalog

PanSTARRS 1 catalog.

ppmXL

type: Catalog

PPMXL catalog.

sdss

type: Catalog

SDSS catalog.

tgss

type: Catalog

TGSS catalog.

twomass

type: Catalog

2MASS catalog.

urat1

type: Catalog

URAT1 catalog.