- OpenLayers updated to
6.15.1 - #1411: Support pre-registering custom projections from appdef
- #1463: Support reading app settings from appdef
- #1461: Support loading Map Definitions that link to a XYZ tileset
- #1447: Support disabling custom cursors through a new
DISABLE_CURSORSapp setting (1to enable,0to disable) - #1258: Modal dialog size and positioning is now persisted
- #1458: Fix potential stale legend state from dispatched update action
- #1411: Fix epsg.io lookup
- #1416: Support Coordinate Tracker with only one projection specified
- #1426: Add separate opacity control for MapGuide Base Layers
- #1412: Un-break viewer API drawing example
- #1444: Restore selection appending while holding down SHIFT key
- #1452: Fix viewer state not pushing to url
- Remove
shortiddependency by replacing existing usages with a simple sequential numerical id generator
- Update to OL 6.13.0
- #1385: Use DOMPurify to sanitize all cases where raw HTML content is being assembled.
- DOMPurify is now also the default HTML cleaning function for the selection panel component if no custom HTML cleaning function is provided.
- #1374: Un-break support for Web Layouts
- Update to OL 6.10.0
- #1368: Fix Firefox instability by debouncing history API access on url state update
- #1369: Fix
e.declutterTree is nullerrors on vector feature hovering - #1370: Allow appdef vector layers to opt-out of automatic hover highlight processing
- #1363: Hover highlighting now only happens if the active map tool is
Select - #1362: Un-break static image layers in appdef
- #1361: Fix inability to load a Map Definition with an arbitrary coordinate system not based in meters.
- #1360: Fix inability to add some GeoJSON-based WFS layers
- #1358: GeoJSON appdef layers can now source their data from a browser global variable
- #1357: Added support for WFS (GeoJSON format) in appdef external layers
- #1354: Support for static images as subject layers
- #1350: Fix opacity not applying to subject layers
- #1348: Basic support for MapGuide Map Definitions that use arbitrary (non-geographic) coordinate systems. Refer to Known Issues for caveats to using the viewer with such maps.
- #1349: Restore display of viewer init warnings on startup
- #1344: Template-specific CSS now embedded alongside its respective layout component. All template HTML files are now virtually identical except for the template to init with. A new PHP version of the template is included that can now also parameterize the template name via a
templatequery string parameter. - #1346: External layer instances can now carry arbitrary JSON metadata to support persistence and restoration of such layers (the viewer will not be doing this, that aspect is left to you, the consuming application to handle)
- #1343: New flag to control whether the select tool can pan via mouse drag
- #1340: Do not try to rebuild (non-existent) MapGuide runtime map layer/group structure in stateless mode
- #1341: Add XYZ tile debug layer
- Fix npm package due to unwanted modules being pulled in from a bad import
- #1175: New powerful declarative styles for vector layers
- External Layer Manager enhancements:
- #398: Viewer can now be used in a non-MapGuide context (no MapGuide Server required!)
- To use this viewer in a general purpose context, you must have a
<Map>element that refers to a "subject layer" instead of a Map Definition. A "subject layer" can be:- A WMS layer
- A vector layer
- In a non-MapGuide context, commands that require a
SESSION/MAPNAMEpair to operate are disabled in all toolbars and menus where the command is referenced. Examples of such commands include:BufferThemeQueryQuickPlotFeatureInfoRedlineSelectWithin
- Refer to this example appdef for an example of a general-purpose Application Definiion
- All viewer templates have been refactored to work in a non-MapGuide context
- Various components have been refactored to be useful in a non-MapGuide context
- Legend: Shows external layers in a separate top-level
External Layersroot folder - #1156 Selection Panel: Can now show attributes of selected client-side vector features
- Legend: Shows external layers in a separate top-level
- To use this viewer in a general purpose context, you must have a
- New "generic" viewer template. This is an opinionated viewer template geared for use in a general purpose context.
- #1288: New "stateless" mode for MapGuide
- In this mode, no session id is created
- Just like the general purpose context, commands that require a
SESSION/MAPNAMEpair to operate are disabled in all toolbars and menus where the command is referenced. - No
CREATERUNTIMEMAPrequest is made to build the layer/group structure for display in the Legend component. Instead, an anonymousGETRESOURCECONTENTrequest for the required Map Definition and the layer/group structure is built from that.
- #1289 New support for UTFGrid layers
- #1187: Client-side vector layers are hover-able
- #1329: Added support for the Fusion print command/widget
- XYZ tileset improvements:
- The
resourcequery string parameter can now refer to either a MapGuide WebLayout/ApplicationDefinition resource ID or a URL to an Application Definition JSON document- If this parameter is not specified, the viewer will now try to load from an Application Definition JSON document named
appdef.jsonat the same root as the viewer html files
- If this parameter is not specified, the viewer will now try to load from an Application Definition JSON document named
- #543: When zooming in or out, if an active feature highlight is shown, it will now properly refresh
-
The
WmsQuerycommand has been removed and consolidated into theSelectcommand/widget. Update your Application Definitions accordingly. -
The viewer bundle is now split into 2 files:
vendor.jsviewer.js
If you are using a custom template, you now must load
vendor.jsbeforeviewer.jsand also make sure to includevendor.cssalongisde theviewer.cssstylesheet. -
Due to the introduction of stateless mode and general-purpose usage context, your usage of the current viewer APIs can no longer assume that you will always have a session id to work with.
- Fix initialElementVisibility not applying for Aqua template
- Fix inconsistent layer/group visibility in legend if doing a refresh after server-side layer/group state changes
- Un-break MapGuide tiled maps support (due to change in tile grid coordinate format introduced in OpenLayers 6.0)
- Un-break map switching
- Almost all components are now functional components with hooks instead of class-based.
- This means component state is now a true implementation detail of the component and cannot be relied on externally (eg. Operating on state of a ref-mounted component instance)
- Most TypeScript component state and dispatch interfaces have been removed as a result.
- Use the new react-redux hooks API for dispatching viewer actions and subscribing/listening to viewer application state.
- Consider using our collection of custom hooks for listening to particular viewer application state.
- Removed optional
factoryargument fromILayerManager.getLayer().- Replacement: Just add the layer yourself aftewards if
ILayerManager.getLayer()returnsundefined.
- Replacement: Just add the layer yourself aftewards if
- Removed
moveDownandmoveUpmethods fromILayerManager.- Replacement: Dispatch the new
SET_LAYER_INDEXredux action for your layer with your desired new index positioning.
- Replacement: Dispatch the new
- Custom template reducer function signature has changed.
- Old signature:
(state: ITemplateReducerState, action: ViewerAction) => ITemplateReducerState - New signature:
(origState: ITemplateReducerState, state: ITemplateReducerState, action: ViewerAction) => ITemplateReducerState - Implications:
- You only need to care about
origStateif you care to apply custom "selection panel is visible" state (per: #478) because your custom viewer template does not treat Legend/Selection/TaskPane as a mutually exclusive visible set of components in an accordion or tab-like UI. Refer to the reducer in the Aqua template for an example of why this new reducer function signature is required.
- You only need to care about
- Old signature:
- #33: Sidebar template shows a red "badge" over the selection panel toggle button to indicate the selection panel has selected features.
- To counteract #478, the selection panel for this particular template only auto-expands the selection panel of the display is greater than a tablet as such behavior would be intrusive on smaller displays. The red "badge" is a visual cue to let the user know to manuall toggle this panel open on mobile if needed.
- #1071: Removed "Invalid Task Pane" warning that may display in multi-map configurations.
- Implications:
- Your task pane content should not rely on the
MAPNAMEquery string parameter to determine what is the current map being viewed, nor should server-side code that renders out HTML/JS use this parameter to determine this. Your task pane content should ask the viewer API directly from JavaScript. You can ignore this note if your application does not involve multiple maps.
- Your task pane content should not rely on the
- Implications:
- Major updates of key libraries:
- #963: Re-designed External Layer Manager
- Can now add file-based layers to the map
- GeoJSON/TopoJSON
- KML
- GPX
- IGC
- Added layers UI reworked and enhanced:
- All layers can now have their visibility and opacity toggled
- All vector layers have the ability to zoom to the bounds of that layer and can be styled
- Certain WMS layers can toggle their legend inline (if the WMS service supports the GetLegendURL sub-capability)
- Reworked add WMS layer UI to be more informative
- Layer management state relocated to the redux store. Adding/removing/reordering external layers is now done through dispatching redux actions.
- Can now add file-based layers to the map
- #1017: React components now showcased in Storybook
- #962: Legend now features a search box filter to easily filter down for specific layers in very large layer trees.
- Internal plumbing changes and restructuring:
- #1018: Convert react components over to functional components with hooks and replace internal usages of legacy React context API over to new context API
- Remove usage of superfluous libraries to improve bundle size where possible:
- Modal dialogs are now resizable via
react-rnd - Update Coordinate Tracker component with Blueprint styling
- #588: Use legend label for layer names in Selection Panel layer dropdown.
- #1040: Refactor toolbar item/command construction to work against a slimmed down version of the application state to avoid excessive toolbar re-rendering, fixing most UI sluggishness as a result.
- This is technically a breaking change as any custom commands you may register may have
enabledorselectedchecks that may break because we are no longer passing the full application state. Please report an issue if there is application state not in this slimmed down version that you need to observe on.
- This is technically a breaking change as any custom commands you may register may have
- #1041: Legend now uses blueprint SVG icons for non-theme-rule icons for better scalability
- #1047: SVG icon replacements for Task Pane and Selection Panel
- #326: Moved positioning aspects of status bar element CSS out of the main viewer css and to their template html files
- #1066: Remove es6 promise polyfill and
whatwg-fetchand replace with script tag reference topolyfill.ioin viewer html files and storybook to polyfill required bits for IE - #1011: Fix incorrect views when browser scaling is involved
- #1118: As a result, for retina/hidpi devices, the map is set up with a higher base DPI to compensate.
- #1107: Fix clicking of tooltip links opening in a new window if the Task Pane has a
component://URI loaded. - #1106: Fix clicking of tooltip links adding 2 entries to the Task Pane's navigation stack
- #1117: Feature tooltip toggle state is now synced with URL state (as
ftparameter) - #1125: Translate invoke script/url icon references for loaded WebLayouts
- #7: Task Pane fixes:
- Loading URLs into the Task Pane no longer adds new entries to the browser's navigation stack
- Fix forward button double-pushing the URL to the navigation stack, resulting in inconsistent back/forward behavior.
- New experimental viewer APIs for:
- Registering/unregistering subscribers to redux application state without rendering custom react components.
- This API is available from both within task pane content and as a
MapGuide.Applicationmount option (for embedding scenarios)
- This API is available from both within task pane content and as a
- Dispatching redux actions.
- Refer to this new TaskPane content example for usage of this new API.
- Registering/unregistering subscribers to redux application state without rendering custom react components.
- #1016: Fix i18n hole in feature tooltip hyperlink prompt.
- #1012: Use command label as title for modal dialogs spawned by it. Fix display and i18n issues in share link to view component.
- Fix
<sup>in measure area displat being unnecessarily escaped
- Fix more i18n gaps in:
- #1006: Fix Task Pane menu not auto-closing if task pane is made invisible.
- Fix production bundle not being minified (due to behavioral change introduced by a recent webpack update)
- #1004: Add OL factory APIs for creating missing OL style types.
- #1000: Fix clicked hyperlinks in tooltips not opening in Task Pane
- #990: Default initial active viewer tool to "Pan" instead of un-set
- #991: Fix default format string for mouse coordinates component missing localized units display
- Fix drawing task pane sample
- #989: Fix scrambled font icons
- #988: Allow map to properly init if session id is passed, but runtime map was not created yet (can happen if loading a weblayout/appdef from a session resource id or the session id was pre-generated up front before the viewer was loaded)
- Fix some warnings around usage of the
historymodule and redux dev tools - Fix possible duplicated source maps as a result of recent versions of webpack
- #968: Fix initial view on appdef breaking viewer
- #964: Plug additional i18n holes in measurement units and OpenLayers controls
- #960: Fix react update exceeded depth errors in WMS (External) layer manager component
- #961: Refine test for QUERYMAPFEATURES 4.0.0 support
- #804: Selection sub-highlighting now only available for MapGuide Open Source 4.0 (and newer) servers.
- #670: Add support for XYZ layers defined in a Flexible Layout to match functional parity with Fusion
- #587: Plug remaining i18n holes in measure and WMS layer manager components.
- #955: Don't word wrap layer/group node labels in Legend component and provide tooltips for these labels
- #940: Remove non-geodesic measure option as it is mostly inaccurate.
- #481: Current selection set now also stashed to local storage to persist (and be restored) between browser refreshes.
- #645: Viewer CSS is now extracted out to a
separate asset (instead of integrated with the JS bundle)
- As part of this change, workaround a potential infinite loop if the error icon asset could not be found by adding an inline base64 copy of this icon.
- #596: Add copy link button to ShareLinkToView widget (via
react-copy-to-clipboard) - #631: Fix init failure if appdef has an empty widget container
- #595: Fix line measurement total showing units in m^2
- #593: Fix measure tool starting measuring when switching measurement type
- #643: Added basic e2e test suite. Powered by
testcafe - #698: Fix memory leak due to dangling measure components being held on by the measure context after unmount
- #569: Update to use
componentDidUpdateinstead ofcomponentWillReceiveProps - #690: Made redux actions more strongly-typed
- Updated Blueprint to 1.40.0
- Updated TypeScript to 3.6.3
- Updated React to 16.9.0
- Replaced
query-stringmodule withqs - Now built with webpack 4.x
- Updated OpenLayers to 4.6.5
- #562: More scalable vertical text CSS for sidebar template
- #566: Fix QuickPlot not working without toggling print box first
- #476: Fix tiled base layer group initial visibility not being respected
- Updated React to 16.2
- Updated Blueprint to 1.35.5
- Updated OpenLayers to 4.6.4
- Updated TypeScript to 2.7.2
- #481: Partial application state now pushed to URL, making a browser reload effectively "resume" from where you left off.
- Current view
- Active map (if multiple maps are present)
- Shown/Hidden group and layer names
- Current session id
- Template changes:
- #192: Measure tool now displays segment lengths (and total length/area) of active measure
- #304: Broken/404 toolbar/menu icons now gracefully show an error icon in its place.
- #475: Support for manual tooltip display (ie. click to show tooltip instead of selecting)
- #244: Flyouts are now mutually exclusive, making them behave more like their Fusion counterparts.
- #243: Port across additional Fusion widgets
CenterSelection
- #239 Port across additional extension parameter support for the following Fusion widgets:
RedlineSelectPolygon
- #30: Support for taskpane/infopane width elements of a Web Layout (only recognized by the
ajax-viewertemplate). - #477: Selection panel now supports HTML property values (through a new
selectionSettings.allowHtmlValuesmount option)- For un-trusted content, a mount option
selectionSettings.cleanHtmlis available to provide a content sanitization function.
- For un-trusted content, a mount option
- #518: Debug viewer bundle (
viewer-debug.js) now included - #531: Improved digitization controls:
- Support undoing last drawn point by pressing the
Ukey - New mount options for customizing keybindings for cancelling digitization (default:
ESC) and undoing last point (default:U)
- Support undoing last drawn point by pressing the
- New components accessible through the existing InvokeURL mechanism:
- #526: Viewer now uses OL
PluggableMapfor reduced bundle size - #517: Fix: Commands now fall back to running in modal dialog if Task Pane is not present.
- #383: Fix: Initial rendered map does not cover full viewport.
- API changes:
- NPM module changes:
- No longer includes
@types/*packages as dependencies to avoid "dll-hell" with conflicting typings. You can install your own typings for React, etc.
- No longer includes
- Updated OpenLayers to 4.3.2
- Update TypeScript to 2.5
- Update Blueprint to 1.27
- #188: QuickPlot now supports box rotation via a numerical slider
- #6: Selection Panel component now highlights the currently selected feature (when multiple features are selected)
- #325: New persistent busy loading indicator
- #36: NPM module now supports customizable Selection Panel body rendering
- #97: Port across Coordinate Tracker widget from Fusion
- #11: Port across view size status bar component
- #329: Removed es6-promise from the main viewer bundle. This is now loaded as a separate script from all the entry-point HTML templates. If you do not care to support Internet Explorer, you can remove this script reference.
- #63: New init warnings reducer, this is used to display warnings about:
- Missing Bing Maps API key
- Unknown Bing Maps layers
- Usage of Google Maps (not supported in mapguide-react-layout)
- #239: Full extension property support for Fusion
CursorPosition - API: #337:
localenow supported as amount()option. - API: #332: Everything can now be imported directly from the
mapguide-react-layoutNPM module (eg. This is now a legal import:import { ApplicationViewModel } from "mapguide-react-layout"). Piecemeal imports is still available. - API: #318: NPM module support for adding in custom application-specific reducers
- API: #150: New APIs for
MapGuide.Application:- A new
onInitmount option that's called once the application is initialized - A new
getCommand(name)function to get a registered command by name - #305: Expose redux
dispatch()to allow redux actions to be dispatched from a browser globals context- All redux action available under
MapGuide.Actions
- All redux action available under
- A new
- API: Added extra factories for
ol.Collectionandol.interaction.translate - API: New
IMapViewerAPIs for:- Getting name of the current runtime map
- Enabling/disabling view rotation
- Setting/getting the current view rotation
- Docs: API docs now versioned (from 0.9.6 onwards)
- #300: Use
async/awaitto simplify init and mapagent request code.- API: Removed
IPromise<T>. All references toIPromise<T>now reference standardPromise<T>to supportasync/await
- API: Removed
- #302: Fix transparency toggler for maps with no external base layer configuration.
- API: Image/cursor file references moved from
utils/assettoconstants/assets
- #250: Added support for toggling layer transparency (via Viewer Options)
- API: Added OL factories for creating extent and snap interactions
- #111: Ensure that scales of new views "snap" to the closest finite scale when viewing a tiled map
- #252: Fix tooltip queries being sent with points instead of pixel-buffered polygons
- #239:
- Support element target (New Window / Task Pane / Specific Frame) for commands
- Expanded extension property support for select Fusion widgets
- #22: Added sprite icon support. Any icon currently in the default Fusion image sprite is supported here.
- #276:
- New standardized path (
dist/stdassets) for all content assets (images/icons/fonts/etc) - Command/Flyout icon settings are now respected.
- #295: Some helpers to ensure proper asset path resolution when using the npm module
- New standardized path (
- Legend now properly renders layers with multiple geometry styles
- Fix: Fusion MapMessage compat not spawning equivalent blueprint toast alerts
- #290: Fix flyout menus requiring double-click to re-open
- #277: Fix excessive blueprint toaster components created when using toast alerts
- Update blueprint to 1.21.0
- Update OpenLayers to 4.2.0
- Update React to 15.6.1
- #261: Now built with Webpack 3 with scope hoisting support for faster bundle loading and slightly smaller bundle size
- #251: Fix inability to interact with tooltip content
- #262: Fix refresh not rebuilding legend
- #246: Support for setting initial template element visibility when mounting
- Update blueprint to 1.17.1
- Update to React 15.5.4
- #210: Now using TypeScript 2.3.2
- Update OpenLayers to 4.1.1
- Now available as a npm module. Use the npm module if you need to customize the viewer with:
- Additional layout templates
- Custom script commands
- Removing un-used features from the viewer bundle
- Check out this example to see how the npm module is used
- #50: API documentation (provided by Typedoc)
- #125: New project landing page
- #189: Added support for Bing Maps as external base layers
- #121: Ported testing infrastructure over to jest
- #99: Now built using Webpack 2.x
- #124: Set up greenkeeper.io service
- #224: The following tools now reuse existing Fusion widget and/or backend code:
- Buffer
- Query
- Theme
- FeatureInfo
- Redline
- QuickPlot
- Search Commands
- As a result, many Fusion viewer APIs have been polyfilled to support these tools
- Components docked into the Task Pane will now properly scroll overflow content if required
- #145: Added support for some Fusion events
- #197: The
ajax-viewerandsidebartemplates now work with Application Definitions - #17: InvokeURL and Search commands now support:
- Frame targeting (Target =
SpecifiedFrame) - Opening in a new window (will use a modal dialog)
- Frame targeting (Target =
- Fusion template tweaks:
limegoldandturquoiseyellowtemplates now use the blueprintjsTabs2component instead of the deprecatedTabscomponent- All templates now listen on a new dedicated redux state branch for controlling visibility/focus of primary elements:
- Task Pane
- Legend
- Selection
- New script commands are registered by default that can push new visibility/focus states to this redux state brach. As a result, any existing InvokeScript widgets that toggled the TaskPane/Legend/SelectionPanel (these commands exist if you created a fresh Application Definition in Maestro), now work out of the box and no longer show
[X] Errorplaceholders - As a result of the new redux state branch, any InvokeURL command executed now automatically toggles the visibility/focus of the Task Pane to be the active element (if hidden or not visible).
- #174: Fix race condition where the viewer finishes init before the fetching custom projections from epsg.io has completed
- #130: Fix
parent.parentpointing to nowhere when viewer itself is embedded in an iframe.
- Update Blueprint to 1.9.0
- Update React to 15.4.2
- Improved performance due to restructured and optimized redux state tree and updates to minimize unnecessary re-rendering
- #108: Added multi-map support
- #64: Ported across MapMenu fusion widget
- #113: Fix small sliver of task pane content visible when task pane collapsed on sidebar template
- #114: Fix legend infinite loop on maps with multiple (>2) levels of group nesting
- #115: Hover styles no longer rendered for disabled toolbar items
- #122: Clicking expanded panel in accordion should not collapse it
- #123: Offset modals more from the top (so toolbars don't obscure them)
- #25: Add support for InvokeURL command parameters
- #3: Complete menu/toolbar loose ends
- #64: Fix accordion not showing last panel as initially expanded in Slate and Maroon templates
- #111: Fix switching to fractional finite display scale not reflecting in scale dropdown
- #109: Restore 'NONE' option in Base Layer Switcher component
- #98: Updated to TypeScript 2.1
- #91: Use Blueprint as UI foundation
- Many UI elements updated/replaced/re-styled with blueprint equivalents
- Menus (flyout and context) can now support multiple levels of nesting
- Replaces the following components/libraries which have been removed
- ol3-contextmenu
- react-flyout
- Our custom fontello icon set
- Feature Tooltips are now toggle-able from Viewer Options
- #64: All Fusion templates ported across
- TurquoiseYellow
- LimeGold
- Slate
- Maroon
- Aqua template changes:
- Added status bar
- Changed to use Blueprint-styled modal dialogs
- Task Pane window opens (if hidden) when an InvokeURL command is executed
- Sidebar template changes:
- Updated to use Blueprint icons and load spinner
- More Fusion widgets ported over
- Now shows busy indicator on viewer startup instead of a "white screen of nothingness"
- #90: Replaced
npmwithyarn - #103: non-
enstring bundles are now loaded on demand if the passed inlocaleparameter is noten - #38: Mouse cursor now updates based on active map tool
- #86: Zoom slider position should now better reflect actual zoom (especially for tiled maps)
- #85: Scale display is now editable. For tiled maps, this becomes a select dropdown of finite scales
- #79: Update OpenLayers to 3.19.1
- #87: Update to TypeScript 2.0.10 and React 15.4.1
- #81: Check that the
resourceparameter is specified - #84: Fix
DisplayInLegendproperty of layers and groups not being used to determine visibility of legend items - #88: Fix property pane "spilling over" in non-Aqua templates when viewing a feature with lots of attributes
- Better/improved tiled layer support
- #76: Fix init error when loading map containing raster layers
- #75: Refactored flyout menus to be physically de-coupled from their toolbars
- #52: Task Pane flyout menu will now properly show over the task pane when it has embedded (ActiveX/Flash/etc) content in IE.
- #74: Implemented ExecuteMapAction AJAX Viewer API.
- #47: Viewer now supports passing in Application Definition resource ids
- See KNOWN_ISSUES.md for features not yet supported
- #64: New layout template: Aqua
- This is a port of the equivalent Fusion template
- #33: Update toolbar CSS in Sidebar layout template so that it better blends in.
- #65: Page document title will now be set to the title of the Web Layout / Application Definition if specified
- #60: Fix bad relative path to webconfig.ini that causes most server-side tools to fail
- #55: Handle and show startup errors
- #40: Measure tool now requires explicit start/stop of measurements
- #66: Error placeholders now shown for toolbar/menu items for invalid command references
- #59: Enable feature tooltips by default
- #73: Fix incorrect ratio for ol.source.ImageMapGuide resulting in image requests that are bigger than viewport
- #71, #72, #29: Set active tool to nothing before digitizing, ensuring selection isn't triggered when drawing
- Selection Panel now respects attribute display order of Layer Definition
- #70: Projections for unknown EPSG codes will now be requested from https://epsg.io
- Added OL controls to base map viewer component
- Overview Map
- #62 Rotation reset
- #53 Code base migrated to TypeScript 2.0
Initial release