Skip to content

Latest commit

 

History

History
352 lines (228 loc) · 23.1 KB

CHANGELOG.md

File metadata and controls

352 lines (228 loc) · 23.1 KB

4.0.2 (2024-01-23)

Bug Fixes

4.0.1 (2023-12-18)

Bug Fixes

  • ol-image-layer: correctly access and provide layer (3e509db)
  • ol-webgl-tile-layer: pass correct defaults (994d1b0)

4.0.0 (2023-12-17)

Bug Fixes

  • ol-style-icon: allow to pass either scale or width/height property (0f3f889), closes #288

chore

  • update dependencies and peerDependency list (3e9b311)

Code Refactoring

  • OlSourceTianditu: rename OlSourceTianDiTu to OlSourceTianditu (71beec4), closes #281

BREAKING CHANGES

    • Drop support for Node.js Versions 16
  • requires a peer dependency of ol@^8.2.0
  • requires a peer dependency of ol-ext@^4.0.13
  • ol-style-icon: ol-style-icon: the property scale has no longer a default of 1. Please pass a value of one explicitly if needed. The change was needed since the underlying OpenLayers lib want's to either have a scale defined or width/height. Before it wasn't possible to define an icon by width/height since the scale was set by default.
  • OlSourceTianditu: - renamed OlSourceTianDiTu to OlSourceTianditu

3.2.1 (2023-12-17)

Bug Fixes

  • handle visibility and opacity changes (733fde8), closes #277

3.2.0 (2023-12-03)

Features

  • ol-style-text: fill and stroke properties for the text (#283) (111be7c)

3.1.0 (2023-11-08)

Bug Fixes

  • ol-source-vector-tile: listen to / pass correct events (abe37e9), closes #271

Features

  • ol-interaction-transform: relay events (350c4e3), closes #270

3.0.0 (2023-10-26)

Bug Fixes

  • add provided for external module for GeoTIFF and OverviewMap (ac39fb2)
  • ol-view: re-enable rotation (57c9a95)
  • demo: use scoped styles and cleanup unused styles (3d7fba4)

Code Refactoring

  • ol-overviewmap-control: adopt OpenLayers API and fix layers rendering (fd82d1a)
  • ol-webgl-tile-layer: adopt OpenLayers API and fix layers rendering (4d44b21)

Features

  • ol-vector-tile-layers: add support for renderMode property (116b576), closes #263
  • ol-source-geo-tiff: add new source for GeoTIFF (78dc2c6)
  • ol-animated-clusterlayer: emit all Cluster events (0867d4b)
  • ol-videorecorder-control: pass-through all props and events from ol-ext (fb99807)
  • ol-map: feat(ol-map) support all Map events from OpenLayers on component. Newly supported events are:
    • change:size
    • change:target
    • change:view
    • rendercomplete Please refer to the OpenLayers docs
  • ol-videorecorder-control: pass-through all props and events from ol-ext
    • if not downloadName is set, the file will not be downloaded but the stop event is fired with the blob data/url.
    • all events are now fired. In addition to the already existing start and stop event, you can now also react to the pause and resume event
    • docs has been updated

BREAKING CHANGES

  • ol-overlay all properties are now passed-trough from OpenLayers directly. Their types and default values can be checked-out in the official OpenLayers docs. Potentially this hasn't changed anything yet, but it can in the future, if OpenLayers changes it's API
  • ol-overlay all events are now fired at component level as defined in OpenLayers. Details:
    • elementChanged is now emitted as change:element
    • offsetChanged is now emitted as change:offset
    • positionChanged is now emitted as change:position
    • positioningChanged is now emitted as change:positioning
  • ol-view: property center's default value has been removed (it was set [0, 0]) before. Now all default values from OpenLayers are used directly
  • ol-view: All Events from OpenLayers are emitted as component events directly now. Please change:
    • resolutionChanged to change:resolution
    • rotationChanged to change:rotation
    • rotationChanged to change:rotation
    • centerChanged to change:center
    • zoomChanged event has been dropped. Please use change:center or change:resolution instead
  • ol-map: properties with default values are now aligned with all default values from OpenLayers

3.0.0-3 (2023-09-24)

Code Refactoring

  • ol-overviewmap-control: adopt OpenLayers API and fix layers rendering (fd82d1a)
  • ol-webgl-tile-layer: adopt OpenLayers API and fix layers rendering (4d44b21)

Features

  • ol-source-geo-tiff: add new source for GeoTIFF (78dc2c6)

BREAKING CHANGES

3.0.0-2 (2023-09-22)

Bug Fixes

  • ol-view: re-enable rotation (57c9a95)

3.0.0-1 (2023-09-20)

Features

  • ol-animated-clusterlayer: emit all Cluster events (0867d4b)

3.0.0-0 (2023-09-20)

Bug Fixes

  • demo: use scoped styles and cleanup unused styles (3d7fba4)

Features

  • ol-videorecorder-control: pass-through all props and events from ol-ext (fb99807)
  • ol-map: feat(ol-map) support all Map events from OpenLayers on component. Newly supported events are:
    • change:size
    • change:target
    • change:view
    • rendercomplete Please refer to the OpenLayers docs
  • ol-videorecorder-control: pass-through all props and events from ol-ext
    • if not downloadName is set, the file will not be downloaded but the stop event is fired with the blob data/url.
    • all events are now fired. In addition to the already existing start and stop event, you can now also react to the pause and resume event
    • docs has been updated

BREAKING CHANGES

  • ol-overlay all properties are now passed-trough from OpenLayers directly. Their types and default values can be checked-out in the official OpenLayers docs. Potentially this hasn't changed anything yet, but it can in the future, if OpenLayers changes it's API
  • ol-overlay all events are now fired at component level as defined in OpenLayers. Details:
    • elementChanged is now emitted as change:element
    • offsetChanged is now emitted as change:offset
    • positionChanged is now emitted as change:position
    • positioningChanged is now emitted as change:positioning
  • ol-view: property center's default value has been removed (it was set [0, 0]) before. Now all default values from OpenLayers are used directly
  • ol-view: All Events from OpenLayers are emitted as component events directly now. Please change:
    • resolutionChanged to change:resolution
    • rotationChanged to change:rotation
    • rotationChanged to change:rotation
    • centerChanged to change:center
    • zoomChanged event has been dropped. Please use change:center or change:resolution instead
  • ol-map: properties with default values are now aligned with all default values from OpenLayers

2.0.0 (2023-09-14)

Bug Fixes

  • allow multiple plugin installation (#247) (9a3b133)
  • allow using controls as childs of bar (#248) (8d59c76)
  • correctly remove controls onUnmounted (3756fbb), closes #246

chore

  • update dependency to openlayers 8.0.0 (a76dd57)

Code Refactoring

  • ol-source-stadia-maps: replace old ol-stamen component (ff9e373)
  • ol-style-icon: pass-through properties from OpenLayers (84232e9)
  • ol-webgl-points-layer: use new flat style format (02b8d1f)

BREAKING CHANGES

Features

  • ol-source-tile-debug: provide new component for TileDebug (b009f7b), closes #250

1.3.0 (2023-09-14)

Bug Fixes

Features

  • ol-source-tile-debug: provide new component for TileDebug (943cc29), closes #250

2.0.0-1 (2023-09-08)

Bug Fixes

  • correctly remove controls onUnmounted (3756fbb), closes #246

2.0.0-0 (2023-09-04)

chore

  • update dependency to openlayers 8.0.0 (a76dd57)

Code Refactoring

  • ol-source-stadia-maps: replace old ol-stamen component (ff9e373)
  • ol-style-icon: pass-through properties from OpenLayers (84232e9)
  • ol-webgl-points-layer: use new flat style format (02b8d1f)

BREAKING CHANGES

1.2.1 (2023-09-01)

Bug Fixes

  • remove exported non-existing function forEachLayerAtPixel (27da611)
  • remove incompatible props and exposed functions (81c6d00), closes #231

1.2.0 (2023-07-26)

Features

  • add ol-vector-tile-layer and ol-source-vector components (#229) (d7b4c0d), closes #228

1.1.0 (2023-07-25)

  • chore(maintenance): update dependencies (258e396)
  • docs(ol-map): add documentation for prop (b54312c)
  • fix(ol-feature): prevent unresponsive map lag (989bc90)
  • fix(ol-zone-control): define props with default values as optional (8275202)
  • docs(ol-interaction-snap): add demo case for draw interaction (e588a5f)
  • Update animatedclusterlayer, improve wording and fluency of explanation (#226) (3191963)
  • docs(ol-geolocation): display icon position correctly (6ae205b)
  • feat(ol-style-text): added backgroundFill and backgroundStroke props (#223) (6f521c9)

1.0.1 (2023-07-18)

  • chore: disable eslint for process access in version script (78455b0)
  • docs: add note for output.globals (c4c6d0f)
  • fix(build): update vite-plugin-dts and configure output.globals (#218) (fe739c4)
  • refactor(ol-view): use ViewOptions interface and remove unneeded composable (5d139eb)
  • refactor: remove unused useLayerControl (3ea0a99)
  • fix(ol-geolocation): prevent Extraneous non-emits event listeners warning (11c14f1)
  • docs: describe how to access ol/Map (5ab6231)
  • docs: updated contribution guidelines (0c38dc3)
  • docs: update getting started (65fed43)
  • chore: update ISSUE_TEMPLATE (a0cf678)
  • docs: update requirements automatically (cdbd12f)
  • docs: replace 'Openlayers' with 'OpenLayers' (bd59efc)

1.0.0 (2023-07-11)

Version 1.0.0 was completely refactored and aligned with the features and also BREAKING CHANGES from OpenLayers 7.x.x. Please be sure to checkout the Changelog of OpenLayers as well. Properties are mostly reflected 1:1 from OpenLayers as Component Properties for the related vue3-openlayers components. The same applies for the default values. Deviating properties with their values and description are listed in the documentation for each component.

Summary (compared to version 0.5.1)

  • 🛠️ migrated all components and features to TypeScript
  • 👩🏻‍🔧 migrated all components to use <script setup> syntax
  • 🗺️ aligned API with OpenLayers 7.4.0
  • 📘 updated & restructured the whole documentation
  • 🧩 added new components: ol-layer-group, ol-source-tile-json, ol-source-stadia-maps and ol-vector-image-layer
  • 🚀 expose all interactions to be able to call access them via ref in templates
  • 🐞 lot's of bug fixes
  • 📖 improved the documentation
  • ✨ better types for improved developer experience

Compability

Please be sure to install the following peerDependencies in your project:

"ol": "^7.4.0",
"ol-contextmenu": "^5.2.1",
"ol-ext": "^4.0.8"

Breaking Changes

general: dropped support for Openlayers 6 and below. Please use Openlayers 7.x.x

general: lot's of property types have been updated to match with the types in Openlayers. This may lead to TypeScript issues that must be fixed. Please have a look at all Changelog notes from the alpha and next releases before.

ol-geolocation: pass-through original events from Openlayers directly and remove legacy events The following events are not emitted anymore and replaced with the events from Openlayers. All new events receive a generic ObjectEvent. This means, changing only the event name in your templates isn't enough, you must adopt the implementations of the handler functions, so the will receive an ObjectEvent as first parameter.

  • positionChanged -> change:position
  • speedChanged -> change:speed
  • headingChanged -> change:heading
  • altitudeChanged -> change:altitude
  • altitudeAccuracyChanged -> change:altitudeAccuracy
  • accuracyGeometryChanged -> change:accuracyGeometry

Please refer to the official Openlayers docs for Geolocation for details of the emitted event data format.

Special Thanks 👏🏼

Special thanks goes to:

  • @MelihAltintas for creating this awesome project, making it open source and enable other maintainers (like @d-koppenhagen) to improve it
  • @mathiash98 for digging deep into the code and fixing tricky issues like #128 and #175
  • @209, for the time invested and the laborious migration of the code base (PR MelihAltintas#149 was the basis for all the related commits)
  • @lukas-zaugg and @pjreed for other important bug fixes and new features
  • all other people who were not mentioned here but who also contributed to version 1.0.0 with their questions and issues 🙌🏼