Remove all inheritDoc tags from src/ol/style
This commit is contained in:
@@ -38,11 +38,10 @@ class CircleStyle extends RegularShape {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Clones the style.
|
* Clones the style.
|
||||||
* @return {CircleStyle} The cloned style.
|
* @return {CircleStyle} The cloned style.
|
||||||
* @override
|
* @api
|
||||||
* @api
|
*/
|
||||||
*/
|
|
||||||
clone() {
|
clone() {
|
||||||
const style = new CircleStyle({
|
const style = new CircleStyle({
|
||||||
fill: this.getFill() ? this.getFill().clone() : undefined,
|
fill: this.getFill() ? this.getFill().clone() : undefined,
|
||||||
|
|||||||
+14
-11
@@ -225,7 +225,9 @@ class Icon extends ImageStyle {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @inheritDoc
|
* Get the anchor point in pixels. The anchor determines the center point for the
|
||||||
|
* symbolizer.
|
||||||
|
* @return {Array<number>} Anchor.
|
||||||
* @api
|
* @api
|
||||||
*/
|
*/
|
||||||
getAnchor() {
|
getAnchor() {
|
||||||
@@ -293,7 +295,6 @@ class Icon extends ImageStyle {
|
|||||||
* Get the image icon.
|
* Get the image icon.
|
||||||
* @param {number} pixelRatio Pixel ratio.
|
* @param {number} pixelRatio Pixel ratio.
|
||||||
* @return {HTMLImageElement|HTMLCanvasElement} Image or Canvas element.
|
* @return {HTMLImageElement|HTMLCanvasElement} Image or Canvas element.
|
||||||
* @override
|
|
||||||
* @api
|
* @api
|
||||||
*/
|
*/
|
||||||
getImage(pixelRatio) {
|
getImage(pixelRatio) {
|
||||||
@@ -301,35 +302,37 @@ class Icon extends ImageStyle {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @override
|
* @return {import("../size.js").Size} Image size.
|
||||||
*/
|
*/
|
||||||
getImageSize() {
|
getImageSize() {
|
||||||
return this.iconImage_.getSize();
|
return this.iconImage_.getSize();
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @override
|
* @return {import("../size.js").Size} Size of the hit-detection image.
|
||||||
*/
|
*/
|
||||||
getHitDetectionImageSize() {
|
getHitDetectionImageSize() {
|
||||||
return this.getImageSize();
|
return this.getImageSize();
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @override
|
* @return {import("../ImageState.js").default} Image state.
|
||||||
*/
|
*/
|
||||||
getImageState() {
|
getImageState() {
|
||||||
return this.iconImage_.getImageState();
|
return this.iconImage_.getImageState();
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @override
|
* @param {number} pixelRatio Pixel ratio.
|
||||||
|
* @return {HTMLImageElement|HTMLCanvasElement} Image element.
|
||||||
*/
|
*/
|
||||||
getHitDetectionImage(pixelRatio) {
|
getHitDetectionImage(pixelRatio) {
|
||||||
return this.iconImage_.getHitDetectionImage(pixelRatio);
|
return this.iconImage_.getHitDetectionImage(pixelRatio);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @inheritDoc
|
* Get the origin of the symbolizer.
|
||||||
|
* @return {Array<number>} Origin.
|
||||||
* @api
|
* @api
|
||||||
*/
|
*/
|
||||||
getOrigin() {
|
getOrigin() {
|
||||||
@@ -371,7 +374,8 @@ class Icon extends ImageStyle {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @inheritDoc
|
* Get the size of the icon (in pixels).
|
||||||
|
* @return {import("../size.js").Size} Image size.
|
||||||
* @api
|
* @api
|
||||||
*/
|
*/
|
||||||
getSize() {
|
getSize() {
|
||||||
@@ -379,7 +383,7 @@ class Icon extends ImageStyle {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @override
|
* @param {function(import("../events/Event.js").default): void} listener Listener function.
|
||||||
*/
|
*/
|
||||||
listenImageChange(listener) {
|
listenImageChange(listener) {
|
||||||
this.iconImage_.addEventListener(EventType.CHANGE, listener);
|
this.iconImage_.addEventListener(EventType.CHANGE, listener);
|
||||||
@@ -390,7 +394,6 @@ class Icon extends ImageStyle {
|
|||||||
* When rendering a feature with an icon style, the vector renderer will
|
* When rendering a feature with an icon style, the vector renderer will
|
||||||
* automatically call this method. However, you might want to call this
|
* automatically call this method. However, you might want to call this
|
||||||
* method yourself for preloading or other purposes.
|
* method yourself for preloading or other purposes.
|
||||||
* @override
|
|
||||||
* @api
|
* @api
|
||||||
*/
|
*/
|
||||||
load() {
|
load() {
|
||||||
@@ -398,7 +401,7 @@ class Icon extends ImageStyle {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @override
|
* @param {function(import("../events/Event.js").default): void} listener Listener function.
|
||||||
*/
|
*/
|
||||||
unlistenImageChange(listener) {
|
unlistenImageChange(listener) {
|
||||||
this.iconImage_.removeEventListener(EventType.CHANGE, listener);
|
this.iconImage_.removeEventListener(EventType.CHANGE, listener);
|
||||||
|
|||||||
@@ -170,6 +170,7 @@ class IconImage extends EventTarget {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
* Get the size of the icon (in pixels).
|
||||||
* @return {import("../size.js").Size} Image size.
|
* @return {import("../size.js").Size} Image size.
|
||||||
*/
|
*/
|
||||||
getSize() {
|
getSize() {
|
||||||
|
|||||||
@@ -233,7 +233,6 @@ class ImageStyle {
|
|||||||
/**
|
/**
|
||||||
* @abstract
|
* @abstract
|
||||||
* @param {function(import("../events/Event.js").default): void} listener Listener function.
|
* @param {function(import("../events/Event.js").default): void} listener Listener function.
|
||||||
* @template T
|
|
||||||
*/
|
*/
|
||||||
listenImageChange(listener) {
|
listenImageChange(listener) {
|
||||||
abstract();
|
abstract();
|
||||||
@@ -250,7 +249,6 @@ class ImageStyle {
|
|||||||
/**
|
/**
|
||||||
* @abstract
|
* @abstract
|
||||||
* @param {function(import("../events/Event.js").default): void} listener Listener function.
|
* @param {function(import("../events/Event.js").default): void} listener Listener function.
|
||||||
* @template T
|
|
||||||
*/
|
*/
|
||||||
unlistenImageChange(listener) {
|
unlistenImageChange(listener) {
|
||||||
abstract();
|
abstract();
|
||||||
|
|||||||
@@ -171,7 +171,9 @@ class RegularShape extends ImageStyle {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @inheritDoc
|
* Get the anchor point in pixels. The anchor determines the center point for the
|
||||||
|
* symbolizer.
|
||||||
|
* @return {Array<number>} Anchor.
|
||||||
* @api
|
* @api
|
||||||
*/
|
*/
|
||||||
getAnchor() {
|
getAnchor() {
|
||||||
@@ -197,14 +199,17 @@ class RegularShape extends ImageStyle {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @inheritDoc
|
* @param {number} pixelRatio Pixel ratio.
|
||||||
|
* @return {HTMLImageElement|HTMLCanvasElement} Image element.
|
||||||
*/
|
*/
|
||||||
getHitDetectionImage(pixelRatio) {
|
getHitDetectionImage(pixelRatio) {
|
||||||
return this.hitDetectionCanvas_;
|
return this.hitDetectionCanvas_;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @inheritDoc
|
* Get the image icon.
|
||||||
|
* @param {number} pixelRatio Pixel ratio.
|
||||||
|
* @return {HTMLImageElement|HTMLCanvasElement} Image or Canvas element.
|
||||||
* @api
|
* @api
|
||||||
*/
|
*/
|
||||||
getImage(pixelRatio) {
|
getImage(pixelRatio) {
|
||||||
@@ -212,28 +217,29 @@ class RegularShape extends ImageStyle {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @inheritDoc
|
* @return {import("../size.js").Size} Image size.
|
||||||
*/
|
*/
|
||||||
getImageSize() {
|
getImageSize() {
|
||||||
return this.imageSize_;
|
return this.imageSize_;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @inheritDoc
|
* @return {import("../size.js").Size} Size of the hit-detection image.
|
||||||
*/
|
*/
|
||||||
getHitDetectionImageSize() {
|
getHitDetectionImageSize() {
|
||||||
return this.hitDetectionImageSize_;
|
return this.hitDetectionImageSize_;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @inheritDoc
|
* @return {import("../ImageState.js").default} Image state.
|
||||||
*/
|
*/
|
||||||
getImageState() {
|
getImageState() {
|
||||||
return ImageState.LOADED;
|
return ImageState.LOADED;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @inheritDoc
|
* Get the origin of the symbolizer.
|
||||||
|
* @return {Array<number>} Origin.
|
||||||
* @api
|
* @api
|
||||||
*/
|
*/
|
||||||
getOrigin() {
|
getOrigin() {
|
||||||
@@ -268,7 +274,8 @@ class RegularShape extends ImageStyle {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @inheritDoc
|
* Get the size of the symbolizer (in pixels).
|
||||||
|
* @return {import("../size.js").Size} Size.
|
||||||
* @api
|
* @api
|
||||||
*/
|
*/
|
||||||
getSize() {
|
getSize() {
|
||||||
@@ -285,17 +292,17 @@ class RegularShape extends ImageStyle {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @inheritDoc
|
* @param {function(import("../events/Event.js").default): void} listener Listener function.
|
||||||
*/
|
*/
|
||||||
listenImageChange(listener) {}
|
listenImageChange(listener) {}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @inheritDoc
|
* Load not yet loaded URI.
|
||||||
*/
|
*/
|
||||||
load() {}
|
load() {}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @inheritDoc
|
* @param {function(import("../events/Event.js").default): void} listener Listener function.
|
||||||
*/
|
*/
|
||||||
unlistenImageChange(listener) {}
|
unlistenImageChange(listener) {}
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user