Skip to content
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.

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

add to each component the module it comes from #180

Merged
merged 2 commits into from
Jun 24, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 5 additions & 3 deletions docs/component/bingmaps-source.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,13 @@
`vl-source-bingmaps` adds ability to display tile data from Bing Maps. To use
this source you should get **API key** at https://www.bingmapsportal.com.

## Versions
## ES6 Module

`vl-source-bingmaps` is a part of **BingmapsSource** module:
```javascript
import { BingmapsSource } from 'vuelayers'

- **ES6**: https://unpkg.com/vuelayers/lib/bingmaps-source/
Vue.use(BingmapsSource)
```

## Usage

Expand Down
8 changes: 8 additions & 0 deletions docs/component/circle-geom.md
Original file line number Diff line number Diff line change
@@ -1 +1,9 @@
# vl-geom-circle

## ES6 Module

```javascript
import { CircleGeom } from 'vuelayers'

Vue.use(CircleGeom);
```
8 changes: 8 additions & 0 deletions docs/component/circle-style.md
Original file line number Diff line number Diff line change
@@ -1 +1,9 @@
# vl-style-circle

## ES6 Module

```javascript
import { CircleStyle } from 'vuelayers'

Vue.use(CircleStyle)
```
8 changes: 8 additions & 0 deletions docs/component/draw-interaction.md
Original file line number Diff line number Diff line change
@@ -1 +1,9 @@
# vl-interaction-draw

## ES6 Module

```javascript
import { DrawInteraction } from 'vuelayers'

Vue.use(DrawInteraction)
```
8 changes: 5 additions & 3 deletions docs/component/feature.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,13 @@ components, without geometry component nothing will be rendered.
Custom feature styles can be applied with [`vl-style-*`](/docs/component/circle-style.md)
components placed inside default slot.

## Versions
## ES6 Module

`vl-feature` component is a part of **Feature** module:
```javascript
import { Feature } from 'vuelayers'

- **ES6**: https://unpkg.com/vuelayers/lib/feature/
Vue.use(Feature)
```

## Usage

Expand Down
8 changes: 5 additions & 3 deletions docs/component/geoloc.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,13 @@
The [Geolocation API](https://www.w3.org/TR/geolocation-API/) is used to locate
a user's position. You can place it to the **default slot** of [`vl-map`](/docs/component/map.md) component.

## Versions
## ES6 Module

`vl-geoloc` is a part of **Geoloc** module:
```javascript
import { Geoloc } from 'vuelayers'

- **ES6**: https://unpkg.com/vuelayers/lib/geoloc/
Vue.use(Geoloc)
```

## Usage

Expand Down
8 changes: 5 additions & 3 deletions docs/component/image-layer.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,13 @@
`vl-layer-image` components can render any server-rendered image, it is a container for
raster source, like [`vl-source-image-static`](/docs/component/image-static-source.md).

## Versions
## ES6 Module

`vl-layer-image` component is a part of **ImageLayer** module:
```javascript
import { ImageLayer } from 'vuelayers'

- **ES6**: https://unpkg.com/vuelayers/lib/image-layer/
Vue.use(ImageLayer)
```

## Usage

Expand Down
8 changes: 7 additions & 1 deletion docs/component/image-static-source.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
# vl-image-static-source

// TODO
## ES6 Module

```javascript
import { ImageStaticSource } from 'vuelayers'

Vue.use(ImageStaticSource)
```
8 changes: 7 additions & 1 deletion docs/component/image-wms-source.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
# vl-image-wms-source

// TODO
## ES6 Module

```javascript
import { ImageWmsSource } from 'vuelayers'

Vue.use(ImageWmsSource)
```
8 changes: 8 additions & 0 deletions docs/component/line-string-geom.md
Original file line number Diff line number Diff line change
@@ -1 +1,9 @@
# vl-geom-line-string

## ES6 Module

```javascript
import { LineStringGeom } from 'vuelayers'

Vue.use(LineStringGeom)
```
8 changes: 5 additions & 3 deletions docs/component/map.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,13 @@ It is a main container for all other VueLayers components and has one `default`
slot to place them all. Usually you will use it together with [`vl-view`](/docs/component/view.md)
component to setup `zoom`, `center`, `projection` and other view related propeties for the map.

## Module system
## ES6 Module

`vl-map` component is a part of **Map** module:
```javascript
import { Map } from 'vuelayers'

- **ES6**: https://unpkg.com/vuelayers/lib/map/
Vue.use(Map)
```

## Usage

Expand Down
8 changes: 8 additions & 0 deletions docs/component/modify-interaction.md
Original file line number Diff line number Diff line change
@@ -1 +1,9 @@
# vl-interaction-modify

## ES6 Module

```javascript
import { ModifyInteraction } from 'vuelayers'

Vue.use(ModifyInteraction)
```
8 changes: 8 additions & 0 deletions docs/component/multi-line-string-geom.md
Original file line number Diff line number Diff line change
@@ -1 +1,9 @@
# vl-geom-multi-line-string

## ES6 Module

```javascript
import { MultiLineStringGeom } from 'vuelayers'

Vue.use(MultiLineStringGeom)
```
8 changes: 8 additions & 0 deletions docs/component/multi-point-geom.md
Original file line number Diff line number Diff line change
@@ -1 +1,9 @@
# vl-geom-multi-point

## ES6 Module

```javascript
import { MultiPointGeom } from 'vuelayers'

Vue.use(MultiPointGeom)
```
8 changes: 8 additions & 0 deletions docs/component/multi-polygon-geom.md
Original file line number Diff line number Diff line change
@@ -1 +1,9 @@
# vl-geom-multi-polygon

## ES6 Module

```javascript
import { MultiPolygonGeom } from 'vuelayers'

Vue.use(MultiPolygonGeom)
```
8 changes: 8 additions & 0 deletions docs/component/osm-source.md
Original file line number Diff line number Diff line change
@@ -1 +1,9 @@
# vl-source-osm

## ES6 Module

```javascript
import { OsmSource } from 'vuelayers'

Vue.use(OsmSource)
```
8 changes: 5 additions & 3 deletions docs/component/overlay.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,13 @@ the map. It has **default** scoped slot to render your custom content. You can
place it any component with slot inside the map components tree to easily bind
it to some coordinate (for example: inside `vl-feature` or `vl-view`).

## Versions
## ES6 Module

`vl-overlay` component is a part of **Overlay** module:
```javascript
import { Overlay } from 'vuelayers'

- **ES6**: https://unpkg.com/vuelayers/lib/overlay/
Vue.use(Overlay)
```

## Usage

Expand Down
8 changes: 8 additions & 0 deletions docs/component/point-geom.md
Original file line number Diff line number Diff line change
@@ -1 +1,9 @@
# vl-geom-point

## ES6 Module

```javascript
import { PointGeom } from 'vuelayers'

Vue.use(PointGeom)
```
8 changes: 8 additions & 0 deletions docs/component/polygon-geom.md
Original file line number Diff line number Diff line change
@@ -1 +1,9 @@
# vl-geom-polygon

## ES6 Module

```javascript
import { PolygonGeom } from 'vuelayers'

Vue.use(PolygonGeom)
```
8 changes: 8 additions & 0 deletions docs/component/select-interaction.md
Original file line number Diff line number Diff line change
@@ -1 +1,9 @@
# vl-interaction-select

## ES6 Module

```javascript
import { SelectInteraction } from 'vuelayers'

Vue.use(SelectInteraction)
```
8 changes: 8 additions & 0 deletions docs/component/snap-interaction.md
Original file line number Diff line number Diff line change
@@ -1 +1,9 @@
# vl-interaction-snap

## ES6 Module

```javascript
import { SnapInteraction } from 'vuelayers'

Vue.use(SnapInteraction)
```
8 changes: 8 additions & 0 deletions docs/component/sputnik-source.md
Original file line number Diff line number Diff line change
@@ -1 +1,9 @@
# vl-source-sputnik

## ES6 Module

```javascript
import { SputnikSource } from 'vuelayers'

Vue.use(SputnikSource)
```
8 changes: 8 additions & 0 deletions docs/component/style-box.md
Original file line number Diff line number Diff line change
@@ -1 +1,9 @@
# vl-style-box

## ES6 Module

```javascript
import { StyleBox } from 'vuelayers'

Vue.use(StyleBox)
```
8 changes: 5 additions & 3 deletions docs/component/tile-layer.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,13 @@
grids organized by zoom levels. It should be used together with tiled source components like
[`vl-source-xyz`](/docs/component/xyz-source.md), [`vl-source-wmts`](/docs/component/wmts-source.md), [`vl-source-osm`](/docs/component/osm-source.md).

## Versions
## ES6 Module

`vl-layer-tile` component is a part of **TileLayer** module:
```javascript
import { TileLayer } from 'vuelayers'

- **ES6**: https://unpkg.com/vuelayers/lib/tile-layer/
Vue.use(TileLayer)
```

## Usage

Expand Down
8 changes: 5 additions & 3 deletions docs/component/vector-layer.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,13 @@
`vl-layer-vector` can render vector from verious backend services. It should be
used with together with [`vl-source-vector`](/docs/component/vector-source.md) component.

## Versions
## ES6 Module

`vl-layer-vector` is a part of **VectorLayer** module:
```javascript
import { VectorLayer } from 'vuelayers'

- **ES6**: https://unpkg.com/vuelayers/lib/vector-layer/
Vue.use(VectorLayer)
```

## Usage

Expand Down
8 changes: 6 additions & 2 deletions docs/component/vector-source.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,13 @@
`vl-source-vector` can be used together with [`vl-layer-vector`](/docs/component/vector-layer.md) to
draw any vector data on the map.

# Versions
## ES6 Module

- **ES6**: https://unpkg.com/vuelayers/lib/vector-source/
```javascript
import { VectorSource } from 'vuelayers'

Vue.use(VectorSource)
```

## Usage

Expand Down
8 changes: 5 additions & 3 deletions docs/component/vector-tile-layer.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,13 @@
`vl-layer-vector-tile` can render tiled vector data in grids organized by zoom levels. It should be used together with
[`vl-source-vector-tile`](/docs/component/vector-tile-source.md) component.

## Versions
## ES6 Module

`vl-layer-vector-tile` component is a part of **VectorTileLayer** module:
```javascript
import { VectorTileLayer } from 'vuelayers'

- **ES6**: https://unpkg.com/vuelayers/lib/vector-tile-layer/
Vue.use(VectorTileLayer)
```

## Usage

Expand Down
8 changes: 8 additions & 0 deletions docs/component/vector-tile-source.md
Original file line number Diff line number Diff line change
@@ -1 +1,9 @@
# vl-source-vector-tile

## ES6 Module

```javascript
import { VectorTileSource } from 'vuelayers'

Vue.use(VectorTileSource)
```
9 changes: 6 additions & 3 deletions docs/component/view.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,14 @@
`vl-view` is the component to act upon to change the **center**, **resolution**
and **rotation** of the map.

## Versions
## ES6 Module

`vl-view` component is a part of **Map** module:
```javascript
// vl-view component comes with vl-map
import { Map } from 'vuelayers'

- **ES6**: https://unpkg.com/vuelayers/lib/map/
Vue.use(Map)
```

## Usage

Expand Down
8 changes: 8 additions & 0 deletions docs/component/wms-source.md
Original file line number Diff line number Diff line change
@@ -1 +1,9 @@
# vl-source-wms

## ES6 Module

```javascript
import { WmsSource } from 'vuelayers'

Vue.use(WmsSource)
```
8 changes: 8 additions & 0 deletions docs/component/wmts-source.md
Original file line number Diff line number Diff line change
@@ -1 +1,9 @@
# vl-source-wmts

## ES6 Module

```javascript
import { WmtsSource } from 'vuelayers'

Vue.use(WmtsSource)
```
8 changes: 8 additions & 0 deletions docs/component/xyz-source.md
Original file line number Diff line number Diff line change
@@ -1 +1,9 @@
# vl-source-xyz

## ES6 Module

```javascript
import { XyzSource } from 'vuelayers'

Vue.use(XyzSource)
```