From 3f248a82ea48ebf35a4af2daa5f8dcf969b385c5 Mon Sep 17 00:00:00 2001
From: bmatthieu3 <matthieu.baumann@astro.unistra.fr>
Date: Tue, 4 Mar 2025 17:12:24 +0100
Subject: [PATCH] add docs on HiPSOptions to explain some properties that
 prevent to fetch the properties file of a HiPS. Copied from #242

---
 src/js/HiPS.js | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/src/js/HiPS.js b/src/js/HiPS.js
index c39c5ec3..a9fd839b 100644
--- a/src/js/HiPS.js
+++ b/src/js/HiPS.js
@@ -129,6 +129,17 @@ PropertyParser.isPlanetaryBody = function (properties) {
 
 /**
  * HiPS options
+ * 
+ * @description Minimal user provided properties will prevent Aladin Lite from fetching the properties file describing the HiPS properties.
+ * These minimal informations needed by aladin lite are:
+ * <ul>
+ * <li>The max HEALPix order of the survey tiles</li>
+ * <li>A location url of the HiPS. If a CDS ID is given (i.e. one took from the {@link https://aladin.cds.unistra.fr/hips/list| CDS HiPS list aggregator}) e.g. CDS/P/2MASS/K) then the properties is retrieved to obtain a base url for fetching the tiles.</li>
+ * <li>The image format of the HiPS tiles ('jpeg', 'png', 'fits', 'webp' are supported)</li>
+ * <li>The size of one tile (typically 512x512)</li>
+ * <li>The coordinate frame of the HiPS</li>
+ * </ul>
+ * 
  * @typedef {Object} HiPSOptions
  * @property {string} [name] - The name of the survey to be displayed in the UI
  * @property {Function} [successCallback] - A callback executed when the HiPS has been loaded