Add descriptions for properties.

This commit is contained in:
Simon Seyock
2021-02-04 18:19:33 +01:00
parent 2fe91b8f4d
commit 2ad5789797
35 changed files with 232 additions and 232 deletions

View File

@@ -48,20 +48,20 @@ import {removeNode} from './dom.js';
* @property {number} pixelRatio The pixel ratio of the frame. * @property {number} pixelRatio The pixel ratio of the frame.
* @property {number} time The time when rendering of the frame was requested. * @property {number} time The time when rendering of the frame was requested.
* @property {import("./View.js").State} viewState The state of the current view. * @property {import("./View.js").State} viewState The state of the current view.
* @property {boolean} animate * @property {boolean} animate Animate.
* @property {import("./transform.js").Transform} coordinateToPixelTransform * @property {import("./transform.js").Transform} coordinateToPixelTransform CoordinateToPixelTransform.
* @property {import("rbush").default} declutterTree * @property {import("rbush").default} declutterTree DeclutterTree.
* @property {null|import("./extent.js").Extent} extent * @property {null|import("./extent.js").Extent} extent Extent.
* @property {number} index * @property {number} index Index.
* @property {Array<import("./layer/Layer.js").State>} layerStatesArray * @property {Array<import("./layer/Layer.js").State>} layerStatesArray LayerStatesArray.
* @property {number} layerIndex * @property {number} layerIndex LayerIndex.
* @property {import("./transform.js").Transform} pixelToCoordinateTransform * @property {import("./transform.js").Transform} pixelToCoordinateTransform PixelToCoordinateTransform.
* @property {Array<PostRenderFunction>} postRenderFunctions * @property {Array<PostRenderFunction>} postRenderFunctions PostRenderFunctions.
* @property {import("./size.js").Size} size * @property {import("./size.js").Size} size Size.
* @property {TileQueue} tileQueue * @property {TileQueue} tileQueue TileQueue.
* @property {!Object<string, Object<string, boolean>>} usedTiles * @property {!Object<string, Object<string, boolean>>} usedTiles UsedTiles.
* @property {Array<number>} viewHints * @property {Array<number>} viewHints ViewHints.
* @property {!Object<string, Object<string, boolean>>} wantedTiles * @property {!Object<string, Object<string, boolean>>} wantedTiles WantedTiles.
*/ */
/** /**
@@ -83,11 +83,11 @@ import {removeNode} from './dom.js';
/** /**
* @typedef {Object} MapOptionsInternal * @typedef {Object} MapOptionsInternal
* @property {Collection<import("./control/Control.js").default>} [controls] * @property {Collection<import("./control/Control.js").default>} [controls] Controls.
* @property {Collection<import("./interaction/Interaction.js").default>} [interactions] * @property {Collection<import("./interaction/Interaction.js").default>} [interactions] Interactions.
* @property {HTMLElement|Document} keyboardEventTarget * @property {HTMLElement|Document} keyboardEventTarget KeyboardEventTarget.
* @property {Collection<import("./Overlay.js").default>} overlays * @property {Collection<import("./Overlay.js").default>} overlays Overlays.
* @property {Object<string, *>} values * @property {Object<string, *>} values Values.
*/ */
/** /**

View File

@@ -7,14 +7,14 @@ import {getUid} from './util.js';
/** /**
* @typedef {Object} ReplayState * @typedef {Object} ReplayState
* @property {boolean} dirty * @property {boolean} dirty Dirty.
* @property {null|import("./render.js").OrderFunction} renderedRenderOrder * @property {null|import("./render.js").OrderFunction} renderedRenderOrder RenderedRenderOrder.
* @property {number} renderedTileRevision * @property {number} renderedTileRevision RenderedTileRevision.
* @property {number} renderedResolution * @property {number} renderedResolution RenderedResolution.
* @property {number} renderedRevision * @property {number} renderedRevision RenderedRevision.
* @property {number} renderedZ * @property {number} renderedZ RenderedZ.
* @property {number} renderedTileResolution * @property {number} renderedTileResolution RenderedTileResolution.
* @property {number} renderedTileZ * @property {number} renderedTileZ RenderedTileZ.
*/ */
/** /**

View File

@@ -54,25 +54,25 @@ import {fromExtent as polygonFromExtent} from './geom/Polygon.js';
* An animation configuration * An animation configuration
* *
* @typedef {Object} Animation * @typedef {Object} Animation
* @property {import("./coordinate.js").Coordinate} [sourceCenter] * @property {import("./coordinate.js").Coordinate} [sourceCenter] Source center.
* @property {import("./coordinate.js").Coordinate} [targetCenter] * @property {import("./coordinate.js").Coordinate} [targetCenter] Target center.
* @property {number} [sourceResolution] * @property {number} [sourceResolution] Source resolution.
* @property {number} [targetResolution] * @property {number} [targetResolution] Target resolution.
* @property {number} [sourceRotation] * @property {number} [sourceRotation] Source rotation.
* @property {number} [targetRotation] * @property {number} [targetRotation] Target rotation.
* @property {import("./coordinate.js").Coordinate} [anchor] * @property {import("./coordinate.js").Coordinate} [anchor] Anchor.
* @property {number} start * @property {number} start Start.
* @property {number} duration * @property {number} duration Duration.
* @property {boolean} complete * @property {boolean} complete Complete.
* @property {function(number):number} easing * @property {function(number):number} easing Easing.
* @property {function(boolean):void} callback * @property {function(boolean):void} callback Callback.
*/ */
/** /**
* @typedef {Object} Constraints * @typedef {Object} Constraints
* @property {import("./centerconstraint.js").Type} center * @property {import("./centerconstraint.js").Type} center Center.
* @property {import("./resolutionconstraint.js").Type} resolution * @property {import("./resolutionconstraint.js").Type} resolution Resolution.
* @property {import("./rotationconstraint.js").Type} rotation * @property {import("./rotationconstraint.js").Type} rotation Rotation.
*/ */
/** /**
@@ -203,11 +203,11 @@ import {fromExtent as polygonFromExtent} from './geom/Polygon.js';
/** /**
* @typedef {Object} State * @typedef {Object} State
* @property {import("./coordinate.js").Coordinate} center * @property {import("./coordinate.js").Coordinate} center Center.
* @property {import("./proj/Projection.js").default} projection * @property {import("./proj/Projection.js").default} projection Projection.
* @property {number} resolution * @property {number} resolution Resolution.
* @property {number} rotation * @property {number} rotation Rotation.
* @property {number} zoom * @property {number} zoom Zoom.
*/ */
/** /**

View File

@@ -4,13 +4,13 @@
/** /**
* @typedef {Object} FontParameters * @typedef {Object} FontParameters
* @property {string} style * @property {string} style Style.
* @property {string} variant * @property {string} variant Variant.
* @property {string} weight * @property {string} weight Weight.
* @property {string} size * @property {string} size Size.
* @property {string} lineHeight * @property {string} lineHeight LineHeight.
* @property {string} family * @property {string} family Family.
* @property {Array<string>} families * @property {Array<string>} families Families.
*/ */
/** /**

View File

@@ -6,9 +6,9 @@ import {clear} from './obj.js';
/** /**
* Key to use with {@link module:ol/Observable~Observable#unByKey}. * Key to use with {@link module:ol/Observable~Observable#unByKey}.
* @typedef {Object} EventsKey * @typedef {Object} EventsKey
* @property {ListenerFunction} listener * @property {ListenerFunction} listener Listener.
* @property {import("./events/Target.js").EventTargetLike} target * @property {import("./events/Target.js").EventTargetLike} target Target.
* @property {string} type * @property {string} type Type.
* @api * @api
*/ */
@@ -22,7 +22,7 @@ import {clear} from './obj.js';
/** /**
* @typedef {Object} ListenerObject * @typedef {Object} ListenerObject
* @property {ListenerFunction} handleEvent * @property {ListenerFunction} handleEvent HandleEvent listener function.
*/ */
/** /**

View File

@@ -109,8 +109,8 @@ const GPX_SERIALIZERS = makeStructureNS(NAMESPACE_URIS, {
/** /**
* @typedef {Object} LayoutOptions * @typedef {Object} LayoutOptions
* @property {boolean} [hasZ] * @property {boolean} [hasZ] HasZ.
* @property {boolean} [hasM] * @property {boolean} [hasM] HasM.
*/ */
/** /**

View File

@@ -56,17 +56,17 @@ import {transformGeometryWithOptions} from './Feature.js';
/** /**
* @typedef {Object} Vec2 * @typedef {Object} Vec2
* @property {number} x * @property {number} x X coordinate.
* @property {import("../style/IconAnchorUnits").default} xunits * @property {import("../style/IconAnchorUnits").default} xunits Units of x.
* @property {number} y * @property {number} y Y coordinate.
* @property {import("../style/IconAnchorUnits").default} yunits * @property {import("../style/IconAnchorUnits").default} yunits Units of Y.
* @property {import("../style/IconOrigin.js").default} origin * @property {import("../style/IconOrigin.js").default} origin Origin.
*/ */
/** /**
* @typedef {Object} GxTrackObject * @typedef {Object} GxTrackObject
* @property {Array<number>} flatCoordinates * @property {Array<number>} flatCoordinates Flat coordinates.
* @property {Array<number>} whens * @property {Array<number>} whens Whens.
*/ */
/** /**

View File

@@ -178,17 +178,17 @@ const TRANSACTION_SERIALIZERS = {
/** /**
* Number of features; bounds/extent. * Number of features; bounds/extent.
* @typedef {Object} FeatureCollectionMetadata * @typedef {Object} FeatureCollectionMetadata
* @property {number} numberOfFeatures * @property {number} numberOfFeatures NumberOfFeatures.
* @property {import("../extent.js").Extent} bounds * @property {import("../extent.js").Extent} bounds Bounds.
*/ */
/** /**
* Total deleted; total inserted; total updated; array of insert ids. * Total deleted; total inserted; total updated; array of insert ids.
* @typedef {Object} TransactionResponse * @typedef {Object} TransactionResponse
* @property {number} totalDeleted * @property {number} totalDeleted TotalDeleted.
* @property {number} totalInserted * @property {number} totalInserted TotalInserted.
* @property {number} totalUpdated * @property {number} totalUpdated TotalUpdated.
* @property {Array<string>} insertIds * @property {Array<string>} insertIds InsertIds.
*/ */
/** /**

View File

@@ -35,9 +35,9 @@ const GeometryConstructor = {
/** /**
* @typedef {Object} Token * @typedef {Object} Token
* @property {number} type * @property {number} type Type.
* @property {number|string} [value] * @property {number|string} [value] Value.
* @property {number} position * @property {number} position Position.
*/ */
/** /**

View File

@@ -81,12 +81,12 @@ const ModifyEventType = {
/** /**
* @typedef {Object} SegmentData * @typedef {Object} SegmentData
* @property {Array<number>} [depth] * @property {Array<number>} [depth] Depth.
* @property {Feature} feature * @property {Feature} feature Feature.
* @property {import("../geom/SimpleGeometry.js").default} geometry * @property {import("../geom/SimpleGeometry.js").default} geometry Geometry.
* @property {number} [index] * @property {number} [index] Index.
* @property {Array<import("../extent.js").Extent>} segment * @property {Array<import("../extent.js").Extent>} segment Segment.
* @property {Array<SegmentData>} [featureSegments] * @property {Array<SegmentData>} [featureSegments] FeatureSegments.
*/ */
/** /**

View File

@@ -28,15 +28,15 @@ import {listen, unlistenByKey} from '../events.js';
/** /**
* @typedef {Object} Result * @typedef {Object} Result
* @property {boolean} snapped * @property {boolean} snapped Snapped.
* @property {import("../coordinate.js").Coordinate|null} vertex * @property {import("../coordinate.js").Coordinate|null} vertex Vertex.
* @property {import("../pixel.js").Pixel|null} vertexPixel * @property {import("../pixel.js").Pixel|null} vertexPixel VertexPixel.
*/ */
/** /**
* @typedef {Object} SegmentData * @typedef {Object} SegmentData
* @property {import("../Feature.js").default} feature * @property {import("../Feature.js").default} feature Feature.
* @property {Array<import("../coordinate.js").Coordinate>} segment * @property {Array<import("../coordinate.js").Coordinate>} segment Segment.
*/ */
/** /**

View File

@@ -72,8 +72,8 @@ const INTERVALS = [
/** /**
* @typedef {Object} GraticuleLabelDataType * @typedef {Object} GraticuleLabelDataType
* @property {Point} geom * @property {Point} geom Geometry.
* @property {string} text * @property {string} text Text.
*/ */
/** /**

View File

@@ -44,17 +44,17 @@ import {listen, unlistenByKey} from '../events.js';
/** /**
* @typedef {Object} State * @typedef {Object} State
* @property {import("./Layer.js").default} layer * @property {import("./Layer.js").default} layer Layer.
* @property {number} opacity Opacity, the value is rounded to two digits to appear after the decimal point. * @property {number} opacity Opacity, the value is rounded to two digits to appear after the decimal point.
* @property {import("../source/State.js").default} sourceState * @property {import("../source/State.js").default} sourceState SourceState.
* @property {boolean} visible * @property {boolean} visible Visible.
* @property {boolean} managed * @property {boolean} managed Managed.
* @property {import("../extent.js").Extent} [extent] * @property {import("../extent.js").Extent} [extent] Extent.
* @property {number} zIndex * @property {number} zIndex ZIndex.
* @property {number} maxResolution * @property {number} maxResolution Maximum resolution.
* @property {number} minResolution * @property {number} minResolution Minimum resolution.
* @property {number} minZoom * @property {number} minZoom Minimum zoom.
* @property {number} maxZoom * @property {number} maxZoom Maximum zoom.
*/ */
/** /**

View File

@@ -15,8 +15,8 @@ import {getTransformFromProjections, getUserProjection} from './proj.js';
/** /**
* @typedef {Object} State * @typedef {Object} State
* @property {CanvasRenderingContext2D} context Canvas context that the layer is being rendered to. * @property {CanvasRenderingContext2D} context Canvas context that the layer is being rendered to.
* @property {import("./Feature.js").FeatureLike} feature * @property {import("./Feature.js").FeatureLike} feature Feature.
* @property {import("./geom/SimpleGeometry.js").default} geometry * @property {import("./geom/SimpleGeometry.js").default} geometry Geometry.
* @property {number} pixelRatio Pixel ratio used by the layer renderer. * @property {number} pixelRatio Pixel ratio used by the layer renderer.
* @property {number} resolution Resolution that the render batch was created and optimized for. * @property {number} resolution Resolution that the render batch was created and optimized for.
* This is not the view's resolution that is being rendered. * This is not the view's resolution that is being rendered.

View File

@@ -11,60 +11,60 @@ import {toString} from '../transform.js';
/** /**
* @typedef {Object} FillState * @typedef {Object} FillState
* @property {import("../colorlike.js").ColorLike} fillStyle * @property {import("../colorlike.js").ColorLike} fillStyle FillStyle.
*/ */
/** /**
* @typedef Label * @typedef Label
* @property {number} width * @property {number} width Width.
* @property {number} height * @property {number} height Height.
* @property {Array<string|number>} contextInstructions * @property {Array<string|number>} contextInstructions ContextInstructions.
*/ */
/** /**
* @typedef {Object} FillStrokeState * @typedef {Object} FillStrokeState
* @property {import("../colorlike.js").ColorLike} [currentFillStyle] * @property {import("../colorlike.js").ColorLike} [currentFillStyle] Current FillStyle.
* @property {import("../colorlike.js").ColorLike} [currentStrokeStyle] * @property {import("../colorlike.js").ColorLike} [currentStrokeStyle] Current StrokeStyle.
* @property {CanvasLineCap} [currentLineCap] * @property {CanvasLineCap} [currentLineCap] Current LineCap.
* @property {Array<number>} currentLineDash * @property {Array<number>} currentLineDash Current LineDash.
* @property {number} [currentLineDashOffset] * @property {number} [currentLineDashOffset] Current LineDashOffset.
* @property {CanvasLineJoin} [currentLineJoin] * @property {CanvasLineJoin} [currentLineJoin] Current LineJoin.
* @property {number} [currentLineWidth] * @property {number} [currentLineWidth] Current LineWidth.
* @property {number} [currentMiterLimit] * @property {number} [currentMiterLimit] Current MiterLimit.
* @property {number} [lastStroke] * @property {number} [lastStroke] Last stroke.
* @property {import("../colorlike.js").ColorLike} [fillStyle] * @property {import("../colorlike.js").ColorLike} [fillStyle] FillStyle.
* @property {import("../colorlike.js").ColorLike} [strokeStyle] * @property {import("../colorlike.js").ColorLike} [strokeStyle] StrokeStyle.
* @property {CanvasLineCap} [lineCap] * @property {CanvasLineCap} [lineCap] LineCap.
* @property {Array<number>} lineDash * @property {Array<number>} lineDash LineDash.
* @property {number} [lineDashOffset] * @property {number} [lineDashOffset] LineDashOffset.
* @property {CanvasLineJoin} [lineJoin] * @property {CanvasLineJoin} [lineJoin] LineJoin.
* @property {number} [lineWidth] * @property {number} [lineWidth] LineWidth.
* @property {number} [miterLimit] * @property {number} [miterLimit] MiterLimit.
*/ */
/** /**
* @typedef {Object} StrokeState * @typedef {Object} StrokeState
* @property {CanvasLineCap} lineCap * @property {CanvasLineCap} lineCap LineCap.
* @property {Array<number>} lineDash * @property {Array<number>} lineDash LineDash.
* @property {number} lineDashOffset * @property {number} lineDashOffset LineDashOffset.
* @property {CanvasLineJoin} lineJoin * @property {CanvasLineJoin} lineJoin LineJoin.
* @property {number} lineWidth * @property {number} lineWidth LineWidth.
* @property {number} miterLimit * @property {number} miterLimit MiterLimit.
* @property {import("../colorlike.js").ColorLike} strokeStyle * @property {import("../colorlike.js").ColorLike} strokeStyle StrokeStyle.
*/ */
/** /**
* @typedef {Object} TextState * @typedef {Object} TextState
* @property {string} font * @property {string} font Font.
* @property {string} [textAlign] * @property {string} [textAlign] TextAlign.
* @property {string} textBaseline * @property {string} textBaseline TextBaseline.
* @property {string} [placement] * @property {string} [placement] Placement.
* @property {number} [maxAngle] * @property {number} [maxAngle] MaxAngle.
* @property {boolean} [overflow] * @property {boolean} [overflow] Overflow.
* @property {import("../style/Fill.js").default} [backgroundFill] * @property {import("../style/Fill.js").default} [backgroundFill] BackgroundFill.
* @property {import("../style/Stroke.js").default} [backgroundStroke] * @property {import("../style/Stroke.js").default} [backgroundStroke] BackgroundStroke.
* @property {import("../size.js").Size} [scale] * @property {import("../size.js").Size} [scale] Scale.
* @property {Array<number>} [padding] * @property {Array<number>} [padding] Padding.
*/ */
/** /**

View File

@@ -29,24 +29,24 @@ import {transform2D} from '../../geom/flat/transform.js';
/** /**
* @typedef {Object} BBox * @typedef {Object} BBox
* @property {number} minX * @property {number} minX Minimal x.
* @property {number} minY * @property {number} minY Minimal y.
* @property {number} maxX * @property {number} maxX Maximal x.
* @property {number} maxY * @property {number} maxY Maximal y
* @property {*} value * @property {*} value Value.
*/ */
/** /**
* @typedef {Object} ImageOrLabelDimensions * @typedef {Object} ImageOrLabelDimensions
* @property {number} drawImageX * @property {number} drawImageX DrawImageX.
* @property {number} drawImageY * @property {number} drawImageY DrawImageY.
* @property {number} drawImageW * @property {number} drawImageW DrawImageW.
* @property {number} drawImageH * @property {number} drawImageH DrawImageH.
* @property {number} originX * @property {number} originX OriginX.
* @property {number} originY * @property {number} originY OriginY.
* @property {Array<number>} scale * @property {Array<number>} scale Scale.
* @property {BBox} declutterBox * @property {BBox} declutterBox DeclutterBox.
* @property {import("../../transform.js").Transform} canvasTransform * @property {import("../../transform.js").Transform} canvasTransform CanvasTransform.
*/ */
/** /**

View File

@@ -12,11 +12,11 @@ import {wrapX} from '../coordinate.js';
/** /**
* @typedef HitMatch * @typedef HitMatch
* @property {import("../Feature.js").FeatureLike} feature * @property {import("../Feature.js").FeatureLike} feature Feature.
* @property {import("../layer/Layer.js").default} layer * @property {import("../layer/Layer.js").default} layer Layer.
* @property {import("../geom/SimpleGeometry.js").default} geometry * @property {import("../geom/SimpleGeometry.js").default} geometry Geometry.
* @property {number} distanceSq * @property {number} distanceSq Squared distance.
* @property {import("./vector.js").FeatureCallback<T>} callback * @property {import("./vector.js").FeatureCallback<T>} callback Callback.
* @template T * @template T
*/ */

View File

@@ -180,8 +180,8 @@ export function calculateSourceExtentResolution(
/** /**
* @typedef {Object} ImageExtent * @typedef {Object} ImageExtent
* @property {import("./extent.js").Extent} extent * @property {import("./extent.js").Extent} extent Extent.
* @property {HTMLCanvasElement|HTMLImageElement|HTMLVideoElement} image * @property {HTMLCanvasElement|HTMLImageElement|HTMLVideoElement} image Image.
*/ */
/** /**

View File

@@ -19,8 +19,8 @@ import {log2, modulo} from '../math.js';
/** /**
* Single triangle; consists of 3 source points and 3 target points. * Single triangle; consists of 3 source points and 3 target points.
* @typedef {Object} Triangle * @typedef {Object} Triangle
* @property {Array<import("../coordinate.js").Coordinate>} source * @property {Array<import("../coordinate.js").Coordinate>} source Source.
* @property {Array<import("../coordinate.js").Coordinate>} target * @property {Array<import("../coordinate.js").Coordinate>} target Target.
*/ */
/** /**

View File

@@ -78,7 +78,7 @@ const TOS_ATTRIBUTION =
/** /**
* @typedef {Object} ResourceSet * @typedef {Object} ResourceSet
* @property {Array<Resource>} resources * @property {Array<Resource>} resources Resources.
*/ */
/** /**

View File

@@ -16,12 +16,12 @@ import {toSize} from '../size.js';
* @typedef {Object} Options * @typedef {Object} Options
* @property {import("./Source.js").AttributionLike} [attributions] Attributions. * @property {import("./Source.js").AttributionLike} [attributions] Attributions.
* @property {boolean} [attributionsCollapsible=true] Attributions are collapsible. * @property {boolean} [attributionsCollapsible=true] Attributions are collapsible.
* @property {number} [cacheSize] * @property {number} [cacheSize] Size of the cache.
* @property {null|string} [crossOrigin] * @property {null|string} [crossOrigin] The value for the crossOrigin option of the request.
* @property {import("../extent.js").Extent} [extent=[0, -height, width, 0]] * @property {import("../extent.js").Extent} [extent=[0, -height, width, 0]] The extent.
* @property {string} [format='jpg'] Requested image format. * @property {string} [format='jpg'] Requested image format.
* @property {boolean} [imageSmoothing=true] Enable image smoothing. * @property {boolean} [imageSmoothing=true] Enable image smoothing.
* @property {import("../proj.js").ProjectionLike} [projection] * @property {import("../proj.js").ProjectionLike} [projection] Projection.
* @property {string} [quality] Requested IIIF image quality. Default is 'native' * @property {string} [quality] Requested IIIF image quality. Default is 'native'
* for version 1, 'default' for versions 2 and 3. * for version 1, 'default' for versions 2 and 3.
* @property {number} [reprojectionErrorThreshold=0.5] Maximum allowed reprojection error (in pixels). * @property {number} [reprojectionErrorThreshold=0.5] Maximum allowed reprojection error (in pixels).
@@ -33,13 +33,13 @@ import {toSize} from '../size.js';
* @property {import("./State.js").default} [state] Source state. * @property {import("./State.js").default} [state] Source state.
* @property {Array<string>} [supports=[]] Supported IIIF region and size calculation * @property {Array<string>} [supports=[]] Supported IIIF region and size calculation
* features. * features.
* @property {number} [tilePixelRatio] * @property {number} [tilePixelRatio] Tile pixel ratio.
* @property {number|import("../size.js").Size} [tileSize] Tile size. * @property {number|import("../size.js").Size} [tileSize] Tile size.
* Same tile size is used for all zoom levels. If tile size is a number, * Same tile size is used for all zoom levels. If tile size is a number,
* a square tile is assumed. If the IIIF image service supports arbitrary * a square tile is assumed. If the IIIF image service supports arbitrary
* tiling (sizeByH, sizeByW, sizeByWh or sizeByPct as well as regionByPx or regionByPct * tiling (sizeByH, sizeByW, sizeByWh or sizeByPct as well as regionByPx or regionByPct
* are supported), the default tilesize is 256. * are supported), the default tilesize is 256.
* @property {number} [transition] * @property {number} [transition] Transition.
* @property {string} [url] Base URL of the IIIF Image service. * @property {string} [url] Base URL of the IIIF Image service.
* This should be the same as the IIIF Image ID. * This should be the same as the IIIF Image ID.
* @property {import("../format/IIIFInfo.js").Versions} [version=Versions.VERSION2] Service's IIIF Image API version. * @property {import("../format/IIIFInfo.js").Versions} [version=Versions.VERSION2] Service's IIIF Image API version.

View File

@@ -62,11 +62,11 @@ export class ImageSourceEvent extends Event {
/** /**
* @typedef {Object} Options * @typedef {Object} Options
* @property {import("./Source.js").AttributionLike} [attributions] * @property {import("./Source.js").AttributionLike} [attributions] Attributions.
* @property {boolean} [imageSmoothing=true] Enable image smoothing. * @property {boolean} [imageSmoothing=true] Enable image smoothing.
* @property {import("../proj.js").ProjectionLike} [projection] * @property {import("../proj.js").ProjectionLike} [projection] Projection.
* @property {Array<number>} [resolutions] * @property {Array<number>} [resolutions] Resolutions.
* @property {import("./State.js").default} [state] * @property {import("./State.js").default} [state] State.
*/ */
/** /**

View File

@@ -26,11 +26,11 @@ import {get as getProjection} from '../proj.js';
/** /**
* @typedef {Object} Options * @typedef {Object} Options
* @property {AttributionLike} [attributions] * @property {AttributionLike} [attributions] Attributions.
* @property {boolean} [attributionsCollapsible=true] Attributions are collapsible. * @property {boolean} [attributionsCollapsible=true] Attributions are collapsible.
* @property {import("../proj.js").ProjectionLike} [projection] Projection. Default is the view projection. * @property {import("../proj.js").ProjectionLike} [projection] Projection. Default is the view projection.
* @property {import("./State.js").default} [state='ready'] * @property {import("./State.js").default} [state='ready'] State.
* @property {boolean} [wrapX=false] * @property {boolean} [wrapX=false] WrapX.
*/ */
/** /**

View File

@@ -17,18 +17,18 @@ import {scale as scaleSize, toSize} from '../size.js';
/** /**
* @typedef {Object} Options * @typedef {Object} Options
* @property {import("./Source.js").AttributionLike} [attributions] * @property {import("./Source.js").AttributionLike} [attributions] Attributions.
* @property {boolean} [attributionsCollapsible=true] Attributions are collapsible. * @property {boolean} [attributionsCollapsible=true] Attributions are collapsible.
* @property {number} [cacheSize] * @property {number} [cacheSize] CacheSize.
* @property {boolean} [opaque=false] Whether the layer is opaque. * @property {boolean} [opaque=false] Whether the layer is opaque.
* @property {number} [tilePixelRatio] * @property {number} [tilePixelRatio] TilePixelRatio.
* @property {import("../proj.js").ProjectionLike} [projection] * @property {import("../proj.js").ProjectionLike} [projection] Projection.
* @property {import("./State.js").default} [state] * @property {import("./State.js").default} [state] State.
* @property {import("../tilegrid/TileGrid.js").default} [tileGrid] * @property {import("../tilegrid/TileGrid.js").default} [tileGrid] TileGrid.
* @property {boolean} [wrapX=true] * @property {boolean} [wrapX=true] WrapX.
* @property {number} [transition] * @property {number} [transition] Transition.
* @property {string} [key] * @property {string} [key] Key.
* @property {number} [zDirection=0] * @property {number} [zDirection=0] ZDirection.
*/ */
/** /**

View File

@@ -10,22 +10,22 @@ import {getUid} from '../util.js';
/** /**
* @typedef {Object} Options * @typedef {Object} Options
* @property {import("./Source.js").AttributionLike} [attributions] * @property {import("./Source.js").AttributionLike} [attributions] Attributions.
* @property {boolean} [attributionsCollapsible=true] Attributions are collapsible. * @property {boolean} [attributionsCollapsible=true] Attributions are collapsible.
* @property {number} [cacheSize] * @property {number} [cacheSize] Cache size.
* @property {boolean} [opaque=false] Whether the layer is opaque. * @property {boolean} [opaque=false] Whether the layer is opaque.
* @property {import("../proj.js").ProjectionLike} [projection] * @property {import("../proj.js").ProjectionLike} [projection] Projection.
* @property {import("./State.js").default} [state] * @property {import("./State.js").default} [state] State.
* @property {import("../tilegrid/TileGrid.js").default} [tileGrid] * @property {import("../tilegrid/TileGrid.js").default} [tileGrid] TileGrid.
* @property {import("../Tile.js").LoadFunction} tileLoadFunction * @property {import("../Tile.js").LoadFunction} tileLoadFunction TileLoadFunction.
* @property {number} [tilePixelRatio] * @property {number} [tilePixelRatio] TilePixelRatio.
* @property {import("../Tile.js").UrlFunction} [tileUrlFunction] * @property {import("../Tile.js").UrlFunction} [tileUrlFunction] TileUrlFunction.
* @property {string} [url] * @property {string} [url] Url.
* @property {Array<string>} [urls] * @property {Array<string>} [urls] Urls.
* @property {boolean} [wrapX=true] * @property {boolean} [wrapX=true] WrapX.
* @property {number} [transition] * @property {number} [transition] Transition.
* @property {string} [key] * @property {string} [key] Key.
* @property {number} [zDirection=0] * @property {number} [zDirection=0] ZDirection.
*/ */
/** /**

View File

@@ -28,7 +28,7 @@ import {toSize} from '../size.js';
* @property {import("./Source.js").AttributionLike} [attributions] Attributions. * @property {import("./Source.js").AttributionLike} [attributions] Attributions.
* @property {boolean} [attributionsCollapsible=true] Attributions are collapsible. * @property {boolean} [attributionsCollapsible=true] Attributions are collapsible.
* @property {number} [cacheSize] Initial tile cache size. Will auto-grow to hold at least twice the number of tiles in the viewport. * @property {number} [cacheSize] Initial tile cache size. Will auto-grow to hold at least twice the number of tiles in the viewport.
* @property {import("../extent.js").Extent} [extent] * @property {import("../extent.js").Extent} [extent] Extent.
* @property {import("../format/Feature.js").default} [format] Feature format for tiles. Used and required by the default. * @property {import("../format/Feature.js").default} [format] Feature format for tiles. Used and required by the default.
* @property {boolean} [overlaps=true] This source may have overlapping geometries. Setting this * @property {boolean} [overlaps=true] This source may have overlapping geometries. Setting this
* to `false` (e.g. for sources with polygons that represent administrative * to `false` (e.g. for sources with polygons that represent administrative

View File

@@ -104,7 +104,7 @@ export class CustomTile extends ImageTile {
* A `{?-?}` template pattern, for example `subdomain{a-f}.domain.com`, may be * A `{?-?}` template pattern, for example `subdomain{a-f}.domain.com`, may be
* used instead of defining each one separately in the `urls` option. * used instead of defining each one separately in the `urls` option.
* @property {string} [tierSizeCalculation] Tier size calculation method: `default` or `truncated`. * @property {string} [tierSizeCalculation] Tier size calculation method: `default` or `truncated`.
* @property {import("../size.js").Size} size * @property {import("../size.js").Size} size Size.
* @property {import("../extent.js").Extent} [extent] Extent for the TileGrid that is created. * @property {import("../extent.js").Extent} [extent] Extent for the TileGrid that is created.
* Default sets the TileGrid in the * Default sets the TileGrid in the
* fourth quadrant, meaning extent is `[0, -height, width, 0]`. To change the * fourth quadrant, meaning extent is `[0, -height, width, 0]`. To change the

View File

@@ -6,10 +6,10 @@ import {assert} from '../asserts.js';
/** /**
* @typedef {Object} Entry * @typedef {Object} Entry
* @property {string} key_ * @property {string} key_ Key.
* @property {Object} newer * @property {Object} newer Newer.
* @property {Object} older * @property {Object} older Older.
* @property {*} value_ * @property {*} value_ Value.
*/ */
/** /**

View File

@@ -4,9 +4,9 @@
/** /**
* @typedef {Object} Item * @typedef {Object} Item
* @property {Item} [prev] * @property {Item} [prev] Previous.
* @property {Item} [next] * @property {Item} [next] Next.
* @property {?} data * @property {?} data Data.
*/ */
/** /**

View File

@@ -8,11 +8,11 @@ import {isEmpty} from '../obj.js';
/** /**
* @typedef {Object} Entry * @typedef {Object} Entry
* @property {number} minX * @property {number} minX MinX.
* @property {number} minY * @property {number} minY MinY.
* @property {number} maxX * @property {number} maxX MaxX.
* @property {number} maxY * @property {number} maxY MaxY.
* @property {Object} [value] * @property {Object} [value] Value.
*/ */
/** /**

View File

@@ -6,11 +6,11 @@ import {toSize} from '../size.js';
/** /**
* @typedef {Object} Options * @typedef {Object} Options
* @property {number} opacity * @property {number} opacity Opacity.
* @property {boolean} rotateWithView * @property {boolean} rotateWithView If the image should get rotated with the view.
* @property {number} rotation * @property {number} rotation Rotation.
* @property {number|import("../size.js").Size} scale * @property {number|import("../size.js").Size} scale Scale.
* @property {Array<number>} displacement * @property {Array<number>} displacement Displacement.
*/ */
/** /**

View File

@@ -36,14 +36,14 @@ import {
/** /**
* @typedef {Object} RenderOptions * @typedef {Object} RenderOptions
* @property {import("../colorlike.js").ColorLike} [strokeStyle] * @property {import("../colorlike.js").ColorLike} [strokeStyle] StrokeStyle.
* @property {number} strokeWidth * @property {number} strokeWidth StrokeWidth.
* @property {number} size * @property {number} size Size.
* @property {CanvasLineCap} lineCap * @property {CanvasLineCap} lineCap LineCap.
* @property {Array<number>} lineDash * @property {Array<number>} lineDash LineDash.
* @property {number} lineDashOffset * @property {number} lineDashOffset LineDashOffset.
* @property {CanvasLineJoin} lineJoin * @property {CanvasLineJoin} lineJoin LineJoin.
* @property {number} miterLimit * @property {number} miterLimit MiterLimit.
*/ */
/** /**

View File

@@ -27,8 +27,8 @@ import {includes} from '../array.js';
/** /**
* @typedef {Object} BufferCacheEntry * @typedef {Object} BufferCacheEntry
* @property {import("./Buffer.js").default} buffer * @property {import("./Buffer.js").default} buffer Buffer.
* @property {WebGLBuffer} webGlBuffer * @property {WebGLBuffer} webGlBuffer WebGlBuffer.
*/ */
/** /**

View File

@@ -8,7 +8,7 @@ import {extend} from './array.js';
* {@link module:ol/xml~makeSimpleNodeFactory}, the top `objectStack` item needs * {@link module:ol/xml~makeSimpleNodeFactory}, the top `objectStack` item needs
* to have this structure. * to have this structure.
* @typedef {Object} NodeStackItem * @typedef {Object} NodeStackItem
* @property {Node} node * @property {Node} node Node.
*/ */
/** /**

View File

@@ -333,8 +333,8 @@
/** /**
* @typedef {Object} XMLEqlOptions * @typedef {Object} XMLEqlOptions
* @property {boolean} [includeWhiteSpace] * @property {boolean} [includeWhiteSpace] IncludeWhiteSpace.
* @property {boolean} [ignoreElementOrder] * @property {boolean} [ignoreElementOrder] IgnoreElementOrder.
*/ */
/** /**