API reference overview

All of components and classes are grouped in the imported library named Panoramax.

components.core

Main web components:

• Basic : base class for other components, embedding shared logic.
• CoverageMap : map showing Panoramax data availability.
• Editor : photo and map display for editing purposes.7
• PhotoViewer : the classic photo-only viewer.
• Viewer : the photo and map viewer.

components.layout

Layout helpers:

• BottomDrawer : a mobile-like drawer from screen bottom.
• CorneredGrid : corner-oriented layout over a background component.
• Mini : reduced and collapsable mini component.
• Tabs : tabbed content manager.

components.menus

All-in-one, ready-to-use menus for complex operations. Note that they don't embed a container (like popup or panel) to be reusable in any situation.

• AnnotationsList : selected picture list of annotations (areas with tags).
• MapBackground : change map background.
• MapFilters : set map filters.
• MapLayers : change map theme and background.
• MapLegend : display map sources and Panoramax info.
• PictureLegend : display date, author and info for a picture.
• PictureMetadata : display full details about a picture.
• PlayerOptions : speed and constrast settings for play sequence feature.
• QualityScoreDoc : details about quality score computation.
• ReportForm : picture issue reporting form.
• ShareMenu : links and iframe sharing.

components.ui

Basic UI components:

• Button : a simple button.
• ButtonGroup : button bar.
• CopyButton : a copy-to-clipboard button.
• Grade : a 5-star rating display.
• HashTags : a list of hashtags associated to a picture.
• LinkButton : a link button.
• ListGroup : a menu-like list of buttons and links.
• ListItem : a Material Design-like list entry.
• Loader : the fullscreen initial loader.
• Map : the browseable map (MapLibre GL).
• MapMore : advanced version of the browseable map.
• Photo : the picture display (Photo Sphere Viewer).
• Popup : an overlaying popup/modal.
• ProgressBar : a progress bar.
• QualityScore : a A/B/C/D/E grade display and input.
• SearchBar : a search bar.
• SemanticsTable : table for showing complete semantic tags of a picture/annotation.
• TogglableGroup : an helper for showing a menu on button click.

components.ui.widgets

More complex UI components (but not menus):

• CopyCoordinates : a copy-to-clipboard button for coordinates, with many format options.
• GeoSearch : a geocoder search bar with GPS location tool.
• Legend : a togglable map/picture legend.
• MapFiltersButton : a togglable map filters button & menu.
• MapLayersButton : a togglable map layers button & menu.
• OSMEditors : shortcuts for OpenStreetMap editing tools.
• PictureLegendActions : various actions from picture legend.
• Player : the previous/next/play/pause toolbar.
• Zoom : the +/- zoom toolbar.

utils

General helpers outside of single component scope:

• API : the Panoramax API helper (many get & post HTTP helpers).
• InitParameters : helper for merging URL and component parameters.
• URLHandler : the window URL manager (changes query part).