JMap Server Lima
English
English
  • Welcome to JMap Server Lima
  • Administrator
    • JMap Server Administrator Manual
      • Introduction
        • Quick Start Guide
        • User Interface
          • Old User Interface
      • Resources: Databases
        • Creating Databases
        • Configuring Databases
          • Database Permissions
        • Managing Databases
        • JMap Server System Database
      • Resources: JMap Server to JMap Server Connections
        • Creating Connections to JMap Server
        • Configuring JMap Server to JMap Server Connections
          • Permissions for the Remote Connection
        • Managing Connections
      • Resources: Spatial Data
        • Basic Concepts
        • Creating Spatial Data Sources
        • Configuring Spatial Data Sources
          • Spatial Data Source Permissions
          • External Attributes
          • Metadata
          • Sharing Spatial Data Sources
        • Managing Spatial Data Sources
        • Vector Data Sources
          • JMap ADF - E00 Arc - Info reader
          • JMap CSV reader
          • JMap DGN V7 - V8 File reader
          • JMap DWG - DXF reader
          • JMap EDIGEO reader
          • JMap File geodatabase reader
          • JMap GeoJSON reader
          • JMap GML reader
          • JMap GPX reader
          • JMap IFC reader
          • JMap KML reader
          • JMap MID - MIF reader
          • JMap Photo reader
          • JMap SHP reader
          • JMap TAB reader
          • Annotations in a database
          • ArcGIS REST
          • ArcSDE geodatabase
          • Coordinates in a database
          • Enterprise geodatabase
          • JMap Server
          • JMap Spatial Table
          • MongoDB
          • MySQL Spatial
          • OGC API Features
          • Oracle Spatial Locator
          • Personal geodatabase
          • PostGIS
          • SQL Server Spatial
          • WFS Server
          • WKB or WKT in a database
        • Raster Data Sources
          • ECW - JPG2000
          • GDAL - Geospatial Data Abstraction Library
          • ArcGIS REST
          • JMap Server
          • OpenStreetMap
          • WMS server
          • WMTS Server
      • Resources: Metadata templates
      • Resources: Projects
        • Creating Projects
          • Multilingual Projects
          • Vector tiles in JMap
        • Configuring Projects
          • Project Permissions
          • Managing Layers
            • Organizing Layers
          • Attribute Queries
            • Attribute Query Forms
          • Image Producer
          • JMap Extensions Compatible with JMap NG or JMap Survey
        • Sharing the Project
        • Managing Projects
      • Resources: Style Templates
        • Creating Style Templates
        • Managing Style Templates
      • Resources: Personal Layers
      • Resources: Layers
        • Creating Layers
        • Configuring Layers
          • Layer Permissions
          • General Settings
          • Dynamic Filters
          • Style
          • Thematics
          • Labels
          • Mouseover
          • Information Reports
          • Forms
            • Configuring Forms
            • Creating Forms
              • Layer Attributes Forms
              • Database Forms
          • JMap Extensions
        • Sharing Layers
      • JMap Server Applications
        • Deployment: Classical JMap applications
          • JMap Pro Applications
          • JMap Web Applications
            • Using a GeoWebCache Server
          • WFS and WMS Services
          • Managing Deployed Applications
          • Downloading Services
        • New generation JMap applications
      • Tools
        • SQL Console
        • Import / Export
          • User Data
        • Scheduler
        • Messaging
        • Debugging tools
      • JMap Server Extensions
        • Installed Extensions
        • Marketplace
      • JMap Server
        • JMap Server Status
        • Sessions
        • Security
          • Users and Groups
            • User Managers
              • JMap DB user manager
              • Composite user manager
              • Active Directory user manager
              • JMap LDAP user manager
              • OpenID Connect (OIDC) user manager
              • SAML2 user manager
            • Single Sign-On for JMap Pro
          • Managing Permissions
          • Using HTTPS with JMap
        • Log Files
        • Usage Statistics
        • JMap Server Settings
    • Technical Specifications
    • Installation Guide
    • Installing and Starting JMap Server (with installer)
    • Installing and Starting JMap Server (in a Docker container)
    • Migration Guide to JMap Server Lima
  • Applications
    • JMap Server Applications
    • JMap Pro User Guide
      • Introduction
        • User Interface
        • Navigating on the Map
        • Map Management
        • Map Settings
      • Map Layers
        • Layer Management
        • Elements Explorer
        • Thematic Maps
        • Layer Metadata
        • Layer Settings
          • General
          • Style
          • Thematics
          • Labeling
          • Mouseover
          • Filters
          • Advanced
        • Editable Layers
          • Editing Data
          • Personal Layers
      • Tools
        • Labeling
        • Interactive Selection
        • Information
          • Information Report
          • Geometry Information
          • Mouseover
        • Snap
        • Measurement
        • Search Tools
          • Attribute Queries
          • Spatial Queries
        • Collaboration Tools
          • Map Contexts
          • Sharing Maps
          • Printing Maps
      • Application Settings
      • Keyboard and Mouse Shortcuts
    • JMap NG User Guide
      • Introduction
        • Connecting to JMap NG
        • User Interface
        • Navigating on the Map
        • Profile and User Settings
      • The Data
        • The Layers Panel
        • Data Layers
          • Displaying Layers
          • Thematics
          • Layer Information
          • Geographic Extent of the Layer
          • Filter Elements on the Map
          • Making Layer Elements Selectable
      • I Wish to...
        • Display Element Information
          • Tooltips
          • Information Reports
        • Perform Searches
        • Select Elements on the Map
        • Measure Distances and Surfaces
        • Add Annotations to the Map
        • Edit Data
        • Create and Manage Customized Maps
        • Export / Print a Map
    • JMap Survey User Guide
      • Introduction
        • Working With an iOS Device
        • Working With an Android Device
        • Logging In
        • User Interface
      • The Data
      • I Wish to...
        • Access Information Associated With an Object
        • Perform Searches
        • Create Objects
        • Modify Objects
        • Work in Offline Mode
        • Synchronize Data with JMap Server
        • Log Out
    • JMap Web
      • JMap Web User Guide
  • Extensions
    • Edition
      • User Interface
      • Basic Concepts
      • I Wish to...
        • Edit Layers Geometries
          • Edition Tools
          • Selecting Elements
          • Node and Polygon Operations
          • Vertical Position and Element Duplication
          • WKT Geometries
        • Perform Spatial Operations
          • Geoprocessing
          • Spatial Tools
    • Export
    • Import
      • Importation Procedure
        • Importing MIF Files
        • Importing SHP Files
        • Importing CSV Files
        • Importing NMEA Data
        • Importing Data From WMS
    • Documents
      • Configuring JMap Documents
        • Selecting Data Sources to Associate Documents with
        • Configuring Document Depots
        • Managing repositories
        • Making Documents available in apps
      • Documents for JMap Pro
        • Graphical Interface
        • Associating Documents with Map Elements
        • Searching for Documents
        • Displaying the List of Documents Associated with Elements
      • Documents for JMap NG
        • Graphical Interface
        • Searching for Documents
        • Showing Selected Documents
      • Documents for JMap Survey
    • Tracking
      • Administrator
      • User
    • JMap NG Configuration
      • Configuration
  • Developer
    • JMap Server REST API
    • JMap Admin REST API
    • JMap Pro / Server API
    • JMap Web API
    • JMap Server SDK
    • JMap NG Developer Manual
      • Startup Options
      • Extensions
      • Examples
        • Start the JMap NG Core library
        • Start the JMap NG App
        • Add a JMap NG App extension
        • Toggle a JMap layer visibility
        • Add a layer to display custom data from GeoJSON file
        • Locate and select features by attribute query
        • Add an event on move end
        • Add attributions on the map
        • Locate and select feature by id
        • Locate and select feature(s) by location
        • Custom mouseover on a layer
        • Create a custom form in a div
      • Changelog
  • Knowledge Base
    • Knowledge Base
Propulsé par GitBook

K2 Geospatial 2024

Sur cette page
Exporter en PDF
  1. Developer
  2. JMap NG Developer Manual

Extensions

PrécédentStartup OptionsSuivantExamples

Dernière mise à jour il y a 12 mois

Extensions are plug-ins for JMap NG App that extend its functionalities. With the JMap NG API, you can develop your own extensions.

Extensions can add their own UI, typically an icon and a side panel. It is possible to have extensions with a different UI and even with no UI at all.

NG Extensions are javascript objects that respect an interface (either or ) and that are loaded by NG at application startup or project load, depending on the type of the extension. Every extension must have a unique id property, a initFn implementation, if implementing , and a onPanelCreation implementation if implementing .

Extension life cycle

Extensions are being "registered" by NG in 2 different ways:

The registering process most importantly includes incorporating your extension's redux reducers, if provided, your translation bundle, if provided, and the extension service to expose, if provided.

When NG registers your extension, it automatically calls your extension's initFn and onPanelCreation methods. In your initFn or onPanelCreation method, you can handle all your extension's initializing process. Once the initFn method is called, you can start calling NG's API to communicate with it.

Extension unique ID

The Extension Unique ID serves a dual purpose for NG: it used by NG to identifiy and manage the loading process of extensions, while also establishing a connection with a server-side extension. This connection can link your extension to specific JMap projects, optionally allowing for the transmission of configuration data to your extension during project loading. The nature of your unique id thus depends on your way of deploying it.

How to deploy your extension

Once your extension is ready to deploy, you can compile it and host it on any CDN of your choice. If your extension is loaded via a project, the URL of your CDN will be configured in the server-side part of your extension. If you include your extension as a <script> tag in an HTML page, you will be able to use the CDN's url. In all cases, this url should always be accessible from the location where NG will run.

if included in the JMap NG , they will be automatically registered by NG.

If loaded from a javascript <script> tag or via a project load, the extension must register itself. This is typically done in the extension "entry point" by calling the method, for a Core extension, or method, for an Application extension.

You can see a full extension example .

startup options
JMap.Extension.register
JMap.Application.Extension.register
here
JCoreExtension
JAppExtension
JCoreExtension
JAppExtension
An extension typical UI