Remove undefined type when the property is optional

This commit is contained in:
Frederic Junod
2018-03-13 12:33:35 +01:00
parent 92d864ee92
commit bb3072153b
4 changed files with 19 additions and 19 deletions

View File

@@ -146,8 +146,8 @@ import Units from './proj/Units.js';
* the animation. * the animation.
* @property {ol.Coordinate|undefined} anchor Optional anchor to remained fixed * @property {ol.Coordinate|undefined} anchor Optional anchor to remained fixed
* during a rotation or resolution animation. * during a rotation or resolution animation.
* @property {number|undefined} [duration=1000] The duration of the animation in milliseconds. * @property {number} [duration=1000] The duration of the animation in milliseconds.
* @property {undefined|function(number):number} [easing] The easing function used * @property {function(number):number} [easing] The easing function used
* during the animation (defaults to {@link ol.easing.inAndOut}). * during the animation (defaults to {@link ol.easing.inAndOut}).
* The function will be called for each frame with a number representing a * The function will be called for each frame with a number representing a
* fraction of the animation's duration. The function should return a number * fraction of the animation's duration. The function should return a number

View File

@@ -12,17 +12,17 @@ import {inherits} from '../index.js';
/** /**
* @typedef {Object} Options * @typedef {Object} Options
* @property {string|undefined} [className='ol-rotate'] CSS class name. * @property {string} [className='ol-rotate'] CSS class name.
* @property {string|Element|undefined} [label='⇧'] Text label to use for the rotate button. * @property {string|Element} [label='⇧'] Text label to use for the rotate button.
* Instead of text, also an element (e.g. a `span` element) can be used. * Instead of text, also an element (e.g. a `span` element) can be used.
* @property {string|undefined} [tipLabel='Reset rotation'] Text label to use for the rotate tip. * @property {string} [tipLabel='Reset rotation'] Text label to use for the rotate tip.
* @property {number|undefined} [duration=250] Animation duration in milliseconds. * @property {number} [duration=250] Animation duration in milliseconds.
* @property {boolean|undefined} [autoHide=true] Hide the control when rotation is 0. * @property {boolean} [autoHide=true] Hide the control when rotation is 0.
* @property {function(ol.MapEvent)|undefined} render Function called when the control should * @property {function(ol.MapEvent)|undefined} render Function called when the control should
* be re-rendered. This is called in a `requestAnimationFrame` callback. * be re-rendered. This is called in a `requestAnimationFrame` callback.
* @property {function()|undefined} [resetNorth] Function called when the control is clicked. * @property {function()} [resetNorth] Function called when the control is clicked.
* This will override the default `resetNorth`. * This will override the default `resetNorth`.
* @property {Element|string|undefined} [target] Specify a target if you want the control to be * @property {Element|string} [target] Specify a target if you want the control to be
* rendered outside of the map's viewport. * rendered outside of the map's viewport.
*/ */

View File

@@ -11,16 +11,16 @@ import {easeOut} from '../easing.js';
/** /**
* @typedef {Object} Options * @typedef {Object} Options
* @property {number|undefined} [duration=250] Animation duration in milliseconds. * @property {number} [duration=250] Animation duration in milliseconds.
* @property {string|undefined} [className='ol-zoom'] CSS class name. * @property {string} [className='ol-zoom'] CSS class name.
* @property {string|Element|undefined} [zoomInLabel='+'] Text label to use for the zoom-in * @property {string|Element} [zoomInLabel='+'] Text label to use for the zoom-in
* button. Instead of text, also an element (e.g. a `span` element) can be used. * button. Instead of text, also an element (e.g. a `span` element) can be used.
* @property {string|Element|undefined} [zoomOutLabel='-'] Text label to use for the zoom-out button. * @property {string|Element} [zoomOutLabel='-'] Text label to use for the zoom-out button.
* Instead of text, also an element (e.g. a `span` element) can be used. * Instead of text, also an element (e.g. a `span` element) can be used.
* @property {string|undefined} [zoomInTipLabel='Zoom in'] Text label to use for the button tip. * @property {string} [zoomInTipLabel='Zoom in'] Text label to use for the button tip.
* @property {string|undefined} [zoomOutTipLabel='Zoom out'] Text label to use for the button tip. * @property {string} [zoomOutTipLabel='Zoom out'] Text label to use for the button tip.
* @property {number|undefined} [delta=1] The zoom delta applied on each click. * @property {number} [delta=1] The zoom delta applied on each click.
* @property {Element|string|undefined} [target] Specify a target if you want the control to be * @property {Element|string} [target] Specify a target if you want the control to be
* rendered outside of the map's viewport. * rendered outside of the map's viewport.
*/ */

View File

@@ -27,8 +27,8 @@ const Direction = {
/** /**
* @typedef {Object} Options * @typedef {Object} Options
* @property {string|undefined} className CSS class name. * @property {string} [className='ol-zoomslider'] CSS class name.
* @property {number|undefined} [duration=200] Animation duration in milliseconds. * @property {number} [duration=200] Animation duration in milliseconds.
* @property {number|undefined} maxResolution Maximum resolution. * @property {number|undefined} maxResolution Maximum resolution.
* @property {number|undefined} minResolution Minimum resolution. * @property {number|undefined} minResolution Minimum resolution.
* @property {function(ol.MapEvent)|undefined} render Function called when the control * @property {function(ol.MapEvent)|undefined} render Function called when the control