ol 10.3.2-dev.1734966546937 → 10.3.2-dev.1735323678164

package/style/webgl.js

@@ -1,133 +0,0 @@
-/**
- * WebGL style objects slightly differ from standard flat styles for certain properties
- * @module ol/style/webgl
- */
-
-/**
- * @typedef {import("../expr/expression.js").ExpressionValue} ExpressionValue
- */
-/**
- * @typedef {import("../color.js").Color|string|Array<ExpressionValue>} ColorExpression
- */
-
-/**
- * @typedef {Object} BaseProps
- * @property {ExpressionValue} [filter] Filter expression. If it resolves to a number strictly greater than 0, the
- * point will be displayed. If undefined, all points will show.
- */
-
-/**
- * @typedef {Object} FillProps
- * @property {ColorExpression} [fill-color] Fill color.
- * @property {string} [fill-pattern-src] Fill pattern image source URI. If `fill-color` is defined as well, it will be used to tint this image.
- * @property {Array<number>|ExpressionValue} [fill-pattern-offset=[0, 0]] Offset, which, together with the size and the offset origin, define the
- * sub-rectangle to use from the original fill pattern image.
- * @property {import("./Icon.js").IconOrigin} [fill-pattern-offset-origin='top-left'] Origin of the offset: `bottom-left`, `bottom-right`,
- * `top-left` or `top-right`.
- * @property {ExpressionValue|import("../size.js").Size} [fill-pattern-size] Fill pattern image size in pixel. Can be used together with `fill-pattern-offset` to define the
- * sub-rectangle to use from the origin (sprite) fill pattern image.
- */
-
-/**
- * @typedef {Object} StrokeProps
- * @property {ColorExpression} [stroke-color] The stroke color.
- * @property {number|ExpressionValue} [stroke-width] Stroke pixel width.
- * @property {number|ExpressionValue} [stroke-offset] Stroke offset in pixel. A positive value offsets the line to the right, relative to the direction of the line.
- * @property {CanvasLineCap|ExpressionValue} [stroke-line-cap='round'] Line cap style: `butt`, `round`, or `square`.
- * @property {CanvasLineJoin|ExpressionValue} [stroke-line-join='round'] Line join style: `bevel`, `round`, or `miter`.
- * @property {Array<number>|Array<ExpressionValue>} [stroke-line-dash] Line dash pattern.
- * @property {number|ExpressionValue} [stroke-line-dash-offset=0] Line dash offset.
- * @property {number|ExpressionValue} [stroke-miter-limit=10] Miter limit.
- * @property {string} [stroke-pattern-src] Stroke pattern image source URI. If `stroke-color` is defined as well, it will be used to tint this image.
- * @property {Array<number>|ExpressionValue} [stroke-pattern-offset=[0, 0]] Offset, which, together with the size and the offset origin, define the
- * sub-rectangle to use from the original fill pattern image.
- * @property {import("./Icon.js").IconOrigin} [stroke-pattern-offset-origin='top-left'] Origin of the offset: `bottom-left`, `bottom-right`,
- * `top-left` or `top-right`.
- * @property {ExpressionValue|import("../size.js").Size} [stroke-pattern-size] Stroke pattern image size in pixel. Can be used together with `stroke-pattern-offset` to define the
- * sub-rectangle to use from the origin (sprite) fill pattern image.
- * @property {number|ExpressionValue} [stroke-pattern-spacing] Spacing between each pattern occurrence in pixels; 0 if undefined.
- */
-
-/**
- * @typedef {Object} IconProps
- * @property {string} [icon-src] Image source URI.
- * @property {Array<number>|ExpressionValue} [icon-anchor=[0.5, 0.5]] Anchor. Default value is the icon center.
- * @property {import("./Icon.js").IconOrigin} [icon-anchor-origin='top-left'] Origin of the anchor: `bottom-left`, `bottom-right`,
- * `top-left` or `top-right`.
- * @property {import("./Icon.js").IconAnchorUnits} [icon-anchor-x-units='fraction'] Units in which the anchor x value is
- * specified. A value of `'fraction'` indicates the x value is a fraction of the icon. A value of `'pixels'` indicates
- * the x value in pixels.
- * @property {import("./Icon.js").IconAnchorUnits} [icon-anchor-y-units='fraction'] Units in which the anchor y value is
- * specified. A value of `'fraction'` indicates the y value is a fraction of the icon. A value of `'pixels'` indicates
- * the y value in pixels.
- * @property {ColorExpression} [icon-color] Color to tint the icon. If not specified,
- * the icon will be left as is.
- * @property {ExpressionValue|number} [icon-opacity=1] Opacity of the icon.
- * @property {null|string} [icon-cross-origin] The `crossOrigin` attribute for loaded images. Note that you must provide a
- * `icon-cross-origin` value if you want to access pixel data with the Canvas renderer.
- * See https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image for more detail.
- * @property {Array<number>|ExpressionValue} [icon-displacement=[0,0]] Displacement of the icon.
- * @property {ExpressionValue|number|import("../size.js").Size} [icon-scale=1] Scale.
- * @property {ExpressionValue|number} [icon-width] Width of the icon. If not specified, the actual image width will be used. Cannot be combined
- * with `scale`.
- * @property {ExpressionValue|number} [icon-height] Height of the icon. If not specified, the actual image height will be used. Cannot be combined
- * with `scale`.
- * @property {ExpressionValue|number} [icon-rotation=0] Rotation in radians (positive rotation clockwise).
- * @property {boolean} [icon-rotate-with-view=false] Whether to rotate the icon with the view.
- * @property {Array<number>|ExpressionValue} [icon-offset=[0, 0]] Offset, which, together with the size and the offset origin, define the
- * sub-rectangle to use from the original icon image.
- * @property {import("./Icon.js").IconOrigin} [icon-offset-origin='top-left'] Origin of the offset: `bottom-left`, `bottom-right`,
- * `top-left` or `top-right`.
- * @property {ExpressionValue|import("../size.js").Size} [icon-size] Icon size in pixel. Can be used together with `icon-offset` to define the
- * sub-rectangle to use from the origin (sprite) icon image.
- */
-
-/**
- * @typedef {Object} ShapeProps
- * @property {ExpressionValue|number} [shape-points] Number of points for stars and regular polygons. In case of a polygon, the number of points
- * is the number of sides.
- * @property {ColorExpression} [shape-fill-color] The fill color.
- * @property {ColorExpression} [shape-stroke-color] The stroke color.
- * @property {ExpressionValue|number} [shape-stroke-width] Stroke pixel width.
- * @property {ExpressionValue|number} [shape-opacity] Shape opacity.
- * @property {ExpressionValue|number} [shape-radius] Radius of a regular polygon.
- * @property {ExpressionValue|number} [shape-radius2] Second radius to make a star instead of a regular polygon.
- * @property {ExpressionValue|number} [shape-angle=0] Shape's angle in radians. A value of 0 will have one of the shape's point facing up.
- * @property {Array<ExpressionValue>|Array<number>} [shape-displacement=[0,0]] Displacement of the shape
- * @property {ExpressionValue|number} [shape-rotation=0] Rotation in radians (positive rotation clockwise).
- * @property {boolean} [shape-rotate-with-view=false] Whether to rotate the shape with the view.
- * @property {ExpressionValue|Array<ExpressionValue>|number|import("../size.js").Size} [shape-scale=1] Scale. Unless two dimensional scaling is required a better
- * result may be obtained with appropriate settings for `shape-radius` and `shape-radius2`.
- */
-
-/**
- * @typedef {Object} CircleProps
- * @property {ExpressionValue|number} [circle-radius] Circle radius.
- * @property {ColorExpression} [circle-fill-color] The fill color.
- * @property {ColorExpression} [circle-stroke-color] The stroke color.
- * @property {ExpressionValue|number} [circle-stroke-width] Stroke pixel width.
- * @property {ExpressionValue|number} [circle-opacity] Circle opacity.
- * @property {Array<ExpressionValue>|Array<number>} [circle-displacement=[0,0]] displacement
- * @property {ExpressionValue|Array<ExpressionValue>|number|import("../size.js").Size} [circle-scale=1] Scale. A two dimensional scale will produce an ellipse.
- * Unless two dimensional scaling is required a better result may be obtained with an appropriate setting for `circle-radius`.
- * @property {ExpressionValue|number} [circle-rotation=0] Rotation in radians
- * (positive rotation clockwise, meaningful only when used in conjunction with a two dimensional scale).
- * @property {boolean} [circle-rotate-with-view=false] Whether to rotate the shape with the view
- * (meaningful only when used in conjunction with a two dimensional scale).
- */
-
-// FIXME Present in flat style but not implemented in webgl style:
-//  - icon declutter mode
-//  - circle line cap/join/miter limit
-//  - circle dash pattern/offset
-//  - circle declutter mode
-//  - shape line cap/join/miter limit
-//  - shape dash pattern/offset
-//  - shape declutter mode
-//  - text style
-
-/**
- * @typedef {BaseProps & IconProps & StrokeProps & FillProps & CircleProps & ShapeProps} WebGLStyle
- */
-
-export {};