v5.3.0

We're continuing to work toward more complete type checking with TypeScript – based on JSDoc annotations in the source. The 5.3 release includes a number of bug fixes related to the type checking effort. In addition the release comes with a handful of new features and improved API reference docs.

Upgrade Notes

The `getUid` function returns string

The getUid function from the ol/util module now returns a string instead of a number.

Attributions are not collapsible for `ol/source/OSM`

When a map contains a layer from a ol/source/OSM source, the ol/control/Attribution control will be shown with the collapsible: false behavior.

To get the previous behavior, configure the ol/control/Attribution control with collapsible: true.

New Features and Fixes

#8642 - Fixes for optional key passing, issue #8067 for tile sources (@dimin)
#8885 - Move GeolocationProperty into Geolocation (@fredj)
#8881 - Remove custom styles in drag-and-drop examples (@fredj)
#8877 - Create context in vector tile layer constructor (@tschaub)
#8883 - New test runner (@tschaub)
#8882 - Import simplification (@fredj)
#8858 - Add condition for viewParams and TypeScript related option (@webgeodatavore)
#8879 - Build with CircleCI (@openlayers)
#8878 - Avoid logging 404 warnings (@tschaub)
#8876 - Remove RenderType enum from vector tile layer (@tschaub)
#8874 - Remove unnecessary type casts in canvas layer renderer (@tschaub)
#8869 - Fix more types for TypeScript (@ahocevar)
#8868 - Throw when calling abstract methods; fix abstract return types (@ahocevar)
#8862 - Legacy build and apidoc improvements (@ahocevar)
#8867 - Fix example builder (@ahocevar)
#8852 - Improve link handling in API docs (@ahocevar)
#8853 - Make rendercomplete work with vector sources without loader (@ahocevar)
#8851 - Use typescript types for RBush (@fredj)
#8850 - Remove old TODO in ol/Graticule (@fredj)
#8847 - Fix API docs (@ahocevar)
#8845 - Remove RenderType enum from vector layer (@tschaub)
#8843 - Fix ts typing for fullscreen button (@tonio)
#8841 - Use super.method instead of prototype.method.call (@fredj)
#8842 - Change target type from Element to HTMLElement (@fredj)
#8840 - Remove unneeded code in VectorTile renderer (@elemoine)
#8844 - Set crossOrigin to anonymous in mapbox-streets-v6-style (@elemoine)
#8776 - Use setTimeout without the window namespace (@ahocevar)
#8837 - Re-export MousePosition from ol/control (@fredj)
#8832 - Remove source foreachfeatureatcoordinate from ol/renderer/webgl/ImageLayer (@fredj)
#8833 - Fix wrong filename in type annotation (@fredj)
#8827 - Removed unused forEachFeatureAtCoordinate from ol/source/Source (@schmidtk)
#8830 - Type annotation fixes in ol/control/ (@fredj)
#8829 - Change getUid return type from number to string (@fredj)
#8825 - Fix TypeScript errors (@schmidtk)
#8828 - Re-export VectorTile from ol/source (@elemoine)
#8806 - Preserve button class name list in full screen control on toggle (@notnotse)
#8817 - Clarify format option for ol/source/WMTS (@romanzoller)
#8824 - Fix TypeScript errors in ol/format/GML (@schmidtk)
#8820 - Polygon intersectsExtent failure - Issue #8795 (@hmdavidjunior)
#8519 - GML Format Improvements #8516 #8517 #8518 (@NielsCharlier)
#8711 - Fix TypeScript errors in ol/format/GML (@schmidtk)
#8818 - Fix the way zoom comes from (@cs09g)
#8804 - Add possibility to disable collapsible attributions from Source (@notnotse)
#8787 - Replace instanceof checks with other logic (@ahocevar)
#8808 - Fix format and version properties in ol/source/WMTS Options typedef (@fredj)
#8812 - Update snap.js (@rosedo)
#8809 - Configurable interval options (@notnotse)
#8798 - Use unpkg.com instead of rawgit.com (@fredj)
#8805 - Do not draw image with width or height < 0.5 (@notnotse)
#8803 - Handle zoom slider position with floating point numbers (@notnotse)
#8789 - Spelling and indentation fixes (@fredj)
#8782 - Fix getSimplifiedGeometry definition (@wallw-bits)
#8783 - Fix missing method declaration (@wallw-bits)
#8781 - Fix type check errors (@schmidtk)
#8779 - Fix additional type check errors (@schmidtk)
#8753 - Fix type check in ol/PluggableMap.js (@wallw-bits)
#8762 - Fix type errors from interaction event handlers (@schmidtk)
#8763 - Fix type check for ol/events (@wallw-bits)
#8774 - Fix type check errors in ol/renderer/webgl (@schmidtk)
#8768 - Fix type check errors in ol/interaction/Select (@schmidtk)
#8764 - Fix TypeScript errors in ol/interaction/Draw (@schmidtk)
#8767 - Fix type check errors in ol/interaction/Modify (@schmidtk)
#8773 - Fix type check errors in ol/renderer/canvas (@schmidtk)
#8769 - Fix type check errors in ol/render/canvas (@schmidtk)
#8770 - Fix type check errors in ol/render/webgl (@schmidtk)
#8765 - Simplify logic for fixed tile url functions (@ahocevar)
#8766 - Use FeatureLike typedef (@fredj)
#8739 - Fix TypeScript errors in ol/format/WMSGetFeatureInfo (@schmidtk)
#8666 - Fix condition TypeScript errors (@schmidtk)
#8757 - Use typeof to simplify JSDoc class types (@schmidtk)
#8759 - Use es6 class inheritance in examples (@fredj)
#8761 - Allow returning RenderFeature in ol/format/Feature (@schmidtk)
#8758 - Fix TS error and prevent extra string conversion (@schmidtk)
#8736 - Typescript misc fixes (@fredj)
#8741 - Fix TypeScript errors in ol/geom/* (@schmidtk)
#8707 - Fix TypeScript errors in ol/format/Feature (@schmidtk)
#8754 - Fix type check in ol/math (@wallw-bits)
#8747 - Update doc/faq.md (@fredj)
#8744 - Fix type checks in VectorTileSource (@wallw-bits)
#8740 - Increase linestring textalign test tolerance to be Firefox compliant. (@benVigie)
#8738 - Cast to parent type to fix TS errors (@schmidtk)
#8737 - Flag optional param to fix TS error (@schmidtk)
#8742 - Fix type checks in Vector source (@wallw-bits)
#8743 - Fix type check in Raster source (@wallw-bits)
#8733 - Fix TypeScript errors in ol/format/WFS (@schmidtk)
#8735 - Fix TypeScript errors in ol/format/WKT (@schmidtk)
#8730 - Fix TypeScript errors in ol/format/KML (@schmidtk)
#8732 - Fix type check in ol/source/Tile (@wallw-bits)
#8731 - Dispatch a GeolocationError in Geolocation (@fredj)
#8729 - Move functions out of the PointerEvent class (@fredj)
#8724 - Typescript misc fixes (@fredj)
#8717 - Fix type checks in TileArcGISRest (@fredj)
#8718 - Fix TypeScript errors in ol/format/GPX (@schmidtk)
#8706 - Use EsriJSON types from @types/arcgis-rest-api (@schmidtk)
#8709 - Fix TypeScript errors in ol/format/GeoJSON (@schmidtk)
#8708 - Fix type checks in ImageCanvas source (@wallw-bits)
#8710 - Fix type checks in ImageArcGISRest (@wallw-bits)
#8698 - Fix zoom slider events (@intouch-smartwater)
#8697 - Remove unused properties from Cluster and Image options (@fredj)
#8688 - Fix PointerEventHandler event type (@fredj)
#8686 - Remove extra imports in jsdoc (@fredj)
#8681 - Check the type of the source before using it (@wallw-bits)
#8691 - Fix assertion error documentation URL (@romanzoller)
#8692 - Type check fixes for Cluster source (@wallw-bits)
#8677 - Type check fixes for VectorSource (@wallw-bits)
#8684 - Define BingMapsImageryMetadataResponse type (@wallw-bits)
#8690 - Fix type checks in CartoDB (@wallw-bits)
#8693 - Fix type check errors for Image source (@wallw-bits)
#8672 - Fix source type in Raster source (@fredj)
#8665 - Fix type check errors in RBush (@wallw-bits)
#8680 - TypeScript fixes for ol/events (@schmidtk)
#8678 - Ensure image is Image or Video before settings src (@wallw-bits)
#8676 - Cast tileGrid to WMTSTileGrid for type check (@wallw-bits)
#8679 - Type check fixes in Triangulation (@wallw-bits)
#8657 - Typescript fixes (@fgravin)
#8671 - Fix typescript in FeatureLoader (@fgravin)
#8675 - Get width as number from number|Size (@wallw-bits)
#8654 - Remove extra imports in jsdoc (@fredj)
#8655 - Remove webkit specific properties from Touch (@fredj)
#8663 - Add vendor-specific TS declarations for the Fullscreen API. (@schmidtk)
#8658 - Don't define functions in the prototype (@fredj)
#8662 - Explicitly define type of 'this' (@wallw-bits)
#8664 - Add native Event to ListenerFunction signature. (@schmidtk)
#8668 - Add missing 'module' annotation (@fredj)
#8643 - Fix style TypeScript errors (@schmidtk)
#8638 - Fix event type in hasListener check (@ahocevar)
#8618 - Use TopoJSON types from @types/topojson (@fredj)
#8619 - Remove wrong Geometry type in KML format (@fredj)
#8627 - Fix several type imports (@ahocevar)
#8629 - Enable circle primitive in draw-shapes example (@megawac)
#8626 - Better type annotations / type casts (@marcjansen)
#8622 - Remove unused method (@tschaub)
#8615 - Use GeoJSON types from @types/geojson (@tschaub)
#8609 - Remove extra imports in jsdoc (@fredj)
#8613 - Lazily detect tainted canvas (@ahocevar)
#8610 - Sensible touch behavior of the MousePosition control (@ahocevar)
#8602 - Add missing map property in ol/layer/Layer constructor options (@fredj)
#8607 - Listener return is boolean or void (@tschaub)
#8595 - Optional arguments and typedef properties (@tschaub)
#8594 - Remove extra imports in jsdoc (@fredj)
#8596 - Add types for the UTFGrid and TileJSON JSON responses (@tschaub)
#8591 - Add missing properties in TextState typedef (@fredj)
#8590 - Don't import ourselves (@fredj)
#8586 - Cast 'originalEvent' in interactions (@fredj)
#8588 - Rework createXYZ (@tschaub)
#8587 - Add a statement to trigger TypeScript checking (@tschaub)
#8345 - TypeScript (1/n) (@tschaub)
#8579 - Better type annotation (@marcjansen)
#8580 - Cast POINTER_ID before comparison (@marcjansen)
#8574 - Rename Extent to ExtentInteraction (@fredj)
#8577 - Remove geojson.js extern inclusion in tasks/generate-info (@fredj)
#8573 - Fix freehand polygon drawing (@fredj)
#8572 - typescript misc fixes (@fredj)
#8569 - Make proj~get simpler and faster (@ahocevar)
#8567 - Use 'Element' type instead of 'Node' (@fredj)
#8558 - Fix default zIndex value and documentation for layer options (@fredj)
#8555 - Do not minify examples that inject code into workers (@ahocevar)
#8557 - Fix typo in release notes (@ahocevar)

<details> <summary>Dependency Updates</summary>

#8884 - Update webpack to the latest version 🚀 (@openlayers)
#8880 - Update webpack to the latest version 🚀 (@openlayers)
#8872 - Update webpack to the latest version 🚀 (@openlayers)
#8860 - Update webpack to the latest version 🚀 (@openlayers)
#8855 - Update webpack to the latest version 🚀 (@openlayers)
#8838 - Update webpack to the latest version 🚀 (@openlayers)
#8834 - Update webpack to the latest version 🚀 (@openlayers)
#8799 - Update rollup to the latest version 🚀 (@openlayers)
#8796 - Update rollup-plugin-commonjs to the latest version 🚀 (@openlayers)
#8793 - Update rollup-plugin-buble to the latest version 🚀 (@openlayers)
#8794 - Update rollup to the latest version 🚀 (@openlayers)
#8788 - Update front-matter to the latest version 🚀 (@openlayers)
#8785 - chore(package): update rollup to version 0.66.4 (@openlayers)
#8719 - Update marked to the latest version 🚀 (@openlayers)
#8714 - chore(package): update webpack to version 4.20.2 (@openlayers)
#8703 - Update webpack to the latest version 🚀 (@openlayers)
#8646 - Update mustache to the latest version 🚀 (@openlayers)
#8645 - Update rollup-plugin-uglify to the latest version 🚀 (@openlayers)
#8685 - Update rollup to the latest version 🚀 (@openlayers)
#8683 - Update rollup to the latest version 🚀 (@openlayers)
#8656 - chore(package): update rollup-plugin-commonjs to version 9.1.8 (@openlayers)
#8667 - chore(package): update uglifyjs-webpack-plugin to version 2.0.1 (@openlayers)
#8661 - Update webpack to the latest version 🚀 (@openlayers)
#8644 - Update rollup to the latest version 🚀 (@openlayers)
#8631 - Update webpack to the latest version 🚀 (@openlayers)
#8630 - Update webpack to the latest version 🚀 (@openlayers)
#8617 - chore(package): update webpack to version 4.18.0 (@openlayers)
#8589 - Update rollup to the latest version 🚀 (@openlayers)
#8581 - Update rollup-plugin-node-resolve to the latest version 🚀 (@openlayers)
#8585 - Update rollup to the latest version 🚀 (@openlayers)
#8578 - Update webpack to the latest version 🚀 (@openlayers)
#8563 - Update rollup-plugin-uglify to the latest version 🚀 (@openlayers)
#8561 - Update rollup-plugin-uglify to the latest version 🚀 (@openlayers)

</details>

v5.3.0

v5.3.0

Upgrade Notes

The getUid function returns string

Attributions are not collapsible for ol/source/OSM

New Features and Fixes

The `getUid` function returns string

Attributions are not collapsible for `ol/source/OSM`