Module type for ol.style.*

This commit is contained in:
Frederic Junod
2018-03-27 15:04:07 +02:00
parent 2de83adb8e
commit 7cbc22fece
24 changed files with 184 additions and 184 deletions

View File

@@ -2598,18 +2598,18 @@ olx.source.ZoomifyOptions.prototype.tileSize;
/**
* @typedef {{fill: (ol.style.Fill|undefined),
* @typedef {{fill: (module:ol/style/Fill~Fill|undefined),
* radius: number,
* snapToPixel: (boolean|undefined),
* stroke: (ol.style.Stroke|undefined),
* atlasManager: (ol.style.AtlasManager|undefined)}}
* stroke: (module:ol/style/Stroke~Stroke|undefined),
* atlasManager: (module:ol/style/AtlasManager~AtlasManager|undefined)}}
*/
olx.style.CircleOptions;
/**
* Fill style.
* @type {ol.style.Fill|undefined}
* @type {module:ol/style/Fill~Fill|undefined}
* @api
*/
olx.style.CircleOptions.prototype.fill;
@@ -2639,7 +2639,7 @@ olx.style.CircleOptions.prototype.snapToPixel;
/**
* Stroke style.
* @type {ol.style.Stroke|undefined}
* @type {module:ol/style/Stroke~Stroke|undefined}
* @api
*/
olx.style.CircleOptions.prototype.stroke;
@@ -2650,7 +2650,7 @@ olx.style.CircleOptions.prototype.stroke;
* recommended to use an atlas manager to avoid texture switching.
* If an atlas manager is given, the circle is added to an atlas.
* By default no atlas manager is used.
* @type {ol.style.AtlasManager|undefined}
* @type {module:ol/style/AtlasManager~AtlasManager|undefined}
*/
olx.style.CircleOptions.prototype.atlasManager;
@@ -2673,14 +2673,14 @@ olx.style.FillOptions.prototype.color;
/**
* @typedef {{anchor: (Array.<number>|undefined),
* anchorOrigin: (ol.style.IconOrigin|undefined),
* anchorXUnits: (ol.style.IconAnchorUnits|undefined),
* anchorYUnits: (ol.style.IconAnchorUnits|undefined),
* anchorOrigin: (module:ol/style/IconOrigin~IconOrigin|undefined),
* anchorXUnits: (module:ol/style/IconAnchorUnits~IconAnchorUnits|undefined),
* anchorYUnits: (module:ol/style/IconAnchorUnits~IconAnchorUnits|undefined),
* color: (ol.Color|string|undefined),
* crossOrigin: (null|string|undefined),
* img: (Image|HTMLCanvasElement|undefined),
* offset: (Array.<number>|undefined),
* offsetOrigin: (ol.style.IconOrigin|undefined),
* offsetOrigin: (module:ol/style/IconOrigin~IconOrigin|undefined),
* opacity: (number|undefined),
* scale: (number|undefined),
* snapToPixel: (boolean|undefined),
@@ -2704,7 +2704,7 @@ olx.style.IconOptions.prototype.anchor;
/**
* Origin of the anchor: `bottom-left`, `bottom-right`, `top-left` or
* `top-right`. Default is `top-left`.
* @type {ol.style.IconOrigin|undefined}
* @type {module:ol/style/IconOrigin~IconOrigin|undefined}
* @api
*/
olx.style.IconOptions.prototype.anchorOrigin;
@@ -2714,7 +2714,7 @@ olx.style.IconOptions.prototype.anchorOrigin;
* Units in which the anchor x value is specified. A value of `'fraction'`
* indicates the x value is a fraction of the icon. A value of `'pixels'`
* indicates the x value in pixels. Default is `'fraction'`.
* @type {ol.style.IconAnchorUnits|undefined}
* @type {module:ol/style/IconAnchorUnits~IconAnchorUnits|undefined}
* @api
*/
olx.style.IconOptions.prototype.anchorXUnits;
@@ -2724,7 +2724,7 @@ olx.style.IconOptions.prototype.anchorXUnits;
* Units in which the anchor y value is specified. A value of `'fraction'`
* indicates the y value is a fraction of the icon. A value of `'pixels'`
* indicates the y value in pixels. Default is `'fraction'`.
* @type {ol.style.IconAnchorUnits|undefined}
* @type {module:ol/style/IconAnchorUnits~IconAnchorUnits|undefined}
* @api
*/
olx.style.IconOptions.prototype.anchorYUnits;
@@ -2773,7 +2773,7 @@ olx.style.IconOptions.prototype.offset;
/**
* Origin of the offset: `bottom-left`, `bottom-right`, `top-left` or
* `top-right`. Default is `top-left`.
* @type {ol.style.IconOrigin|undefined}
* @type {module:ol/style/IconOrigin~IconOrigin|undefined}
* @api
*/
olx.style.IconOptions.prototype.offsetOrigin;
@@ -2854,24 +2854,24 @@ olx.style.IconOptions.prototype.src;
/**
* Specify radius for regular polygons, or radius1 and radius2 for stars.
* @typedef {{fill: (ol.style.Fill|undefined),
* @typedef {{fill: (module:ol/style/Fill~Fill|undefined),
* points: number,
* radius: (number|undefined),
* radius1: (number|undefined),
* radius2: (number|undefined),
* angle: (number|undefined),
* snapToPixel: (boolean|undefined),
* stroke: (ol.style.Stroke|undefined),
* stroke: (module:ol/style/Stroke~Stroke|undefined),
* rotation: (number|undefined),
* rotateWithView: (boolean|undefined),
* atlasManager: (ol.style.AtlasManager|undefined)}}
* atlasManager: (module:ol/style/AtlasManager~AtlasManager|undefined)}}
*/
olx.style.RegularShapeOptions;
/**
* Fill style.
* @type {ol.style.Fill|undefined}
* @type {module:ol/style/Fill~Fill|undefined}
* @api
*/
olx.style.RegularShapeOptions.prototype.fill;
@@ -2936,7 +2936,7 @@ olx.style.RegularShapeOptions.prototype.snapToPixel;
/**
* Stroke style.
* @type {ol.style.Stroke|undefined}
* @type {module:ol/style/Stroke~Stroke|undefined}
* @api
*/
olx.style.RegularShapeOptions.prototype.stroke;
@@ -2963,7 +2963,7 @@ olx.style.RegularShapeOptions.prototype.rotateWithView;
* recommended to use an atlas manager to avoid texture switching.
* If an atlas manager is given, the symbol is added to an atlas.
* By default no atlas manager is used.
* @type {ol.style.AtlasManager|undefined}
* @type {module:ol/style/AtlasManager~AtlasManager|undefined}
*/
olx.style.RegularShapeOptions.prototype.atlasManager;
@@ -3050,17 +3050,17 @@ olx.style.StrokeOptions.prototype.width;
* offsetX: (number|undefined),
* offsetY: (number|undefined),
* overflow: (boolean|undefined),
* placement: (ol.style.TextPlacement|string|undefined),
* placement: (module:ol/style/Text~TextPlacement|string|undefined),
* scale: (number|undefined),
* rotateWithView: (boolean|undefined),
* rotation: (number|undefined),
* text: (string|undefined),
* textAlign: (string|undefined),
* textBaseline: (string|undefined),
* fill: (ol.style.Fill|undefined),
* stroke: (ol.style.Stroke|undefined),
* backgroundFill: (ol.style.Fill|undefined),
* backgroundStroke: (ol.style.Stroke|undefined),
* fill: (module:ol/style/Fill~Fill|undefined),
* stroke: (module:ol/style/Stroke~Stroke|undefined),
* backgroundFill: (module:ol/style/Fill~Fill|undefined),
* backgroundStroke: (module:ol/style/Stroke~Stroke|undefined),
* padding: (Array.<number>|undefined)}}
*/
olx.style.TextOptions;
@@ -3116,7 +3116,7 @@ olx.style.TextOptions.prototype.overflow;
/**
* Text placement.
* @type {ol.style.TextPlacement|undefined}
* @type {module:ol/style/Text~TextPlacement|undefined}
* @api
*/
olx.style.TextOptions.prototype.placement;
@@ -3176,7 +3176,7 @@ olx.style.TextOptions.prototype.textBaseline;
/**
* Fill style. If none is provided, we'll use a dark fill-style (#333).
* @type {ol.style.Fill|undefined}
* @type {module:ol/style/Fill~Fill|undefined}
* @api
*/
olx.style.TextOptions.prototype.fill;
@@ -3184,7 +3184,7 @@ olx.style.TextOptions.prototype.fill;
/**
* Stroke style.
* @type {ol.style.Stroke|undefined}
* @type {module:ol/style/Stroke~Stroke|undefined}
* @api
*/
olx.style.TextOptions.prototype.stroke;
@@ -3193,7 +3193,7 @@ olx.style.TextOptions.prototype.stroke;
/**
* Fill style for the text background when `placement` is `'point'`. Default is
* no fill.
* @type {ol.style.Fill|undefined}
* @type {module:ol/style/Fill~Fill|undefined}
* @api
*/
olx.style.TextOptions.prototype.backgroundFill;
@@ -3202,7 +3202,7 @@ olx.style.TextOptions.prototype.backgroundFill;
/**
* Stroke style for the text background when `placement` is `'point'`. Default
* is no stroke.
* @type {ol.style.Stroke|undefined}
* @type {module:ol/style/Stroke~Stroke|undefined}
* @api
*/
olx.style.TextOptions.prototype.backgroundStroke;
@@ -3220,11 +3220,11 @@ olx.style.TextOptions.prototype.padding;
/**
* @typedef {{geometry: (undefined|string|module:ol/geom/Geometry~Geometry|ol.StyleGeometryFunction),
* fill: (ol.style.Fill|undefined),
* image: (ol.style.Image|undefined),
* fill: (module:ol/style/Fill~Fill|undefined),
* image: (module:ol/style/Image~ImageStyle|undefined),
* renderer: (ol.StyleRenderFunction|undefined),
* stroke: (ol.style.Stroke|undefined),
* text: (ol.style.Text|undefined),
* stroke: (module:ol/style/Stroke~Stroke|undefined),
* text: (module:ol/style/Text~Text|undefined),
* zIndex: (number|undefined)}}
*/
olx.style.StyleOptions;
@@ -3241,7 +3241,7 @@ olx.style.StyleOptions.prototype.geometry;
/**
* Fill style.
* @type {ol.style.Fill|undefined}
* @type {module:ol/style/Fill~Fill|undefined}
* @api
*/
olx.style.StyleOptions.prototype.fill;
@@ -3249,7 +3249,7 @@ olx.style.StyleOptions.prototype.fill;
/**
* Image style.
* @type {ol.style.Image|undefined}
* @type {module:ol/style/Image~ImageStyle|undefined}
* @api
*/
olx.style.StyleOptions.prototype.image;
@@ -3267,7 +3267,7 @@ olx.style.StyleOptions.prototype.renderer;
/**
* Stroke style.
* @type {ol.style.Stroke|undefined}
* @type {module:ol/style/Stroke~Stroke|undefined}
* @api
*/
olx.style.StyleOptions.prototype.stroke;
@@ -3275,7 +3275,7 @@ olx.style.StyleOptions.prototype.stroke;
/**
* Text style.
* @type {ol.style.Text|undefined}
* @type {module:ol/style/Text~Text|undefined}
* @api
*/
olx.style.StyleOptions.prototype.text;