Add @api stable annotations for ol.Overlay
This commit is contained in:
+1
-1
@@ -287,7 +287,7 @@ olx.MapOptions.prototype.view;
|
|||||||
* positioning: (ol.OverlayPositioning|string|undefined),
|
* positioning: (ol.OverlayPositioning|string|undefined),
|
||||||
* stopEvent: (boolean|undefined),
|
* stopEvent: (boolean|undefined),
|
||||||
* insertFirst: (boolean|undefined)}}
|
* insertFirst: (boolean|undefined)}}
|
||||||
* @api
|
* @api stable
|
||||||
*/
|
*/
|
||||||
olx.OverlayOptions;
|
olx.OverlayOptions;
|
||||||
|
|
||||||
|
|||||||
+10
-10
@@ -30,7 +30,7 @@ ol.OverlayProperty = {
|
|||||||
* `'center-left'`, `'center-center'`, `'center-right'`, `'top-left'`,
|
* `'center-left'`, `'center-center'`, `'center-right'`, `'top-left'`,
|
||||||
* `'top-center'`, `'top-right'`
|
* `'top-center'`, `'top-right'`
|
||||||
* @enum {string}
|
* @enum {string}
|
||||||
* @api
|
* @api stable
|
||||||
*/
|
*/
|
||||||
ol.OverlayPositioning = {
|
ol.OverlayPositioning = {
|
||||||
BOTTOM_LEFT: 'bottom-left',
|
BOTTOM_LEFT: 'bottom-left',
|
||||||
@@ -155,7 +155,7 @@ goog.inherits(ol.Overlay, ol.Object);
|
|||||||
* Get the DOM element of this overlay.
|
* Get the DOM element of this overlay.
|
||||||
* @return {Element|undefined} The Element containing the overlay.
|
* @return {Element|undefined} The Element containing the overlay.
|
||||||
* @observable
|
* @observable
|
||||||
* @api
|
* @api stable
|
||||||
*/
|
*/
|
||||||
ol.Overlay.prototype.getElement = function() {
|
ol.Overlay.prototype.getElement = function() {
|
||||||
return /** @type {Element|undefined} */ (
|
return /** @type {Element|undefined} */ (
|
||||||
@@ -171,7 +171,7 @@ goog.exportProperty(
|
|||||||
* Get the map associated with this overlay.
|
* Get the map associated with this overlay.
|
||||||
* @return {ol.Map|undefined} The map that the overlay is part of.
|
* @return {ol.Map|undefined} The map that the overlay is part of.
|
||||||
* @observable
|
* @observable
|
||||||
* @api
|
* @api stable
|
||||||
*/
|
*/
|
||||||
ol.Overlay.prototype.getMap = function() {
|
ol.Overlay.prototype.getMap = function() {
|
||||||
return /** @type {ol.Map|undefined} */ (
|
return /** @type {ol.Map|undefined} */ (
|
||||||
@@ -187,7 +187,7 @@ goog.exportProperty(
|
|||||||
* Get the offset of this overlay.
|
* Get the offset of this overlay.
|
||||||
* @return {Array.<number>} The offset.
|
* @return {Array.<number>} The offset.
|
||||||
* @observable
|
* @observable
|
||||||
* @api
|
* @api stable
|
||||||
*/
|
*/
|
||||||
ol.Overlay.prototype.getOffset = function() {
|
ol.Overlay.prototype.getOffset = function() {
|
||||||
return /** @type {Array.<number>} */ (
|
return /** @type {Array.<number>} */ (
|
||||||
@@ -204,7 +204,7 @@ goog.exportProperty(
|
|||||||
* @return {ol.Coordinate|undefined} The spatial point that the overlay is
|
* @return {ol.Coordinate|undefined} The spatial point that the overlay is
|
||||||
* anchored at.
|
* anchored at.
|
||||||
* @observable
|
* @observable
|
||||||
* @api
|
* @api stable
|
||||||
*/
|
*/
|
||||||
ol.Overlay.prototype.getPosition = function() {
|
ol.Overlay.prototype.getPosition = function() {
|
||||||
return /** @type {ol.Coordinate|undefined} */ (
|
return /** @type {ol.Coordinate|undefined} */ (
|
||||||
@@ -221,7 +221,7 @@ goog.exportProperty(
|
|||||||
* @return {ol.OverlayPositioning} How the overlay is positioned
|
* @return {ol.OverlayPositioning} How the overlay is positioned
|
||||||
* relative to its point on the map.
|
* relative to its point on the map.
|
||||||
* @observable
|
* @observable
|
||||||
* @api
|
* @api stable
|
||||||
*/
|
*/
|
||||||
ol.Overlay.prototype.getPositioning = function() {
|
ol.Overlay.prototype.getPositioning = function() {
|
||||||
return /** @type {ol.OverlayPositioning} */ (
|
return /** @type {ol.OverlayPositioning} */ (
|
||||||
@@ -307,7 +307,7 @@ ol.Overlay.prototype.handlePositioningChanged = function() {
|
|||||||
* Set the DOM element to be associated with this overlay.
|
* Set the DOM element to be associated with this overlay.
|
||||||
* @param {Element|undefined} element The Element containing the overlay.
|
* @param {Element|undefined} element The Element containing the overlay.
|
||||||
* @observable
|
* @observable
|
||||||
* @api
|
* @api stable
|
||||||
*/
|
*/
|
||||||
ol.Overlay.prototype.setElement = function(element) {
|
ol.Overlay.prototype.setElement = function(element) {
|
||||||
this.set(ol.OverlayProperty.ELEMENT, element);
|
this.set(ol.OverlayProperty.ELEMENT, element);
|
||||||
@@ -322,7 +322,7 @@ goog.exportProperty(
|
|||||||
* Set the map to be associated with this overlay.
|
* Set the map to be associated with this overlay.
|
||||||
* @param {ol.Map|undefined} map The map that the overlay is part of.
|
* @param {ol.Map|undefined} map The map that the overlay is part of.
|
||||||
* @observable
|
* @observable
|
||||||
* @api
|
* @api stable
|
||||||
*/
|
*/
|
||||||
ol.Overlay.prototype.setMap = function(map) {
|
ol.Overlay.prototype.setMap = function(map) {
|
||||||
this.set(ol.OverlayProperty.MAP, map);
|
this.set(ol.OverlayProperty.MAP, map);
|
||||||
@@ -337,7 +337,7 @@ goog.exportProperty(
|
|||||||
* Set the offset for this overlay.
|
* Set the offset for this overlay.
|
||||||
* @param {Array.<number>} offset Offset.
|
* @param {Array.<number>} offset Offset.
|
||||||
* @observable
|
* @observable
|
||||||
* @api
|
* @api stable
|
||||||
*/
|
*/
|
||||||
ol.Overlay.prototype.setOffset = function(offset) {
|
ol.Overlay.prototype.setOffset = function(offset) {
|
||||||
this.set(ol.OverlayProperty.OFFSET, offset);
|
this.set(ol.OverlayProperty.OFFSET, offset);
|
||||||
@@ -369,7 +369,7 @@ goog.exportProperty(
|
|||||||
* @param {ol.OverlayPositioning} positioning how the overlay is
|
* @param {ol.OverlayPositioning} positioning how the overlay is
|
||||||
* positioned relative to its point on the map.
|
* positioned relative to its point on the map.
|
||||||
* @observable
|
* @observable
|
||||||
* @api
|
* @api stable
|
||||||
*/
|
*/
|
||||||
ol.Overlay.prototype.setPositioning = function(positioning) {
|
ol.Overlay.prototype.setPositioning = function(positioning) {
|
||||||
this.set(ol.OverlayProperty.POSITIONING, positioning);
|
this.set(ol.OverlayProperty.POSITIONING, positioning);
|
||||||
|
|||||||
Reference in New Issue
Block a user