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.

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

Jump to bottom

Categulario/style docs extended #227

Merged
merged 4 commits into from
Sep 12, 2019
Merged

Categulario/style docs extended #227

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
bdcbf8c
document circle and box styles
categulario Aug 2, 2019
6ddfc5b
document fill and stroke styles
categulario Aug 3, 2019
d4670be
document extParams on wms source
categulario Sep 6, 2019
d0f78e1
Merge branch 'master' into categulario/style-docs-extended
categulario Sep 6, 2019
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
110 changes: 110 additions & 0 deletions docs/component/circle-style.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,119 @@
# vl-style-circle

> Styles points as circles.

Use it inside [`vl-style-box`](/docs/component/style-box.md) to style points as circles.

## ES6 Module

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

Vue.use(CircleStyle)
```

## Usage

Styling a feature inside a vector layer.

<vuep template="#circle-style-feature"></vuep>

<script v-pre type="text/x-template" id="circle-style-feature">
<template>
<div>
<vl-map :load-tiles-while-animating="true" :load-tiles-while-interacting="true" data-projection="EPSG:4326" style="height: 400px">
<vl-view :zoom.sync="zoom" :center.sync="center" :rotation.sync="rotation"></vl-view>

<vl-layer-tile>
<vl-source-osm></vl-source-osm>
</vl-layer-tile>

<vl-layer-vector>
<vl-feature>
<vl-geom-point
:coordinates="[12.492442,41.890170]"
></vl-geom-point>

<vl-style-box>
<vl-style-circle :radius="20">
<vl-style-fill color="white"></vl-style-fill>
<vl-style-stroke color="red"></vl-style-stroke>
</vl-style-circle>
</vl-style-box>
</vl-feature>
</vl-layer-vector>
</vl-map>
</div>
</template>

<script>
export default {
data () {
return {
zoom: 15,
center: [12.492442,41.890170],
rotation: 0,
}
},
}
</script>
</script>

Styling the whole layer

<vuep template="#circle-style-layer"></vuep>

<script v-pre type="text/x-template" id="circle-style-layer">
<template>
<div>
<vl-map :load-tiles-while-animating="true" :load-tiles-while-interacting="true" data-projection="EPSG:4326" style="height: 400px">
<vl-view :zoom.sync="zoom" :center.sync="center" :rotation.sync="rotation"></vl-view>

<vl-layer-tile>
<vl-source-osm></vl-source-osm>
</vl-layer-tile>

<vl-layer-vector>
<vl-source-vector :features="points"></vl-source-vector>

<vl-style-box>
<vl-style-circle :radius="20">
<vl-style-fill color="white"></vl-style-fill>
<vl-style-stroke color="red"></vl-style-stroke>
</vl-style-circle>
</vl-style-box>
</vl-layer-vector>
</vl-map>
</div>
</template>

<script>
export default {
data () {
return {
zoom: 15,
center: [12.492442,41.890170],
rotation: 0,
points: [
{
type: 'Feature',
geometry: {
type: 'Point',
coordinates: [12.492442,41.890170],
},
properties: {},
}
],
}
},
}
</script>
</script>

## Properties

### radius

- **Type**: `number`

Radius in pixels of the circle.
166 changes: 166 additions & 0 deletions docs/component/fill-style.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,175 @@
# vl-style-fill

> Color the filling of a polygon or mulipolygon in a vector layer

Use it inside [`vl-style-box`](/docs/component/style-box.md) along with [`vl-style-stroke`](/docs/component/stroke-style.md) to style polygons and other shapes with area like circles.

## ES6 Module

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

Vue.use(FillStyle)
```

## Usage

Styling points like circles with filling.

<vuep template="#fill-style-feature"></vuep>

<script v-pre type="text/x-template" id="fill-style-feature">
<template>
<div>
<vl-map :load-tiles-while-animating="true" :load-tiles-while-interacting="true" data-projection="EPSG:4326" style="height: 400px">
<vl-view :zoom.sync="zoom" :center.sync="center" :rotation.sync="rotation"></vl-view>

<vl-layer-tile>
<vl-source-osm></vl-source-osm>
</vl-layer-tile>

<vl-layer-vector>
<vl-feature>
<vl-geom-point
:coordinates="[12.492442,41.890170]"
></vl-geom-point>

<vl-style-box>
<vl-style-circle :radius="20">
<vl-style-fill color="white"></vl-style-fill>
<vl-style-stroke color="red"></vl-style-stroke>
</vl-style-circle>
</vl-style-box>
</vl-feature>
</vl-layer-vector>
</vl-map>
</div>
</template>

<script>
export default {
data () {
return {
zoom: 15,
center: [12.492442,41.890170],
rotation: 0,
}
},
}
</script>
</script>

Styling all features with filling in a layer.

<vuep template="#fill-style-layer"></vuep>

<script v-pre type="text/x-template" id="fill-style-layer">
<template>
<div>
<vl-map :load-tiles-while-animating="true" :load-tiles-while-interacting="true" data-projection="EPSG:4326" style="height: 400px">
<vl-view :zoom.sync="zoom" :center.sync="center" :rotation.sync="rotation"></vl-view>

<vl-layer-tile>
<vl-source-osm></vl-source-osm>
</vl-layer-tile>

<vl-layer-vector>
<vl-source-vector :features="features"></vl-source-vector>

<vl-style-box>
<vl-style-fill color="white"></vl-style-fill>
<vl-style-stroke color="red"></vl-style-stroke>
</vl-style-box>
</vl-layer-vector>
</vl-map>
</div>
</template>

<script>
export default {
data () {
return {
zoom: 15,
center: [12.492442,41.890170],
rotation: 0,
features: [
{
"type": "Feature",
"properties": {},
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
12.483816146850586,
41.88866861985328
],
[
12.488279342651365,
41.886687809812926
],
[
12.489266395568846,
41.89032989704626
],
[
12.485275268554686,
41.89109662579462
],
[
12.483816146850586,
41.88866861985328
]
]
]
}
},
{
"type": "Feature",
"properties": {},
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
12.491540908813477,
41.89288562375104
],
[
12.492055892944336,
41.889307577732616
],
[
12.495832443237305,
41.8896909493925
],
[
12.495746612548828,
41.89282173182968
],
[
12.49445915222168,
41.8946745716015
],
[
12.491540908813477,
41.89288562375104
]
]
]
}
}
],
}
},
}
</script>
</script>

## Properties

### color

- **Type**: `string`, `array`

The color either in hexadecimal or as RGB array with red, green, and blue values between 0 and 255 and alpha between 0 and 1 inclusive.
Loading