Merge pull request #8418 from ahocevar/classdesc-constructor-api

Set api annotation on classdesc, not constructor
This commit is contained in:
Andreas Hocevar
2018-07-21 17:33:30 +02:00
committed by GitHub
101 changed files with 484 additions and 382 deletions
+1
View File
@@ -4,6 +4,7 @@
import {UNDEFINED} from './functions.js'; import {UNDEFINED} from './functions.js';
/** /**
* @classdesc
* Objects that need to clean up after themselves. * Objects that need to clean up after themselves.
*/ */
class Disposable { class Disposable {
-1
View File
@@ -53,7 +53,6 @@ import Style from './style/Style.js';
* @api * @api
*/ */
class Feature extends BaseObject { class Feature extends BaseObject {
/** /**
* @param {module:ol/geom/Geometry|Object.<string, *>=} opt_geometryOrProperties * @param {module:ol/geom/Geometry|Object.<string, *>=} opt_geometryOrProperties
* You may pass a Geometry object directly, or an object literal containing * You may pass a Geometry object directly, or an object literal containing
+1 -1
View File
@@ -7,6 +7,7 @@ import Spatial from '../filter/Spatial.js';
* @classdesc * @classdesc
* Represents a `<Contains>` operator to test whether a geometry-valued property * Represents a `<Contains>` operator to test whether a geometry-valued property
* contains a given geometry. * contains a given geometry.
* @api
*/ */
class Contains extends Spatial { class Contains extends Spatial {
@@ -15,7 +16,6 @@ class Contains extends Spatial {
* @param {!module:ol/geom/Geometry} geometry Geometry. * @param {!module:ol/geom/Geometry} geometry Geometry.
* @param {string=} opt_srsName SRS name. No srsName attribute will be * @param {string=} opt_srsName SRS name. No srsName attribute will be
* set on geometries when this is not provided. * set on geometries when this is not provided.
* @api
*/ */
constructor(geometryName, geometry, opt_srsName) { constructor(geometryName, geometry, opt_srsName) {
+1 -1
View File
@@ -6,6 +6,7 @@ import Comparison from '../filter/Comparison.js';
/** /**
* @classdesc * @classdesc
* Represents a `<During>` comparison operator. * Represents a `<During>` comparison operator.
* @api
*/ */
class During extends Comparison { class During extends Comparison {
@@ -13,7 +14,6 @@ class During extends Comparison {
* @param {!string} propertyName Name of the context property to compare. * @param {!string} propertyName Name of the context property to compare.
* @param {!string} begin The begin date in ISO-8601 format. * @param {!string} begin The begin date in ISO-8601 format.
* @param {!string} end The end date in ISO-8601 format. * @param {!string} end The end date in ISO-8601 format.
* @api
*/ */
constructor(propertyName, begin, end) { constructor(propertyName, begin, end) {
super('During', propertyName); super('During', propertyName);
+1 -1
View File
@@ -6,6 +6,7 @@ import ComparisonBinary from '../filter/ComparisonBinary.js';
/** /**
* @classdesc * @classdesc
* Represents a `<PropertyIsEqualTo>` comparison operator. * Represents a `<PropertyIsEqualTo>` comparison operator.
* @api
*/ */
class EqualTo extends ComparisonBinary { class EqualTo extends ComparisonBinary {
@@ -13,7 +14,6 @@ class EqualTo extends ComparisonBinary {
* @param {!string} propertyName Name of the context property to compare. * @param {!string} propertyName Name of the context property to compare.
* @param {!(string|number)} expression The value to compare. * @param {!(string|number)} expression The value to compare.
* @param {boolean=} opt_matchCase Case-sensitive? * @param {boolean=} opt_matchCase Case-sensitive?
* @api
*/ */
constructor(propertyName, expression, opt_matchCase) { constructor(propertyName, expression, opt_matchCase) {
super('PropertyIsEqualTo', propertyName, expression, opt_matchCase); super('PropertyIsEqualTo', propertyName, expression, opt_matchCase);
+1 -1
View File
@@ -6,13 +6,13 @@ import ComparisonBinary from '../filter/ComparisonBinary.js';
/** /**
* @classdesc * @classdesc
* Represents a `<PropertyIsGreaterThan>` comparison operator. * Represents a `<PropertyIsGreaterThan>` comparison operator.
* @api
*/ */
class GreaterThan extends ComparisonBinary { class GreaterThan extends ComparisonBinary {
/** /**
* @param {!string} propertyName Name of the context property to compare. * @param {!string} propertyName Name of the context property to compare.
* @param {!number} expression The value to compare. * @param {!number} expression The value to compare.
* @api
*/ */
constructor(propertyName, expression) { constructor(propertyName, expression) {
super('PropertyIsGreaterThan', propertyName, expression); super('PropertyIsGreaterThan', propertyName, expression);
+1 -1
View File
@@ -6,13 +6,13 @@ import ComparisonBinary from '../filter/ComparisonBinary.js';
/** /**
* @classdesc * @classdesc
* Represents a `<PropertyIsGreaterThanOrEqualTo>` comparison operator. * Represents a `<PropertyIsGreaterThanOrEqualTo>` comparison operator.
* @api
*/ */
class GreaterThanOrEqualTo extends ComparisonBinary { class GreaterThanOrEqualTo extends ComparisonBinary {
/** /**
* @param {!string} propertyName Name of the context property to compare. * @param {!string} propertyName Name of the context property to compare.
* @param {!number} expression The value to compare. * @param {!number} expression The value to compare.
* @api
*/ */
constructor(propertyName, expression) { constructor(propertyName, expression) {
super('PropertyIsGreaterThanOrEqualTo', propertyName, expression); super('PropertyIsGreaterThanOrEqualTo', propertyName, expression);
+1
View File
@@ -7,6 +7,7 @@ import Spatial from '../filter/Spatial.js';
* @classdesc * @classdesc
* Represents a `<Intersects>` operator to test whether a geometry-valued property * Represents a `<Intersects>` operator to test whether a geometry-valued property
* intersects a given geometry. * intersects a given geometry.
* @api
*/ */
class Intersects extends Spatial { class Intersects extends Spatial {
+1 -1
View File
@@ -6,6 +6,7 @@ import Comparison from '../filter/Comparison.js';
/** /**
* @classdesc * @classdesc
* Represents a `<PropertyIsBetween>` comparison operator. * Represents a `<PropertyIsBetween>` comparison operator.
* @api
*/ */
class IsBetween extends Comparison { class IsBetween extends Comparison {
@@ -13,7 +14,6 @@ class IsBetween extends Comparison {
* @param {!string} propertyName Name of the context property to compare. * @param {!string} propertyName Name of the context property to compare.
* @param {!number} lowerBoundary The lower bound of the range. * @param {!number} lowerBoundary The lower bound of the range.
* @param {!number} upperBoundary The upper bound of the range. * @param {!number} upperBoundary The upper bound of the range.
* @api
*/ */
constructor(propertyName, lowerBoundary, upperBoundary) { constructor(propertyName, lowerBoundary, upperBoundary) {
super('PropertyIsBetween', propertyName); super('PropertyIsBetween', propertyName);
+1 -1
View File
@@ -6,6 +6,7 @@ import Comparison from '../filter/Comparison.js';
/** /**
* @classdesc * @classdesc
* Represents a `<PropertyIsLike>` comparison operator. * Represents a `<PropertyIsLike>` comparison operator.
* @api
*/ */
class IsLike extends Comparison { class IsLike extends Comparison {
@@ -20,7 +21,6 @@ class IsLike extends Comparison {
* @param {string=} opt_escapeChar Escape character which can be used to escape * @param {string=} opt_escapeChar Escape character which can be used to escape
* the pattern characters. Default is '!'. * the pattern characters. Default is '!'.
* @param {boolean=} opt_matchCase Case-sensitive? * @param {boolean=} opt_matchCase Case-sensitive?
* @api
*/ */
constructor(propertyName, pattern, opt_wildCard, opt_singleChar, opt_escapeChar, opt_matchCase) { constructor(propertyName, pattern, opt_wildCard, opt_singleChar, opt_escapeChar, opt_matchCase) {
super('PropertyIsLike', propertyName); super('PropertyIsLike', propertyName);
+1 -1
View File
@@ -6,12 +6,12 @@ import Comparison from '../filter/Comparison.js';
/** /**
* @classdesc * @classdesc
* Represents a `<PropertyIsNull>` comparison operator. * Represents a `<PropertyIsNull>` comparison operator.
* @api
*/ */
class IsNull extends Comparison { class IsNull extends Comparison {
/** /**
* @param {!string} propertyName Name of the context property to compare. * @param {!string} propertyName Name of the context property to compare.
* @api
*/ */
constructor(propertyName) { constructor(propertyName) {
super('PropertyIsNull', propertyName); super('PropertyIsNull', propertyName);
+1 -1
View File
@@ -6,13 +6,13 @@ import ComparisonBinary from '../filter/ComparisonBinary.js';
/** /**
* @classdesc * @classdesc
* Represents a `<PropertyIsLessThan>` comparison operator. * Represents a `<PropertyIsLessThan>` comparison operator.
* @api
*/ */
class LessThan extends ComparisonBinary { class LessThan extends ComparisonBinary {
/** /**
* @param {!string} propertyName Name of the context property to compare. * @param {!string} propertyName Name of the context property to compare.
* @param {!number} expression The value to compare. * @param {!number} expression The value to compare.
* @api
*/ */
constructor(propertyName, expression) { constructor(propertyName, expression) {
super('PropertyIsLessThan', propertyName, expression); super('PropertyIsLessThan', propertyName, expression);
+1 -1
View File
@@ -6,13 +6,13 @@ import ComparisonBinary from '../filter/ComparisonBinary.js';
/** /**
* @classdesc * @classdesc
* Represents a `<PropertyIsLessThanOrEqualTo>` comparison operator. * Represents a `<PropertyIsLessThanOrEqualTo>` comparison operator.
* @api
*/ */
class LessThanOrEqualTo extends ComparisonBinary { class LessThanOrEqualTo extends ComparisonBinary {
/** /**
* @param {!string} propertyName Name of the context property to compare. * @param {!string} propertyName Name of the context property to compare.
* @param {!number} expression The value to compare. * @param {!number} expression The value to compare.
* @api
*/ */
constructor(propertyName, expression) { constructor(propertyName, expression) {
super('PropertyIsLessThanOrEqualTo', propertyName, expression); super('PropertyIsLessThanOrEqualTo', propertyName, expression);
+1 -1
View File
@@ -6,12 +6,12 @@ import Filter from '../filter/Filter.js';
/** /**
* @classdesc * @classdesc
* Represents a logical `<Not>` operator for a filter condition. * Represents a logical `<Not>` operator for a filter condition.
* @api
*/ */
class Not extends Filter { class Not extends Filter {
/** /**
* @param {!module:ol/format/filter/Filter} condition Filter condition. * @param {!module:ol/format/filter/Filter} condition Filter condition.
* @api
*/ */
constructor(condition) { constructor(condition) {
+1 -1
View File
@@ -6,6 +6,7 @@ import ComparisonBinary from '../filter/ComparisonBinary.js';
/** /**
* @classdesc * @classdesc
* Represents a `<PropertyIsNotEqualTo>` comparison operator. * Represents a `<PropertyIsNotEqualTo>` comparison operator.
* @api
*/ */
class NotEqualTo extends ComparisonBinary { class NotEqualTo extends ComparisonBinary {
@@ -13,7 +14,6 @@ class NotEqualTo extends ComparisonBinary {
* @param {!string} propertyName Name of the context property to compare. * @param {!string} propertyName Name of the context property to compare.
* @param {!(string|number)} expression The value to compare. * @param {!(string|number)} expression The value to compare.
* @param {boolean=} opt_matchCase Case-sensitive? * @param {boolean=} opt_matchCase Case-sensitive?
* @api
*/ */
constructor(propertyName, expression, opt_matchCase) { constructor(propertyName, expression, opt_matchCase) {
super('PropertyIsNotEqualTo', propertyName, expression, opt_matchCase); super('PropertyIsNotEqualTo', propertyName, expression, opt_matchCase);
+1 -1
View File
@@ -6,12 +6,12 @@ import LogicalNary from '../filter/LogicalNary.js';
/** /**
* @classdesc * @classdesc
* Represents a logical `<Or>` operator between two ore more filter conditions. * Represents a logical `<Or>` operator between two ore more filter conditions.
* @api
*/ */
class Or extends LogicalNary { class Or extends LogicalNary {
/** /**
* @param {...module:ol/format/filter/Filter} conditions Conditions. * @param {...module:ol/format/filter/Filter} conditions Conditions.
* @api
*/ */
constructor(conditions) { constructor(conditions) {
const params = ['Or'].concat(Array.prototype.slice.call(arguments)); const params = ['Or'].concat(Array.prototype.slice.call(arguments));
+1 -1
View File
@@ -7,6 +7,7 @@ import Spatial from '../filter/Spatial.js';
* @classdesc * @classdesc
* Represents a `<Within>` operator to test whether a geometry-valued property * Represents a `<Within>` operator to test whether a geometry-valued property
* is within a given geometry. * is within a given geometry.
* @api
*/ */
class Within extends Spatial { class Within extends Spatial {
@@ -15,7 +16,6 @@ class Within extends Spatial {
* @param {!module:ol/geom/Geometry} geometry Geometry. * @param {!module:ol/geom/Geometry} geometry Geometry.
* @param {string=} opt_srsName SRS name. No srsName attribute will be * @param {string=} opt_srsName SRS name. No srsName attribute will be
* set on geometries when this is not provided. * set on geometries when this is not provided.
* @api
*/ */
constructor(geometryName, geometry, opt_srsName) { constructor(geometryName, geometry, opt_srsName) {
super('Within', geometryName, geometry, opt_srsName); super('Within', geometryName, geometry, opt_srsName);
+1 -1
View File
@@ -15,12 +15,12 @@ import Interaction, {zoomByDelta} from '../interaction/Interaction.js';
/** /**
* @classdesc * @classdesc
* Allows the user to zoom by double-clicking on the map. * Allows the user to zoom by double-clicking on the map.
* @api
*/ */
class DoubleClickZoom extends Interaction { class DoubleClickZoom extends Interaction {
/** /**
* @param {module:ol/interaction/DoubleClickZoom~Options=} opt_options Options. * @param {module:ol/interaction/DoubleClickZoom~Options=} opt_options Options.
* @api
*/ */
constructor(opt_options) { constructor(opt_options) {
super({ super({
+1 -1
View File
@@ -83,13 +83,13 @@ class DragAndDropEvent extends Event {
/** /**
* @classdesc * @classdesc
* Handles input of vector data by drag and drop. * Handles input of vector data by drag and drop.
* @api
* *
* @fires module:ol/interaction/DragAndDrop~DragAndDropEvent * @fires module:ol/interaction/DragAndDrop~DragAndDropEvent
*/ */
class DragAndDrop extends Interaction { class DragAndDrop extends Interaction {
/** /**
* @param {module:ol/interaction/DragAndDrop~Options=} opt_options Options. * @param {module:ol/interaction/DragAndDrop~Options=} opt_options Options.
* @api
*/ */
constructor(opt_options) { constructor(opt_options) {
+1 -1
View File
@@ -107,11 +107,11 @@ class DragBoxEvent extends Event {
* This interaction is only supported for mouse devices. * This interaction is only supported for mouse devices.
* *
* @fires module:ol/interaction/DragBox~DragBoxEvent * @fires module:ol/interaction/DragBox~DragBoxEvent
* @api
*/ */
class DragBox extends PointerInteraction { class DragBox extends PointerInteraction {
/** /**
* @param {module:ol/interaction/DragBox~Options=} opt_options Options. * @param {module:ol/interaction/DragBox~Options=} opt_options Options.
* @api
*/ */
constructor(opt_options) { constructor(opt_options) {
+1 -1
View File
@@ -21,11 +21,11 @@ import PointerInteraction, {centroid as centroidFromPointers} from '../interacti
/** /**
* @classdesc * @classdesc
* Allows the user to pan the map by dragging the map. * Allows the user to pan the map by dragging the map.
* @api
*/ */
class DragPan extends PointerInteraction { class DragPan extends PointerInteraction {
/** /**
* @param {module:ol/interaction/DragPan~Options=} opt_options Options. * @param {module:ol/interaction/DragPan~Options=} opt_options Options.
* @api
*/ */
constructor(opt_options) { constructor(opt_options) {
+1 -1
View File
@@ -26,12 +26,12 @@ import PointerInteraction from '../interaction/Pointer.js';
* it to when the alt and shift keys are held down. * it to when the alt and shift keys are held down.
* *
* This interaction is only supported for mouse devices. * This interaction is only supported for mouse devices.
* @api
*/ */
class DragRotate extends PointerInteraction { class DragRotate extends PointerInteraction {
/** /**
* @param {module:ol/interaction/DragRotate~Options=} opt_options Options. * @param {module:ol/interaction/DragRotate~Options=} opt_options Options.
* @api
*/ */
constructor(opt_options) { constructor(opt_options) {
+1 -1
View File
@@ -27,12 +27,12 @@ import PointerInteraction from '../interaction/Pointer.js';
* This interaction is only supported for mouse devices. * This interaction is only supported for mouse devices.
* *
* And this interaction is not included in the default interactions. * And this interaction is not included in the default interactions.
* @api
*/ */
class DragRotateAndZoom extends PointerInteraction { class DragRotateAndZoom extends PointerInteraction {
/** /**
* @param {module:ol/interaction/DragRotateAndZoom~Options=} opt_options Options. * @param {module:ol/interaction/DragRotateAndZoom~Options=} opt_options Options.
* @api
*/ */
constructor(opt_options) { constructor(opt_options) {
+1 -1
View File
@@ -28,11 +28,11 @@ import DragBox from '../interaction/DragBox.js';
* *
* To change the style of the box, use CSS and the `.ol-dragzoom` selector, or * To change the style of the box, use CSS and the `.ol-dragzoom` selector, or
* your custom one configured with `className`. * your custom one configured with `className`.
* @api
*/ */
class DragZoom extends DragBox { class DragZoom extends DragBox {
/** /**
* @param {module:ol/interaction/DragZoom~Options=} opt_options Options. * @param {module:ol/interaction/DragZoom~Options=} opt_options Options.
* @api
*/ */
constructor(opt_options) { constructor(opt_options) {
const options = opt_options ? opt_options : {}; const options = opt_options ? opt_options : {};
+1 -1
View File
@@ -154,11 +154,11 @@ class DrawEvent extends Event {
* Interaction for drawing feature geometries. * Interaction for drawing feature geometries.
* *
* @fires module:ol/interaction/Draw~DrawEvent * @fires module:ol/interaction/Draw~DrawEvent
* @api
*/ */
class Draw extends PointerInteraction { class Draw extends PointerInteraction {
/** /**
* @param {module:ol/interaction/Draw~Options} options Options. * @param {module:ol/interaction/Draw~Options} options Options.
* @api
*/ */
constructor(options) { constructor(options) {
+1 -1
View File
@@ -77,11 +77,11 @@ class ExtentInteractionEvent extends Event {
* This interaction is only supported for mouse devices. * This interaction is only supported for mouse devices.
* *
* @fires module:ol/interaction/Extent~Event * @fires module:ol/interaction/Extent~Event
* @api
*/ */
class ExtentInteraction extends PointerInteraction { class ExtentInteraction extends PointerInteraction {
/** /**
* @param {module:ol/interaction/Extent~Options=} opt_options Options. * @param {module:ol/interaction/Extent~Options=} opt_options Options.
* @api
*/ */
constructor(opt_options) { constructor(opt_options) {
+1 -1
View File
@@ -29,11 +29,11 @@ import {clamp} from '../math.js';
* by a keyboard event not a button element event. * by a keyboard event not a button element event.
* Although interactions do not have a DOM element, some of them do render * Although interactions do not have a DOM element, some of them do render
* vectors and so are visible on the screen. * vectors and so are visible on the screen.
* @api
*/ */
class Interaction extends BaseObject { class Interaction extends BaseObject {
/** /**
* @param {module:ol/interaction/Interaction~InteractionOptions} options Options. * @param {module:ol/interaction/Interaction~InteractionOptions} options Options.
* @api
*/ */
constructor(options) { constructor(options) {
super(); super();
+1 -1
View File
@@ -32,11 +32,11 @@ import Interaction, {pan} from '../interaction/Interaction.js';
* element, focus will have to be on, and returned to, this element if the keys * element, focus will have to be on, and returned to, this element if the keys
* are to function. * are to function.
* See also {@link module:ol/interaction/KeyboardZoom~KeyboardZoom}. * See also {@link module:ol/interaction/KeyboardZoom~KeyboardZoom}.
* @api
*/ */
class KeyboardPan extends Interaction { class KeyboardPan extends Interaction {
/** /**
* @param {module:ol/interaction/KeyboardPan~Options=} opt_options Options. * @param {module:ol/interaction/KeyboardPan~Options=} opt_options Options.
* @api
*/ */
constructor(opt_options) { constructor(opt_options) {
+1 -1
View File
@@ -28,11 +28,11 @@ import Interaction, {zoomByDelta} from '../interaction/Interaction.js';
* element, focus will have to be on, and returned to, this element if the keys * element, focus will have to be on, and returned to, this element if the keys
* are to function. * are to function.
* See also {@link moudle:ol/interaction/KeyboardPan~KeyboardPan}. * See also {@link moudle:ol/interaction/KeyboardPan~KeyboardPan}.
* @api
*/ */
class KeyboardZoom extends Interaction { class KeyboardZoom extends Interaction {
/** /**
* @param {module:ol/interaction/KeyboardZoom~Options=} opt_options Options. * @param {module:ol/interaction/KeyboardZoom~Options=} opt_options Options.
* @api
*/ */
constructor(opt_options) { constructor(opt_options) {
+1 -1
View File
@@ -149,11 +149,11 @@ export class ModifyEvent extends Event {
* key is pressed. To configure the interaction with a different condition * key is pressed. To configure the interaction with a different condition
* for deletion, use the `deleteCondition` option. * for deletion, use the `deleteCondition` option.
* @fires module:ol/interaction/Modify~ModifyEvent * @fires module:ol/interaction/Modify~ModifyEvent
* @api
*/ */
class Modify extends PointerInteraction { class Modify extends PointerInteraction {
/** /**
* @param {module:ol/interaction/Modify~Options} options Options. * @param {module:ol/interaction/Modify~Options} options Options.
* @api
*/ */
constructor(options) { constructor(options) {
+1 -1
View File
@@ -46,11 +46,11 @@ export const Mode = {
/** /**
* @classdesc * @classdesc
* Allows the user to zoom the map by scrolling the mouse wheel. * Allows the user to zoom the map by scrolling the mouse wheel.
* @api
*/ */
class MouseWheelZoom extends Interaction { class MouseWheelZoom extends Interaction {
/** /**
* @param {module:ol/interaction/MouseWheelZoom~Options=} opt_options Options. * @param {module:ol/interaction/MouseWheelZoom~Options=} opt_options Options.
* @api
*/ */
constructor(opt_options) { constructor(opt_options) {
+1 -1
View File
@@ -20,11 +20,11 @@ import {disable} from '../rotationconstraint.js';
* @classdesc * @classdesc
* Allows the user to rotate the map by twisting with two fingers * Allows the user to rotate the map by twisting with two fingers
* on a touch screen. * on a touch screen.
* @api
*/ */
class PinchRotate extends PointerInteraction { class PinchRotate extends PointerInteraction {
/** /**
* @param {module:ol/interaction/PinchRotate~Options=} opt_options Options. * @param {module:ol/interaction/PinchRotate~Options=} opt_options Options.
* @api
*/ */
constructor(opt_options) { constructor(opt_options) {
+1 -1
View File
@@ -19,11 +19,11 @@ import PointerInteraction, {centroid as centroidFromPointers} from '../interacti
* @classdesc * @classdesc
* Allows the user to zoom the map by pinching with two fingers * Allows the user to zoom the map by pinching with two fingers
* on a touch screen. * on a touch screen.
* @api
*/ */
class PinchZoom extends PointerInteraction { class PinchZoom extends PointerInteraction {
/** /**
* @param {module:ol/interaction/PinchZoom~Options=} opt_options Options. * @param {module:ol/interaction/PinchZoom~Options=} opt_options Options.
* @api
*/ */
constructor(opt_options) { constructor(opt_options) {
+1 -1
View File
@@ -73,11 +73,11 @@ const handleMoveEvent = UNDEFINED;
* started. During a drag sequence the `handleDragEvent` user function is * started. During a drag sequence the `handleDragEvent` user function is
* called on `move` events. The drag sequence ends when the `handleUpEvent` * called on `move` events. The drag sequence ends when the `handleUpEvent`
* user function is called and returns `false`. * user function is called and returns `false`.
* @api
*/ */
class PointerInteraction extends Interaction { class PointerInteraction extends Interaction {
/** /**
* @param {module:ol/interaction/Pointer~Options=} opt_options Options. * @param {module:ol/interaction/Pointer~Options=} opt_options Options.
* @api
*/ */
constructor(opt_options) { constructor(opt_options) {
+1 -1
View File
@@ -152,11 +152,11 @@ class SelectEvent extends Event {
* Selected features are added to an internal unmanaged layer. * Selected features are added to an internal unmanaged layer.
* *
* @fires SelectEvent * @fires SelectEvent
* @api
*/ */
class Select extends Interaction { class Select extends Interaction {
/** /**
* @param {module:ol/interaction/Select~Options=} opt_options Options. * @param {module:ol/interaction/Select~Options=} opt_options Options.
* @api
*/ */
constructor(opt_options) { constructor(opt_options) {
+2 -1
View File
@@ -62,11 +62,12 @@ import RBush from '../structs/RBush.js';
* var snap = new Snap({ * var snap = new Snap({
* source: source * source: source
* }); * });
*
* @api
*/ */
class Snap extends PointerInteraction { class Snap extends PointerInteraction {
/** /**
* @param {module:ol/interaction/Snap~Options=} opt_options Options. * @param {module:ol/interaction/Snap~Options=} opt_options Options.
* @api
*/ */
constructor(opt_options) { constructor(opt_options) {
+1 -1
View File
@@ -91,11 +91,11 @@ export class TranslateEvent extends Event {
* Interaction for translating (moving) features. * Interaction for translating (moving) features.
* *
* @fires module:ol/interaction/Translate~TranslateEvent * @fires module:ol/interaction/Translate~TranslateEvent
* @api
*/ */
class Translate extends PointerInteraction { class Translate extends PointerInteraction {
/** /**
* @param {module:ol/interaction/Translate~Options=} opt_options Options. * @param {module:ol/interaction/Translate~Options=} opt_options Options.
* @api
*/ */
constructor(opt_options) { constructor(opt_options) {
super({ super({
+5 -3
View File
@@ -22,8 +22,7 @@ import {assign} from '../obj.js';
*/ */
class BaseLayer extends BaseObject { /**
/**
* @classdesc * @classdesc
* Abstract base class; normally only used for creating subclasses and not * Abstract base class; normally only used for creating subclasses and not
* instantiated in apps. * instantiated in apps.
@@ -31,9 +30,12 @@ class BaseLayer extends BaseObject {
* the options is set as a {@link module:ol/Object} property on the layer object, so * the options is set as a {@link module:ol/Object} property on the layer object, so
* is observable, and has get/set accessors. * is observable, and has get/set accessors.
* *
* @param {module:ol/layer/Base~Options} options Layer options.
* @api * @api
*/ */
class BaseLayer extends BaseObject {
/**
* @param {module:ol/layer/Base~Options} options Layer options.
*/
constructor(options) { constructor(options) {
super(); super();
+5 -3
View File
@@ -40,16 +40,18 @@ const Property = {
}; };
class LayerGroup extends BaseLayer { /**
/**
* @classdesc * @classdesc
* A {@link module:ol/Collection~Collection} of layers that are handled together. * A {@link module:ol/Collection~Collection} of layers that are handled together.
* *
* A generic `change` event is triggered when the group/Collection changes. * A generic `change` event is triggered when the group/Collection changes.
* *
* @param {module:ol/layer/Group~Options=} opt_options Layer options.
* @api * @api
*/ */
class LayerGroup extends BaseLayer {
/**
* @param {module:ol/layer/Group~Options=} opt_options Layer options.
*/
constructor(opt_options) { constructor(opt_options) {
const options = opt_options || {}; const options = opt_options || {};
+5 -3
View File
@@ -59,8 +59,7 @@ const Property = {
const DEFAULT_GRADIENT = ['#00f', '#0ff', '#0f0', '#ff0', '#f00']; const DEFAULT_GRADIENT = ['#00f', '#0ff', '#0f0', '#ff0', '#f00'];
class Heatmap extends VectorLayer { /**
/**
* @classdesc * @classdesc
* Layer for rendering vector data as a heatmap. * Layer for rendering vector data as a heatmap.
* Note that any property set in the options is set as a {@link module:ol/Object~BaseObject} * Note that any property set in the options is set as a {@link module:ol/Object~BaseObject}
@@ -68,9 +67,12 @@ class Heatmap extends VectorLayer {
* options means that `title` is observable, and has get/set accessors. * options means that `title` is observable, and has get/set accessors.
* *
* @fires module:ol/render/Event~RenderEvent * @fires module:ol/render/Event~RenderEvent
* @param {module:ol/layer/Heatmap~Options=} opt_options Options.
* @api * @api
*/ */
class Heatmap extends VectorLayer {
/**
* @param {module:ol/layer/Heatmap~Options=} opt_options Options.
*/
constructor(opt_options) { constructor(opt_options) {
const options = opt_options ? opt_options : {}; const options = opt_options ? opt_options : {};
+6 -4
View File
@@ -25,9 +25,7 @@ import Layer from '../layer/Layer.js';
*/ */
class ImageLayer extends Layer { /**
/**
* @classdesc * @classdesc
* Server-rendered images that are available for arbitrary extents and * Server-rendered images that are available for arbitrary extents and
* resolutions. * resolutions.
@@ -36,9 +34,13 @@ class ImageLayer extends Layer {
* options means that `title` is observable, and has get/set accessors. * options means that `title` is observable, and has get/set accessors.
* *
* @fires module:ol/render/Event~RenderEvent * @fires module:ol/render/Event~RenderEvent
* @param {module:ol/layer/Image~Options=} opt_options Layer options.
* @api * @api
*/ */
class ImageLayer extends Layer {
/**
* @param {module:ol/layer/Image~Options=} opt_options Layer options.
*/
constructor(opt_options) { constructor(opt_options) {
const options = opt_options ? opt_options : {}; const options = opt_options ? opt_options : {};
super(options); super(options);
+4 -4
View File
@@ -43,9 +43,7 @@ import SourceState from '../source/State.js';
* @property {number} minResolution * @property {number} minResolution
*/ */
/**
class Layer extends BaseLayer {
/**
* @classdesc * @classdesc
* Abstract base class; normally only used for creating subclasses and not * Abstract base class; normally only used for creating subclasses and not
* instantiated in apps. * instantiated in apps.
@@ -61,8 +59,10 @@ class Layer extends BaseLayer {
* A generic `change` event is fired when the state of the source changes. * A generic `change` event is fired when the state of the source changes.
* *
* @fires module:ol/render/Event~RenderEvent * @fires module:ol/render/Event~RenderEvent
*/
class Layer extends BaseLayer {
/**
* @param {module:ol/layer/Layer~Options} options Layer options. * @param {module:ol/layer/Layer~Options} options Layer options.
* @api
*/ */
constructor(options) { constructor(options) {
+5 -4
View File
@@ -29,9 +29,7 @@ import {assign} from '../obj.js';
* @property {boolean} [useInterimTilesOnError=true] Use interim tiles on error. * @property {boolean} [useInterimTilesOnError=true] Use interim tiles on error.
*/ */
/**
class TileLayer extends Layer {
/**
* @classdesc * @classdesc
* For layer sources that provide pre-rendered, tiled images in grids that are * For layer sources that provide pre-rendered, tiled images in grids that are
* organized by zoom levels for specific resolutions. * organized by zoom levels for specific resolutions.
@@ -39,9 +37,12 @@ class TileLayer extends Layer {
* property on the layer object; for example, setting `title: 'My Title'` in the * property on the layer object; for example, setting `title: 'My Title'` in the
* options means that `title` is observable, and has get/set accessors. * options means that `title` is observable, and has get/set accessors.
* *
* @param {module:ol/layer/Tile~Options=} opt_options Tile layer options.
* @api * @api
*/ */
class TileLayer extends Layer {
/**
* @param {module:ol/layer/Tile~Options=} opt_options Tile layer options.
*/
constructor(opt_options) { constructor(opt_options) {
const options = opt_options ? opt_options : {}; const options = opt_options ? opt_options : {};
+5 -3
View File
@@ -77,17 +77,19 @@ const Property = {
}; };
class VectorLayer extends Layer { /**
/**
* @classdesc * @classdesc
* Vector data that is rendered client-side. * Vector data that is rendered client-side.
* Note that any property set in the options is set as a {@link module:ol/Object~BaseObject} * Note that any property set in the options is set as a {@link module:ol/Object~BaseObject}
* property on the layer object; for example, setting `title: 'My Title'` in the * property on the layer object; for example, setting `title: 'My Title'` in the
* options means that `title` is observable, and has get/set accessors. * options means that `title` is observable, and has get/set accessors.
* *
* @param {module:ol/layer/Vector~Options=} opt_options Options.
* @api * @api
*/ */
class VectorLayer extends Layer {
/**
* @param {module:ol/layer/Vector~Options=} opt_options Options.
*/
constructor(opt_options) { constructor(opt_options) {
const options = opt_options ? const options = opt_options ?
opt_options : /** @type {module:ol/layer/Vector~Options} */ ({}); opt_options : /** @type {module:ol/layer/Vector~Options} */ ({});
+5 -2
View File
@@ -86,8 +86,7 @@ export const RenderType = {
*/ */
class VectorTileLayer extends VectorLayer { /**
/**
* @classdesc * @classdesc
* Layer for vector tile data that is rendered client-side. * Layer for vector tile data that is rendered client-side.
* Note that any property set in the options is set as a {@link module:ol/Object~BaseObject} * Note that any property set in the options is set as a {@link module:ol/Object~BaseObject}
@@ -97,6 +96,10 @@ class VectorTileLayer extends VectorLayer {
* @param {module:ol/layer/VectorTile~Options=} opt_options Options. * @param {module:ol/layer/VectorTile~Options=} opt_options Options.
* @api * @api
*/ */
class VectorTileLayer extends VectorLayer {
/**
* @param {module:ol/layer/VectorTile~Options=} opt_options Options.
*/
constructor(opt_options) { constructor(opt_options) {
const options = opt_options ? opt_options : {}; const options = opt_options ? opt_options : {};
+1
View File
@@ -3,6 +3,7 @@
*/ */
/** /**
* @classdesc
* Context for drawing geometries. A vector context is available on render * Context for drawing geometries. A vector context is available on render
* events and does not need to be constructed directly. * events and does not need to be constructed directly.
* @api * @api
+4 -3
View File
@@ -16,8 +16,7 @@ import VectorContext from '../VectorContext.js';
import {defaultTextAlign, defaultFillStyle, defaultLineCap, defaultLineDash, defaultLineDashOffset, defaultLineJoin, defaultLineWidth, defaultMiterLimit, defaultStrokeStyle, defaultTextBaseline, defaultFont} from '../canvas.js'; import {defaultTextAlign, defaultFillStyle, defaultLineCap, defaultLineDash, defaultLineDashOffset, defaultLineJoin, defaultLineWidth, defaultMiterLimit, defaultStrokeStyle, defaultTextBaseline, defaultFont} from '../canvas.js';
import {create as createTransform, compose as composeTransform} from '../../transform.js'; import {create as createTransform, compose as composeTransform} from '../../transform.js';
class CanvasImmediateRenderer extends VectorContext { /**
/**
* @classdesc * @classdesc
* A concrete subclass of {@link module:ol/render/VectorContext} that implements * A concrete subclass of {@link module:ol/render/VectorContext} that implements
* direct rendering of features and geometries to an HTML5 Canvas context. * direct rendering of features and geometries to an HTML5 Canvas context.
@@ -25,7 +24,9 @@ class CanvasImmediateRenderer extends VectorContext {
* provided to application code as vectorContext member of the * provided to application code as vectorContext member of the
* {@link module:ol/render/Event~RenderEvent} object associated with postcompose, precompose and * {@link module:ol/render/Event~RenderEvent} object associated with postcompose, precompose and
* render events emitted by layers and maps. * render events emitted by layers and maps.
* */
class CanvasImmediateRenderer extends VectorContext {
/**
* @param {CanvasRenderingContext2D} context Context. * @param {CanvasRenderingContext2D} context Context.
* @param {number} pixelRatio Pixel ratio. * @param {number} pixelRatio Pixel ratio.
* @param {module:ol/extent~Extent} extent Extent. * @param {module:ol/extent~Extent} extent Extent.
+5 -1
View File
@@ -13,11 +13,15 @@ import {layerRendererConstructors} from './Map.js';
import IntermediateCanvasRenderer from './IntermediateCanvas.js'; import IntermediateCanvasRenderer from './IntermediateCanvas.js';
import {create as createTransform, compose as composeTransform} from '../../transform.js'; import {create as createTransform, compose as composeTransform} from '../../transform.js';
/**
* @classdesc
* Canvas renderer for image layers.
* @api
*/
class CanvasImageLayerRenderer extends IntermediateCanvasRenderer { class CanvasImageLayerRenderer extends IntermediateCanvasRenderer {
/** /**
* @param {module:ol/layer/Image|module:ol/layer/Vector} imageLayer Image or vector layer. * @param {module:ol/layer/Image|module:ol/layer/Vector} imageLayer Image or vector layer.
* @api
*/ */
constructor(imageLayer) { constructor(imageLayer) {
+5 -2
View File
@@ -19,12 +19,15 @@ import SourceState from '../../source/State.js';
*/ */
export const layerRendererConstructors = []; export const layerRendererConstructors = [];
/**
* @classdesc
* Canvas map renderer.
* @api
*/
class CanvasMapRenderer extends MapRenderer { class CanvasMapRenderer extends MapRenderer {
/** /**
* @param {module:ol/PluggableMap} map Map. * @param {module:ol/PluggableMap} map Map.
* @api
*/ */
constructor(map) { constructor(map) {
super(map); super(map);
+5 -1
View File
@@ -11,12 +11,16 @@ import {containsExtent, createEmpty, equals, getIntersection, isEmpty} from '../
import IntermediateCanvasRenderer from '../canvas/IntermediateCanvas.js'; import IntermediateCanvasRenderer from '../canvas/IntermediateCanvas.js';
import {create as createTransform, compose as composeTransform} from '../../transform.js'; import {create as createTransform, compose as composeTransform} from '../../transform.js';
/**
* @classdesc
* Canvas renderer for tile layers.
* @api
*/
class CanvasTileLayerRenderer extends IntermediateCanvasRenderer { class CanvasTileLayerRenderer extends IntermediateCanvasRenderer {
/** /**
* @param {module:ol/layer/Tile|module:ol/layer/VectorTile} tileLayer Tile layer. * @param {module:ol/layer/Tile|module:ol/layer/VectorTile} tileLayer Tile layer.
* @param {boolean=} opt_noContext Skip the context creation. * @param {boolean=} opt_noContext Skip the context creation.
* @api
*/ */
constructor(tileLayer, opt_noContext) { constructor(tileLayer, opt_noContext) {
+5 -1
View File
@@ -15,11 +15,15 @@ import CanvasReplayGroup from '../../render/canvas/ReplayGroup.js';
import CanvasLayerRenderer from '../canvas/Layer.js'; import CanvasLayerRenderer from '../canvas/Layer.js';
import {defaultOrder as defaultRenderOrder, getTolerance as getRenderTolerance, getSquaredTolerance as getSquaredRenderTolerance, renderFeature} from '../vector.js'; import {defaultOrder as defaultRenderOrder, getTolerance as getRenderTolerance, getSquaredTolerance as getSquaredRenderTolerance, renderFeature} from '../vector.js';
/**
* @classdesc
* Canvas renderer for vector layers.
* @api
*/
class CanvasVectorLayerRenderer extends CanvasLayerRenderer { class CanvasVectorLayerRenderer extends CanvasLayerRenderer {
/** /**
* @param {module:ol/layer/Vector} vectorLayer Vector layer. * @param {module:ol/layer/Vector} vectorLayer Vector layer.
* @api
*/ */
constructor(vectorLayer) { constructor(vectorLayer) {
+5 -1
View File
@@ -47,11 +47,15 @@ const VECTOR_REPLAYS = {
}; };
/**
* @classdesc
* Canvas renderer for vector tile layers.
* @api
*/
class CanvasVectorTileLayerRenderer extends CanvasTileLayerRenderer { class CanvasVectorTileLayerRenderer extends CanvasTileLayerRenderer {
/** /**
* @param {module:ol/layer/VectorTile} layer VectorTile layer. * @param {module:ol/layer/VectorTile} layer VectorTile layer.
* @api
*/ */
constructor(layer) { constructor(layer) {
+5 -1
View File
@@ -21,12 +21,16 @@ import {
import {CLAMP_TO_EDGE} from '../../webgl.js'; import {CLAMP_TO_EDGE} from '../../webgl.js';
import {createTexture} from '../../webgl/Context.js'; import {createTexture} from '../../webgl/Context.js';
/**
* @classdesc
* WebGL renderer for image layers.
* @api
*/
class WebGLImageLayerRenderer extends WebGLLayerRenderer { class WebGLImageLayerRenderer extends WebGLLayerRenderer {
/** /**
* @param {module:ol/renderer/webgl/Map} mapRenderer Map renderer. * @param {module:ol/renderer/webgl/Map} mapRenderer Map renderer.
* @param {module:ol/layer/Image} imageLayer Tile layer. * @param {module:ol/layer/Image} imageLayer Tile layer.
* @api
*/ */
constructor(mapRenderer, imageLayer) { constructor(mapRenderer, imageLayer) {
+5 -1
View File
@@ -37,11 +37,15 @@ import ContextEventType from '../../webgl/ContextEventType.js';
const WEBGL_TEXTURE_CACHE_HIGH_WATER_MARK = 1024; const WEBGL_TEXTURE_CACHE_HIGH_WATER_MARK = 1024;
/**
* @classdesc
* WebGL map renderer.
* @api
*/
class WebGLMapRenderer extends MapRenderer { class WebGLMapRenderer extends MapRenderer {
/** /**
* @param {module:ol/PluggableMap} map Map. * @param {module:ol/PluggableMap} map Map.
* @api
*/ */
constructor(map) { constructor(map) {
super(map); super(map);
+5 -1
View File
@@ -24,12 +24,16 @@ import {
import {COLOR_BUFFER_BIT, BLEND, ARRAY_BUFFER, FLOAT, LINEAR, TRIANGLE_STRIP} from '../../webgl.js'; import {COLOR_BUFFER_BIT, BLEND, ARRAY_BUFFER, FLOAT, LINEAR, TRIANGLE_STRIP} from '../../webgl.js';
import WebGLBuffer from '../../webgl/Buffer.js'; import WebGLBuffer from '../../webgl/Buffer.js';
/**
* @classdesc
* WebGL renderer for tile layers.
* @api
*/
class WebGLTileLayerRenderer extends WebGLLayerRenderer { class WebGLTileLayerRenderer extends WebGLLayerRenderer {
/** /**
* @param {module:ol/renderer/webgl/Map} mapRenderer Map renderer. * @param {module:ol/renderer/webgl/Map} mapRenderer Map renderer.
* @param {module:ol/layer/Tile} tileLayer Tile layer. * @param {module:ol/layer/Tile} tileLayer Tile layer.
* @api
*/ */
constructor(mapRenderer, tileLayer) { constructor(mapRenderer, tileLayer) {
+6 -1
View File
@@ -10,12 +10,17 @@ import {defaultOrder as defaultRenderOrder, getTolerance as getRenderTolerance,
import WebGLLayerRenderer from '../webgl/Layer.js'; import WebGLLayerRenderer from '../webgl/Layer.js';
import {apply as applyTransform} from '../../transform.js'; import {apply as applyTransform} from '../../transform.js';
/**
* @classdesc
* WebGL renderer for vector layers.
* @api
*/
class WebGLVectorLayerRenderer extends WebGLLayerRenderer { class WebGLVectorLayerRenderer extends WebGLLayerRenderer {
/** /**
* @param {module:ol/renderer/webgl/Map} mapRenderer Map renderer. * @param {module:ol/renderer/webgl/Map} mapRenderer Map renderer.
* @param {module:ol/layer/Vector} vectorLayer Vector layer. * @param {module:ol/layer/Vector} vectorLayer Vector layer.
* @api
*/ */
constructor(mapRenderer, vectorLayer) { constructor(mapRenderer, vectorLayer) {
+4 -3
View File
@@ -17,12 +17,13 @@ import Triangulation from '../reproj/Triangulation.js';
*/ */
class ReprojImage extends ImageBase { /**
/**
* @classdesc * @classdesc
* Class encapsulating single reprojected image. * Class encapsulating single reprojected image.
* See {@link module:ol/source/Image~ImageSource}. * See {@link module:ol/source/Image~ImageSource}.
* */
class ReprojImage extends ImageBase {
/**
* @param {module:ol/proj/Projection} sourceProj Source projection (of the data). * @param {module:ol/proj/Projection} sourceProj Source projection (of the data).
* @param {module:ol/proj/Projection} targetProj Target projection. * @param {module:ol/proj/Projection} targetProj Target projection.
* @param {module:ol/extent~Extent} targetExtent Target extent. * @param {module:ol/extent~Extent} targetExtent Target extent.
+4 -2
View File
@@ -18,12 +18,14 @@ import Triangulation from '../reproj/Triangulation.js';
*/ */
class ReprojTile extends Tile { /**
/**
* @classdesc * @classdesc
* Class encapsulating single reprojected tile. * Class encapsulating single reprojected tile.
* See {@link module:ol/source/TileImage~TileImage}. * See {@link module:ol/source/TileImage~TileImage}.
* *
*/
class ReprojTile extends Tile {
/**
* @param {module:ol/proj/Projection} sourceProj Source projection. * @param {module:ol/proj/Projection} sourceProj Source projection.
* @param {module:ol/tilegrid/TileGrid} sourceTileGrid Source tile grid. * @param {module:ol/tilegrid/TileGrid} sourceTileGrid Source tile grid.
* @param {module:ol/proj/Projection} targetProj Target projection. * @param {module:ol/proj/Projection} targetProj Target projection.
+6 -4
View File
@@ -44,14 +44,16 @@ const TOS_ATTRIBUTION = '<a class="ol-attribution-bing-tos" ' +
* To disable the opacity transition, pass `transition: 0`. * To disable the opacity transition, pass `transition: 0`.
*/ */
class BingMaps extends TileImage {
/** /**
* @classdesc * @classdesc
* Layer source for Bing Maps tile data. * Layer source for Bing Maps tile data.
*
* @param {module:ol/source/BingMaps~Options=} options Bing Maps options.
* @api * @api
*/ */
class BingMaps extends TileImage {
/**
* @param {module:ol/source/BingMaps~Options=} options Bing Maps options.
*/
constructor(options) { constructor(options) {
const hidpi = options.hidpi !== undefined ? options.hidpi : false; const hidpi = options.hidpi !== undefined ? options.hidpi : false;
+5 -4
View File
@@ -31,14 +31,15 @@ import XYZ from '../source/XYZ.js';
*/ */
class CartoDB extends XYZ { /**
/**
* @classdesc * @classdesc
* Layer source for the CartoDB Maps API. * Layer source for the CartoDB Maps API.
*
* @param {module:ol/source/CartoDB~Options=} options CartoDB options.
* @api * @api
*/ */
class CartoDB extends XYZ {
/**
* @param {module:ol/source/CartoDB~Options=} options CartoDB options.
*/
constructor(options) { constructor(options) {
super({ super({
attributions: options.attributions, attributions: options.attributions,
+5 -4
View File
@@ -36,16 +36,17 @@ import VectorSource from '../source/Vector.js';
*/ */
class Cluster extends VectorSource { /**
/**
* @classdesc * @classdesc
* Layer source to cluster vector data. Works out of the box with point * Layer source to cluster vector data. Works out of the box with point
* geometries. For other geometry types, or if not all geometries should be * geometries. For other geometry types, or if not all geometries should be
* considered for clustering, a custom `geometryFunction` can be defined. * considered for clustering, a custom `geometryFunction` can be defined.
*
* @param {module:ol/source/Cluster~Options=} options Cluster options.
* @api * @api
*/ */
class Cluster extends VectorSource {
/**
* @param {module:ol/source/Cluster~Options=} options Cluster options.
*/
constructor(options) { constructor(options) {
super({ super({
attributions: options.attributions, attributions: options.attributions,
+9 -8
View File
@@ -41,13 +41,13 @@ const ImageSourceEventType = {
}; };
class ImageSourceEvent extends Event { /**
/**
* @classdesc * @classdesc
* Events emitted by {@link module:ol/source/Image~ImageSource} instances are instances of this * Events emitted by {@link module:ol/source/Image~ImageSource} instances are instances of this
* type. * type.
* */
class ImageSourceEvent extends Event {
/**
* @param {string} type Type. * @param {string} type Type.
* @param {module:ol/Image} image The image. * @param {module:ol/Image} image The image.
*/ */
@@ -77,16 +77,17 @@ class ImageSourceEvent extends Event {
*/ */
class ImageSource extends Source { /**
/**
* @classdesc * @classdesc
* Abstract base class; normally only used for creating subclasses and not * Abstract base class; normally only used for creating subclasses and not
* instantiated in apps. * instantiated in apps.
* Base class for sources providing a single image. * Base class for sources providing a single image.
*
* @param {module:ol/source/Image~Options} options Single image source options.
* @api * @api
*/ */
class ImageSource extends Source {
/**
* @param {module:ol/source/Image~Options} options Single image source options.
*/
constructor(options) { constructor(options) {
super({ super({
attributions: options.attributions, attributions: options.attributions,
+5 -3
View File
@@ -39,8 +39,7 @@ import {appendParams} from '../uri.js';
*/ */
class ImageArcGISRest extends ImageSource { /**
/**
* @classdesc * @classdesc
* Source for data from ArcGIS Rest services providing single, untiled images. * Source for data from ArcGIS Rest services providing single, untiled images.
* Useful when underlying map service has labels. * Useful when underlying map service has labels.
@@ -50,9 +49,12 @@ class ImageArcGISRest extends ImageSource {
* {@link module:ol/source/TileArcGISRest} data source. * {@link module:ol/source/TileArcGISRest} data source.
* *
* @fires ol/source/Image~ImageSourceEvent * @fires ol/source/Image~ImageSourceEvent
* @param {module:ol/source/ImageArcGISRest~Options=} opt_options Image ArcGIS Rest Options.
* @api * @api
*/ */
class ImageArcGISRest extends ImageSource {
/**
* @param {module:ol/source/ImageArcGISRest~Options=} opt_options Image ArcGIS Rest Options.
*/
constructor(opt_options) { constructor(opt_options) {
const options = opt_options || {}; const options = opt_options || {};
+5 -4
View File
@@ -42,14 +42,15 @@ import ImageSource from '../source/Image.js';
*/ */
class ImageCanvasSource extends ImageSource { /**
/**
* @classdesc * @classdesc
* Base class for image sources where a canvas element is the image. * Base class for image sources where a canvas element is the image.
*
* @param {module:ol/source/ImageCanvas~Options=} options ImageCanvas options.
* @api * @api
*/ */
class ImageCanvasSource extends ImageSource {
/**
* @param {module:ol/source/ImageCanvas~Options=} options ImageCanvas options.
*/
constructor(options) { constructor(options) {
super({ super({
+5 -3
View File
@@ -32,15 +32,17 @@ import {appendParams} from '../uri.js';
*/ */
class ImageMapGuide extends ImageSource { /**
/**
* @classdesc * @classdesc
* Source for images from Mapguide servers * Source for images from Mapguide servers
* *
* @fires ol/source/Image~ImageSourceEvent * @fires ol/source/Image~ImageSourceEvent
* @param {module:ol/source/ImageMapGuide~Options=} options ImageMapGuide options.
* @api * @api
*/ */
class ImageMapGuide extends ImageSource {
/**
* @param {module:ol/source/ImageMapGuide~Options=} options ImageMapGuide options.
*/
constructor(options) { constructor(options) {
super({ super({
+5 -4
View File
@@ -28,14 +28,15 @@ import ImageSource, {defaultImageLoadFunction} from '../source/Image.js';
*/ */
class Static extends ImageSource { /**
/**
* @classdesc * @classdesc
* A layer source for displaying a single, static image. * A layer source for displaying a single, static image.
*
* @param {module:ol/source/ImageStatic~Options=} options ImageStatic options.
* @api * @api
*/ */
class Static extends ImageSource {
/**
* @param {module:ol/source/ImageStatic~Options=} options ImageStatic options.
*/
constructor(options) { constructor(options) {
const imageExtent = options.imageExtent; const imageExtent = options.imageExtent;
+5 -3
View File
@@ -51,15 +51,17 @@ const GETFEATUREINFO_IMAGE_SIZE = [101, 101];
*/ */
class ImageWMS extends ImageSource { /**
/**
* @classdesc * @classdesc
* Source for WMS servers providing single, untiled images. * Source for WMS servers providing single, untiled images.
* *
* @fires ol/source/Image~ImageSourceEvent * @fires ol/source/Image~ImageSourceEvent
* @param {module:ol/source/ImageWMS~Options=} [opt_options] ImageWMS options.
* @api * @api
*/ */
class ImageWMS extends ImageSource {
/**
* @param {module:ol/source/ImageWMS~Options=} [opt_options] ImageWMS options.
*/
constructor(opt_options) { constructor(opt_options) {
const options = opt_options || {}; const options = opt_options || {};
+5 -5
View File
@@ -41,15 +41,15 @@ export const ATTRIBUTION = '&copy; ' +
*/ */
class OSM extends XYZ { /**
/**
* @classdesc * @classdesc
* Layer source for the OpenStreetMap tile server. * Layer source for the OpenStreetMap tile server.
*
* @param {module:ol/source/OSM~Options=} [opt_options] Open Street Map options.
* @api * @api
*/ */
class OSM extends XYZ {
/**
* @param {module:ol/source/OSM~Options=} [opt_options] Open Street Map options.
*/
constructor(opt_options) { constructor(opt_options) {
const options = opt_options || {}; const options = opt_options || {};
+9 -7
View File
@@ -72,13 +72,13 @@ const RasterOperationType = {
}; };
class RasterSourceEvent extends Event { /**
/**
* @classdesc * @classdesc
* Events emitted by {@link module:ol/source/Raster} instances are instances of this * Events emitted by {@link module:ol/source/Raster} instances are instances of this
* type. * type.
* */
class RasterSourceEvent extends Event {
/**
* @param {string} type Type. * @param {string} type Type.
* @param {module:ol/PluggableMap~FrameState} frameState The frame state. * @param {module:ol/PluggableMap~FrameState} frameState The frame state.
* @param {Object} data An object made available to operations. * @param {Object} data An object made available to operations.
@@ -133,17 +133,19 @@ class RasterSourceEvent extends Event {
*/ */
class RasterSource extends ImageSource { /**
/**
* @classdesc * @classdesc
* A source that transforms data from any number of input sources using an * A source that transforms data from any number of input sources using an
* {@link module:ol/source/Raster~Operation} function to transform input pixel values into * {@link module:ol/source/Raster~Operation} function to transform input pixel values into
* output pixel values. * output pixel values.
* *
* @fires ol/source/Raster~RasterSourceEvent * @fires ol/source/Raster~RasterSourceEvent
* @param {module:ol/source/Raster~Options=} options Options.
* @api * @api
*/ */
class RasterSource extends ImageSource {
/**
* @param {module:ol/source/Raster~Options=} options Options.
*/
constructor(options) { constructor(options) {
super({}); super({});
+5 -4
View File
@@ -37,18 +37,19 @@ import SourceState from '../source/State.js';
*/ */
class Source extends BaseObject { /**
/**
* @classdesc * @classdesc
* Abstract base class; normally only used for creating subclasses and not * Abstract base class; normally only used for creating subclasses and not
* instantiated in apps. * instantiated in apps.
* Base class for {@link module:ol/layer/Layer~Layer} sources. * Base class for {@link module:ol/layer/Layer~Layer} sources.
* *
* A generic `change` event is triggered when the state of the source changes. * A generic `change` event is triggered when the state of the source changes.
*
* @param {module:ol/source/Source~Options} options Source options.
* @api * @api
*/ */
class Source extends BaseObject {
/**
* @param {module:ol/source/Source~Options} options Source options.
*/
constructor(options) { constructor(options) {
super(); super();
+5 -5
View File
@@ -109,15 +109,15 @@ const ProviderConfig = {
*/ */
class Stamen extends XYZ { /**
/**
* @classdesc * @classdesc
* Layer source for the Stamen tile server. * Layer source for the Stamen tile server.
*
* @param {module:ol/source/Stamen~Options=} options Stamen options.
* @api * @api
*/ */
class Stamen extends XYZ {
/**
* @param {module:ol/source/Stamen~Options=} options Stamen options.
*/
constructor(options) { constructor(options) {
const i = options.layer.indexOf('-'); const i = options.layer.indexOf('-');
const provider = i == -1 ? options.layer : options.layer.slice(0, i); const provider = i == -1 ? options.layer : options.layer.slice(0, i);
+8 -7
View File
@@ -27,16 +27,17 @@ import {wrapX, getForProjection as getTileGridForProjection} from '../tilegrid.j
*/ */
class TileSource extends Source { /**
/**
* @classdesc * @classdesc
* Abstract base class; normally only used for creating subclasses and not * Abstract base class; normally only used for creating subclasses and not
* instantiated in apps. * instantiated in apps.
* Base class for sources providing images divided into a tile grid. * Base class for sources providing images divided into a tile grid.
*
* @param {module:ol/source/Tile~Options=} options SourceTile source options.
* @api * @api
*/ */
class TileSource extends Source {
/**
* @param {module:ol/source/Tile~Options=} options SourceTile source options.
*/
constructor(options) { constructor(options) {
super({ super({
@@ -307,12 +308,12 @@ TileSource.prototype.useTile = UNDEFINED;
* @classdesc * @classdesc
* Events emitted by {@link module:ol/source/Tile~TileSource} instances are instances of this * Events emitted by {@link module:ol/source/Tile~TileSource} instances are instances of this
* type. * type.
* */
export class TileSourceEvent extends Event {
/**
* @param {string} type Type. * @param {string} type Type.
* @param {module:ol/Tile} tile The tile. * @param {module:ol/Tile} tile The tile.
*/ */
export class TileSourceEvent extends Event {
constructor(type, tile) { constructor(type, tile) {
super(type); super(type);
+5 -4
View File
@@ -51,18 +51,19 @@ import {appendParams} from '../uri.js';
*/ */
class TileArcGISRest extends TileImage { /**
/**
* @classdesc * @classdesc
* Layer source for tile data from ArcGIS Rest services. Map and Image * Layer source for tile data from ArcGIS Rest services. Map and Image
* Services are supported. * Services are supported.
* *
* For cached ArcGIS services, better performance is available using the * For cached ArcGIS services, better performance is available using the
* {@link module:ol/source/XYZ~XYZ} data source. * {@link module:ol/source/XYZ~XYZ} data source.
*
* @param {module:ol/source/TileArcGISRest~Options=} opt_options Tile ArcGIS Rest options.
* @api * @api
*/ */
class TileArcGISRest extends TileImage {
/**
* @param {module:ol/source/TileArcGISRest~Options=} opt_options Tile ArcGIS Rest options.
*/
constructor(opt_options) { constructor(opt_options) {
const options = opt_options || {}; const options = opt_options || {};
+5 -4
View File
@@ -80,18 +80,19 @@ class LabeledTile extends Tile {
*/ */
class TileDebug extends TileSource { /**
/**
* @classdesc * @classdesc
* A pseudo tile source, which does not fetch tiles from a server, but renders * A pseudo tile source, which does not fetch tiles from a server, but renders
* a grid outline for the tile grid/projection along with the coordinates for * a grid outline for the tile grid/projection along with the coordinates for
* each tile. See examples/canvas-tiles for an example. * each tile. See examples/canvas-tiles for an example.
* *
* Uses Canvas context2d, so requires Canvas support. * Uses Canvas context2d, so requires Canvas support.
*
* @param {module:ol/source/TileDebug~Options=} options Debug tile options.
* @api * @api
*/ */
class TileDebug extends TileSource {
/**
* @param {module:ol/source/TileDebug~Options=} options Debug tile options.
*/
constructor(options) { constructor(options) {
super({ super({
+5 -3
View File
@@ -54,15 +54,17 @@ import {getForProjection as getTileGridForProjection} from '../tilegrid.js';
*/ */
class TileImage extends UrlTile { /**
/**
* @classdesc * @classdesc
* Base class for sources providing images divided into a tile grid. * Base class for sources providing images divided into a tile grid.
* *
* @fires module:ol/source/Tile~TileSourceEvent * @fires module:ol/source/Tile~TileSourceEvent
* @param {module:ol/source/TileImage~Options=} options Image tile options.
* @api * @api
*/ */
class TileImage extends UrlTile {
/**
* @param {module:ol/source/TileImage~Options=} options Image tile options.
*/
constructor(options) { constructor(options) {
super({ super({
+5 -4
View File
@@ -44,14 +44,15 @@ import {createXYZ, extentFromProjection} from '../tilegrid.js';
*/ */
class TileJSON extends TileImage { /**
/**
* @classdesc * @classdesc
* Layer source for tile data in TileJSON format. * Layer source for tile data in TileJSON format.
*
* @param {module:ol/source/TileJSON~Options=} options TileJSON options.
* @api * @api
*/ */
class TileJSON extends TileImage {
/**
* @param {module:ol/source/TileJSON~Options=} options TileJSON options.
*/
constructor(options) { constructor(options) {
super({ super({
attributions: options.attributions, attributions: options.attributions,
+5 -4
View File
@@ -71,14 +71,15 @@ import {appendParams} from '../uri.js';
*/ */
class TileWMS extends TileImage { /**
/**
* @classdesc * @classdesc
* Layer source for tile data from WMS servers. * Layer source for tile data from WMS servers.
*
* @param {module:ol/source/TileWMS~Options=} [opt_options] Tile WMS options.
* @api * @api
*/ */
class TileWMS extends TileImage {
/**
* @param {module:ol/source/TileWMS~Options=} [opt_options] Tile WMS options.
*/
constructor(opt_options) { constructor(opt_options) {
const options = opt_options || {}; const options = opt_options || {};
+8 -8
View File
@@ -17,7 +17,9 @@ import {getKeyZXY} from '../tilecoord.js';
import {createXYZ, extentFromProjection} from '../tilegrid.js'; import {createXYZ, extentFromProjection} from '../tilegrid.js';
/** export class CustomTile extends Tile {
/**
* @param {module:ol/tilecoord~TileCoord} tileCoord Tile coordinate. * @param {module:ol/tilecoord~TileCoord} tileCoord Tile coordinate.
* @param {module:ol/TileState} state State. * @param {module:ol/TileState} state State.
* @param {string} src Image source URI. * @param {string} src Image source URI.
@@ -25,8 +27,6 @@ import {createXYZ, extentFromProjection} from '../tilegrid.js';
* @param {boolean} preemptive Load the tile when visible (before it's needed). * @param {boolean} preemptive Load the tile when visible (before it's needed).
* @param {boolean} jsonp Load the tile as a script. * @param {boolean} jsonp Load the tile as a script.
*/ */
export class CustomTile extends Tile {
constructor(tileCoord, state, src, extent, preemptive, jsonp) { constructor(tileCoord, state, src, extent, preemptive, jsonp) {
super(tileCoord, state); super(tileCoord, state);
@@ -267,15 +267,15 @@ CustomTile.prototype.load = function() {
*/ */
class UTFGrid extends TileSource { /**
/**
* @classdesc * @classdesc
* Layer source for UTFGrid interaction data loaded from TileJSON format. * Layer source for UTFGrid interaction data loaded from TileJSON format.
*
* @param {module:ol/source/UTFGrid~Options=} options Source options.
* @api * @api
*/ */
class UTFGrid extends TileSource {
/**
* @param {module:ol/source/UTFGrid~Options=} options Source options.
*/
constructor(options) { constructor(options) {
super({ super({
projection: getProjection('EPSG:3857'), projection: getProjection('EPSG:3857'),
+4 -2
View File
@@ -27,12 +27,14 @@ import {getKeyZXY} from '../tilecoord.js';
*/ */
class UrlTile extends TileSource { /**
/**
* @classdesc * @classdesc
* Base class for sources providing tiles divided into a tile grid over http. * Base class for sources providing tiles divided into a tile grid over http.
* *
* @fires module:ol/source/TileEvent * @fires module:ol/source/TileEvent
*/
class UrlTile extends TileSource {
/**
* @param {module:ol/source/UrlTile~Options=} options Image tile options. * @param {module:ol/source/UrlTile~Options=} options Image tile options.
*/ */
constructor(options) { constructor(options) {
+9 -7
View File
@@ -35,12 +35,13 @@ import RBush from '../structs/RBush.js';
* @classdesc * @classdesc
* Events emitted by {@link module:ol/source/Vector} instances are instances of this * Events emitted by {@link module:ol/source/Vector} instances are instances of this
* type. * type.
*
* @param {string} type Type.
* @param {module:ol/Feature=} opt_feature Feature.
*/ */
export class VectorSourceEvent extends Event { export class VectorSourceEvent extends Event {
/**
* @param {string} type Type.
* @param {module:ol/Feature=} opt_feature Feature.
*/
constructor(type, opt_feature) { constructor(type, opt_feature) {
super(type); super(type);
@@ -147,18 +148,19 @@ export class VectorSourceEvent extends Event {
*/ */
class VectorSource extends Source { /**
/**
* @classdesc * @classdesc
* Provides a source of features for vector layers. Vector features provided * Provides a source of features for vector layers. Vector features provided
* by this source are suitable for editing. See {@link module:ol/source/VectorTile~VectorTile} for * by this source are suitable for editing. See {@link module:ol/source/VectorTile~VectorTile} for
* vector data that is optimized for rendering. * vector data that is optimized for rendering.
* *
* @fires ol/source/Vector~VectorSourceEvent * @fires ol/source/Vector~VectorSourceEvent
* @param {module:ol/source/Vector~Options=} opt_options Vector source options.
* @api * @api
*/ */
class VectorSource extends Source {
/**
* @param {module:ol/source/Vector~Options=} opt_options Vector source options.
*/
constructor(opt_options) { constructor(opt_options) {
const options = opt_options || {}; const options = opt_options || {};
+5 -4
View File
@@ -58,9 +58,7 @@ import {createXYZ, extentFromProjection, createForProjection} from '../tilegrid.
*/ */
class VectorTile extends UrlTile { /**
/**
* @classdesc * @classdesc
* Class for layer sources providing vector data divided into a tile grid, to be * Class for layer sources providing vector data divided into a tile grid, to be
* used with {@link module:ol/layer/VectorTile~VectorTile}. Although this source receives tiles * used with {@link module:ol/layer/VectorTile~VectorTile}. Although this source receives tiles
@@ -71,9 +69,12 @@ class VectorTile extends UrlTile {
* editing. * editing.
* *
* @fires module:ol/source/Tile~TileSourceEvent * @fires module:ol/source/Tile~TileSourceEvent
* @param {module:ol/source/VectorTile~Options=} options Vector tile options.
* @api * @api
*/ */
class VectorTile extends UrlTile {
/**
* @param {module:ol/source/VectorTile~Options=} options Vector tile options.
*/
constructor(options) { constructor(options) {
const projection = options.projection || 'EPSG:3857'; const projection = options.projection || 'EPSG:3857';
+5 -5
View File
@@ -56,15 +56,15 @@ import {appendParams} from '../uri.js';
*/ */
class WMTS extends TileImage { /**
/**
* @classdesc * @classdesc
* Layer source for tile data from WMTS servers. * Layer source for tile data from WMTS servers.
*
* @param {module:ol/source/WMTS~Options=} options WMTS options.
* @api * @api
*/ */
class WMTS extends TileImage {
/**
* @param {module:ol/source/WMTS~Options=} options WMTS options.
*/
constructor(options) { constructor(options) {
// TODO: add support for TileMatrixLimits // TODO: add support for TileMatrixLimits
+5 -5
View File
@@ -44,9 +44,7 @@ import {createXYZ, extentFromProjection} from '../tilegrid.js';
*/ */
class XYZ extends TileImage { /**
/**
* @classdesc * @classdesc
* Layer source for tile data with URLs in a set XYZ format that are * Layer source for tile data with URLs in a set XYZ format that are
* defined in a URL template. By default, this follows the widely-used * defined in a URL template. By default, this follows the widely-used
@@ -62,10 +60,12 @@ class XYZ extends TileImage {
* coordinate[1] + '/' + coordinate[2] + '.png'; * coordinate[1] + '/' + coordinate[2] + '.png';
* } * }
* *
*
* @param {module:ol/source/XYZ~Options=} opt_options XYZ options.
* @api * @api
*/ */
class XYZ extends TileImage {
/**
* @param {module:ol/source/XYZ~Options=} opt_options XYZ options.
*/
constructor(opt_options) { constructor(opt_options) {
const options = opt_options || {}; const options = opt_options || {};
const projection = options.projection !== undefined ? const projection = options.projection !== undefined ?
+9 -8
View File
@@ -23,7 +23,9 @@ const TierSizeCalculation = {
}; };
/** export class CustomTile extends ImageTile {
/**
* @param {module:ol/tilegrid/TileGrid} tileGrid TileGrid that the tile belongs to. * @param {module:ol/tilegrid/TileGrid} tileGrid TileGrid that the tile belongs to.
* @param {module:ol/tilecoord~TileCoord} tileCoord Tile coordinate. * @param {module:ol/tilecoord~TileCoord} tileCoord Tile coordinate.
* @param {module:ol/TileState} state State. * @param {module:ol/TileState} state State.
@@ -32,8 +34,6 @@ const TierSizeCalculation = {
* @param {module:ol/Tile~LoadFunction} tileLoadFunction Tile load function. * @param {module:ol/Tile~LoadFunction} tileLoadFunction Tile load function.
* @param {module:ol/Tile~Options=} opt_options Tile options. * @param {module:ol/Tile~Options=} opt_options Tile options.
*/ */
export class CustomTile extends ImageTile {
constructor(tileGrid, tileCoord, state, src, crossOrigin, tileLoadFunction, opt_options) { constructor(tileGrid, tileCoord, state, src, crossOrigin, tileLoadFunction, opt_options) {
super(tileCoord, state, src, crossOrigin, tileLoadFunction, opt_options); super(tileCoord, state, src, crossOrigin, tileLoadFunction, opt_options);
@@ -115,16 +115,17 @@ CustomTile.prototype.getImage = function() {
*/ */
class Zoomify extends TileImage { /**
/**
* @classdesc * @classdesc
* Layer source for tile data in Zoomify format (both Zoomify and Internet * Layer source for tile data in Zoomify format (both Zoomify and Internet
* Imaging Protocol are supported). * Imaging Protocol are supported).
*
* @param {module:ol/source/Zoomify~Options=} opt_options Options.
* @api * @api
*/ */
class Zoomify extends TileImage {
/**
* @param {module:ol/source/Zoomify~Options=} opt_options Options.
*/
constructor(opt_options) { constructor(opt_options) {
const options = opt_options || {}; const options = opt_options || {};
+1
View File
@@ -17,6 +17,7 @@ import EventType from '../events/EventType.js';
/** /**
* @classdesc
* Implements a Least-Recently-Used cache where the keys do not conflict with * Implements a Least-Recently-Used cache where the keys do not conflict with
* Object's properties (e.g. 'hasOwnProperty' is not allowed as a key). Expiring * Object's properties (e.g. 'hasOwnProperty' is not allowed as a key). Expiring
* items from the cache is the responsibility of the user. * items from the cache is the responsibility of the user.
+4 -3
View File
@@ -10,12 +10,13 @@
* @property {?} data * @property {?} data
*/ */
/**
* @classdesc
* Creates an empty linked list structure.
*/
class LinkedList { class LinkedList {
/** /**
* Creates an empty linked list structure.
*
* @param {boolean=} opt_circular The last item is connected to the first one, * @param {boolean=} opt_circular The last item is connected to the first one,
* and the first item to the last one. Default is true. * and the first item to the last one. Default is true.
*/ */
+1
View File
@@ -12,6 +12,7 @@ export const DROP = Infinity;
/** /**
* @classdesc
* Priority queue. * Priority queue.
* *
* The implementation is inspired from the Closure Library's Heap class and * The implementation is inspired from the Closure Library's Heap class and
+1 -1
View File
@@ -16,13 +16,13 @@ import {isEmpty} from '../obj.js';
*/ */
/** /**
* @classdesc
* Wrapper around the RBush by Vladimir Agafonkin. * Wrapper around the RBush by Vladimir Agafonkin.
* See https://github.com/mourner/rbush. * See https://github.com/mourner/rbush.
* *
* @template T * @template T
*/ */
class RBush { class RBush {
/** /**
* @param {number=} opt_maxEntries Max entries. * @param {number=} opt_maxEntries Max entries.
*/ */
+12 -2
View File
@@ -21,9 +21,9 @@ import {createCanvasContext2D} from '../dom.js';
* @property {HTMLCanvasElement} image * @property {HTMLCanvasElement} image
*/ */
class Atlas {
/** /**
* @classesc
* This class facilitates the creation of image atlases. * This class facilitates the creation of image atlases.
* *
* Images added to an atlas will be rendered onto a single * Images added to an atlas will be rendered onto a single
@@ -38,6 +38,16 @@ class Atlas {
* edges overlap when being rendered). To avoid this we add a * edges overlap when being rendered). To avoid this we add a
* padding around each image. * padding around each image.
*/ */
class Atlas {
/**
* @param {number} size The size in pixels of the sprite image.
* @param {number} space The space in pixels between images.
* Because texture coordinates are float values, the edges of
* images might not be completely correct (in a way that the
* edges overlap when being rendered). To avoid this we add a
* padding around each image.
*/
constructor(size, space) { constructor(size, space) {
/** /**
+5 -3
View File
@@ -41,8 +41,8 @@ const INITIAL_ATLAS_SIZE = 256;
const MAX_ATLAS_SIZE = -1; const MAX_ATLAS_SIZE = -1;
class AtlasManager { /**
/** * @classdesc
* Manages the creation of image atlases. * Manages the creation of image atlases.
* *
* Images added to this manager will be inserted into an atlas, which * Images added to this manager will be inserted into an atlas, which
@@ -53,8 +53,10 @@ class AtlasManager {
* *
* If an application uses many images or very large images, it is recommended * If an application uses many images or very large images, it is recommended
* to set a higher `size` value to avoid the creation of too many atlases. * to set a higher `size` value to avoid the creation of too many atlases.
*
* @api * @api
*/
class AtlasManager {
/**
* @param {module:ol/style/AtlasManager~Options=} opt_options Options. * @param {module:ol/style/AtlasManager~Options=} opt_options Options.
*/ */
constructor(opt_options) { constructor(opt_options) {
+5 -4
View File
@@ -20,14 +20,15 @@ import RegularShape from '../style/RegularShape.js';
*/ */
class CircleStyle extends RegularShape { /**
/**
* @classdesc * @classdesc
* Set circle style for vector features. * Set circle style for vector features.
*
* @param {module:ol/style/Circle~Options=} opt_options Options.
* @api * @api
*/ */
class CircleStyle extends RegularShape {
/**
* @param {module:ol/style/Circle~Options=} opt_options Options.
*/
constructor(opt_options) { constructor(opt_options) {
const options = opt_options || {}; const options = opt_options || {};
+1 -1
View File
@@ -16,11 +16,11 @@ import {asString} from '../color.js';
/** /**
* @classdesc * @classdesc
* Set fill style for vector features. * Set fill style for vector features.
* @api
*/ */
class Fill { class Fill {
/** /**
* @param {module:ol/style/Fill~Options=} opt_options Options. * @param {module:ol/style/Fill~Options=} opt_options Options.
* @api
*/ */
constructor(opt_options) { constructor(opt_options) {
+5 -4
View File
@@ -52,14 +52,15 @@ import ImageStyle from '../style/Image.js';
*/ */
class Icon extends ImageStyle { /**
/**
* @classdesc * @classdesc
* Set icon style for vector features. * Set icon style for vector features.
*
* @param {module:ol/style/Icon~Options=} opt_options Options.
* @api * @api
*/ */
class Icon extends ImageStyle {
/**
* @param {module:ol/style/Icon~Options=} opt_options Options.
*/
constructor(opt_options) { constructor(opt_options) {
const options = opt_options || {}; const options = opt_options || {};
+1
View File
@@ -4,6 +4,7 @@
import {asString} from '../color.js'; import {asString} from '../color.js';
/** /**
* @classdesc
* Singleton class. Available through {@link module:ol/style/IconImageCache~shared}. * Singleton class. Available through {@link module:ol/style/IconImageCache~shared}.
*/ */
class IconImageCache { class IconImageCache {
+1 -1
View File
@@ -18,11 +18,11 @@
* A base class used for creating subclasses and not instantiated in * A base class used for creating subclasses and not instantiated in
* apps. Base class for {@link module:ol/style/Icon~Icon}, {@link module:ol/style/Circle~CircleStyle} and * apps. Base class for {@link module:ol/style/Icon~Icon}, {@link module:ol/style/Circle~CircleStyle} and
* {@link module:ol/style/RegularShape~RegularShape}. * {@link module:ol/style/RegularShape~RegularShape}.
* @api
*/ */
class ImageStyle { class ImageStyle {
/** /**
* @param {module:ol/style/Image~Options} options Options. * @param {module:ol/style/Image~Options} options Options.
* @api
*/ */
constructor(options) { constructor(options) {
+5 -4
View File
@@ -46,16 +46,17 @@ import ImageStyle from '../style/Image.js';
*/ */
class RegularShape extends ImageStyle { /**
/**
* @classdesc * @classdesc
* Set regular shape style for vector features. The resulting shape will be * Set regular shape style for vector features. The resulting shape will be
* a regular polygon when `radius` is provided, or a star when `radius1` and * a regular polygon when `radius` is provided, or a star when `radius1` and
* `radius2` are provided. * `radius2` are provided.
*
* @param {module:ol/style/RegularShape~Options} options Options.
* @api * @api
*/ */
class RegularShape extends ImageStyle {
/**
* @param {module:ol/style/RegularShape~Options} options Options.
*/
constructor(options) { constructor(options) {
/** /**
* @type {boolean} * @type {boolean}
+1 -2
View File
@@ -26,12 +26,11 @@ import {getUid} from '../util.js';
* Note that the defaults given are the Canvas defaults, which will be used if * Note that the defaults given are the Canvas defaults, which will be used if
* option is not defined. The `get` functions return whatever was entered in * option is not defined. The `get` functions return whatever was entered in
* the options; they will not return the default. * the options; they will not return the default.
* @api
*/ */
class Stroke { class Stroke {
/** /**
* @param {module:ol/style/Stroke~Options=} opt_options Options. * @param {module:ol/style/Stroke~Options=} opt_options Options.
* @api
*/ */
constructor(opt_options) { constructor(opt_options) {
+1 -2
View File
@@ -143,12 +143,11 @@ import Stroke from '../style/Stroke.js';
* Container for vector feature rendering styles. Any changes made to the style * Container for vector feature rendering styles. Any changes made to the style
* or its children through `set*()` methods will not take effect until the * or its children through `set*()` methods will not take effect until the
* feature or layer that uses the style is re-rendered. * feature or layer that uses the style is re-rendered.
* @api
*/ */
class Style { class Style {
/** /**
* @param {module:ol/style/Style~Options=} opt_options Style options. * @param {module:ol/style/Style~Options=} opt_options Style options.
* @api
*/ */
constructor(opt_options) { constructor(opt_options) {
+1 -2
View File
@@ -48,12 +48,11 @@ const DEFAULT_FILL_COLOR = '#333';
/** /**
* @classdesc * @classdesc
* Set text style for vector features. * Set text style for vector features.
* @api
*/ */
class Text { class Text {
/** /**
* @param {module:ol/style/Text~Options=} opt_options Options. * @param {module:ol/style/Text~Options=} opt_options Options.
* @api
*/ */
constructor(opt_options) { constructor(opt_options) {
+1 -2
View File
@@ -48,12 +48,11 @@ const tmpTileCoord = [0, 0, 0];
* @classdesc * @classdesc
* Base class for setting the grid pattern for sources accessing tiled-image * Base class for setting the grid pattern for sources accessing tiled-image
* servers. * servers.
* @api
*/ */
class TileGrid { class TileGrid {
/** /**
* @param {module:ol/tilegrid/TileGrid~Options} options Tile grid options. * @param {module:ol/tilegrid/TileGrid~Options} options Tile grid options.
* @api
*/ */
constructor(options) { constructor(options) {

Some files were not shown because too many files have changed in this diff Show More