Constructor for a MapViewer, setting:
Map properties
Language instance
Used to access button bar API to create buttons and button panels on the app-bar
Used to access basemap API functions
The controller registry owning all framework-level controllers.
Try not to use this accessor, as it creates a backwards dependency from the domain to the controllers. It is here for legacy reasons, but should be removed in the future.
Used to access feature highlight API functions
Used to access the footer bar API to create buttons and footer panels on the footer-bar
Used to access geometry API to create and manage geometries
Max number of icons cached
Used to access layers functions
The OpenLayers map instance
Map features configuration properties
The id of the map
Modals creation
Used to access button bar API to create buttons and button panels on the nav-bar
Used to attach the notification class
The overview map React root
Plugins attached to the map
Used to manage states
StaticDEFAULT_Static ReadonlyDEFAULT_Static ReadonlyDEFAULT_Default DPI values
Static ReadonlyDEFAULT_Default inches per meter used by OpenLayers
StaticDEFAULT_Default densification number when forming layer extents, to make ture to compensate for earth curvature
Static ReadonlyEFFECTIVE_Buffer applied to effective scale calculations to account for visibility thresholds
Getter for map is init
Getter for map layers loaded
Getter for map layers processed
Getter for map is ready. A Map is ready when all layers have been processed.
Add a new custom component to the map.
An id to the new component
The component to add
Shows a marker on the map.
The marker to add
The projected coordinates of the marker
Transforms coordinate from map projection to given projection.
The given coordinate
The projection that should be output
The coordinate in the given projection
Transforms coordinate from given projection to the current projection of the map.
The given coordinate
The projection of the given coordinate
The coordinate in the map projection
Transforms coordinate from LonLat to the current projection of the map.
The LonLat coordinate
The coordinate in the map projection
Transforms coordinate from current projection of the map to LonLat.
The coordinate in map projection
The coordinate in LonLat
Transforms extent from map projection to given projection. If the projections are the same, the extent is simply returned.
The given extent
The projection that should be output
The extent in the given projection
Transforms extent from given projection to the current projection of the map.
The given extent
The projection of the given extent
The number of stops to perform densification on the extent
The extent in the map projection
Transforms extent from LonLat to the current projection of the map.
The LonLat extent
The number of stops to perform densification on the extent
The extent in the map projection
Transforms extent from current projection of the map to LonLat.
The extent in map projection
The extent in LonLat
Create an Open Layer map from configuration attached to the class. This function is called from a useEffect and should be running synchronously.
HTML element to create the map within
The OpenLayer map
Creates a map config based on current map state.
Optional - Indicates if geocore layer names should be kept as is or returned to defaults. Set to false after a language change to update the layer names with the new language.
Optional - Indicates if feature info should be included in the config for each layer.
Map config with current map state, or undefined if unavailable
Deletes the MapViewer, including its plugins, layers, etc. This function does not unmount the MapViewer. To completely delete a MapViewer, use cgpv.api.deleteMapViewer() which will delete the MapViewer and unmount it - for React.
A promise that resolves when the deletion is complete
Returns the click marker overlay.
The click marker overlay
Retrieves the configuration object for a specific core plugin from the map's features configuration.
The ID of the core plugin to look up
The configuration object for the specified plugin, or undefined if not found
Returns the current display language.
The display language
Returns the current display theme.
The display theme
Gets geolocator search area.
The geolocator search area with coordinates and optional bounding box, or undefined if not set
Gets the i18nInstance for localization.
The i18n instance
Converts a map scale denominator (1:X) into the corresponding OpenLayers resolution.
Resolution is computed using: resolution = scale / (metersPerUnit * inchesPerMeter * dpi)
The scale denominator (e.g., 50000000 for 1:50,000,000). Optional; returns undefined if not provided
Dots per inch to use for conversion. Defaults to MapViewer.DEFAULT_DPI (usually 96 or 90.714 depending on standard)
The map resolution in map units per pixel, or undefined if targetScale is not provided
Gets map scale for Web Mercator or Lambert Conformal Conic projections.
The map scale (e.g. 50000 for 1:50,000), or undefined if meters per unit is unavailable
Converts a zoom level to a map scale.
The desired zoom (e.g. 50000 for 1:50,000)
The closest scale for the given zoom number, rounded to the nearest unit, or undefined if meters per unit is unavailable
Returns the map current state information.
The map state
Get north arrow bearing. Angle use to rotate north arrow for non Web Mercator projection. https://www.movable-type.co.uk/scripts/latlong.html
The arrow angle
Returns the north pole marker overlay.
The north pole marker overlay
Gets if north pole is visible. This is not a perfect solution and is more a work around.
This approach is rotation-agnostic — it works regardless of the map's current rotation angle.
True if the north pole is visible in the viewport, false otherwise
Gets the map projection.
The map projection
Gets the map projection EPSG string.
The map projection EPSG string
Gets the map projection number.
The map projection number
Gets the map viewSettings.
The map viewSettings
Initializes drawing interactions on the given vector source.
The geometry group key in which to hold the geometries
The type of geometry to draw (Polygon, LineString, Circle, etc)
The styles for the drawing
OptionalgeometryFunction: GeometryFunction
Optional geometry function for custom drawing behavior
The draw interaction
Initializes map, layer class and geometries. This function must be called once the Map is rendered.
A promise that resolves when the map initialization is complete
Initializes the map controls
Initializes modifying interactions on the given vector source.
The geometry group key in which to hold the geometries
Optionalstyle: TypeFeatureStyle
Optional styles for the modification
OptionalinsertVertexCondition: Condition
Optional condition for inserting vertices
OptionalpixelTolerance: number
Optional pixel tolerance for modification
The modify interaction
Initializes selection interactions.
The select interaction
Initializes snapping interactions on the given vector source.
The geometry group key in which to hold the geometries
The snap interaction
Initializes transform interactions for feature manipulation.
Optionaloptions: Partial<TransformOptions>
Optional options for the transform interaction
The transform interaction
Initializes translation interactions without requireing the extra selection click. Note: This will limit translation interactions to one feature at a time.
The translate interaction
Unregisters a component added event callback.
The callback to stop being called whenever the event is emitted
Unregisters a component removed event callback.
The callback to stop being called whenever the event is emitted
Unregisters a map init event callback.
The callback to stop being called whenever the event is emitted
Unregisters an interaction changed event callback.
The callback to stop being called whenever the event is emitted
Unregisters a language changed event callback.
The callback to stop being called whenever the event is emitted
Unregisters a map layers loaded event callback.
The callback to stop being called whenever the event is emitted
Unregisters a map layers processed event callback.
The callback to stop being called whenever the event is emitted
Unregisters a map mouse enter event callback.
The callback to stop being called whenever the event is emitted
Unregisters a map mouse leave event callback.
The callback to stop being called whenever the event is emitted
Unregisters a map move end event callback.
The callback to stop being called whenever the event is emitted
Unregisters a map pointer move event callback.
The callback to stop being called whenever the event is emitted
Unregisters a map pointer stop event callback.
The callback to stop being called whenever the event is emitted
Unregisters a map projection changed event callback.
The callback to stop being called whenever the event is emitted
Unregisters a map projection changed event callback.
The callback to stop being called whenever the event is emitted
Unregisters a map ready event callback.
The callback to stop being called whenever the event is emitted
Unregisters a map zoom end event callback.
The callback to stop being called whenever the event is emitted
Unregisters a map rotation event callback.
The callback to stop being called whenever the event is emitted
Unregisters a map single click end event callback.
The callback to stop being called whenever the event is emitted
Unregisters a map change size event callback.
The callback to stop being called whenever the event is emitted
Unregisters a marker icon showed event callback.
The callback to stop being called whenever the event is emitted
Returns a promise that resolves the next time the map move end event fires.
Optionalfilter: (event: MapMoveEndEvent) => boolean
Optional filter predicate. When provided, only events passing the filter resolve the promise
A promise that resolves with the event payload when map move end fires
Returns a promise that resolves the next time the map ready event fires.
Optionalfilter: (event: MapBaseEvent) => boolean
Optional filter predicate. When provided, only events passing the filter resolve the promise
A promise that resolves with the event payload when map ready fires
Registers a component added event callback.
The callback to be executed whenever the event is emitted
The callback delegate that was registered
Registers a component removed event callback.
The callback to be executed whenever the event is emitted
The callback delegate that was registered
Registers a map init event callback.
The callback to be executed whenever the event is emitted
The callback delegate that was registered
Registers an interaction changed event callback.
The callback to be executed whenever the event is emitted
The callback delegate that was registered
Registers a language changed event callback.
The callback to be executed whenever the event is emitted
The callback delegate that was registered
Registers a map layers loaded event callback.
The callback to be executed whenever the event is emitted
The callback delegate that was registered
Registers a map layers processed event callback.
The callback to be executed whenever the event is emitted
The callback delegate that was registered
Registers a map mouse enter event callback.
The callback to be executed whenever the event is emitted
The callback delegate that was registered
Registers a map mouse leave event callback.
The callback to be executed whenever the event is emitted
The callback delegate that was registered
Registers a map move end event callback.
The callback to be executed whenever the event is emitted
The callback delegate that was registered
Registers a map pointer move event callback.
The callback to be executed whenever the event is emitted
The callback delegate that was registered
Registers a map pointer stop event callback.
The callback to be executed whenever the event is emitted
The callback delegate that was registered
Registers a map projection changed event callback.
The callback to be executed whenever the event is emitted
The callback delegate that was registered
Registers a map projection change event callback.
The callback to be executed whenever the event is emitted
The callback delegate that was registered
Registers a map ready event callback.
The callback to be executed whenever the event is emitted
The callback delegate that was registered
Registers a map zoom end event callback.
The callback to be executed whenever the event is emitted
The callback delegate that was registered
Registers a map rotation event callback.
The callback to be executed whenever the event is emitted
The callback delegate that was registered
Registers a map single click event callback.
The callback to be executed whenever the event is emitted
The callback delegate that was registered
Registers a map change size event callback.
The callback to be executed whenever the event is emitted
The callback delegate that was registered
Registers a marker icon showed event callback.
The callback to be executed whenever the event is emitted
The callback delegate that was registered
Register handlers on pointer move and map single click.
Map to register events on
Remove an existing custom component from the map
The id of the component to remove
Searches through a map config and replaces any matching layer names with their provided partner.
The array of name pairs. Presumably one english and one french name in each pair
OptionalmapConfig: TypeMapFeaturesConfig
Optional config to modify, or one created using the current map state if not provided
Optional - Whether or not names not provided should be removed from config
Map config with updated names, or undefined if no config is available
Rotates the view to align it at the given degrees.
The degrees to rotate the map to
Sets the timezone used to display date values for this map.
This affects how parsed date instants are converted and presented in the UI, without modifying the underlying stored values.
The IANA timezone identifier to use for display
Set fullscreen / exit fullscreen.
Toggle fullscreen or exit fullscreen status
The element to toggle fullscreen on
Sets the home button view settings for the map.
The view settings to set for the home button
Set map to either dynamic or static.
Map interaction
Set the display language of the map.
The language to use (en, fr)
OptionalreloadLayers: boolean
Optional flag to ask viewer to reload layers with the new localize language
A promise that resolves when the language change is complete
Set the map zoom level instantaneously, no animation.
New zoom level
Set the maximum map zoom level.
New maximum zoom level
Set the minimum map zoom level.
New minimum zoom level
Set the display projection of the map.
The projection code (3978, 3857)
True if the projection was changed, false if the projection code is unsupported
Set the display theme of the map.
The theme to use (geo.ca, light, dark)
Set the map viewSettings (coordinate values in lon/lat).
Map viewSettings object
Simulate a map click and return promises of store update and ui update.
The lonlat coordinates to simulate
The simulated map click information
Unregister handlers on pointer move and map single click.
Map to unregister events on
Update the size of the icon image list based on styles.
The legend to check
Waits for the map to be ready before resolving the promise.
This function checks if the map is already ready, and if not, it waits for the onMapReady event to be triggered.
A promise that resolves when the map is ready
Waits for the next map move-end event to be emitted.
A promise that resolves when the map move-end event fires
Waits for the next rendercomplete event to be emitted.
Forces a synchronous frame via map.renderSync() so rendercomplete is guaranteed to fire,
even when the map is idle. Without this, waiting on rendercomplete for an idle map hangs
forever because OL does not schedule a frame unless something invalidates the view.
A promise that resolves when the map render is complete
Animates the map to the specified zoom level.
The store is updated automatically via the MapViewer move-end event.
The target zoom level
Indicates if a zoom animation should be used, default: true
Optional animation duration in ms
A promise that resolves when the zoom animation is complete
Zooms to the specified extent.
The extent to zoom to
Indicates if a zoom animation should be used, default: true
The options to configure the zoomToExtent (default: { padding: [100, 100, 100, 100], maxZoom: 13, duration: 500 })
A promise that resolves when the zoom animation is complete
Returns to initial view state of the map using config.
Indicates if a zoom animation should be used, default: true
A promise that resolves when the zoom animation is complete
Zoom to specified extent or coordinate provided in lonlat.
The extent or coordinate to zoom to
Indicates if a zoom animation should be used, default: true
Optionaloptions: FitOptions
Optional options to configure the zoomToExtent (default: { padding: [100, 100, 100, 100], maxZoom: 11 })
A promise that resolves when the zoom operation completes
StaticcomputeComputes the effective minimum and maximum scales for a layer from its configuration and initial settings.
Combines scales from configuration and initial settings zoom levels, selecting the most restrictive value.
The map viewer used for zoom-to-scale conversions
The layer configuration to compute scales from
Object with effective scale thresholds and buffered visibility limits
StaticgetRetrieves the scale information from the DOM elements for the given map ID.
The unique identifier of the map
The scale information object
Class used to manage created maps.