Merge pull request #930 from elemoine/externs

Use @exportSymbol instead of @exportClass|Function
This commit is contained in:
Éric Lemoine
2013-12-12 23:40:44 -08:00
128 changed files with 272 additions and 282 deletions

View File

@@ -30,7 +30,6 @@ function collectExports(source) {
var encoding = env.conf.encoding || 'utf8';
var fs = require('jsdoc/fs');
collectExports(fs.readFileSync('build/src/external/src/exports.js', encoding));
collectExports(fs.readFileSync('build/src/external/src/types.js', encoding));
exports.handlers = {

View File

@@ -220,7 +220,7 @@ class ObjectLiteral(Exportable):
return ''.join(lines)
def extern_name(self):
return re.sub(r'ol\.(\S+)', r'olx.\1Extern', self.name)
return re.sub(r'(olx\.\S+)', r'\1Extern', self.name)
def extern_namespace(self):
return '.'.join(self.extern_name().split('.')[:-1]) or None
@@ -398,6 +398,7 @@ def main(argv):
else:
sys.stdout.write('var %s;\n' % (namespace,))
for object_literal in object_literals:
sys.stdout.write(object_literal.typedef())
sys.stdout.write(object_literal.extern())
if options.typedef:

View File

@@ -91,8 +91,7 @@ EXPORTS = [path
EXTERNAL_SRC = [
'build/src/external/externs/types.js',
'build/src/external/src/exports.js',
'build/src/external/src/types.js']
'build/src/external/src/exports.js']
EXAMPLES = [path
for path in ifind('examples')
@@ -237,13 +236,6 @@ def build_src_external_src_exports_js(t):
'--exports', 'src/objectliterals.jsdoc', EXPORTS)
@target('build/src/external/src/types.js', 'bin/generate-exports.py',
'src/objectliterals.jsdoc')
def build_src_external_src_types_js(t):
t.output('%(PYTHON)s', 'bin/generate-exports.py',
'--typedef', 'src/objectliterals.jsdoc')
for glsl_src in GLSL_SRC:
def shader_src_helper(glsl_src):
@target(glsl_src.replace('.glsl', 'shader.js'), glsl_src,

View File

@@ -18,7 +18,6 @@
"inputs": [
"../build/src/internal/src/requireall.js",
"../build/src/internal/src/types.js",
"../build/src/external/src/exports.js"
]

View File

@@ -14,6 +14,7 @@
"externs": [
"//json.js",
"../build/src/external/externs/types.js",
"../externs/bingmaps.js",
"../externs/geojson.js",
"../externs/topojson.js",
@@ -27,7 +28,7 @@
"inputs": [
"../build/src/internal/src/requireall.js",
"../build/src/internal/src/types.js"
"../build/src/external/src/exports.js"
],
"mode": "SIMPLE",

View File

@@ -27,8 +27,7 @@
"inherits": "ol.json",
"inputs": [
"../build/src/internal/src/requireall.js",
"../build/src/internal/src/types.js"
"../build/src/internal/src/requireall.js"
],
"mode": "WHITESPACE",

View File

@@ -27,8 +27,7 @@
"inherits": "base.json",
"inputs": [
"../build/src/external/src/exports.js",
"../build/src/external/src/types.js"
"../build/src/external/src/exports.js"
],
"output-wrapper": "// OpenLayers 3. see http://ol3js.org/\n(function(){%output%})();",

View File

@@ -1,5 +1,5 @@
/**
* @typedef {Object} ol.AttributionOptions
* @typedef {Object} olx.AttributionOptions
* @property {string} html HTML markup for this attribution.
* @property {Object.<string, Array.<ol.TileRange>>|undefined} tileRanges
* Tile ranges (FOR INTERNAL USE ONLY).
@@ -7,13 +7,13 @@
*/
/**
* @typedef {Object} ol.DeviceOrientationOptions
* @typedef {Object} olx.DeviceOrientationOptions
* @property {boolean|undefined} tracking Start tracking. Default is `false`.
* @todo stability experimental
*/
/**
* @typedef {Object} ol.GeolocationOptions
* @typedef {Object} olx.GeolocationOptions
* @property {boolean|undefined} tracking Start Tracking. Default is `false`.
* @property {GeolocationPositionOptions|undefined} trackingOptions Tracking options.
* @property {ol.proj.ProjectionLike} projection Projection.
@@ -21,7 +21,7 @@
*/
/**
* @typedef {Object} ol.GetFeatureInfoOptions
* @typedef {Object} olx.GetFeatureInfoOptions
* @property {ol.Pixel} pixel Pixel coordinate relative to the map viewport.
* @property {Array.<ol.layer.Layer>|undefined} layers Layers to restrict the
* query to. All map layers will be queried if not provided.
@@ -37,7 +37,7 @@
*/
/**
* @typedef {Object} ol.GetFeaturesOptions
* @typedef {Object} olx.GetFeaturesOptions
* @property {ol.Pixel} pixel Pixel coordinate relative to the map viewport.
* @property {Array.<ol.layer.Layer>|undefined} layers Layers to restrict the
* query to. All layers will be queried if not provided.
@@ -54,7 +54,7 @@
/**
* Object literal with config options for the map.
* @typedef {Object} ol.MapOptions
* @typedef {Object} olx.MapOptions
* @property {ol.Collection|Array.<ol.control.Control>|undefined} controls
* Controls initially added to the map.
* @property {ol.Collection|Array.<ol.interaction.Interaction>|undefined} interactions
@@ -72,7 +72,7 @@
/**
* Object literal with config options for the overlay.
* @typedef {Object} ol.OverlayOptions
* @typedef {Object} olx.OverlayOptions
* @property {Element|undefined} element The overlay element.
* @property {ol.Coordinate|undefined} position The overlay position in map
* projection.
@@ -91,7 +91,7 @@
/**
* Object literal with config options for the Proj4js projection.
* @typedef {Object} ol.Proj4jsProjectionOptions
* @typedef {Object} olx.Proj4jsProjectionOptions
* @property {string} code The SRS identifier code, e.g. `EPSG:31256`.
* @property {ol.Extent|undefined} extent The validity extent for the SRS.
* @property {boolean|undefined} global Whether the projection is valid for the
@@ -101,7 +101,7 @@
/**
* Object literal with config options for the projection.
* @typedef {Object} ol.ProjectionOptions
* @typedef {Object} olx.ProjectionOptions
* @property {string} code The SRS identifier code, e.g. `EPSG:4326`.
* @property {ol.proj.Units} units Units.
* @property {ol.Extent|undefined} extent The validity extent for the SRS.
@@ -114,7 +114,7 @@
/**
* Object literal with config options for the view.
* @typedef {Object} ol.View2DOptions
* @typedef {Object} olx.View2DOptions
* @property {ol.Coordinate|undefined} center The initial center for the view.
* The coordinate system for the center is specified with the `projection`
* option. Default is `undefined`, and layer sources will not be fetched if
@@ -154,7 +154,7 @@
*/
/**
* @typedef {Object} ol.animation.BounceOptions
* @typedef {Object} olx.animation.BounceOptions
* @property {number} resolution The resolution to start the bounce from, typically `map.getView().getResolution()`.
* @property {number|undefined} start The start time of the animation. Default is immediately.
* @property {number|undefined} duration The duration of the animation in milliseconds. Default is `1000`.
@@ -163,7 +163,7 @@
*/
/**
* @typedef {Object} ol.animation.PanOptions
* @typedef {Object} olx.animation.PanOptions
* @property {ol.Coordinate} source The location to start panning from, typically `map.getView().getCenter()`.
* @property {number|undefined} start The start time of the animation. Default is immediately.
* @property {number|undefined} duration The duration of the animation in milliseconds. Default is `1000`.
@@ -172,7 +172,7 @@
*/
/**
* @typedef {Object} ol.animation.RotateOptions
* @typedef {Object} olx.animation.RotateOptions
* @property {number} rotation The rotation to apply, in radians.
* @property {number|undefined} start The start time of the animation. Default is immediately.
* @property {number|undefined} duration The duration of the animation in milliseconds. Default is `1000`.
@@ -181,7 +181,7 @@
*/
/**
* @typedef {Object} ol.animation.ZoomOptions
* @typedef {Object} olx.animation.ZoomOptions
* @property {number} resolution number The resolution to begin zooming from, typically `map.getView().getResolution()`.
* @property {number|undefined} start The start time of the animation. Default is immediately.
* @property {number|undefined} duration The duration of the animation in milliseconds. Default is `1000`.
@@ -190,33 +190,33 @@
*/
/**
* @typedef {Object} ol.control.AttributionOptions
* @typedef {Object} olx.control.AttributionOptions
* @property {string|undefined} className CSS class name. Default is `ol-attribution`.
* @property {Element|undefined} target Target.
* @todo stability experimental
*/
/**
* @typedef {Object} ol.control.ControlOptions
* @typedef {Object} olx.control.ControlOptions
* @property {Element|undefined} element Element.
* @property {Element|undefined} target Target.
* @todo stability experimental
*/
/**
* @typedef {Object} ol.control.DefaultsOptions
* @typedef {Object} olx.control.DefaultsOptions
* @property {boolean|undefined} attribution Attribution.
* @property {ol.control.AttributionOptions|undefined} attributionOptions
* @property {olx.control.AttributionOptions|undefined} attributionOptions
* Attribution options.
* @property {boolean|undefined} logo Logo.
* @property {ol.control.LogoOptions|undefined} logoOptions Logo options.
* @property {olx.control.LogoOptions|undefined} logoOptions Logo options.
* @property {boolean|undefined} zoom Zoom.
* @property {ol.control.ZoomOptions|undefined} zoomOptions Zoom options.
* @property {olx.control.ZoomOptions|undefined} zoomOptions Zoom options.
* @todo stability experimental
*/
/**
* @typedef {Object} ol.control.FullScreenOptions
* @typedef {Object} olx.control.FullScreenOptions
* @property {string|undefined} className CSS class name. Default is `ol-full-screen`.
* @property {boolean|undefined} keys Full keyboard access.
* @property {Element|undefined} target Target.
@@ -224,14 +224,14 @@
*/
/**
* @typedef {Object} ol.control.LogoOptions
* @typedef {Object} olx.control.LogoOptions
* @property {string|undefined} className CSS class name. Default is `ol-logo`.
* @property {Element|undefined} target Target.
* @todo stability experimental
*/
/**
* @typedef {Object} ol.control.MousePositionOptions
* @typedef {Object} olx.control.MousePositionOptions
* @property {string|undefined} className CSS class name. Default is `ol-mouse-position`.
* @property {ol.CoordinateFormatType|undefined} coordinateFormat Coordinate
* format.
@@ -243,7 +243,7 @@
*/
/**
* @typedef {Object} ol.control.ScaleLineOptions
* @typedef {Object} olx.control.ScaleLineOptions
* @property {string|undefined} className CSS Class name. Default is `ol-scale-line`.
* @property {number|undefined} minWidth Minimum width in pixels.
* @property {Element|undefined} target Target.
@@ -252,7 +252,7 @@
*/
/**
* @typedef {Object} ol.control.ZoomOptions
* @typedef {Object} olx.control.ZoomOptions
* @property {number|undefined} duration Animation duration in milliseconds. Default is `250`.
* @property {string|undefined} className CSS class name. Default is `ol-zoom`.
* @property {number|undefined} delta The zoom delta applied on each click.
@@ -261,7 +261,7 @@
*/
/**
* @typedef {Object} ol.control.ZoomSliderOptions
* @typedef {Object} olx.control.ZoomSliderOptions
* @property {string|undefined} className CSS class name.
* @property {number|undefined} maxResolution Maximum resolution.
* @property {number|undefined} minResolution Minimum resolution.
@@ -269,7 +269,7 @@
*/
/**
* @typedef {Object} ol.control.ZoomToExtentOptions
* @typedef {Object} olx.control.ZoomToExtentOptions
* @property {string|undefined} className Class name. Default is `ol-zoom-extent`.
* @property {Element|undefined} target Target.
* @property {ol.Extent|undefined} extent The extent to zoom to. If
@@ -278,7 +278,7 @@
*/
/**
* @typedef {Object} ol.interaction.DoubleClickZoomOptions
* @typedef {Object} olx.interaction.DoubleClickZoomOptions
* @property {number|undefined} duration Animation duration in milliseconds. Default is `250`.
* @property {number|undefined} delta The zoom delta applied on each double
* click, default is `1`.
@@ -286,7 +286,7 @@
*/
/**
* @typedef {Object} ol.interaction.DragPanOptions
* @typedef {Object} olx.interaction.DragPanOptions
* @property {ol.Kinetic|undefined} kinetic Kinetic inertia to apply to the pan.
* @property {ol.events.ConditionType|undefined} condition A conditional
* modifier (i.e. Shift key) that determines if the interaction is active
@@ -295,7 +295,7 @@
*/
/**
* @typedef {Object} ol.interaction.DragRotateOptions
* @typedef {Object} olx.interaction.DragRotateOptions
* @property {ol.events.ConditionType|undefined} condition A conditional
* modifier (i.e. Shift key) that determines if the interaction is active
* or not, default is both shift and alt keys.
@@ -303,7 +303,7 @@
*/
/**
* @typedef {Object} ol.interaction.DragRotateAndZoomOptions
* @typedef {Object} olx.interaction.DragRotateAndZoomOptions
* @property {ol.events.ConditionType|undefined} condition A conditional
* modifier (i.e. Shift key) that determines if the interaction is active
* or not, default is shify key.
@@ -311,7 +311,7 @@
*/
/**
* @typedef {Object} ol.interaction.DragZoomOptions
* @typedef {Object} olx.interaction.DragZoomOptions
* @property {ol.events.ConditionType|undefined} condition A conditional
* modifier (i.e. Shift key) that determines if the interaction is active
* or not, default is shift key.
@@ -320,7 +320,7 @@
/**
* Interactions for the map. Default is `true` for all options.
* @typedef {Object} ol.interaction.DefaultsOptions
* @typedef {Object} olx.interaction.DefaultsOptions
* @property {boolean|undefined} altShiftDragRotate Whether Alt-Shift-drag
* rotate is desired.
* @property {boolean|undefined} doubleClickZoom Whether double click zoom is
@@ -342,7 +342,7 @@
*/
/**
* @typedef {Object} ol.interaction.DrawOptions
* @typedef {Object} olx.interaction.DrawOptions
* @property {ol.layer.Vector} layer Destination layer for the features.
* @property {number|undefined} snapTolerance Pixel distance for snapping to the
* drawing finish (default is 12).
@@ -352,7 +352,7 @@
*/
/**
* @typedef {Object} ol.interaction.KeyboardPanOptions
* @typedef {Object} olx.interaction.KeyboardPanOptions
* @property {ol.events.ConditionType|undefined} condition A conditional
* modifier (i.e. Shift key) that determines if the interaction is active
* or not, default is no modifiers.
@@ -362,7 +362,7 @@
*/
/**
* @typedef {Object} ol.interaction.KeyboardZoomOptions
* @typedef {Object} olx.interaction.KeyboardZoomOptions
* @property {number|undefined} duration Animation duration in milliseconds. Default is `100`.
* @property {ol.events.ConditionType|undefined} condition A conditional
* modifier (i.e. Shift key) that determines if the interaction is active
@@ -372,13 +372,13 @@
*/
/**
* @typedef {Object} ol.interaction.MouseWheelZoomOptions
* @typedef {Object} olx.interaction.MouseWheelZoomOptions
* @property {number|undefined} duration Animation duration in milliseconds. Default is `250`.
* @todo stability experimental
*/
/**
* @typedef {Object} ol.interaction.ModifyOptions
* @typedef {Object} olx.interaction.ModifyOptions
* @property {undefined|Array.<ol.layer.Layer>|function(ol.layer.Layer):boolean} layers
* Layers or filter function to restrict modification to a subset of layers.
* @property {number|undefined} pixelTolerance Pixel tolerance for considering
@@ -386,7 +386,7 @@
*/
/**
* @typedef {Object} ol.interaction.SelectOptions
* @typedef {Object} olx.interaction.SelectOptions
* @property {ol.events.ConditionType|undefined} addCondition A conditional
* modifier (e.g. shift key) that determines if the selection is added to
* the current selection. By default, a shift-click adds to the current
@@ -401,27 +401,27 @@
*/
/**
* @typedef {Object} ol.interaction.TouchPanOptions
* @typedef {Object} olx.interaction.TouchPanOptions
* @property {ol.Kinetic|undefined} kinetic Kinetic inertia to apply to the
* pan.
* @todo stability experimental
*/
/**
* @typedef {Object} ol.interaction.TouchRotateOptions
* @typedef {Object} olx.interaction.TouchRotateOptions
* @property {number|undefined} threshold Minimal angle in radians to start a rotation.
* Default is `0.3`.
* @todo stability experimental
*/
/**
* @typedef {Object} ol.interaction.TouchZoomOptions
* @typedef {Object} olx.interaction.TouchZoomOptions
* @property {number|undefined} duration Animation duration in milliseconds. Default is `400`.
* @todo stability experimental
*/
/**
* @typedef {Object} ol.layer.BaseOptions
* @typedef {Object} olx.layer.BaseOptions
* @property {number|undefined} brightness Brightness. Default is `0`.
* @property {number|undefined} contrast Contrast. Default is `1`.
* @property {number|undefined} hue Hue. Default is `0`.
@@ -436,7 +436,7 @@
*/
/**
* @typedef {Object} ol.layer.LayerOptions
* @typedef {Object} olx.layer.LayerOptions
* @property {number|undefined} brightness Brightness. Default is `0`.
* @property {number|undefined} contrast Contrast. Default is `1`.
* @property {number|undefined} hue Hue. Default is `0`.
@@ -452,7 +452,7 @@
*/
/**
* @typedef {Object} ol.layer.GroupOptions
* @typedef {Object} olx.layer.GroupOptions
* @property {number|undefined} brightness Brightness. Default is `0`.
* @property {number|undefined} contrast Contrast. Default is `1`.
* @property {number|undefined} hue Hue. Default is `0`.
@@ -468,7 +468,7 @@
*/
/**
* @typedef {Object} ol.layer.TileOptions
* @typedef {Object} olx.layer.TileOptions
* @property {number|undefined} brightness Brightness. Default is `0`.
* @property {number|undefined} contrast Contrast. Default is `1`.
* @property {number|undefined} hue Hue. Default is `0`.
@@ -485,7 +485,7 @@
*/
/**
* @typedef {Object} ol.layer.VectorLayerOptions
* @typedef {Object} olx.layer.VectorLayerOptions
* @property {function(Array.<ol.Feature>):string|undefined} transformFeatureInfo
* Function to render an array of
* features into feature info markup. If not provided, a comma separated
@@ -502,7 +502,7 @@
*/
/**
* @typedef {Object} ol.parser.KMLOptions
* @typedef {Object} olx.parser.KMLOptions
* @property {boolean|undefined} extractAttributes Should we extract attributes
* from the KML? Default is `true`.
* @property {boolean|undefined} extractStyles Should we extract styles from the
@@ -515,20 +515,20 @@
*/
/**
* @typedef {Object} ol.parser.GMLReadOptions
* @typedef {Object} olx.parser.GMLReadOptions
* @property {string|undefined} axisOrientation The axis orientation.
* @todo stability experimental
*/
/**
* @typedef {Object} ol.parser.GMLWriteOptions
* @typedef {Object} olx.parser.GMLWriteOptions
* @property {ol.proj.ProjectionLike} srsName The srsName to use when writing.
* @property {string|undefined} axisOrientation The axis orientation.
* @todo stability experimental
*/
/**
* @typedef {Object} ol.parser.GMLOptions
* @typedef {Object} olx.parser.GMLOptions
* @property {boolean|undefined} curve Write gml:Curve instead of
* gml:LineString elements. This also affects the elements in multi-part
* geometries. Default is `false`. This only applies to GML version 3.
@@ -549,15 +549,15 @@
* @property {boolean|undefined} surface Write gml:Surface instead of
* gml:Polygon elements. This also affects the elements in multi-part
* geometries. Default is `false`. This only applies to GML version 3.
* @property {ol.parser.GMLReadOptions|undefined} readOptions readOptions to
* @property {olx.parser.GMLReadOptions|undefined} readOptions readOptions to
* use for this instance.
* @property {ol.parser.GMLWriteOptions|undefined} writeOptions writeOptions
* @property {olx.parser.GMLWriteOptions|undefined} writeOptions writeOptions
* to use for this instance.
* @todo stability experimental
*/
/**
* @typedef {Object} ol.parser.GPXOptions
* @typedef {Object} olx.parser.GPXOptions
* @property {string|undefined} creator The creator attribute to be added to
* the written GPX files. Defaults to `OpenLayers`.
* @property {string|undefined} defaultDesc Default description for the
@@ -575,7 +575,7 @@
*/
/**
* @typedef {Object} ol.parser.GPXWriteOptions
* @typedef {Object} olx.parser.GPXWriteOptions
* @property {Array.<ol.Feature>|ol.Feature} features The features to write
* out.
* @property {Object|undefined} metadata Metadata key/value pair with keys:
@@ -584,19 +584,19 @@
*/
/**
* @typedef {Object} ol.parser.SLDReadOptions
* @typedef {Object} olx.parser.SLDReadOptions
* @property {ol.proj.Units} units The units to use in scale to resolution
* calculations.
*/
/**
* @typedef {Object} ol.parser.SLDWriteOptions
* @typedef {Object} olx.parser.SLDWriteOptions
* @property {ol.proj.Units} units The units to use in resolution to scale
* calculations.
*/
/**
* @typedef {Object} ol.parser.WFSWriteGetFeatureOptions
* @typedef {Object} olx.parser.WFSWriteGetFeatureOptions
* @property {string} featureNS The namespace URI used for features.
* @property {string} featurePrefix The prefix for the feature namespace.
* @property {Array.<string>} featureTypes The feature type names.
@@ -609,7 +609,7 @@
*/
/**
* @typedef {Object} ol.parser.WFSWriteTransactionOptions
* @typedef {Object} olx.parser.WFSWriteTransactionOptions
* @property {string} featureNS The namespace URI used for features.
* @property {string} featurePrefix The prefix for the feature namespace.
* @property {string} featureType The feature type name.
@@ -621,7 +621,7 @@
*/
/**
* @typedef {Object} ol.source.BingMapsOptions
* @typedef {Object} olx.source.BingMapsOptions
* @property {string|undefined} culture Culture code. Default is `en-us`.
* @property {string} key Bing Maps API key. Get yours at
* http://bingmapsportal.com/.
@@ -632,7 +632,7 @@
*/
/**
* @typedef {Object} ol.source.MapGuideOptions
* @typedef {Object} olx.source.MapGuideOptions
* @property {string|undefined} url The mapagent url.
* @property {number|undefined} metersPerUnit The meters-per-unit value.
* @property {ol.Extent|undefined} extent Extent..
@@ -648,14 +648,14 @@
*/
/**
* @typedef {Object} ol.source.MapQuestOptions
* @typedef {Object} olx.source.MapQuestOptions
* @property {ol.TileLoadFunctionType|undefined} tileLoadFunction Optional
* function to load a tile given a URL.
* @todo stability experimental
*/
/**
* @typedef {Object} ol.source.TileDebugOptions
* @typedef {Object} olx.source.TileDebugOptions
* @property {ol.Extent|undefined} extent Extent.
* @property {ol.proj.ProjectionLike} projection Projection.
* @property {ol.tilegrid.TileGrid|undefined} tileGrid Tile grid.
@@ -663,7 +663,7 @@
*/
/**
* @typedef {Object} ol.source.OSMOptions
* @typedef {Object} olx.source.OSMOptions
* @property {Array.<ol.Attribution>|undefined} attributions Attributions.
* @property {number|undefined} maxZoom Max zoom.
* @property {ol.TileLoadFunctionType|undefined} tileLoadFunction Optional
@@ -675,12 +675,12 @@
*/
/**
* @typedef {Object} ol.source.ImageWMSOptions
* @typedef {Object} olx.source.ImageWMSOptions
* @property {Array.<ol.Attribution>|undefined} attributions Attributions.
* @property {null|string|undefined} crossOrigin crossOrigin setting for image
* requests.
* @property {ol.Extent|undefined} extent Extent.
* @property {ol.source.WMSGetFeatureInfoOptions|undefined} getFeatureInfoOptions
* @property {olx.source.WMSGetFeatureInfoOptions|undefined} getFeatureInfoOptions
* Options for GetFeatureInfo.
* @property {Object.<string,*>} params WMS request parameters. At least a
* `LAYERS` param is required. `STYLES` is `` by default. `VERSION` is
@@ -697,7 +697,7 @@
*/
/**
* @typedef {Object} ol.source.StamenOptions
* @typedef {Object} olx.source.StamenOptions
* @property {string} layer Layer.
* @property {number|undefined} minZoom Minimum zoom.
* @property {number|undefined} maxZoom Maximum zoom.
@@ -710,7 +710,7 @@
*/
/**
* @typedef {Object} ol.source.ImageStaticOptions
* @typedef {Object} olx.source.ImageStaticOptions
* @property {Array.<ol.Attribution>|undefined} attributions Attributions.
* @property {null|string|undefined} crossOrigin crossOrigin setting for image
* requests.
@@ -723,7 +723,7 @@
*/
/**
* @typedef {Object} ol.source.TileJSONOptions
* @typedef {Object} olx.source.TileJSONOptions
* @property {null|string|undefined} crossOrigin crossOrigin setting for image
* requests.
* @property {ol.TileLoadFunctionType|undefined} tileLoadFunction Optional
@@ -733,7 +733,7 @@
*/
/**
* @typedef {Object} ol.source.TileWMSOptions
* @typedef {Object} olx.source.TileWMSOptions
* @property {Array.<ol.Attribution>|undefined} attributions Attributions.
* @property {Object.<string,*>} params WMS request parameters. At least a
* `LAYERS` param is required. `STYLES` is `` by default. `VERSION` is
@@ -742,7 +742,7 @@
* @property {null|string|undefined} crossOrigin crossOrigin setting for image
* requests.
* @property {ol.Extent|undefined} extent Extent.
* @property {ol.source.WMSGetFeatureInfoOptions|undefined} getFeatureInfoOptions
* @property {olx.source.WMSGetFeatureInfoOptions|undefined} getFeatureInfoOptions
* Options for GetFeatureInfo.
* @property {string|undefined} logo Logo.
* @property {ol.tilegrid.TileGrid|undefined} tileGrid Tile grid.
@@ -757,7 +757,7 @@
*/
/**
* @typedef {Object} ol.source.VectorOptions
* @typedef {Object} olx.source.VectorOptions
* @property {Array.<ol.Attribution>|undefined} attributions Attributions.
* @property {Array.<ol.Feature>|undefined} features Any features to be added
* to the source. Providing features is an alternative to providing
@@ -776,7 +776,13 @@
*/
/**
* @typedef {Object} ol.source.WMTSOptions
* @typedef {Object} olx.source.WMSGetFeatureInfoOptions
* @property {ol.source.WMSGetFeatureInfoMethod|undefined} method Method.
* @property {Object.<string,string>|undefined} params Params.
*/
/**
* @typedef {Object} olx.source.WMTSOptions
* @property {Array.<ol.Attribution>|undefined} attributions Attributions.
* @property {string|null|undefined} crossOrigin crossOrigin setting for image
* requests.
@@ -801,7 +807,7 @@
*/
/**
* @typedef {Object} ol.source.XYZOptions
* @typedef {Object} olx.source.XYZOptions
* @property {Array.<ol.Attribution>|undefined} attributions Attributions.
* @property {null|string|undefined} crossOrigin Cross origin setting for image
* requests.
@@ -822,7 +828,7 @@
*/
/**
* @typedef {Object} ol.style.IconOptions
* @typedef {Object} olx.style.IconOptions
* @property {string|ol.expr.Expression} url Icon image URL.
* @property {number|ol.expr.Expression|undefined} width Width of the icon
* in pixels. Default is the width of the icon image.
@@ -841,7 +847,7 @@
*/
/**
* @typedef {Object} ol.style.FillOptions
* @typedef {Object} olx.style.FillOptions
* @property {string|ol.expr.Expression|undefined} color Fill color as hex color
* code.
* @property {number|ol.expr.Expression|undefined} opacity Opacity (0, 1). Default is `1`.
@@ -850,7 +856,7 @@
*/
/**
* @typedef {Object} ol.style.RuleOptions
* @typedef {Object} olx.style.RuleOptions
* @property {ol.expr.Expression|string|undefined} filter Filter.
* @property {number|undefined} maxResolution Optional maximum resolution. If
* a value is provided, the rule will apply at resolutions less than
@@ -865,7 +871,7 @@
*/
/**
* @typedef {Object} ol.style.ShapeOptions
* @typedef {Object} olx.style.ShapeOptions
* @property {ol.style.ShapeType|undefined} type Type.
* @property {number|ol.expr.Expression|undefined} size Size in pixels.
* @property {ol.style.Fill|undefined} fill Fill symbolizer for shape.
@@ -875,7 +881,7 @@
*/
/**
* @typedef {Object} ol.style.StrokeOptions
* @typedef {Object} olx.style.StrokeOptions
* @property {string|ol.expr.Expression|undefined} color Stroke color as hex
* color code.
* @property {number|ol.expr.Expression|undefined} opacity Stroke opacity (0, 1). Default is `1`.
@@ -885,7 +891,7 @@
*/
/**
* @typedef {Object} ol.style.StyleOptions
* @typedef {Object} olx.style.StyleOptions
* @property {Array.<ol.style.Rule>|undefined} rules Rules.
* @property {Array.<ol.style.Symbolizer>|undefined} symbolizers Symbolizers
* (that apply if no rules are provided or where none of the provided rules
@@ -896,7 +902,7 @@
*/
/**
* @typedef {Object} ol.style.TextOptions
* @typedef {Object} olx.style.TextOptions
* @property {string|ol.expr.Expression|undefined} color Color.
* @property {string|ol.expr.Expression|undefined} fontFamily Font family.
* @property {number|ol.expr.Expression|undefined} fontSize Font size in pixels.
@@ -909,7 +915,7 @@
*/
/**
* @typedef {Object} ol.tilegrid.TileGridOptions
* @typedef {Object} olx.tilegrid.TileGridOptions
* @property {number|undefined} minZoom Minimum zoom.
* @property {ol.Coordinate|undefined} origin Origin.
* @property {Array.<ol.Coordinate>|undefined} origins Origins.
@@ -920,7 +926,7 @@
*/
/**
* @typedef {Object} ol.tilegrid.WMTSOptions
* @typedef {Object} olx.tilegrid.WMTSOptions
* @property {ol.Coordinate|undefined} origin Origin.
* @property {Array.<ol.Coordinate>|undefined} origins Origins.
* @property {!Array.<number>} resolutions Resolutions.
@@ -931,7 +937,7 @@
*/
/**
* @typedef {Object} ol.tilegrid.XYZOptions
* @typedef {Object} olx.tilegrid.XYZOptions
* @property {number} maxZoom Maximum zoom.
* @todo stability experimental
*/

View File

@@ -1,4 +1,4 @@
@exportFunction ol.animation.bounce ol.animation.BounceOptions ol.PreRenderFunction
@exportFunction ol.animation.pan ol.animation.PanOptions ol.PreRenderFunction
@exportFunction ol.animation.rotate ol.animation.RotateOptions ol.PreRenderFunction
@exportFunction ol.animation.zoom ol.animation.ZoomOptions ol.PreRenderFunction
@exportSymbol ol.animation.bounce ol.animation.bounce
@exportSymbol ol.animation.pan ol.animation.pan
@exportSymbol ol.animation.rotate ol.animation.rotate
@exportSymbol ol.animation.zoom ol.animation.zoom

View File

@@ -8,7 +8,7 @@ goog.require('ol.easing');
/**
* @param {ol.animation.BounceOptions} options Bounce options.
* @param {olx.animation.BounceOptions} options Bounce options.
* @return {ol.PreRenderFunction} Pre-render function.
* @todo stability experimental
*/
@@ -43,7 +43,7 @@ ol.animation.bounce = function(options) {
/**
* @param {ol.animation.PanOptions} options Pan options.
* @param {olx.animation.PanOptions} options Pan options.
* @return {ol.PreRenderFunction} Pre-render function.
* @todo stability experimental
*/
@@ -82,7 +82,7 @@ ol.animation.pan = function(options) {
/**
* @param {ol.animation.RotateOptions} options Rotate options.
* @param {olx.animation.RotateOptions} options Rotate options.
* @return {ol.PreRenderFunction} Pre-render function.
* @todo stability experimental
*/
@@ -119,7 +119,7 @@ ol.animation.rotate = function(options) {
/**
* @param {ol.animation.ZoomOptions} options Zoom options.
* @param {olx.animation.ZoomOptions} options Zoom options.
* @return {ol.PreRenderFunction} Pre-render function.
* @todo stability experimental
*/

View File

@@ -1 +1 @@
@exportClass ol.Attribution ol.AttributionOptions
@exportSymbol ol.Attribution

View File

@@ -20,7 +20,7 @@ goog.require('ol.TileRange');
* ..
*
* @constructor
* @param {ol.AttributionOptions} options Attribution options.
* @param {olx.AttributionOptions} options Attribution options.
* @todo stability experimental
*/
ol.Attribution = function(options) {

View File

@@ -1,2 +1,2 @@
@exportClass ol.control.Attribution ol.control.AttributionOptions
@exportSymbol ol.control.Attribution
@exportProperty ol.control.Attribution.prototype.setMap

View File

@@ -21,7 +21,7 @@ goog.require('ol.css');
* be changed by using a css selector for `.ol-attribution`.
* @constructor
* @extends {ol.control.Control}
* @param {ol.control.AttributionOptions=} opt_options Attribution options.
* @param {olx.control.AttributionOptions=} opt_options Attribution options.
* @todo stability experimental
*/
ol.control.Attribution = function(opt_options) {

View File

@@ -1,3 +1,3 @@
@exportClass ol.control.Control ol.control.ControlOptions
@exportSymbol ol.control.Control
@exportProperty ol.control.Control.prototype.getMap
@exportProperty ol.control.Control.prototype.setMap

View File

@@ -15,7 +15,7 @@ goog.require('ol.Object');
* @constructor
* @extends {ol.Object}
* @implements {oli.control.Control}
* @param {ol.control.ControlOptions} options Control options.
* @param {olx.control.ControlOptions} options Control options.
* @todo stability experimental
*/
ol.control.Control = function(options) {

View File

@@ -1 +1 @@
@exportFunction ol.control.defaults ol.control.DefaultsOptions ol.Collection
@exportSymbol ol.control.defaults ol.control.defaults

View File

@@ -7,7 +7,7 @@ goog.require('ol.control.Zoom');
/**
* @param {ol.control.DefaultsOptions=} opt_options Defaults options.
* @param {olx.control.DefaultsOptions=} opt_options Defaults options.
* @return {ol.Collection} Controls.
* @todo stability experimental
*/

View File

@@ -1 +1 @@
@exportClass ol.control.FullScreen ol.control.FullScreenOptions
@exportSymbol ol.control.FullScreen

View File

@@ -22,7 +22,7 @@ goog.require('ol.css');
*
* @constructor
* @extends {ol.control.Control}
* @param {ol.control.FullScreenOptions=} opt_options Options.
* @param {olx.control.FullScreenOptions=} opt_options Options.
* @todo stability experimental
*/
ol.control.FullScreen = function(opt_options) {

View File

@@ -1,2 +1,2 @@
@exportClass ol.control.Logo ol.control.LogoOptions
@exportSymbol ol.control.Logo
@exportProperty ol.control.Logo.prototype.setMap

View File

@@ -17,7 +17,7 @@ goog.require('ol.css');
* be styled by using a css selector for `.ol-logo`.
* @constructor
* @extends {ol.control.Control}
* @param {ol.control.LogoOptions=} opt_options Logo options.
* @param {olx.control.LogoOptions=} opt_options Logo options.
* @todo stability experimental
*/
ol.control.Logo = function(opt_options) {

View File

@@ -1,2 +1,2 @@
@exportClass ol.control.MousePosition ol.control.MousePositionOptions
@exportSymbol ol.control.MousePosition
@exportProperty ol.control.MousePosition.prototype.setMap

View File

@@ -36,7 +36,8 @@ ol.control.MousePositionProperty = {
*
* @constructor
* @extends {ol.control.Control}
* @param {ol.control.MousePositionOptions=} opt_options Mouse position options.
* @param {olx.control.MousePositionOptions=} opt_options Mouse position
* options.
* @todo stability experimental
* @todo observable projection {ol.proj.Projection} the projection to report
* mouse position in

View File

@@ -1,4 +1,4 @@
@exportClass ol.control.ScaleLine ol.control.ScaleLineOptions
@exportSymbol ol.control.ScaleLine
@exportProperty ol.control.ScaleLine.prototype.setMap
@exportSymbol ol.control.ScaleLineUnits

View File

@@ -49,7 +49,7 @@ ol.control.ScaleLineUnits = {
*
* @constructor
* @extends {ol.control.Control}
* @param {ol.control.ScaleLineOptions=} opt_options Scale line options.
* @param {olx.control.ScaleLineOptions=} opt_options Scale line options.
* @todo stability experimental
* @todo observable units {ol.control.ScaleLineUnits} the units to use in the
* scale line

View File

@@ -1,2 +1,2 @@
@exportClass ol.control.Zoom ol.control.ZoomOptions
@exportSymbol ol.control.Zoom
@exportProperty ol.control.Zoom.prototype.setMap

View File

@@ -19,7 +19,7 @@ goog.require('ol.easing');
* use css selectors `.ol-zoom-in` and `.ol-zoom-out`.
* @constructor
* @extends {ol.control.Control}
* @param {ol.control.ZoomOptions=} opt_options Zoom options.
* @param {olx.control.ZoomOptions=} opt_options Zoom options.
* @todo stability experimental
*/
ol.control.Zoom = function(opt_options) {

View File

@@ -1 +1 @@
@exportClass ol.control.ZoomSlider ol.control.ZoomSliderOptions
@exportSymbol ol.control.ZoomSlider

View File

@@ -37,7 +37,7 @@ ol.control.ZOOMSLIDER_ANIMATION_DURATION = 200;
*
* @constructor
* @extends {ol.control.Control}
* @param {ol.control.ZoomSliderOptions=} opt_options Zoom slider options.
* @param {olx.control.ZoomSliderOptions=} opt_options Zoom slider options.
* @todo stability experimental
*/
ol.control.ZoomSlider = function(opt_options) {

View File

@@ -1 +1 @@
@exportClass ol.control.ZoomToExtent ol.control.ZoomToExtentOptions
@exportSymbol ol.control.ZoomToExtent

View File

@@ -17,7 +17,7 @@ goog.require('ol.css');
* css selector `.ol-zoom-extent`.
* @constructor
* @extends {ol.control.Control}
* @param {ol.control.ZoomToExtentOptions=} opt_options Options.
* @param {olx.control.ZoomToExtentOptions=} opt_options Options.
* @todo stability experimental
*/
ol.control.ZoomToExtent = function(opt_options) {

View File

@@ -1,2 +1,2 @@
@exportClass ol.DeviceOrientation ol.DeviceOrientationOptions
@exportSymbol ol.DeviceOrientation
@exportSymbol ol.DeviceOrientation.SUPPORTED ol.DeviceOrientation.SUPPORTED

View File

@@ -67,7 +67,7 @@ ol.DeviceOrientationProperty = {
*
* @constructor
* @extends {ol.Object}
* @param {ol.DeviceOrientationOptions=} opt_options Options.
* @param {olx.DeviceOrientationOptions=} opt_options Options.
* @todo stability experimental
* @todo observable alpha {number} readonly the euler angle in radians of the
* device from the standard X axis

View File

@@ -1,2 +1,2 @@
@exportClass ol.Geolocation ol.GeolocationOptions
@exportSymbol ol.Geolocation
@exportSymbol ol.Geolocation.SUPPORTED ol.Geolocation.SUPPORTED

View File

@@ -45,7 +45,7 @@ ol.GeolocationProperty = {
*
* @constructor
* @extends {ol.Object}
* @param {ol.GeolocationOptions=} opt_options Options.
* @param {olx.GeolocationOptions=} opt_options Options.
* @todo stability experimental
* @todo observable accuracy {number} readonly the accuracy of the position
* measurement

View File

@@ -1 +1 @@
@exportClass ol.interaction.DoubleClickZoom ol.interaction.DoubleClickZoomOptions
@exportSymbol ol.interaction.DoubleClickZoom

View File

@@ -14,7 +14,7 @@ goog.require('ol.interaction.Interaction');
*
* @constructor
* @extends {ol.interaction.Interaction}
* @param {ol.interaction.DoubleClickZoomOptions=} opt_options Options.
* @param {olx.interaction.DoubleClickZoomOptions=} opt_options Options.
* @todo stability experimental
*/
ol.interaction.DoubleClickZoom = function(opt_options) {

View File

@@ -1 +1 @@
@exportClass ol.interaction.DragPan ol.interaction.DragPanOptions
@exportSymbol ol.interaction.DragPan

View File

@@ -18,7 +18,7 @@ goog.require('ol.interaction.Drag');
* Allows the user to pan the map by clickng and dragging.
* @constructor
* @extends {ol.interaction.Drag}
* @param {ol.interaction.DragPanOptions=} opt_options Options.
* @param {olx.interaction.DragPanOptions=} opt_options Options.
* @todo stability experimental
*/
ol.interaction.DragPan = function(opt_options) {

View File

@@ -1 +1 @@
@exportClass ol.interaction.DragRotate ol.interaction.DragRotateOptions
@exportSymbol ol.interaction.DragRotate

View File

@@ -1 +1 @@
@exportClass ol.interaction.DragRotateAndZoom ol.interaction.DragRotateAndZoomOptions
@exportSymbol ol.interaction.DragRotateAndZoom

View File

@@ -26,7 +26,7 @@ ol.interaction.DRAGROTATEANDZOOM_ANIMATION_DURATION = 400;
* This interaction is not included in the default interactions.
* @constructor
* @extends {ol.interaction.Drag}
* @param {ol.interaction.DragRotateAndZoomOptions=} opt_options Options.
* @param {olx.interaction.DragRotateAndZoomOptions=} opt_options Options.
* @todo stability experimental
*/
ol.interaction.DragRotateAndZoom = function(opt_options) {

View File

@@ -21,7 +21,7 @@ ol.interaction.DRAGROTATE_ANIMATION_DURATION = 250;
* it to when the alt and shift keys are held down.
* @constructor
* @extends {ol.interaction.Drag}
* @param {ol.interaction.DragRotateOptions=} opt_options Options.
* @param {olx.interaction.DragRotateOptions=} opt_options Options.
*/
ol.interaction.DragRotate = function(opt_options) {

View File

@@ -1 +1 @@
@exportClass ol.interaction.DragZoom ol.interaction.DragZoomOptions
@exportSymbol ol.interaction.DragZoom

View File

@@ -34,7 +34,7 @@ ol.SHIFT_DRAG_ZOOM_HYSTERESIS_PIXELS_SQUARED =
* it to when the shift key is held down.
* @constructor
* @extends {ol.interaction.Drag}
* @param {ol.interaction.DragZoomOptions=} opt_options Options.
* @param {olx.interaction.DragZoomOptions=} opt_options Options.
* @todo stability experimental
*/
ol.interaction.DragZoom = function(opt_options) {

View File

@@ -1 +1 @@
@exportClass ol.interaction.Draw ol.interaction.DrawOptions
@exportSymbol ol.interaction.Draw

View File

@@ -23,7 +23,7 @@ goog.require('ol.source.Vector');
/**
* Interaction that allows drawing geometries.
* @param {ol.interaction.DrawOptions} options Options.
* @param {olx.interaction.DrawOptions} options Options.
* @constructor
* @extends {ol.interaction.Interaction}
*/

View File

@@ -1 +1 @@
@exportFunction ol.interaction.defaults ol.interaction.DefaultsOptions ol.Collection
@exportSymbol ol.interaction.defaults ol.interaction.defaults

View File

@@ -23,7 +23,7 @@ goog.require('ol.interaction.TouchZoom');
* {@link ol.interaction} instances and insert them into an
* {@link ol.Collection} in the order you want before creating your ol.Map
* instance.
* @param {ol.interaction.DefaultsOptions=} opt_options Defaults options.
* @param {olx.interaction.DefaultsOptions=} opt_options Defaults options.
* @return {ol.Collection} A collection of interactions to be used with
* the ol.Map constructor's interactions option.
* @todo stability experimental

View File

@@ -1 +1 @@
@exportClass ol.interaction.KeyboardPan ol.interaction.KeyboardPanOptions
@exportSymbol ol.interaction.KeyboardPan

View File

@@ -24,7 +24,7 @@ ol.interaction.KEYBOARD_PAN_DURATION = 100;
* Allows the user to pan the map using keyboard arrows.
* @constructor
* @extends {ol.interaction.Interaction}
* @param {ol.interaction.KeyboardPanOptions=} opt_options Options.
* @param {olx.interaction.KeyboardPanOptions=} opt_options Options.
* @todo stability experimental
*/
ol.interaction.KeyboardPan = function(opt_options) {

View File

@@ -1 +1 @@
@exportClass ol.interaction.KeyboardZoom ol.interaction.KeyboardZoomOptions
@exportSymbol ol.interaction.KeyboardZoom

View File

@@ -13,7 +13,7 @@ goog.require('ol.interaction.Interaction');
/**
* Allows the user to zoom the map using keyboard + and -.
* @constructor
* @param {ol.interaction.KeyboardZoomOptions=} opt_options Options.
* @param {olx.interaction.KeyboardZoomOptions=} opt_options Options.
* @extends {ol.interaction.Interaction}
* @todo stability experimental
*/

View File

@@ -1 +1 @@
@exportClass ol.interaction.Modify ol.interaction.ModifyOptions
@exportSymbol ol.interaction.Modify

View File

@@ -38,7 +38,7 @@ ol.interaction.SegmentDataType;
/**
* @constructor
* @extends {ol.interaction.Drag}
* @param {ol.interaction.ModifyOptions=} opt_options Options.
* @param {olx.interaction.ModifyOptions=} opt_options Options.
*/
ol.interaction.Modify = function(opt_options) {
goog.base(this);

View File

@@ -27,7 +27,7 @@ ol.interaction.MOUSEWHEELZOOM_TIMEOUT_DURATION = 80;
* Allows the user to zoom the map by scrolling the mouse wheel.
* @constructor
* @extends {ol.interaction.Interaction}
* @param {ol.interaction.MouseWheelZoomOptions=} opt_options Options.
* @param {olx.interaction.MouseWheelZoomOptions=} opt_options Options.
* @todo stability experimental
*/
ol.interaction.MouseWheelZoom = function(opt_options) {

View File

@@ -1 +1 @@
@exportClass ol.interaction.Select ol.interaction.SelectOptions
@exportSymbol ol.interaction.Select

View File

@@ -15,7 +15,7 @@ goog.require('ol.layer.Vector');
* Allows the user to select features on the map.
* @constructor
* @extends {ol.interaction.Interaction}
* @param {ol.interaction.SelectOptions=} opt_options Options.
* @param {olx.interaction.SelectOptions=} opt_options Options.
* @todo stability experimental
*/
ol.interaction.Select = function(opt_options) {

View File

@@ -1 +1 @@
@exportClass ol.interaction.TouchPan ol.interaction.TouchPanOptions
@exportSymbol ol.interaction.TouchPan

View File

@@ -15,7 +15,7 @@ goog.require('ol.interaction.Touch');
* on a touch screen.
* @constructor
* @extends {ol.interaction.Touch}
* @param {ol.interaction.TouchPanOptions=} opt_options Options.
* @param {olx.interaction.TouchPanOptions=} opt_options Options.
* @todo stability experimental
*/
ol.interaction.TouchPan = function(opt_options) {

View File

@@ -1 +1 @@
@exportClass ol.interaction.TouchRotate ol.interaction.TouchRotateOptions
@exportSymbol ol.interaction.TouchRotate

View File

@@ -21,7 +21,7 @@ ol.interaction.TOUCHROTATE_ANIMATION_DURATION = 250;
* on a touch screen.
* @constructor
* @extends {ol.interaction.Touch}
* @param {ol.interaction.TouchRotateOptions=} opt_options Options.
* @param {olx.interaction.TouchRotateOptions=} opt_options Options.
* @todo stability experimental
*/
ol.interaction.TouchRotate = function(opt_options) {

View File

@@ -15,7 +15,7 @@ goog.require('ol.interaction.Touch');
* on a touch screen.
* @constructor
* @extends {ol.interaction.Touch}
* @param {ol.interaction.TouchZoomOptions=} opt_options Options.
* @param {olx.interaction.TouchZoomOptions=} opt_options Options.
* @todo stability experimental
*/
ol.interaction.TouchZoom = function(opt_options) {

View File

@@ -1 +1 @@
@exportClass ol.layer.Image ol.layer.LayerOptions
@exportSymbol ol.layer.Image

View File

@@ -8,7 +8,7 @@ goog.require('ol.source.Image');
/**
* @constructor
* @extends {ol.layer.Layer}
* @param {ol.layer.LayerOptions} options Layer options.
* @param {olx.layer.LayerOptions} options Layer options.
* @todo stability experimental
*/
ol.layer.Image = function(options) {

View File

@@ -12,7 +12,7 @@ goog.require('ol.source.Source');
/**
* @constructor
* @extends {ol.layer.Base}
* @param {ol.layer.LayerOptions} options Layer options.
* @param {olx.layer.LayerOptions} options Layer options.
* @todo stability experimental
* @todo observable brightness {number} the brightness of the layer
* @todo observable contrast {number} the contrast of the layer
@@ -25,7 +25,7 @@ goog.require('ol.source.Source');
*/
ol.layer.Layer = function(options) {
var baseOptions = /** @type {ol.layer.LayerOptions} */
var baseOptions = /** @type {olx.layer.LayerOptions} */
(goog.object.clone(options));
delete baseOptions.source;

View File

@@ -43,7 +43,7 @@ ol.layer.LayerState;
/**
* @constructor
* @extends {ol.Object}
* @param {ol.layer.BaseOptions} options Layer options.
* @param {olx.layer.BaseOptions} options Layer options.
*/
ol.layer.Base = function(options) {

View File

@@ -1 +1 @@
@exportClass ol.layer.Group ol.layer.GroupOptions
@exportSymbol ol.layer.Group

View File

@@ -26,7 +26,7 @@ ol.layer.GroupProperty = {
/**
* @constructor
* @extends {ol.layer.Base}
* @param {ol.layer.GroupOptions=} opt_options Layer options.
* @param {olx.layer.GroupOptions=} opt_options Layer options.
* @todo stability experimental
* @todo observable layers {ol.Collection} collection of layers that are part
* of this group
@@ -34,7 +34,7 @@ ol.layer.GroupProperty = {
ol.layer.Group = function(opt_options) {
var options = goog.isDef(opt_options) ? opt_options : {};
var baseOptions = /** @type {ol.layer.GroupOptions} */
var baseOptions = /** @type {olx.layer.GroupOptions} */
(goog.object.clone(options));
delete baseOptions.layers;

View File

@@ -1 +1 @@
@exportClass ol.layer.Tile ol.layer.TileOptions
@exportSymbol ol.layer.Tile

View File

@@ -16,7 +16,7 @@ ol.layer.TileProperty = {
/**
* @constructor
* @extends {ol.layer.Layer}
* @param {ol.layer.TileOptions} options Tile layer options.
* @param {olx.layer.TileOptions} options Tile layer options.
* @todo stability experimental
* @todo observable preload {number} the level to preload tiles up to
*/

View File

@@ -1 +1 @@
@exportClass ol.layer.Vector ol.layer.VectorLayerOptions
@exportSymbol ol.layer.Vector

View File

@@ -15,12 +15,12 @@ goog.require('ol.style.Style');
/**
* @constructor
* @extends {ol.layer.Layer}
* @param {ol.layer.VectorLayerOptions} options Vector layer options.
* @param {olx.layer.VectorLayerOptions} options Vector layer options.
* @todo stability experimental
*/
ol.layer.Vector = function(options) {
var baseOptions = /** @type {ol.layer.VectorLayerOptions} */
var baseOptions = /** @type {olx.layer.VectorLayerOptions} */
(goog.object.clone(options));
/**
@@ -45,7 +45,7 @@ ol.layer.Vector = function(options) {
*/
this.temporary_ = false;
goog.base(this, /** @type {ol.layer.LayerOptions} */ (baseOptions));
goog.base(this, /** @type {olx.layer.LayerOptions} */ (baseOptions));
};
goog.inherits(ol.layer.Vector, ol.layer.Layer);

View File

@@ -1,4 +1,4 @@
@exportClass ol.Map ol.MapOptions
@exportSymbol ol.Map
@exportProperty ol.Map.prototype.addControl
@exportProperty ol.Map.prototype.addInteraction
@exportProperty ol.Map.prototype.addLayer

View File

@@ -141,7 +141,7 @@ ol.MapProperty = {
*
* @constructor
* @extends {ol.Object}
* @param {ol.MapOptions} options Map options.
* @param {olx.MapOptions} options Map options.
* @todo stability experimental
* @todo observable layergroup {ol.layer.LayerGroup} a layer group containing
* the layers in this map.
@@ -563,7 +563,7 @@ ol.Map.prototype.getOverlays = function() {
/**
* Get feature information for a pixel on the map.
*
* @param {ol.GetFeatureInfoOptions} options Options.
* @param {olx.GetFeatureInfoOptions} options Options.
* @todo stability experimental
*/
ol.Map.prototype.getFeatureInfo = function(options) {
@@ -577,7 +577,7 @@ ol.Map.prototype.getFeatureInfo = function(options) {
/**
* Get features for a pixel on the map.
*
* @param {ol.GetFeaturesOptions} options Options.
* @param {olx.GetFeaturesOptions} options Options.
* @todo stability experimental
*/
ol.Map.prototype.getFeatures = function(options) {
@@ -1241,7 +1241,7 @@ ol.MapOptionsInternal;
/**
* @param {ol.MapOptions} options Map options.
* @param {olx.MapOptions} options Map options.
* @return {ol.MapOptionsInternal} Internal map options.
*/
ol.Map.createOptionsInternal = function(options) {

View File

@@ -1,4 +1,4 @@
@exportClass ol.Overlay ol.OverlayOptions
@exportSymbol ol.Overlay
@exportSymbol ol.OverlayPositioning
@exportProperty ol.OverlayPositioning.BOTTOM_LEFT

View File

@@ -55,7 +55,7 @@ ol.OverlayPositioning = {
*
* @constructor
* @extends {ol.Object}
* @param {ol.OverlayOptions} options Overlay options.
* @param {olx.OverlayOptions} options Overlay options.
* @todo stability experimental
* @todo observable element {Element} the Element containing the overlay
* @todo observable map {ol.Map} the map that the overlay is part of

View File

@@ -21,12 +21,12 @@ goog.require('ol.parser.XML');
* @implements {ol.parser.DomFeatureParser}
* @implements {ol.parser.StringFeatureParser}
* @implements {ol.parser.ObjectFeatureParser}
* @param {ol.parser.GPXOptions=} opt_options Optional configuration object.
* @param {olx.parser.GPXOptions=} opt_options Optional configuration object.
* @extends {ol.parser.XML}
* @todo stability experimental
*/
ol.parser.GPX = function(opt_options) {
var options = /** @type {ol.parser.GPXOptions} */
var options = /** @type {olx.parser.GPXOptions} */
(goog.isDef(opt_options) ? opt_options : {});
this.extractAttributes = goog.isDef(options.extractAttributes) ?
options.extractAttributes : true;
@@ -269,7 +269,7 @@ ol.parser.GPX.prototype.readFeaturesFromObject = function(obj) {
/**
* @param {ol.parser.GPXWriteOptions} obj Object structure to write out
* @param {olx.parser.GPXWriteOptions} obj Object structure to write out
* as GPX.
* @return {string} An string representing the GPX document.
*/

View File

@@ -40,12 +40,12 @@ goog.require('ol.style.Stroke');
* @implements {ol.parser.StringFeatureParser}
* @implements {ol.parser.AsyncObjectFeatureParser}
* @implements {ol.parser.AsyncStringFeatureParser}
* @param {ol.parser.KMLOptions=} opt_options Optional configuration object.
* @param {olx.parser.KMLOptions=} opt_options Optional configuration object.
* @extends {ol.parser.XML}
* @todo stability experimental
*/
ol.parser.KML = function(opt_options) {
var options = /** @type {ol.parser.KMLOptions} */
var options = /** @type {olx.parser.KMLOptions} */
(goog.isDef(opt_options) ? opt_options : {});
this.extractAttributes = goog.isDef(options.extractAttributes) ?
options.extractAttributes : true;

View File

@@ -649,6 +649,6 @@ ol.parser.ogc.Filter_v1.prototype.setSrsName = function(srsName) {
this.srsName = srsName;
if (goog.isDefAndNotNull(this.gmlParser_)) {
this.gmlParser_.applyWriteOptions({},
/** @type {ol.parser.GMLWriteOptions} */ ({srsName: srsName}));
/** @type {olx.parser.GMLWriteOptions} */ ({srsName: srsName}));
}
};

View File

@@ -22,12 +22,12 @@ goog.require('ol.proj');
/**
* @constructor
* @implements {ol.parser.StringFeatureParser}
* @param {ol.parser.GMLOptions=} opt_options
* @param {olx.parser.GMLOptions=} opt_options
* Optional configuration object.
* @extends {ol.parser.XML}
*/
ol.parser.ogc.GML = function(opt_options) {
var options = /** @type {ol.parser.GMLOptions} */
var options = /** @type {olx.parser.GMLOptions} */
(goog.isDef(opt_options) ? opt_options : {});
this.extractAttributes = goog.isDef(options.extractAttributes) ?
options.extractAttributes : true;
@@ -491,7 +491,7 @@ ol.parser.ogc.GML.prototype.writeGeometry = function(geometry) {
/**
* @param {string|Document|Element|Object} data Data to read.
* @param {ol.parser.GMLReadOptions=} opt_options Read options.
* @param {olx.parser.GMLReadOptions=} opt_options Read options.
* @return {ol.parser.ReadFeaturesResult} An object representing the document.
*/
ol.parser.ogc.GML.prototype.read = function(data, opt_options) {
@@ -630,7 +630,7 @@ ol.parser.ogc.GML.prototype.readFeaturesFromString = function(str) {
* Applies the writeOptions passed into the write function.
* @param {ol.parser.ReadFeaturesResult} obj Object structure to write out as
* GML.
* @param {ol.parser.GMLWriteOptions=} opt_options Write options.
* @param {olx.parser.GMLWriteOptions=} opt_options Write options.
*/
ol.parser.ogc.GML.prototype.applyWriteOptions = function(obj, opt_options) {
// srsName handling: opt_options -> this.writeOptions -> obj.metadata

View File

@@ -11,7 +11,7 @@ goog.require('ol.parser.ogc.GML');
* version 2.1.2
*
* @constructor
* @param {ol.parser.GMLOptions=} opt_options Optional configuration object.
* @param {olx.parser.GMLOptions=} opt_options Optional configuration object.
* @extends {ol.parser.ogc.GML}
* @todo stability experimental
*/
@@ -127,7 +127,7 @@ goog.inherits(ol.parser.ogc.GML_v2, ol.parser.ogc.GML);
/**
* @param {ol.parser.ReadFeaturesResult} obj Object structure to write out as
* GML.
* @param {ol.parser.GMLWriteOptions=} opt_options Write options.
* @param {olx.parser.GMLWriteOptions=} opt_options Write options.
* @return {string} A string representing the GML document.
* @todo stability experimental
*/

View File

@@ -13,7 +13,7 @@ goog.require('ol.parser.ogc.GML');
* version 3.1.1
*
* @constructor
* @param {ol.parser.GMLOptions=} opt_options Optional configuration object.
* @param {olx.parser.GMLOptions=} opt_options Optional configuration object.
* @extends {ol.parser.ogc.GML}
* @todo stability experimental
*/
@@ -425,7 +425,7 @@ goog.inherits(ol.parser.ogc.GML_v3, ol.parser.ogc.GML);
/**
* @param {ol.parser.ReadFeaturesResult} obj Object structure to write out as
* XML.
* @param {ol.parser.GMLWriteOptions=} opt_options Write options.
* @param {olx.parser.GMLWriteOptions=} opt_options Write options.
* @return {string} An string representing the XML document.
* @todo stability experimental
*/

View File

@@ -89,7 +89,7 @@ ol.parser.ogc.SLD_v1 = function() {
delete config.fill;
config.zIndex = this.featureTypeCounter;
rule.symbolizers.push(
new ol.style.Text(/** @type {ol.style.TextOptions} */(config))
new ol.style.Text(/** @type {olx.style.TextOptions} */(config))
);
},
'Label': function(node, symbolizer) {
@@ -197,7 +197,7 @@ ol.parser.ogc.SLD_v1 = function() {
if (goog.isDef(config.externalGraphic)) {
config.width = config.height = config.size;
symbolizer = new ol.style.Icon(
/** @type {ol.style.IconOptions} */(config));
/** @type {olx.style.IconOptions} */(config));
} else {
symbolizer = new ol.style.Shape(config);
}
@@ -689,7 +689,7 @@ ol.parser.ogc.SLD_v1.prototype.getScaleDenominatorFromResolution_ =
/**
* @param {string|Document|Element} data Data to read.
* @param {ol.parser.SLDReadOptions=} opt_options Read options.
* @param {olx.parser.SLDReadOptions=} opt_options Read options.
* @return {Object} An object representing the document.
*/
ol.parser.ogc.SLD_v1.prototype.read = function(data, opt_options) {
@@ -713,7 +713,7 @@ ol.parser.ogc.SLD_v1.prototype.read = function(data, opt_options) {
/**
* @param {Object} style The style to write out.
* @param {ol.parser.SLDWriteOptions=} opt_options Write options.
* @param {olx.parser.SLDWriteOptions=} opt_options Write options.
* @return {string} The serialized SLD.
*/
ol.parser.ogc.SLD_v1.prototype.write = function(style, opt_options) {

View File

@@ -28,9 +28,9 @@ ol.parser.ogc.WFS_v1 = function(opt_options) {
this.writers = {};
this.writers[this.defaultNamespaceURI] = {
/**
* @param {ol.parser.WFSWriteGetFeatureOptions} options Options.
* @param {olx.parser.WFSWriteGetFeatureOptions} options Options.
* @return {{node: Node,
* options: ol.parser.WFSWriteGetFeatureOptions}} Object.
* options: olx.parser.WFSWriteGetFeatureOptions}} Object.
* @this {ol.parser.XML}
*/
'GetFeature': function(options) {
@@ -64,7 +64,7 @@ ol.parser.ogc.WFS_v1 = function(opt_options) {
* @param {{inserts: Array.<ol.Feature>,
* updates: Array.<ol.Feature>,
* deletes: Array.<ol.Feature>,
* options: ol.parser.WFSWriteTransactionOptions}} obj Object.
* options: olx.parser.WFSWriteTransactionOptions}} obj Object.
* @return {Element} Node.
* @this {ol.parser.XML}
*/
@@ -120,7 +120,7 @@ ol.parser.ogc.WFS_v1 = function(opt_options) {
},
/**
* @param {{feature: ol.Feature,
* options: ol.parser.WFSWriteTransactionOptions}} obj Object.
* options: olx.parser.WFSWriteTransactionOptions}} obj Object.
* @return {Element} Node.
* @this {ol.parser.XML}
*/
@@ -140,7 +140,7 @@ ol.parser.ogc.WFS_v1 = function(opt_options) {
},
/**
* @param {{feature: ol.Feature,
* options: ol.parser.WFSWriteTransactionOptions}} obj Object.
* options: olx.parser.WFSWriteTransactionOptions}} obj Object.
* @return {Element} Node.
* @this {ol.parser.XML}
*/
@@ -213,7 +213,7 @@ ol.parser.ogc.WFS_v1 = function(opt_options) {
},
/**
* @param {{feature: ol.Feature,
* options: ol.parser.WFSWriteTransactionOptions}} obj Object.
* options: olx.parser.WFSWriteTransactionOptions}} obj Object.
* @return {Element} Node.
* @this {ol.parser.XML}
*/
@@ -338,7 +338,7 @@ ol.parser.ogc.WFS_v1.prototype.read = function(data) {
/**
* @param {ol.parser.WFSWriteGetFeatureOptions} options Options.
* @param {olx.parser.WFSWriteGetFeatureOptions} options Options.
* @return {string} A serialized WFS GetFeature query.
*/
ol.parser.ogc.WFS_v1.prototype.writeGetFeature = function(options) {
@@ -352,7 +352,7 @@ ol.parser.ogc.WFS_v1.prototype.writeGetFeature = function(options) {
* @param {Array.<ol.Feature>} inserts The features to insert.
* @param {Array.<ol.Feature>} updates The features to update.
* @param {Array.<ol.Feature>} deletes The features to delete.
* @param {ol.parser.WFSWriteTransactionOptions} options Write options.
* @param {olx.parser.WFSWriteTransactionOptions} options Write options.
* @return {string} A serialized WFS transaction.
*/
ol.parser.ogc.WFS_v1.prototype.writeTransaction =

View File

@@ -1,4 +1,4 @@
@exportClass ol.proj.Projection ol.ProjectionOptions
@exportSymbol ol.proj.Projection
@exportProperty ol.proj.Projection.prototype.getCode
@exportProperty ol.proj.Projection.prototype.getExtent

View File

@@ -58,7 +58,7 @@ ol.METERS_PER_UNIT[ol.proj.Units.METERS] = 1;
/**
* @constructor
* @param {ol.ProjectionOptions} options Projection options.
* @param {olx.ProjectionOptions} options Projection options.
* @todo stability experimental
*/
ol.proj.Projection = function(options) {
@@ -198,14 +198,14 @@ ol.proj.Projection.prototype.setDefaultTileGrid = function(tileGrid) {
* @constructor
* @extends {ol.proj.Projection}
* @param {Proj4js.Proj} proj4jsProj Proj4js projection.
* @param {ol.Proj4jsProjectionOptions} options Proj4js projection options.
* @param {olx.Proj4jsProjectionOptions} options Proj4js projection options.
* @private
*/
ol.Proj4jsProjection_ = function(proj4jsProj, options) {
var units = /** @type {ol.proj.Units} */ (proj4jsProj.units);
var config = /** @type {ol.ProjectionOptions} */ ({
var config = /** @type {olx.ProjectionOptions} */ ({
units: units,
axisOrientation: proj4jsProj.axis
});
@@ -491,7 +491,7 @@ ol.proj.get = function(projectionLike) {
/**
* @param {ol.Proj4jsProjectionOptions} options Proj4js projection options.
* @param {olx.Proj4jsProjectionOptions} options Proj4js projection options.
* @private
* @return {ol.Proj4jsProjection_} Proj4js projection.
*/
@@ -504,7 +504,7 @@ ol.proj.getProj4jsProjectionFromCode_ = function(options) {
var srsCode = proj4jsProj.srsCode;
proj4jsProjection = proj4jsProjections[srsCode];
if (!goog.isDef(proj4jsProjection)) {
var config = /** @type {ol.Proj4jsProjectionOptions} */
var config = /** @type {olx.Proj4jsProjectionOptions} */
(goog.object.clone(options));
config.code = srsCode;
proj4jsProjection = new ol.Proj4jsProjection_(proj4jsProj, config);
@@ -709,7 +709,7 @@ ol.proj.transformWithProjections =
/**
* @param {ol.Proj4jsProjectionOptions} options Proj4js projection options.
* @param {olx.Proj4jsProjectionOptions} options Proj4js projection options.
* @return {ol.proj.Projection} Proj4js projection.
* @todo stability experimental
*/

View File

@@ -1,2 +1,2 @@
@exportClass ol.source.BingMaps ol.source.BingMapsOptions
@exportSymbol ol.source.BingMaps
@exportProperty ol.source.BingMaps.TOS_ATTRIBUTION

View File

@@ -18,7 +18,7 @@ goog.require('ol.tilegrid.XYZ');
/**
* @constructor
* @extends {ol.source.TileImage}
* @param {ol.source.BingMapsOptions} options Bing Maps options.
* @param {olx.source.BingMapsOptions} options Bing Maps options.
* @todo stability experimental
*/
ol.source.BingMaps = function(options) {

View File

@@ -1 +1 @@
@exportClass ol.source.TileDebug ol.source.TileDebugOptions
@exportSymbol ol.source.TileDebug

View File

@@ -85,7 +85,7 @@ ol.DebugTile_.prototype.getImage = function(opt_context) {
/**
* @constructor
* @extends {ol.source.Tile}
* @param {ol.source.TileDebugOptions} options Debug tile options.
* @param {olx.source.TileDebugOptions} options Debug tile options.
* @todo stability experimental
*/
ol.source.TileDebug = function(options) {

View File

@@ -1 +1 @@
@exportClass ol.source.ImageStatic ol.source.ImageStaticOptions
@exportSymbol ol.source.ImageStatic

View File

@@ -11,7 +11,7 @@ goog.require('ol.source.Image');
/**
* @constructor
* @extends {ol.source.Image}
* @param {ol.source.ImageStaticOptions} options Options.
* @param {olx.source.ImageStaticOptions} options Options.
* @todo stability experimental
*/
ol.source.ImageStatic = function(options) {

View File

@@ -1,3 +1,3 @@
@exportClass ol.source.ImageWMS ol.source.ImageWMSOptions
@exportSymbol ol.source.ImageWMS
@exportProperty ol.source.ImageWMS.prototype.getParams
@exportProperty ol.source.ImageWMS.prototype.updateParams

View File

@@ -15,7 +15,7 @@ goog.require('ol.source.wms');
* @constructor
* @extends {ol.source.Image}
* @implements {ol.source.FeatureInfoSource}
* @param {ol.source.ImageWMSOptions} options Options.
* @param {olx.source.ImageWMSOptions} options Options.
* @todo stability experimental
*/
ol.source.ImageWMS = function(options) {
@@ -42,11 +42,11 @@ ol.source.ImageWMS = function(options) {
/**
* @private
* @type {ol.source.WMSGetFeatureInfoOptions}
* @type {olx.source.WMSGetFeatureInfoOptions}
*/
this.getFeatureInfoOptions_ = goog.isDef(options.getFeatureInfoOptions) ?
options.getFeatureInfoOptions :
/** @type {ol.source.WMSGetFeatureInfoOptions} */ ({});
/** @type {olx.source.WMSGetFeatureInfoOptions} */ ({});
/**
* @private

View File

@@ -11,7 +11,7 @@ goog.require('ol.source.Image');
/**
* @constructor
* @extends {ol.source.Image}
* @param {ol.source.MapGuideOptions} options Options.
* @param {olx.source.MapGuideOptions} options Options.
*/
ol.source.MapGuide = function(options) {

View File

@@ -10,7 +10,7 @@ goog.require('ol.source.XYZ');
/**
* @constructor
* @extends {ol.source.XYZ}
* @param {ol.source.MapQuestOptions=} opt_options MapQuest options.
* @param {olx.source.MapQuestOptions=} opt_options MapQuest options.
* @todo stability experimental
*/
ol.source.MapQuestOSM = function(opt_options) {
@@ -43,7 +43,7 @@ goog.inherits(ol.source.MapQuestOSM, ol.source.XYZ);
/**
* @constructor
* @extends {ol.source.XYZ}
* @param {ol.source.MapQuestOptions=} opt_options MapQuest options.
* @param {olx.source.MapQuestOptions=} opt_options MapQuest options.
* @todo stability experimental
*/
ol.source.MapQuestOpenAerial = function(opt_options) {

View File

@@ -8,7 +8,7 @@ goog.require('ol.source.XYZ');
/**
* @constructor
* @extends {ol.source.XYZ}
* @param {ol.source.OSMOptions=} opt_options Open Street Map options.
* @param {olx.source.OSMOptions=} opt_options Open Street Map options.
* @todo stability experimental
*/
ol.source.OSM = function(opt_options) {

View File

@@ -1 +1 @@
@exportClass ol.source.Stamen ol.source.StamenOptions
@exportSymbol ol.source.Stamen

Some files were not shown because too many files have changed in this diff Show More