Skip to content

Latest commit

 

History

History
84 lines (65 loc) · 3.69 KB

components-packages.md

File metadata and controls

84 lines (65 loc) · 3.69 KB
Raw

Components versus Packages

The main difference between a component and a package is their level of customization. Components are potentially configurable basic elements with which we can build other more complex elements. On the other hand, a package is something built with several basic or customized components. By analogy, we can compare components to Lego blocks and packages to structures built with them.

What is a components

Components are part of the geoview-core package where we find the basic functionality of GeoView (api, events, translation, ...). Some components, like legends and data table can be reused in another package or directly from the GeoView API as we can see in these demos:

Other components can be added to the map from the configuration via the following line:

'components': ['north-arrow', 'overview-map']

In all these cases, components are building blocks on which we can build more important functionality.

What is a packages

Packages are collections of components that extend the functionality of the viewer. There are two types of packages, Core Package and External Package.

A Core Package is a package developed and maintained by the viewer team. The viewer supports few core packages such as a basemap panel or time slider. Core packages can be added to the map from the configuration via the following line for map package like swiper:

'corePackages': ['swiper'],

For package who are inside a component, use that component to initialize it properly like

'appBar': {
  'tabs': {
   'core': ['basemap-panel']
  }
},
'footerBar': {
 'tabs': {
   'core': ['time-slider']
 }
},

Each of these packages is associated with a default schema and configuration. It is therefore possible to configure them to some extent according to our needs. For exemple, the basemap panel has this schema and default configuration. If necessary, the user can customize the package by providing a custom configuration file to initialize the package.

To associate a custom configuration with a package, follow these steps:

  • Provide in the map's div tag a json configuration file, say package-bp1-lcc-config.json using the key data-config-url as shown below:
<div
  id="mapLCC"
  class="geoview-map"
  data-lang="en"
  data-config-url="./configs/package-bp1-lcc-config.json"
></div>
  • In the provided json file, specify the desired core package using the corePackages key as follows:
'corePackages': ['swiper'],
 'appBar': {
   'tabs': {
    'core': ['basemap-panel']
   }
 },
'footerBar': {
 'tabs': {
   'core': ['time-slider']
 }
},
  • Then, create a configuration file for the package and name it -(i.e. package-bp1-lcc-config-basemap-panel.json)
  • Put both configuration files in the same folder

An External Package is a package developed outside the GeoView repository and not maintained by the viewer team. You can see a demonstration in this repository.

Currently there is no mechanism to reuse an external package in another viewer instance, this is a work in progress.