diff --git a/website/doc/API/examples/all-examples.json b/website/doc/API/examples/all-examples.json index 838c80e7..84c202f1 100644 --- a/website/doc/API/examples/all-examples.json +++ b/website/doc/API/examples/all-examples.json @@ -4,9 +4,12 @@ {"title": "Set an image layer by name", "url": "image-layer-by-name/"}, {"title": "Overlay an image layer on a base image layer", "url": "overlay-image-layer/"}, {"title": "Set the color map of an image layer", "url": "color-map/"}, + {"title": "Create a catalogue with a custom shape", "url": "cat-custom-shape/"}, + {"title": "Display objectnames", "url": "onames-labels/"}, {"title": "Load a table from a VOTable URL", "url": "load-votable/"}, {"title": "Create markers", "url": "marker-creation/"}, {"title": "Add some footprints overlays", "url": "footprints/"}, + {"title": "Add a polyline overlay", "url": "polyline/"}, {"title": "Animate to a given position", "url": "animation/"}, {"title": "Demo page for AAS 225", "url": "AAS225/"} ] diff --git a/website/doc/API/index.gml b/website/doc/API/index.gml index f867aaf2..df9a016a 100644 --- a/website/doc/API/index.gml +++ b/website/doc/API/index.gml @@ -141,10 +141,34 @@

Catalogue layers

-

Loading a VOTable

-

Calling A.catalogFromURL(<votable-URL>, <options>?) will return a Catalog object which can then be added to the Aladin Lite instance.

+

Creating a new catalogue layer

+

Catalogue layers are meant to hold list of astronomical sources. They are created using A.catalog(<options>?) and added to Aladin Lite with aladin.addCatalog(catalogInstance)

+

Possible options are:

+ + + + + + + + + + + + +
Key nameDescription
shapeThe shape used for each source in the catalog.
Possible values are: plus, rhomb, cross, triangle and square (default value).
An Image object can also be passed (JPEG, PNG formats are supported, even SVG in most modern browsers).
colorThe color of the shape for each source.
sourceSizeThe size of the source in pixels.
labelColumnA label can be displayed next to the source shape. The value of labelColumn is the name of the column to be used for this purpose.
If this option is used, color and font of the label can be given with labelColor and labelFont.
labelColorColor of the label
labelFontFont of the label, eg 12px sans-serif
-

Example: loading a VOTable from VizieR

+

Adding some sources to the catalogue

+

Sources can be created manually using A.source(ra, dec, option) and added to an existing catalog layer

+

Example: Creating a catalog with a custom shape

+ +

Loading a VOTable

+

Catalogue layers can also be created from a VOTable URL: calling A.catalogFromURL(<votable-URL>, <options>?) will return a Catalog object which can then be added to the Aladin Lite instance.

+ +

Examples:
+ Loading a VOTable from VizieR
+ Using labels to display object names +

Creating a marker

A marker displays a position on the sky. Clicking on a marker will open a popup with a title and text set upon creation.

@@ -157,6 +181,21 @@

diff --git a/website/doc/index.gml b/website/doc/index.gml index e54d8a30..473018c9 100644 --- a/website/doc/index.gml +++ b/website/doc/index.gml @@ -145,7 +145,7 @@ -

Aladin Lite source code will be available in the coming weeks under GPL3 licence. +

Aladin Lite source code is available under GPL3 licence (Download Aladin Lite source code).