Skip to content

Add LVideoOverlay #683

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 9 commits into
base: master
Choose a base branch
from
Open

Add LVideoOverlay #683

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
0558af3
Add LVideoOverlay
Jul 21, 2021
88d2737
Fix props
Jul 21, 2021
9af2158
Move url prop
Jul 21, 2021
ba85428
Merge branch 'move-url-prop' into video-overlay
Jul 21, 2021
50180d6
Update types
Jul 21, 2021
900d8ec
Update types
Jul 21, 2021
bbd6763
Merge branch 'move-url-prop' into video-overlay
Jul 21, 2021
af50a6e
Cleanup :lipstick:
Jul 21, 2021
581dafc
Merge branch 'move-url-prop' into video-overlay
Jul 21, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/components/LImageOverlay.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,6 @@ export default {
| visible | | boolean | - | true |
| interactive | | boolean | - | false |
| bubblingMouseEvents | | boolean | - | true |
| url | | string | - | |
| bounds | | | - | |
| opacity | | number | - | 1.0 |
| alt | | string | - | '' |
Expand All @@ -68,6 +67,7 @@ export default {
| zIndex | | number | - | 1 |
| className | | string | - | '' |
| options | Leaflet options to pass to the component constructor | object | - | {} |
| url | | string | - | null |

## Events

Expand Down
74 changes: 74 additions & 0 deletions docs/components/LVideoOverlay.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
---
title: LVideoOverlay
---

# LVideoOverlay

> Easily display a video overlay.

---

## Demo

::: demo
<template>
<l-map style="height: 350px" :zoom="zoom" :center="center">
<l-tile-layer :url="url"></l-tile-layer>
<l-video-overlay :video="video" :bounds="bounds"></l-video-overlay>
</l-map>
</template>

<script>
import {LMap, LVideoOverlay, LTileLayer} from 'vue2-leaflet';

export default {
components: {
LMap,
LVideoOverlay,
LTileLayer
},
data () {
return {
zoom: 4,
center: [25, -110],
url: 'https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png',
video: 'https://www.mapbox.com/bites/00188/patricia_nasa.webm',
bounds: [[ 32, -130], [ 13, -100]]
};
}
}
</script>

:::

## Props

| Prop name | Description | Type | Values | Default |
| ------------------- | ---------------------------------------------------- | ------------------------------- | ------ | ------------- |
| pane | | string | - | 'overlayPane' |
| attribution | | string | - | null |
| name | | string | - | undefined |
| layerType | | string | - | undefined |
| visible | | boolean | - | true |
| interactive | | boolean | - | false |
| bubblingMouseEvents | | boolean | - | true |
| bounds | | | - | |
| opacity | | number | - | 1.0 |
| alt | | string | - | '' |
| crossOrigin | | boolean | - | false |
| errorOverlayUrl | | string | - | '' |
| zIndex | | number | - | 1 |
| className | | string | - | '' |
| autoplay | | boolean | - | true |
| loop | | boolean | - | true |
| keepAspectRatio | | boolean | - | true |
| muted | | boolean | - | false |
| options | Leaflet options to pass to the component constructor | object | - | {} |
| video | | string\|array\|HTMLVideoElement | - | null |

## Events

| Event name | Type | Description |
| -------------- | ------- | -------------------------------------------------- |
| update:visible | boolean | Triggers when the visible prop needs to be updated |
| ready | object | Triggers when the component is ready |
7 changes: 7 additions & 0 deletions src/components/LImageOverlay.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,13 @@ import { imageOverlay, DomEvent } from 'leaflet';
export default {
name: 'LImageOverlay',
mixins: [ImageOverlayMixin, Options],
props: {
url: {
type: String,
custom: true,
default: null
}
},
mounted() {
const options = optionsMerger(this.imageOverlayOptions, this);
this.mapObject = imageOverlay(this.url, this.bounds, options);
Expand Down
72 changes: 72 additions & 0 deletions src/components/LVideoOverlay.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
<script>
import { optionsMerger, propsBinder, findRealParent } from '../utils/utils.js';
import VideoOverlayMixin from '../mixins/VideoOverlay.js';
import Options from '../mixins/Options.js';
import { videoOverlay, DomEvent } from 'leaflet';

/**
* Easily display a video overlay.
*/
export default {
name: 'LVideoOverlay',
mixins: [VideoOverlayMixin, Options],
props: {
video: {
type: [String, Array, HTMLVideoElement],
default: null
}
},
mounted() {
const options = optionsMerger(this.videoOverlayOptions, this);
this.mapObject = videoOverlay(this.video, this.bounds, options);
DomEvent.on(this.mapObject, this.$listeners);
propsBinder(this, this.mapObject, this.$options.props);
this.parentContainer = findRealParent(this.$parent);
this.parentContainer.addLayer(this, !this.visible);
this.$nextTick(() => {
/**
* Triggers when the component is ready
* @type {object}
* @property {object} mapObject - reference to leaflet map object
*/
this.$emit('ready', this.mapObject);
});
},
render() {
return null;
},
};
</script>

<docs>
## Demo
::: demo
<template>
<l-map style="height: 350px" :zoom="zoom" :center="center">
<l-tile-layer :url="url"></l-tile-layer>
<l-video-overlay :video="video" :bounds="bounds"></l-video-overlay>
</l-map>
</template>

<script>
import {LMap, LVideoOverlay, LTileLayer} from 'vue2-leaflet';

export default {
components: {
LMap,
LVideoOverlay,
LTileLayer
},
data () {
return {
zoom: 4,
center: [25, -110],
url: 'https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png',
video: 'https://www.mapbox.com/bites/00188/patricia_nasa.webm',
bounds: [[ 32, -130], [ 13, -100]]
};
}
}
</script>
:::
</docs>
1 change: 1 addition & 0 deletions src/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,5 @@ export { default as LPopup } from './components/LPopup';
export { default as LRectangle } from './components/LRectangle';
export { default as LTileLayer } from './components/LTileLayer';
export { default as LTooltip } from './components/LTooltip';
export { default as LVideoOverlay } from './components/LVideoOverlay';
export { default as LWMSTileLayer } from './components/LWMSTileLayer';
4 changes: 0 additions & 4 deletions src/mixins/ImageOverlay.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,6 @@ import InteractiveLayer from './InteractiveLayer';
export default {
mixins: [Layer, InteractiveLayer],
props: {
url: {
type: String,
custom: true
},
bounds: {
custom: true
},
Expand Down
40 changes: 40 additions & 0 deletions src/mixins/VideoOverlay.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
import ImageOverlay from './ImageOverlay.js';

export default {
mixins: [ImageOverlay],
props: {
autoplay: {
type: Boolean,
default: true
},
loop: {
type: Boolean,
default: true
},
keepAspectRatio: {
type: Boolean,
default: true
},
muted: {
type: Boolean,
default: false
}
},
mounted () {
this.videoOverlayOptions = {
...this.imageOverlayOptions,
autoplay: this.autoplay,
loop: this.loop,
keepAspectRatio: this.keepAspectRatio,
muted: this.muted
};
},
methods: {
getElement () {
return this.mapObject.getElement();
}
},
render () {
return null;
}
};
40 changes: 38 additions & 2 deletions types/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,12 +69,29 @@ declare module "vue2-leaflet" {
*/
zIndex: number;
}
class ImageOverlay extends Mixins(Layer, InteractiveLayer) {
class VideoOverlay extends Mixins(ImageOverlay) {
// props
url: string;
/**
* @default true
*/
autoplay: boolean;
/**
* @default true
*/
loop: boolean;
/**
* @default true
*/
keepAspectRatio: boolean;
/**
* @default false
*/
muted: boolean;
// methods
getElement(): HTMLVideoElement;
}
class ImageOverlay extends Mixins(Layer, InteractiveLayer) {
// props
bounds: boolean;
/**
* @default 1.0
Expand Down Expand Up @@ -488,7 +505,25 @@ declare module "vue2-leaflet" {
// methods
setImagePath(newVal: string, oldVal?: string): void;
}
class LVideoOverlay extends Mixins(VideoOverlay) {
// props
/**
* @default null
*/
video: string | Array<string> | HTMLVideoElement | null;

// data
mapObject: L.VideoOverlay;
parentContainer: any;
}
class LImageOverlay extends Mixins(ImageOverlay) {
// props
/**
* @default null
*/
url: string | null;

// data
mapObject: L.ImageOverlay;
parentContainer: any;
}
Expand Down Expand Up @@ -724,6 +759,7 @@ declare module "vue2-leaflet" {
LGridLayer,
LIcon,
LIconDefault,
LVideoOverlay,
LImageOverlay,
LLayerGroup,
LMap,
Expand Down