Overview ​

An official and professional documentation site is still in the works. This page will serve to help quickly find existing content and view using github's built-in markdown renderer.

Some texts are still incomplete or outdated. We appreciate your patience, things will shape up in time. Missing or incorrect items may be logged as issues, we will do our best to prioritize.

Basic Implementation ​

The Instantiation page provides examples of how to instantiate a RAMP instance, and basic HTML templates to reference.

Migration from RAMP 2 / RAMP 3 ​

• The v4.0.0 Release Notes will highlight breaking changes and features not yet implemented.
• This Config Upgrade Sample Page shows how one can utilize the provided upgrade functions in an attempt to migrate a RAMP2 configuration to the RAMP4 schema. Note the functions configUpgrade() and layerConfigUpgrade() are available on the RAMP. global if using the standard build, or can be imported if using the esm build.
• The Config Incompatibilty page provides a list of RAMP2 config properties that are currently not supported.
• The API Migration page is horribly incomplete but provides some detail on API differences.
• The Config Schema provides a technical specification of the new RAMP4 configuration structure.

App Configuration ​

• Configuring across different languages. Be aware the text residing in the RAMP core is compiled, so those items are currently available only in English and French. New languages can be added but requires a re-build of the library.
• The Layers Configuration page is fairly complete.
• Configuration for various fixtures
  • Appbar
  • Details
  • Geosearch
  • Grid
  • Layer Settings
  • Legend (configuration snippets are embedded in functional descriptions)
• The collection of sample configs on the repo may also be of use to see working examples.

API Documentation ​

APIs exposed by the library:

• Instance API
• Events API
• Geometry API
• Layers API
• Legend Fixture API
• Notification API
• Panels API (doc is incomplete)

Information on more involved modifications via the API:

• Information on Default Behaviors
• Creating Custom Fixtures

Developer Resources ​

• Core Classes Overview
• How Focus Lists behave
• The Panels system
• A very brief blurb about tooltips
• How Pinia Stores are used internally
• Information about various fixtures
  • Appbar (outdated)
  • Details (outdated)
  • Geo Search
  • Grid
  • Layer Settings
  • Legend