sgauthier
6e64e138e2
All checks were successful
Publish To Prod / deploy_and_publish (push) Successful in 35s
239 lines
8.2 KiB
TypeScript
239 lines
8.2 KiB
TypeScript
export default Icon;
|
|
export type Options = {
|
|
/**
|
|
* Anchor. Default value is the icon center.
|
|
*/
|
|
anchor?: number[] | undefined;
|
|
/**
|
|
* Origin of the anchor: `bottom-left`, `bottom-right`,
|
|
* `top-left` or `top-right`.
|
|
*/
|
|
anchorOrigin?: any;
|
|
/**
|
|
* 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.
|
|
*/
|
|
anchorXUnits?: any;
|
|
/**
|
|
* 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.
|
|
*/
|
|
anchorYUnits?: any;
|
|
/**
|
|
* Color to tint the icon. If not specified,
|
|
* the icon will be left as is.
|
|
*/
|
|
color?: string | import("../color.js").Color | undefined;
|
|
/**
|
|
* The `crossOrigin` attribute for loaded images. Note that you must provide a
|
|
* `crossOrigin` 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.
|
|
*/
|
|
crossOrigin?: string | null | undefined;
|
|
/**
|
|
* Image object for the icon. If the `src` option is not provided then the
|
|
* provided image must already be loaded. And in that case, it is required
|
|
* to provide the size of the image, with the `imgSize` option.
|
|
*/
|
|
img?: HTMLCanvasElement | HTMLImageElement | undefined;
|
|
/**
|
|
* Offset, which, together with the size and the offset origin, define the
|
|
* sub-rectangle to use from the original icon image.
|
|
*/
|
|
offset?: number[] | undefined;
|
|
/**
|
|
* Displacement of the icon.
|
|
*/
|
|
displacement?: number[] | undefined;
|
|
/**
|
|
* Origin of the offset: `bottom-left`, `bottom-right`,
|
|
* `top-left` or `top-right`.
|
|
*/
|
|
offsetOrigin?: any;
|
|
/**
|
|
* Opacity of the icon.
|
|
*/
|
|
opacity?: number | undefined;
|
|
/**
|
|
* Scale.
|
|
*/
|
|
scale?: number | import("../size.js").Size | undefined;
|
|
/**
|
|
* Whether to rotate the icon with the view.
|
|
*/
|
|
rotateWithView?: boolean | undefined;
|
|
/**
|
|
* Rotation in radians (positive rotation clockwise).
|
|
*/
|
|
rotation?: number | undefined;
|
|
/**
|
|
* Icon size in pixel. Can be used together with `offset` to define the
|
|
* sub-rectangle to use from the origin (sprite) icon image.
|
|
*/
|
|
size?: import("../size.js").Size | undefined;
|
|
/**
|
|
* Image size in pixels. Only required if `img` is set and `src` is not, and
|
|
* for SVG images in Internet Explorer 11. The provided `imgSize` needs to match the actual size of the image.
|
|
*/
|
|
imgSize?: import("../size.js").Size | undefined;
|
|
/**
|
|
* Image source URI.
|
|
*/
|
|
src?: string | undefined;
|
|
/**
|
|
* Declutter mode
|
|
*/
|
|
declutterMode?: "declutter" | "obstacle" | "none" | undefined;
|
|
};
|
|
/**
|
|
* @typedef {Object} Options
|
|
* @property {Array<number>} [anchor=[0.5, 0.5]] Anchor. Default value is the icon center.
|
|
* @property {import("./IconOrigin.js").default} [anchorOrigin='top-left'] Origin of the anchor: `bottom-left`, `bottom-right`,
|
|
* `top-left` or `top-right`.
|
|
* @property {import("./IconAnchorUnits.js").default} [anchorXUnits='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("./IconAnchorUnits.js").default} [anchorYUnits='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 {import("../color.js").Color|string} [color] Color to tint the icon. If not specified,
|
|
* the icon will be left as is.
|
|
* @property {null|string} [crossOrigin] The `crossOrigin` attribute for loaded images. Note that you must provide a
|
|
* `crossOrigin` 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 {HTMLImageElement|HTMLCanvasElement} [img] Image object for the icon. If the `src` option is not provided then the
|
|
* provided image must already be loaded. And in that case, it is required
|
|
* to provide the size of the image, with the `imgSize` option.
|
|
* @property {Array<number>} [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 {Array<number>} [displacement=[0,0]] Displacement of the icon.
|
|
* @property {import("./IconOrigin.js").default} [offsetOrigin='top-left'] Origin of the offset: `bottom-left`, `bottom-right`,
|
|
* `top-left` or `top-right`.
|
|
* @property {number} [opacity=1] Opacity of the icon.
|
|
* @property {number|import("../size.js").Size} [scale=1] Scale.
|
|
* @property {boolean} [rotateWithView=false] Whether to rotate the icon with the view.
|
|
* @property {number} [rotation=0] Rotation in radians (positive rotation clockwise).
|
|
* @property {import("../size.js").Size} [size] Icon size in pixel. Can be used together with `offset` to define the
|
|
* sub-rectangle to use from the origin (sprite) icon image.
|
|
* @property {import("../size.js").Size} [imgSize] Image size in pixels. Only required if `img` is set and `src` is not, and
|
|
* for SVG images in Internet Explorer 11. The provided `imgSize` needs to match the actual size of the image.
|
|
* @property {string} [src] Image source URI.
|
|
* @property {"declutter"|"obstacle"|"none"|undefined} [declutterMode] Declutter mode
|
|
*/
|
|
/**
|
|
* @classdesc
|
|
* Set icon style for vector features.
|
|
* @api
|
|
*/
|
|
declare class Icon extends ImageStyle {
|
|
/**
|
|
* @param {Options} [opt_options] Options.
|
|
*/
|
|
constructor(opt_options?: Options | undefined);
|
|
/**
|
|
* @private
|
|
* @type {Array<number>}
|
|
*/
|
|
private anchor_;
|
|
/**
|
|
* @private
|
|
* @type {Array<number>}
|
|
*/
|
|
private normalizedAnchor_;
|
|
/**
|
|
* @private
|
|
* @type {import("./IconOrigin.js").default}
|
|
*/
|
|
private anchorOrigin_;
|
|
/**
|
|
* @private
|
|
* @type {import("./IconAnchorUnits.js").default}
|
|
*/
|
|
private anchorXUnits_;
|
|
/**
|
|
* @private
|
|
* @type {import("./IconAnchorUnits.js").default}
|
|
*/
|
|
private anchorYUnits_;
|
|
/**
|
|
* @private
|
|
* @type {?string}
|
|
*/
|
|
private crossOrigin_;
|
|
/**
|
|
* @private
|
|
* @type {import("../size.js").Size|undefined}
|
|
*/
|
|
private imgSize_;
|
|
/**
|
|
* @private
|
|
* @type {import("../color.js").Color}
|
|
*/
|
|
private color_;
|
|
/**
|
|
* @private
|
|
* @type {import("./IconImage.js").default}
|
|
*/
|
|
private iconImage_;
|
|
/**
|
|
* @private
|
|
* @type {Array<number>}
|
|
*/
|
|
private offset_;
|
|
/**
|
|
* @private
|
|
* @type {import("./IconOrigin.js").default}
|
|
*/
|
|
private offsetOrigin_;
|
|
/**
|
|
* @private
|
|
* @type {Array<number>}
|
|
*/
|
|
private origin_;
|
|
/**
|
|
* @private
|
|
* @type {import("../size.js").Size}
|
|
*/
|
|
private size_;
|
|
/**
|
|
* Clones the style. The underlying Image/HTMLCanvasElement is not cloned.
|
|
* @return {Icon} The cloned style.
|
|
* @api
|
|
*/
|
|
clone(): Icon;
|
|
/**
|
|
* Set the anchor point. The anchor determines the center point for the
|
|
* symbolizer.
|
|
*
|
|
* @param {Array<number>} anchor Anchor.
|
|
* @api
|
|
*/
|
|
setAnchor(anchor: Array<number>): void;
|
|
/**
|
|
* Get the icon color.
|
|
* @return {import("../color.js").Color} Color.
|
|
* @api
|
|
*/
|
|
getColor(): import("../color.js").Color;
|
|
/**
|
|
* Get the image icon.
|
|
* @param {number} pixelRatio Pixel ratio.
|
|
* @return {HTMLImageElement|HTMLCanvasElement} Image or Canvas element.
|
|
* @api
|
|
*/
|
|
getImage(pixelRatio: number): HTMLImageElement | HTMLCanvasElement;
|
|
/**
|
|
* @return {HTMLImageElement|HTMLCanvasElement} Image element.
|
|
*/
|
|
getHitDetectionImage(): HTMLImageElement | HTMLCanvasElement;
|
|
/**
|
|
* Get the image URL.
|
|
* @return {string|undefined} Image src.
|
|
* @api
|
|
*/
|
|
getSrc(): string | undefined;
|
|
}
|
|
import ImageStyle from "./Image.js";
|
|
//# sourceMappingURL=Icon.d.ts.map
|