Skip to content

Commit

Permalink
docs(ol-source-*): drop opaque option since it has been removed wit…
Browse files Browse the repository at this point in the history
…h OpenLayers 10

BREAKING-CHANGE: The `opaque` option was previously used to hint the renderer to perform some optimizations on layers known to be fully opaque.
This is no longer needed, and the option has been removed.
The option is no longer handled by `OlSourceOSM`, `OlSourceXYZ` and `OlSourceTianditu`.
It has been removed with [OpenLayers 10](https://github.com/openlayers/openlayers/releases/tag/v10.0.0)

see #239
  • Loading branch information
d-koppenhagen committed Aug 4, 2024
1 parent 44bee6b commit 8de0e3d
Show file tree
Hide file tree
Showing 6 changed files with 1 addition and 12 deletions.
7 changes: 1 addition & 6 deletions docs/componentsguide/sources/xyz/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,12 +46,7 @@ This deviating props are described in the section below.

### Deviating Properties

#### `opaque`

The value for `opaque` is currently set to `true` by default.
However, this behaviour will be aligned with the OpenLayers default of `false` in the future.

See related issue [XYZ source opacity problem #239](https://github.com/MelihAltintas/vue3-openlayers/issues/239).
none.

## Events

Expand Down
1 change: 0 additions & 1 deletion src/components/sources/OlSourceOSM.vue
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ const props = withDefaults(defineProps<Options>(), {
crossOrigin: "anonymous",
interpolate: true,
maxZoom: 19,
opaque: true,
reprojectionErrorThreshold: 0.5,
transition: 250,
url: "https://tile.openstreetmap.org/{z}/{x}/{y}.png",
Expand Down
1 change: 0 additions & 1 deletion src/components/sources/OlSourceOsm.vue
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ const props = withDefaults(defineProps<Options>(), {
crossOrigin: "anonymous",
interpolate: true,
maxZoom: 19,
opaque: true,
reprojectionErrorThreshold: 0.5,
transition: 250,
url: "https://tile.openstreetmap.org/{z}/{x}/{y}.png",
Expand Down
1 change: 0 additions & 1 deletion src/components/sources/OlSourceXYZ.vue
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ defineOptions({
const props = withDefaults(defineProps<Options>(), {
attributionsCollapsible: true,
interpolate: true,
opaque: true,
maxZoom: 42,
minZoom: 0,
projection: "EPSG:3857",
Expand Down
1 change: 0 additions & 1 deletion src/components/sources/OlSourceXyz.vue
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ defineOptions({
const props = withDefaults(defineProps<Options>(), {
attributionsCollapsible: true,
interpolate: true,
opaque: true,
maxZoom: 42,
minZoom: 0,
projection: "EPSG:3857",
Expand Down
2 changes: 0 additions & 2 deletions src/components/sources/TiandituClass.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ export type Options = WMTSOptions & {
tk?: string;
isLabel?: boolean;
maxZoom?: number;
opaque?: boolean;
};
export class Tianditu extends WMTSSource {
static layerLabelMap: Record<string, string> = {};
Expand Down Expand Up @@ -61,7 +60,6 @@ export class Tianditu extends WMTSSource {
style: options.style || "default",
cacheSize: options.cacheSize,
crossOrigin,
opaque: options.opaque === undefined ? true : options.opaque,
maxZoom: Tianditu.layerZoomMap[options.layerType],
reprojectionErrorThreshold: options.reprojectionErrorThreshold,
url: options.url,
Expand Down

0 comments on commit 8de0e3d

Please # to comment.