CoverageMap

Panoramax.components.core.CoverageMap ⇐ Basic

Kind: static class of Panoramax.components.core
Extends: Basic
Emits: select, ready, broken
Element: pnx-coverage-map
Properties

• .CoverageMap ⇐ Basic
  • new CoverageMap()
  • .properties : Object
  • .onceReady() ⇒ Promise
  • .onceAPIReady() ⇒ Promise
  • .getClassName() ⇒ string
  • .select([seqId], [picId], [force])
  • .isWidthSmall() ⇒ boolean
  • .isHeightSmall() ⇒ boolean
  • .getSubComponentsNames() ⇒ Array.<string>
  • .addEventListener(type, listener, [options])
  • "menu-opened"
  • "select"
  • "ready"
  • "broken"

new CoverageMap()

Coverage Map is a basic map showing Panoramax coverage.

Make sure to set width/height through CSS for proper display.

Example

<pnx-coverage-map
  endpoint="https://panoramax.openstreetmap.fr/"
  map-options='{"bounds": [[-73.9876, 40.7661], [-73.9397, 40.8002]]}'
  style="width: 300px; height: 250px"
/>

coverageMap.properties : Object

Component properties.

Kind: instance property of CoverageMap
Mixes: properties
Overrides: properties
Properties

coverageMap.onceReady() ⇒ Promise

Waits for component to have its first loading done.

Each inheriting class must override this method.

Kind: instance method of CoverageMap
Fulfil: null When initialization is complete.
Reject: string Error message

coverageMap.onceAPIReady() ⇒ Promise

Waits for initial API setup.

Kind: instance method of CoverageMap
Fulfil: null When API is ready.
Reject: string Error message

coverageMap.getClassName() ⇒ string

This allows to retrieve an always correct class name. This is crap, but avoids issues with Webpack & so on.

Each inheriting class must override this method.

Kind: instance method of CoverageMap
Returns: string - The class name (for example "Basic")

coverageMap.select([seqId], [picId], [force])

Change the currently picture and/or sequence. Calling the method without parameters unselects.

Kind: instance method of CoverageMap

coverageMap.isWidthSmall() ⇒ boolean

Is the view running in a small container (small embed or smartphone)

Kind: instance method of CoverageMap
Returns: boolean - True if container is small

coverageMap.isHeightSmall() ⇒ boolean

Is the view running in a small-height container (small embed or smartphone)

Kind: instance method of CoverageMap
Returns: boolean - True if container height is small

coverageMap.getSubComponentsNames() ⇒ Array.<string>

List names of sub-components (like loader, api, map, psv) available in this component.

Kind: instance method of CoverageMap
Returns: Array.<string> - Sub-components names.

coverageMap.addEventListener(type, listener, [options])

Listen to events from this components or one of its sub-components.

For example, you can listen to map events using prefix map:.

me.addEventListener("map:move", doSomething);

Kind: instance method of CoverageMap

"menu-opened"

Event for overlaying menu opening

Kind: event emitted by CoverageMap
Properties

"select"

Event for sequence/picture selection

Kind: event emitted by CoverageMap
Properties

"ready"

Event when component is ready to use. This happens when loader screen disappear, with picture and map loaded.

To follow more precisely loading steps, you can also watch for sub-components ready events.

// Watch API-readiness
viewer.addEventListener("api:ready", ...); // From parent
viewer.api.addEventListener("ready", ...); // Or on sub-component

Kind: event emitted by CoverageMap

"broken"

Event for viewer failing to initially load.

To follow more precisely loading failures, you can also watch for sub-components broken events.

// Watch API breaks
viewer.addEventListener("api:broken", ...); // From parent
viewer.api.addEventListener("broken", ...); // Or on sub-component

Kind: event emitted by CoverageMap
Properties