Move ControlOptions to ol/control/Control

This commit is contained in:
Tim Schaub
2018-03-11 10:43:58 -06:00
parent cddfd7cb3b
commit 9468fd45ec
3 changed files with 15 additions and 47 deletions

View File

@@ -12,41 +12,6 @@ let olx;
olx.control;
/**
* @typedef {{element: (Element|undefined),
* render: (function(ol.MapEvent)|undefined),
* target: (Element|string|undefined)}}
*/
olx.control.ControlOptions;
/**
* The element is the control's container element. This only needs to be
* specified if you're developing a custom control.
* @type {Element|undefined}
* @api
*/
olx.control.ControlOptions.prototype.element;
/**
* Function called when the control should be re-rendered. This is called
* in a requestAnimationFrame callback.
* @type {function(ol.MapEvent)|undefined}
* @api
*/
olx.control.ControlOptions.prototype.render;
/**
* Specify a target if you want the control to be rendered outside of the map's
* viewport.
* @type {Element|string|undefined}
* @api
*/
olx.control.ControlOptions.prototype.target;
/**
* @typedef {{className: (string|undefined),
* label: (string|Element|undefined),

View File

@@ -1,15 +1,4 @@
/**
* @typedef {Object} control_ControlOptions
* @property {Element|undefined} element The element is the control's container element. This only needs to be
* specified if you're developing a custom control.
* @property {function(ol.MapEvent)|undefined} render Function called when the control should be re-rendered. This is called
* in a requestAnimationFrame callback.
* @property {Element|string|undefined} target Specify a target if you want the control to be rendered outside of the map's
* viewport.
*/
/**
* @typedef {Object} control_FullScreenOptions
* @property {string|undefined} className CSS class name. Default is `ol-full-screen`.

View File

@@ -8,6 +8,20 @@ import BaseObject from '../Object.js';
import {removeNode} from '../dom.js';
import {listen, unlistenByKey} from '../events.js';
/**
* @typedef {Object} Options
* @property {Element|undefined} element The element is the control's
* container element. This only needs to be specified if you're developing
* a custom control.
* @property {function(ol.MapEvent)|undefined} render Function called when
* the control should be re-rendered. This is called in a `requestAnimationFrame`
* callback.
* @property {Element|string|undefined} target Specify a target if you want
* the control to be rendered outside of the map's viewport.
*/
/**
* @classdesc
* A control is a visible widget with a DOM element in a fixed position on the
@@ -34,7 +48,7 @@ import {listen, unlistenByKey} from '../events.js';
* @constructor
* @extends {ol.Object}
* @implements {oli.control.Control}
* @param {olx.control.ControlOptions} options Control options.
* @param {module:ol/control/Control~Options} options Control options.
* @api
*/
const Control = function(options) {