gitea-mirror/aladin-lite
1
0
Fork 0
mirror of https://github.com/cds-astro/aladin-lite.git synced 2025-12-12 07:40:26 -08:00
Code Issues Packages Projects Releases Wiki Activity

#210 add documentation for catalogFromSimbad and fix the default nb_ref order to be in desc order direction by default

Browse Source
This commit is contained in:
Matthieu Baumann
2025-02-13 23:25:21 +01:00
parent aed511abd8
commit 4eea3d3bf9
2 changed files with 8 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
src/js/A.js
View File

@@ -648,9 +648,11 @@ A.catalogFromURL = function (url, options, successCallback, errorCallback, usePr
* @param {number} target.ra - Right Ascenscion in degrees of the cone's center
* @param {number} target.dec - Declination in degrees of the cone's center
* @param {number} radius - Radius of the cone in degrees
* @param {Object|CatalogOptions} [options] - Additional configuration options for SIMBAD cone search. See the {@link https://simbad.cds.unistra.fr/cone/help/#/ConeSearch/get_ SIMBAD cone search} parameters.
* @param {number} [options.limit] - The max number of sources to return
* @param {string} [options.orderBy='nb_ref'] - Order the result by specific ref number
* @param {Object|CatalogOptions} [options] - Additional configuration options for SIMBAD cone search. See this {@link https://simbad.cds.unistra.fr/cone/help/#/ConeSearch/get_ SIMBAD cone search} page for more explanations about the optional parameters you can pass here.
* @param {number} [options.limit] - The max number of sources to return. The SIMBAD query will be truncated so that the output does not exceed that number of rows.
* @param {string} [options.orderBy='nb_ref'] - Return the sources satisfying a specific order in priority. Default is descending order based on the ref number of the source i.e. sources will be returned from the most cited one at first to the least cited one at last.
* Available values are: oid4, oid4ref, main_id, ra, dec, coo, otype, otype_label, pm, radvel, plx, dim, sp_type, morph_type, U, B, V, R, I, J, H, K, G, nb_ref, distance
* @param {string} [options.orderDir='DESC'] - Change to 'ASC' for ascending order. By default, sources being the most referred are returned at first (i.e. 'nb_ref' in DESC order dir).
* @param {number} [options.verbosity=2] - Verbosity, put 3 if you want all the column
* @param {function} [successCallback] - The callback function to execute on successful catalog creation.
* @param {function} [errorCallback] - The callback function to execute on error during catalog creation.

3
src/js/URLBuilder.js
View File

@@ -47,6 +47,9 @@ export let URLBuilder = (function() {
const orderBy = options && options.orderBy || 'nb_ref';
url += '&ORDER_BY=' + orderBy;
const orderDir = options && options.orderDir || 'DESC';
url += '&ORDER_DIR=' + orderDir;
return url;
},