fix internal tag

maptalks · Aug 9, 2024 · ae68b54 · ae68b54
1 parent 27fe774
commit ae68b54
Show file tree

Hide file tree

Showing 117 changed files with 1,354 additions and 1,355 deletions.
diff --git a/src/control/Control.Attribution.ts b/src/control/Control.Attribution.ts
@@ -47,7 +47,7 @@ const layerEvents = 'addlayer removelayer setbaselayer baselayerremove';
  */
 class Attribution extends Control {
     options: AttributionOptionsType;
-    //@interlal
+    //@internal
     _attributionContainer: HTMLDivElement;
 
     buildOn() {
@@ -66,7 +66,7 @@ class Attribution extends Control {
         this.getMap().off(layerEvents, this._update, this);
     }
 
-    //@interlal
+    //@internal
     _update() {
         const map = this.getMap();
         if (!map) {

diff --git a/src/control/Control.Compass.ts b/src/control/Control.Compass.ts
@@ -22,9 +22,9 @@ const options = {
 
 class Compass extends Control {
     options: CompassOptionsType;
-    //@interlal
+    //@internal
     _compass: HTMLDivElement;
-    //@interlal
+    //@internal
     _bearing: number;
     /**
      * method to build DOM of the control
@@ -47,18 +47,18 @@ class Compass extends Control {
         this._rotateCompass();
     }
 
-    //@interlal
+    //@internal
     _getCompass() {
         const compass = createEl('div', 'maptalks-compass');
         return compass;
     }
 
-    //@interlal
+    //@internal
     _registerDomEvents() {
         on(this._compass, 'click', this._resetView, this);
     }
 
-    //@interlal
+    //@internal
     _rotateCompass() {
         const b = this.getMap().getBearing().toFixed(1);
         let bearing = parseFloat(b);
@@ -78,7 +78,7 @@ class Compass extends Control {
         delete this._bearing;
     }
 
-    //@interlal
+    //@internal
     _resetView() {
         const view = { bearing: 0 };
         this.getMap().animateTo(view);

diff --git a/src/control/Control.LayerSwitcher.ts b/src/control/Control.LayerSwitcher.ts
@@ -71,30 +71,30 @@ class LayerSwitcher extends Control {
         }
     }
 
-    //@interlal
+    //@internal
     _show() {
         if (!hasClass(this.container, 'shown')) {
             addClass(this.container, 'shown');
             this._createPanel();
         }
     }
 
-    //@interlal
+    //@internal
     _hide(e) {
         if (!this.panel.contains(e.toElement || e.relatedTarget)) {
             setClass(this.container, this.options['containerClass']);
         }
     }
 
-    //@interlal
+    //@internal
     _createPanel() {
         this.panel.innerHTML = '';
         const ul = createEl('ul');
         this.panel.appendChild(ul);
         this._renderLayers(this.getMap(), ul);
     }
 
-    //@interlal
+    //@internal
     _renderLayers(map: Map, elm: HTMLElement) {
         const base = map.getBaseLayer(),
             layers = map.getLayers(),
@@ -203,14 +203,14 @@ class LayerSwitcher extends Control {
         }
     }
 
-    //@interlal
+    //@internal
     _isExcluded(layer: Layer) {
         const id = layer.getId(),
             excludeLayers = this.options['excludeLayers'];
         return !(excludeLayers.length && excludeLayers.indexOf(id) >= 0);
     }
 
-    //@interlal
+    //@internal
     _renderLayer(layer, isBase?: boolean, parentChecked = true) {
         const li = createEl('li', 'layer'),
             label = createEl('label'),

diff --git a/src/control/Control.Overview.ts b/src/control/Control.Overview.ts
@@ -55,9 +55,9 @@ class Overview extends Control {
     options: OverviewOptionsType;
     mapContainer: HTMLDivElement;
     button: HTMLDivElement;
-    //@interlal
+    //@internal
     _overview: Map;
-    //@interlal
+    //@internal
     _perspective: Polygon;
 
     /**
@@ -145,7 +145,7 @@ class Overview extends Control {
         return this._overview;
     }
 
-    //@interlal
+    //@internal
     _onButtonClick() {
         if (!this._overview) {
             this.maxmize();
@@ -155,7 +155,7 @@ class Overview extends Control {
         this._updateButtonText();
     }
 
-    //@interlal
+    //@internal
     _updateButtonText() {
         if (this._overview) {
             this.button.innerHTML = '-';
@@ -164,7 +164,7 @@ class Overview extends Control {
         }
     }
 
-    //@interlal
+    //@internal
     _createOverview() {
         const map = this.getMap(),
             dom = this.mapContainer;
@@ -195,7 +195,7 @@ class Overview extends Control {
         this.fire('load');
     }
 
-    //@interlal
+    //@internal
     _getOverviewZoom() {
         const map = this.getMap(),
             zoom = map.getZoom(),
@@ -219,14 +219,14 @@ class Overview extends Control {
     }
 
 
-    //@interlal
+    //@internal
     _onDragEnd() {
         const center = this._perspective.getCenter();
         this._overview.setCenter(center);
         this.getMap().panTo(center);
     }
 
-    //@interlal
+    //@internal
     _getPerspectiveCoords() {
         const map = this.getMap();
         const projection = map.getProjection();
@@ -240,7 +240,7 @@ class Overview extends Control {
         });
     }
 
-    //@interlal
+    //@internal
     _update() {
         if (!this._overview) {
             return;
@@ -252,7 +252,7 @@ class Overview extends Control {
         this._overview.setCenterAndZoom(this.getMap().getCenter(), this._getOverviewZoom());
     }
 
-    //@interlal
+    //@internal
     _updateSpatialReference() {
         if (!this._overview) {
             return;
@@ -262,7 +262,7 @@ class Overview extends Control {
         this._overview.setSpatialReference(spatialRef);
     }
 
-    //@interlal
+    //@internal
     _updateBaseLayer() {
         if (!this._overview) {
             return;

diff --git a/src/control/Control.Panel.ts b/src/control/Control.Panel.ts
@@ -40,9 +40,9 @@ const options: PanelOptionsType = {
 class Panel extends Control {
     draggable: DragHandler;
     options: PanelOptionsType;
-    //@interlal
+    //@internal
     _startPos: Point;
-    //@interlal
+    //@internal
     _startPosition: DomPositionType;
 
     /**
@@ -148,7 +148,7 @@ class Panel extends Control {
         return this.options['content'];
     }
 
-    //@interlal
+    //@internal
     _cancelOn(domEvent) {
         const target = domEvent.srcElement || domEvent.target,
             tagName = target.tagName.toLowerCase();
@@ -162,7 +162,7 @@ class Panel extends Control {
         return false;
     }
 
-    //@interlal
+    //@internal
     _onDragStart(param) {
         this._startPos = param['mousePos'];
         this._startPosition = extend({}, this.getPosition());
@@ -178,7 +178,7 @@ class Panel extends Control {
         this.fire('dragstart', param);
     }
 
-    //@interlal
+    //@internal
     _onDragging(param) {
         const pos = param['mousePos'];
         const offset = pos.sub(this._startPos);
@@ -210,7 +210,7 @@ class Panel extends Control {
         this.fire('dragging', param);
     }
 
-    //@interlal
+    //@internal
     _onDragEnd(param) {
         delete this._startPos;
         delete this._startPosition;
@@ -230,7 +230,7 @@ class Panel extends Control {
      * Get the connect points of panel for connector lines.
      * @private
      */
-    //@interlal
+    //@internal
     _getConnectPoints() {
         const map = this.getMap();
         const containerPoint = this.getContainerPoint();

diff --git a/src/control/Control.Reset.ts b/src/control/Control.Reset.ts
@@ -22,9 +22,9 @@ const options: ResetOptionsType = {
 };
 
 class Reset extends Control {
-    //@interlal
+    //@internal
     _reset: HTMLDivElement;
-    //@interlal
+    //@internal
     _view: MapViewType;
     options: ResetOptionsType;
     /**
@@ -50,13 +50,13 @@ class Reset extends Control {
         this._view = view;
     }
 
-    //@interlal
+    //@internal
     _getReset() {
         const reset = createEl('div', 'maptalks-reset');
         return reset as HTMLDivElement;
     }
 
-    //@interlal
+    //@internal
     _registerDomEvents() {
         on(this._reset, 'click', this._resetView, this);
     }
@@ -66,7 +66,7 @@ class Reset extends Control {
         delete this._view;
     }
 
-    //@interlal
+    //@internal
     _resetView() {
         this.getMap().setView(this._view);
     }

diff --git a/src/control/Control.Scale.ts b/src/control/Control.Scale.ts
@@ -38,11 +38,11 @@ const options: ScaleOptionsType = {
 const EVENTS_TO_LISTEN = 'zoomend moving moveend';
 
 class Scale extends Control {
-    //@interlal
+    //@internal
     _scaleContainer: HTMLDivElement;
-    //@interlal
+    //@internal
     _mScale: HTMLDivElement;
-    //@interlal
+    //@internal
     _iScale: HTMLDivElement;
     options: ScaleOptionsType;
 
@@ -67,7 +67,7 @@ class Scale extends Control {
         this.getMap().off(EVENTS_TO_LISTEN, this._update, this);
     }
 
-    //@interlal
+    //@internal
     _addScales() {
         const css = 'border: 2px solid #000000;border-top: none;line-height: 1.1;padding: 0px;' +
             'color: #000000;font-size: 11px;text-align:center;white-space: nowrap;overflow: hidden' +
@@ -80,14 +80,14 @@ class Scale extends Control {
         }
     }
 
-    //@interlal
+    //@internal
     _update() {
         const map = this._map;
         const maxMeters = map.pixelToDistance(this.options['maxWidth'], 0);
         this._updateScales(maxMeters);
     }
 
-    //@interlal
+    //@internal
     _updateScales(maxMeters: number) {
         if (this.options['metric'] && maxMeters) {
             this._updateMetric(maxMeters);
@@ -97,15 +97,15 @@ class Scale extends Control {
         }
     }
 
-    //@interlal
+    //@internal
     _updateMetric(maxMeters: number) {
         const meters = this._getRoundNum(maxMeters),
             label = meters < 1000 ? meters + ' m' : (meters / 1000) + ' km';
 
         this._updateScale(this._mScale, label, meters / maxMeters);
     }
 
-    //@interlal
+    //@internal
     _updateImperial(maxMeters: number) {
         const maxFeet = maxMeters * 3.2808399;
         let maxMiles, miles, feet;
@@ -121,13 +121,13 @@ class Scale extends Control {
         }
     }
 
-    //@interlal
+    //@internal
     _updateScale(scale: HTMLDivElement, text: string, ratio: number) {
         scale['style']['width'] = Math.round(this.options['maxWidth'] * ratio) + 'px';
         scale['innerHTML'] = text;
     }
 
-    //@interlal
+    //@internal
     _getRoundNum(num: number) {
         const pow10 = Math.pow(10, (Math.floor(num) + '').length - 1);
         let d = num / pow10;

diff --git a/src/control/Control.Toolbar.ts b/src/control/Control.Toolbar.ts
@@ -119,7 +119,7 @@ class Toolbar extends Control {
         return dom;
     }
 
-    //@interlal
+    //@internal
     _createDropMenu(index: number) {
         const me = this;
 
@@ -181,7 +181,7 @@ class Toolbar extends Control {
         return menuDom;
     }
 
-    //@interlal
+    //@internal
     _getItems() {
         return this.options['items'] || [];
     }