From d9bb3adbe850c1a80f39b56a356f3ba154082f88 Mon Sep 17 00:00:00 2001 From: Andreas Hocevar Date: Fri, 11 Dec 2015 10:08:13 +0100 Subject: [PATCH] Improve vector tile related docs --- config/jsdoc/api/index.md | 2 ++ externs/olx.js | 8 +++++--- 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/config/jsdoc/api/index.md b/config/jsdoc/api/index.md index 0d78a0e8c1..f2406a60c4 100644 --- a/config/jsdoc/api/index.md +++ b/config/jsdoc/api/index.md @@ -11,6 +11,7 @@ [ol.layer.Tile](ol.layer.Tile.html)
[ol.layer.Image](ol.layer.Image.html)
[ol.layer.Vector](ol.layer.Vector.html) +[ol.layer.VectorTile](ol.layer.VectorTile.html) ControlsInteractionsSources and formats @@ -27,6 +28,7 @@ Interactions for [vector features](ol.Feature.html) [Tile sources](ol.source.Tile.html) for [ol.layer.Tile](ol.layer.Tile.html)
[Image sources](ol.source.Image.html) for [ol.layer.Image](ol.layer.Image.html)
[Vector sources](ol.source.Vector.html) for [ol.layer.Vector](ol.layer.Vector.html) +
[Vector tile sources](ol.source.VectorTile.html) for [ol.layer.VectorTile](ol.layer.VectorTile.html)
[Formats](ol.format.Feature.html) for reading/writing vector data
[ol.format.WMSCapabilities](ol.format.WMSCapabilities.html) ProjectionsObservable objectsOther components diff --git a/externs/olx.js b/externs/olx.js index 1c99056954..cbb4a1de09 100644 --- a/externs/olx.js +++ b/externs/olx.js @@ -3688,9 +3688,11 @@ olx.layer.VectorTileOptions; /** - * The buffer around the viewport extent used by the renderer when getting - * features from the vector source for the rendering or hit-detection. - * Recommended value: the size of the largest symbol, line width or label. + * The buffer around the tile extent used by the renderer when getting features + * from the vector tile for the rendering or hit-detection. + * Recommended value: Vector tiles are usually generated with a buffer, so this + * value should match the largest possible buffer of the used tiles. It should + * be at least the size of the largest point symbol or line width. * Default is 100 pixels. * @type {number|undefined} * @api