geopf-extensions-openlayers
    Preparing search index...

    Class Panoramax

    Hierarchy (View Summary)

    Index
    constructor
    auto btnPanoramaxLayerswitcher collapsed container description displayable disposed draggable element eventActived eventsListeners hover isResetEventPropagation listable listenerKeys on once options PANORAMAX_LAYERS_TYPES photoViewerPictureRotatedListener un
    addChangeListener addEventListener addWidget allowPointerMoveOnMap applyFilters applyGroupFilter applyProperties changed createPhotoViewer createWidgetBtnBack createWidgetBtnClose createWidgetBtnFullScreen createWidgetBtnZoom createWidgetCmpMinimap createWidgetCmpPictureLegend dispatchEvent displayPhotoViewer displayPreview dispose disposeInternal get getCollapsed getContainer getKeys getListeners getMap getProperties getPropertiesInternal getRevision hasListener hasProperties load notify onceInternal onInternal onPointerMoveDebounced onResetPanoramaxFiltersClick preventPointerMoveOnMap removeChangeListener removeEventListener removeWidgetAnnotationsSwitch removeWidgetPictureLegendDrawer removeWidgetPlayer render reset resetAllGroupFilters resetGroupFilter set setCollapsed setMap setMarker setPopup setPosition setProperties setSizeWindow setTarget stopImmediatePropagation unInternal unset updatePosition
    CLICKED_DATA_PANORAMAX_CB HOVERED_DATA_PANORAMAX_CB LAYER_PANORAMAX_REMOVE_CB
    CHANGE_PICTURE_PANORAMAX_EVENT CHANGE_SEQUENCE_PANORAMAX_EVENT CLICKED_DATA_PANORAMAX_CB CLOSED_PANORAMAX_EVENT DISPLAY_PHOTO_PANORAMAX_EVENT FILTER_DATES_PANORAMAX_EVENT FILTER_INIT_PANORAMAX_EVENT FILTER_PERIODE_PANORAMAX_EVENT FILTER_RENDER_PANORAMAX_EVENT FILTER_TYPE_PANORAMAX_EVENT FULLSCREEN_PANORAMAX_EVENT HOVERED_DATA_PANORAMAX_CB LAYER_PANORAMAX_REMOVE_CB OPENED_PANORAMAX_EVENT READY_PANORAMAX_EVENT

    • Parameters

      Returns Panoramax

      pnx:ready

      pnx:fullscreen

      pnx:opened

      pnx:data:clicked

      pnx:data:hovered

      pnx:filter:dates

      pnx:filter:periode

      pnx:filter:type

      change:picture

      change:sequence

      change:display

      var panoramax = new ol.control.Panoramax({
        collapsed: false,
        draggable: true,
        auto: true,
        hover: true,
        position: "top-right",
        layer: {
          url: "https://api.panoramax.xyz/api/map/style.json",
          name: "Panoramax",
          minZoom: 6,
          maxZoom: 21
        },
        background: {
         active: true,
         url: "https://data.geopf.fr/annexes/ressources/vectorTiles/styles/PLAN.IGN/gris.json",
         name: "Background",
         minZoom: 6,
         maxZoom: 21
        },
        buttonsWindow: {
          display: true,
          position: "top-right",
          order: ["filters", "contributions", "hover", "styles", "background"],
          filters: {
            display: true,
            label: "Filtrer",
            description: "Filtrer les images affichées",
            content: {
              dates: true,
              types: true,
              periodes: true
            }
          },
          hover: {
            display: true,
            label: "Aperçu au survol",
            description: "Afficher un aperçu de l'image au survol"
          },
          contributions: {
            display: true,
            label: "Contribuer",
            description: "Accéder au parcours de contribution",
            link: "https://panoramax.openstreetmap.fr/why-contribute"
          },
          styles: {
            display: false,
            label: "Style",
            description: "Personnaliser le style d'affichage des images",
            content: {}
          },
          background: {
            display: true,
            label: "Fond de carte",
            description: "Afficher ou masquer un fond de carte de référence"
          }
        },
        visualizationWindow: {
          display: true,
          position: "top-right",
          size: "medium"
        },
        viewer: {
          endpoint: "https://explore.panoramax.fr/",
          share: {
            url: "https://explore.panoramax.fr/",
            type: "panoramax"
          },
          widgets : [
           "btnBack",
           "btnClose",
           "btnZoom",
           "btnFullscreen",
           "cmpPictureLegend",
           "cmpMinimap",
          ],
          pnxOptions: {
           class: "",
           widgets: true,
           psvOptions: {}
          },
      }}});
      map.addControl(panoramax);
    auto: boolean | undefined
    btnPanoramaxLayerswitcher: any
    collapsed: boolean | undefined
    container: HTMLElement
    description: any
    displayable: boolean | undefined
    disposed: boolean

    The object has already been disposed.

    draggable: boolean | undefined
    element: HTMLElement
    eventActived: boolean | undefined
    eventsListeners: any
    hover: boolean | undefined
    isResetEventPropagation: boolean | undefined
    listable: boolean
    listenerKeys: EventsKey[]
    on: ObjectOnSignature<EventsKey>
    once: ObjectOnSignature<EventsKey>
    options:
        | {
            auto: boolean;
            background: { active: boolean; name: string; url: string };
            buttonsWindow: {
                background: { description: string; display: boolean; label: string };
                contributions: {
                    description: string;
                    display: boolean;
                    label: string;
                    link: string;
                };
                display: boolean;
                filters: {
                    content: { dates: boolean; periodes: boolean; types: boolean };
                    description: string;
                    display: boolean;
                    exclusive: boolean;
                    label: string;
                };
                hover: { description: string; display: boolean; label: string };
                layerswitcher: { description: string; display: boolean; label: string };
                order: string[];
                position: string;
                styles: {
                    content: string[];
                    description: string;
                    display: boolean;
                    label: string;
                };
                target: null;
            };
            collapsed: boolean;
            displayable: boolean;
            draggable: boolean;
            group: boolean;
            gutter: boolean;
            hover: boolean;
            interactions: {
                grid: { actions: string[]; active: boolean };
                pictures: { actions: string[]; active: boolean };
                sequences: { actions: string[]; active: boolean };
            };
            layer: { name: string; source: string; url: string };
            panel: boolean;
            position: string;
            viewer: {
                endpoint: string;
                pnxOptions: { class: string; psvOptions: {}; widgets: boolean };
                share: { type: string; url: string };
                widgets: string[];
            };
            visualizationWindow: {
                display: boolean;
                position: string;
                size: string;
                target: null;
            };
        }
        | undefined
    PANORAMAX_LAYERS_TYPES: string[] | undefined

    Types de couches Panoramax disponibles dans le TMS vecteur (https://api.panoramax.xyz/api/map/style.json).

    photoViewerPictureRotatedListener: (() => void) | null | undefined
    un: ObjectOnSignature<void>

    • Parameters

      • key: string

        Key name.

      • listener: Listener

        Listener.

      Returns void

    • Parameters

      • type: string

        Type.

      • listener: Listener

        Listener.

      Returns void

    • Ajoute un widget personnalisé au viewer de photos de Panoramax.

      Parameters

      • widget: HTMLElement

        Élément du widget à ajouter.

      • container: HTMLElement

        Conteneur dans lequel ajouter le widget (le viewer de photos).

      Returns void

    • Applique les filtres sélectionnés à la couche Panoramax.

      Parameters

      • mapboxLayers: any[]

        format Mapbox Style.

      Returns Promise<any>

      Promise résolue lorsque les filtres sont appliqués.

    • Protected

      Apply any properties from another object without triggering events.

      Parameters

      • source: BaseObject

        The source object.

      Returns void

    • Increases the revision counter and dispatches a 'change' event.

      Returns void

    • Crée et configure le viewer de photos de Panoramax, en ajoutant les widgets spécifiés dans les options.

      Returns HTMLElement | null

      Élément du viewer de photos créé, ou null si le conteneur n'est pas disponible.

    • Crée un composant de légende des photos personnalisé pour le viewer de photos de Panoramax.

      Parameters

      • share: any

        Url et Type de partage du visualiseur : panoramax (défaut) ou geoplateforme.

      Returns HTMLElement

      Élément du composant de légende des photos.

    • Dispatches an event and calls all listeners listening for events of this type. The event parameter can either be a string or an Object with a type property.

      Parameters

      • event: string | BaseEvent

        Event object.

      Returns boolean | undefined

      false if anyone called preventDefault on the event object or if any of the listeners returned false.

    • Affiche le viewer de photos de Panoramax avec l'image spécifiée par les identifiants de séquence et de photo.

      Parameters

      • sequenceId: string

        Identifiant de la séquence.

      • pictureId: string

        Identifiant de la photo.

      Returns void

    • Clean up.

      Returns void

    • Protected

      Extension point for disposable objects.

      Returns void

    • Gets a value.

      Parameters

      • key: string

        Key name.

      Returns any

      Value.

    • Get a list of object property names.

      Returns string[]

      List of property names.

    • Get the listeners for a specified event type. Listeners are returned in the order that they will be called in.

      Parameters

      • type: string

        Type.

      Returns Listener[] | undefined

      Listeners.

    • Get the map associated with this control.

      Returns Map | null

      Map.

    • Get an object of all property names and values.

      Returns NoInfer<{ [x: string]: any }>

      Object.

    • Get an object of all property names and values.

      Returns Partial<NoInfer<{ [x: string]: any }>> | null

      Object.

    • Get the version number for this object. Each time the object is modified, its version number will be incremented.

      Returns number

      Revision.

    • Parameters

      • Optionaltype: string

        Type. If not provided, true will be returned if this event target has any listeners.

      Returns boolean

      Has listeners.

    • Returns boolean

      The object has properties.

    • Parameters

      • key: string

        Key name.

      • oldValue: any

        Old value.

      Returns void

    • Protected

      Parameters

      • type: string | string[]

        Type.

      • listener: (arg0: Event | BaseEvent) => unknown

        Listener.

      Returns EventsKey | EventsKey[]

      Event key.

    • Protected

      Parameters

      • type: string | string[]

        Type.

      • listener: (arg0: Event | BaseEvent) => unknown

        Listener.

      Returns EventsKey | EventsKey[]

      Event key.

    • Parameters

      • handler: any

      Returns { cancel(): void; destroy(): void; (...args: any[]): void }

    • Gère le clic de réinitialisation des filtres Panoramax.

      Parameters

      • e: Event

        Événement DOM du bouton de réinitialisation.

      Returns void

    • Parameters

      • key: string

        Key name.

      • listener: Listener

        Listener.

      Returns void

    • Parameters

      • type: string

        Type.

      • listener: Listener

        Listener.

      Returns void

    • Supprime le widget "Picture legend" du viewer de photos de Panoramax On supprime le mode drawer pour le widget de légende des photos

      Returns Promise<void>

    • Renders the control.

      Parameters

      • mapEvent: MapEvent

        Map event.

      Returns void

    • Sets a value.

      Parameters

      • key: string

        Key name.

      • value: any

        Value.

      • Optionalsilent: boolean

        Update without triggering an event.

      Returns void

    • Affiche ou met à jour le marqueur de prévisualisation. * *

      Parameters

      • coordinates: number[]

        Coordonnées [x, y] en projection carte.

      Returns void

    • Affiche ou met à jour la popup de prévisualisation.

      Parameters

      • coordinates: number[]

        Coordonnées [x, y] en projection carte.

      • Optionalcontent: string = ""

        Contenu HTML injecté dans la popup.

      Returns void

    • Sets a collection of key-value pairs. Note that this changes any existing properties and adds new ones (it does not remove any existing properties).

      Parameters

      • values: Partial<NoInfer<Properties>>

        Values.

      • Optionalsilent: boolean

        Update without triggering an event.

      Returns void

    • Applique la taille de fenêtre de visualisation spécifiée dans les options, en ajoutant la classe CSS correspondante au container de la fenêtre de visualisation.

      Parameters

      • size: string

        Taille de la fenêtre de visualisation : "small", "medium", "large", "fullscreen", ou "fullscreen-map".

      Returns void

    • This function is used to set a target element for the control. It has no effect if it is called after the control has been added to the map (i.e. after setMap is called on the control). If no target is set in the options passed to the control constructor and if setTarget is not called then the control is added to the map's overlay container.

      Parameters

      • target: string | HTMLElement

        Target.

      Returns void

    • Protected

      Unlisten for a certain type of event.

      Parameters

      • type: string | string[]

        Type.

      • listener: (arg0: Event | BaseEvent) => unknown

        Listener.

      Returns void

    • Unsets a property.

      Parameters

      • key: string

        Key name.

      • Optionalsilent: boolean

        Unset without triggering an event.

      Returns void

    CLICKED_DATA_PANORAMAX_CB: string | undefined

    Nom du callback déclenché lors d'un clic sur la couche Panoramax active. pnx:data:clicked

    "pnx:data:clicked"

    Ce callback est utilisé pour récupérer la première entité touchée au clic (coordonnées et propriétés) sur la couche Panoramax.

    HOVERED_DATA_PANORAMAX_CB: string | undefined

    Nom du callback déclenché lors du survol de la couche Panoramax active. pnx:data:hovered

    "pnx:data:hovered"

    Ce callback est utilisé pour récupérer la première entité touchée au survol (coordonnées et propriétés) sur la couche Panoramax.

    LAYER_PANORAMAX_REMOVE_CB: string | undefined

    Nom du callback déclenché lors de la suppression de la couche Panoramax active. pnx:layer:removed

    "pnx:layer:removed"

    Ce callback est utilisé pour indiquer que la couche Panoramax a été supprimée de la carte. Il peut être utilisé pour déclencher des actions complémentaires de nettoyage.

    CHANGE_PICTURE_PANORAMAX_EVENT: string | undefined

    Nom de l'événement déclenché quand on change la property 'picture'. change:picture

    "change:picture"

    Cet événement est émis quand la propriété 'picture' change. Il peut être utilisé pour déclencher des actions complémentaires.

    panoramax.set("picture", "1234567890");
    CHANGE_SEQUENCE_PANORAMAX_EVENT: string | undefined

    Nom de l'événement déclenché quand on change de séquence dans le viewer. change:sequence

    "change:sequence"

    Cet événement est émis quand la propriété 'sequence' change. Il peut être utilisé pour déclencher des actions complémentaires.

    panoramax.set("sequence", "1234567890");
    CLICKED_DATA_PANORAMAX_CB: string | undefined

    Nom du callback déclenché lors d'un clic sur la couche Panoramax active. pnx:data:clicked

    "pnx:data:clicked"

    Ce callback est utilisé pour récupérer la première entité touchée au clic (coordonnées et propriétés) sur la couche Panoramax.

    CLOSED_PANORAMAX_EVENT: string | undefined

    Événement déclenché à la fermeture de Panoramax. pnx:closed

    "pnx:closed"

    Cet événement est émis quand Panoramax est fermé. Il indique que le processus Panoramax est terminé. Il peut être utilisé pour déclencher des actions complémentaires.

    DISPLAY_PHOTO_PANORAMAX_EVENT: string | undefined

    Nom de l'événement déclenché quand on change la propriété 'display'. change:display

    "change:display"

    Cet événement est émis quand la propriété 'display' change. Il peut être utilisé pour déclencher des actions complémentaires.

    panoramax.set("display", true);
    FILTER_DATES_PANORAMAX_EVENT: string | undefined

    Nom de l'événement déclenché quand une plage de dates est saisie. pnx:filter:dates

    "pnx:filter:dates"
    FILTER_INIT_PANORAMAX_EVENT: string | undefined

    Événement déclenché à l'initialisation du panneau des filtres. pnx:filter:init

    "pnx:filter:init"
    FILTER_PERIODE_PANORAMAX_EVENT: string | undefined

    Nom de l'événement déclenché quand une période prédéfinie est sélectionnée. pnx:filter:periode

    "pnx:filter:periode"
    FILTER_RENDER_PANORAMAX_EVENT: string | undefined

    Nom de l'événement déclenché quand les filtres sont appliqués. pnx:filter:render

    "pnx:filter:render"
    FILTER_TYPE_PANORAMAX_EVENT: string | undefined

    Nom de l'événement déclenché quand un type d'image est sélectionné. pnx:filter:type

    "pnx:filter:type"
    FULLSCREEN_PANORAMAX_EVENT: string | undefined

    Nom de l'événement déclenché quand on change le mode fullscreen. pnx:fullscreen

    "pnx:fullscreen"
    HOVERED_DATA_PANORAMAX_CB: string | undefined

    Nom du callback déclenché lors du survol de la couche Panoramax active. pnx:data:hovered

    "pnx:data:hovered"

    Ce callback est utilisé pour récupérer la première entité touchée au survol (coordonnées et propriétés) sur la couche Panoramax.

    LAYER_PANORAMAX_REMOVE_CB: string | undefined

    Nom du callback déclenché lors de la suppression de la couche Panoramax active. pnx:layer:removed

    "pnx:layer:removed"

    Ce callback est utilisé pour indiquer que la couche Panoramax a été supprimée de la carte. Il peut être utilisé pour déclencher des actions complémentaires de nettoyage.

    OPENED_PANORAMAX_EVENT: string | undefined

    Événement déclenché à l'ouverture du panneau Panoramax. pnx:opened

    "pnx:opened"

    Cet événement est émis quand le panneau Panoramax est ouvert. Il indique que le processus Panoramax est démarré. Il peut être utilisé pour déclencher des actions complémentaires.

    READY_PANORAMAX_EVENT: string | undefined

    Événement déclenché à l'initialisation de Panoramax. pnx:ready

    "pnx:ready"

    Cet événement est émis quand le PhotoViewer Panoramax est prêt. Il indique que le viewer de photos est initialisé et peut être utilisé. Il peut être utilisé pour déclencher des actions complémentaires.

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods
    addChangeListeneraddEventListeneraddWidgetallowPointerMoveOnMapapplyFiltersapplyGroupFilterapplyPropertieschangedcreatePhotoViewercreateWidgetBtnBackcreateWidgetBtnClosecreateWidgetBtnFullScreencreateWidgetBtnZoomcreateWidgetCmpMinimapcreateWidgetCmpPictureLegenddispatchEventdisplayPhotoViewerdisplayPreviewdisposedisposeInternalgetgetCollapsedgetContainergetKeysgetListenersgetMapgetPropertiesgetPropertiesInternalgetRevisionhasListenerhasPropertiesloadnotifyonceInternalonInternalonPointerMoveDebouncedonResetPanoramaxFiltersClickpreventPointerMoveOnMapremoveChangeListenerremoveEventListenerremoveWidgetAnnotationsSwitchremoveWidgetPictureLegendDrawerremoveWidgetPlayerrenderresetresetAllGroupFiltersresetGroupFiltersetsetCollapsedsetMapsetMarkersetPopupsetPositionsetPropertiessetSizeWindowsetTargetstopImmediatePropagationunInternalunsetupdatePosition
    Callbacks
    Events