Skip to content

ChangeLog.md

Latest commit

 

History

History
190 lines (155 loc) · 11.9 KB

ChangeLog.md

File metadata and controls

190 lines (155 loc) · 11.9 KB

v1.X (TBD)

Important:

  • Run yarn install to upgrade dependencies.
  • Consult the list of incompatible changes below.

News:

Incomplete list of changes, for full details, please consult the [commit history](see https://github.com/qgis/qwc2/compare/v1.0...master)

  • Allow exporting identify results to CSV
  • Allow configuring WMS hidpi from config.json
  • Allow hiding legend print button
  • Support specifying print labels to omit in the print dialog in the printLabelBlacklist array in themesConfig.json
  • Display print result in inline window
  • Allow adding external-url launcher entries to menu and toolbar
  • Support an array of background printLayers, with maxScale determining which one is used
  • Support scale in search result items if bbox is empty

Incompatible changes:

  • enableExport has been replaced by exportFormat in the Identify plugin configuration parameters in config.json

  • The qwc2 submodule is now registered as a yarn workspace dependency (see package.json), all it's dependencies were moved to qwc2/package.json. The webpack.config.js also needs to be updated, see commit 6ff4ce0. At the same time, the MapStore2 and QWC2Components trees were merged in the qwc2 submdoule.

  • The qwc2-icons.css stylesheet isn't loaded anymore by the Icon.jsx component in the qwc2 submodule, but needs to be referenced in the application specific code, for instance by adding to js/app.jsx

    require('../icons/build/qwc2-icons.css');

  • The Redlining plugin import in appConfig.js must be invoked as a function, with the enabled plugins as argument

v1.0 (Feb 13 2019)

Important:

  • Run yarn install to upgrade dependencies.
  • Consult the list of incompatible changes below.

News:

Incomplete list of changes, for full details, please consult the [commit history](see https://github.com/qgis/qwc2/compare/v0.2...v1.0)

  • Allow specifying WMS image format in themes configuration
  • Add Toolbar component for quick-launch buttons next to search bar
  • Add option to store current view as center + scale in URL
  • Add support for URL crs parameter to specify in wich CRS the center/extent coordinates are specified
  • Make TopBar components configurable
  • Make logo format configurable
  • Move coordinates search provider to app
  • Add optional search provider selection menu
  • Add support for search queries with multiple input fields
  • Allow removing entire layers from identify results list
  • Add button to export the identify results to json
  • Add component to identify all features within a selected region
  • Add possibility to not display any background layer
  • Make the short permalink share component fall back to the full URL if no QWC2 server is configured
  • Make map button positions configurable
  • Add button to toggle the layertree
  • Add expanders to layer tree groups
  • Allow hiding layer icons in layertree
  • Honour layer drawing order
  • Allow limiting available map scales for printing
  • Also encode layer transparencies in the layer query parameter
  • Make the overview map display the actual theme map instead of an OSM layer
  • Add info dialog for displaying layer metadata and legend
  • Expose composer labels in print dialog
  • Show label with search result text along with pin marker
  • Also highlight the geometry of the selected search result in the print output
  • Increase size of theme thumbnails
  • Add raster-export component to save a selected area of the map to an image
  • Add button to print current layertree legend
  • Automatically select search result if only one result is returned
  • Automatically perform search when theme is loaded an a search text query parameter exists. If the search results in exactly one result, it will get selected.
  • Make custom commands in package.json windows compatible
  • Update all dependencies to latest version available as of Feb 27 2017
  • Add draw component
  • Move various scripts to qwc2/scripts
  • Allow selectively overriding translation strings while importing the rest from the qwc2/translations
  • Map projections are now set individually for each theme
  • Add preserveExtentOnThemeSwitch and preserveBackgroundOnThemeSwitch to config.json to control whether extent / background layer should be preserved (if possible) on theme switch
  • Make identify results dialog resizeable
  • Insert anchor tags for urls / email addresses in feature attributes
  • Allow configuring grid interval for print output
  • Allow specifying human readable labels for the CRS EPSG codes in js/appConfig.js
  • Allow limiting available resolutions for printing
  • Add per-theme "collapseLayerGroupsBelowLevel" setting to control level below which layer groups are collapsed by default in the layer tree
  • Add per-theme "skipEmptyFeatureAttributes" setting to control whether empty/NULL attributes should be skipped in the feature info table
  • Add optional label attribute to search result items to display in map on select (defaults to item text)
  • Added LayerTree config properties: showRootEntry, showQueryableIcon, allowMapTips
  • Use assets/templates/legendprint.html as a template for the map legend print.
  • Added LayerTree groupTogglesSublayers config property to control whether toggling a group toggles just the group or also all the sublayers
  • New Redlining module
  • Editing support
  • Support for importing WMS layers
  • Support for importing KML layers
  • Add option to flatten layer tree groups (config.json -> LayerTree -> flattenGroups)
  • Optionally allow reordering layers in layer tree (controlled via config.json -> allowReorderingLayers)
  • Add option to preseve non-theme layers on theme switch (config.json -> preserveNonThemeLayersOnThemeSwitch)
  • Add possibility to specify DPIs for raster export (config.json -> RasterExport -> dpis)
  • Add option to reset to default theme when logo image is clicked (config.json -> TopBar -> logoClickResetsTheme)
  • Add possibility to compare top layer with remaining layers of map
  • Redlining and additional layers added by the user are sent to the permalink service and restored if the service returns them, see https://github.com/sourcepole/qwc2-server
  • Add height profile plugin, see https://github.com/sourcepole/qwc2-server for a sample service
  • Add a plugin for displaying a map info tooltip on rightclick
  • Add client-side logic to download feature reports, see https://github.com/sourcepole/qwc2-server for a sample service
  • Pure WMS identify-region tool (requires QGIS-Server 3.0.1+)
  • Add support for mutually exclusive groups in layer tree
  • Allow storing full layer state (including redlining) in Parmalink (requires server-side support by the permalink service)
  • Add option to display identify results as a flat list instead of a tree of results
  • Allow displaying additional client-side computed attributes in identify results, look for attributeCalculator in js/appConfig.js.
  • Allow controlling per-theme visibility of menu and toolbar items, by adding a themeWhitelist entry to the respective item in config.json.
  • External layers are now also stored in non-compact permalink

Incompatible changes:

  • Keys of TopBar menuItems in config.js have been renamed

  • Center/extent coordinates in URL by default in map projection instead of EPSG:4326

  • The search text URL parameter key is now st instead of s

  • The individual TopBar plugin components are now configured in js/appConfig.js

  • The coordinate search provider was moved to js/SearchProviders.js

  • The search providers onSearch and getMoreResults take an additional requestId argument

  • The searchResultsLoaded action has changed:

      -const {searchResultLoaded} = require("../qwc2/MapStore2/web/client/actions/search");
  +const {addSearchResults} = require("../qwc2/QWC2Components/actions/search");

  • The search providers must return the additional fields provider and reqId:

      {data: results, provider: providerId, reqId: requestId}

  • Various scripts have been moved to qwc2/scripts. The "scripts" section of package.json has been adapted to use these.

  • The translations/updateTranslations.py was removed in favour of qwc2/scripts/updateTranslations.js, the translation languages now need to be specified in translations/tsconfig.json along with application specific message ids. Consult the README for more details.

  • Map projections are now set individually for each theme via the mapCrs entry. If unset, it will default to EPSG:3857.

  • The defaultScales list in themesConfig.json is now required

  • The locale definitions under supportedLocales in appConfig.js must provide a localeData field

      localeData: require('react-intl/locale-data/<lang>')

  • The print legend functionality requires a assets/templates/legendprint.html file with an element with id="legendcontainer", which will contain the legend graphics. The HTML document title of this template may influence the suggested output name when printing to a file (depending on the browser).

  • The enabled MapPlugin components need to be specified in appConfig.js

  • The custom extent in themesConfig.json needs to be specified w.r.t. the crs specified in the theme mapCrs

  • Ported react components to use class definition and ES7 syntax, see i.e. https://babeljs.io/blog/2015/06/07/react-on-es6-plus. Any custom react components will need to be updated.

  • Most of the logic in js/app.jsx was moved to the core components, the file needs to be updated according to the latest version in qwc2-demo-app

  • The stylesheet assets/css/qwc2.css needs to be updated to include the style for #container, accoding to the latest version in qwc2-demo-app

  • The npm packages are now used for openlayers and proj4. The corresponding link and script lines need to be removed from index.html, and in js/appConfig.js the proj import needs to be changed to const Proj4js = require('proj4').default;. Also, the following line needs to be removed from webpack.config.js:

    new webpack.NormalModuleReplacementPlugin(/proj4$/, path.join(__dirname, "qwc2", "libs", "proj4")),

  • qwc2serverUrl in config.json was renamed to permalinkServiceUrl for clarity

  • proxyUrl in config.json was renamed to proxyServiceUrl for clarity, and is now only the base URL without url query parameter

  • The codebase now consistently uses [x, y] as point format (instead of a mix of {x: x, y: y} and [x, y]). So i.e. CoordinatesUtils.reproject will also return a point in [x, y] format.

  • The following lines need to be removed from assets/css/qwc2.css:

    -input[type=range] {
 -    display: initial!important;
 -    width: initial!important;
-}

  • The assets/css/qwc2.css stylesheet is now empty by default

  • Some color keys in styleConfig.js have changed

  • The bootstrap stylesheet in index.html is not used anymore and can be removed

  • All icons are now built into a custom icon font, replacing the svgs in assets/img and the bootstrap glyphicons used previously. Applications will need to be updated as follows:

    • Add the toplevel icons folder from qwc2-demo-app to your app (the svgs in assets/img are not used anymore)

    • The icons in menuItemsand toolbarItems in config.json now only need to contain the icon name, not the relative svg path. So i.e. img/themes.svg becomes themes.

    • The font rule needs to be added to webpack.config.js:

      +      {
+        test: /\.(woff|woff2)(\?\w+)?$/,
+        use: {
+          loader: "url-loader",
+          options: {
+            limit: 50000,
+            mimetype: "application/font-woff",
+            name: "fonts/[name].[ext]",
+          }
+        }
+      }

    • package.json needs to be updated with the new dependencies, and the iconfont script.

v0.2 (Jan 03 2017):

v0.1 (Dec 21 2017):

  • Initial public release