You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
229 lines
6.0 KiB
229 lines
6.0 KiB
export default ImageStyle;
|
|
export type Options = {
|
|
/**
|
|
* Opacity.
|
|
*/
|
|
opacity: number;
|
|
/**
|
|
* If the image should get rotated with the view.
|
|
*/
|
|
rotateWithView: boolean;
|
|
/**
|
|
* Rotation.
|
|
*/
|
|
rotation: number;
|
|
/**
|
|
* Scale.
|
|
*/
|
|
scale: number | import("../size.js").Size;
|
|
/**
|
|
* Displacement.
|
|
*/
|
|
displacement: Array<number>;
|
|
/**
|
|
* Declutter mode: `declutter`, `obstacle`, 'none
|
|
*/
|
|
declutterMode: "declutter" | "obstacle" | "none" | undefined;
|
|
};
|
|
/**
|
|
* @typedef {Object} Options
|
|
* @property {number} opacity Opacity.
|
|
* @property {boolean} rotateWithView If the image should get rotated with the view.
|
|
* @property {number} rotation Rotation.
|
|
* @property {number|import("../size.js").Size} scale Scale.
|
|
* @property {Array<number>} displacement Displacement.
|
|
* @property {"declutter"|"obstacle"|"none"|undefined} declutterMode Declutter mode: `declutter`, `obstacle`, 'none */
|
|
/**
|
|
* @classdesc
|
|
* 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
|
|
* {@link module:ol/style/RegularShape~RegularShape}.
|
|
* @abstract
|
|
* @api
|
|
*/
|
|
declare class ImageStyle {
|
|
/**
|
|
* @param {Options} options Options.
|
|
*/
|
|
constructor(options: Options);
|
|
/**
|
|
* @private
|
|
* @type {number}
|
|
*/
|
|
private opacity_;
|
|
/**
|
|
* @private
|
|
* @type {boolean}
|
|
*/
|
|
private rotateWithView_;
|
|
/**
|
|
* @private
|
|
* @type {number}
|
|
*/
|
|
private rotation_;
|
|
/**
|
|
* @private
|
|
* @type {number|import("../size.js").Size}
|
|
*/
|
|
private scale_;
|
|
/**
|
|
* @private
|
|
* @type {import("../size.js").Size}
|
|
*/
|
|
private scaleArray_;
|
|
/**
|
|
* @private
|
|
* @type {Array<number>}
|
|
*/
|
|
private displacement_;
|
|
/**
|
|
* @private
|
|
* @type {"declutter"|"obstacle"|"none"|undefined}
|
|
*/
|
|
private declutterMode_;
|
|
/**
|
|
* Clones the style.
|
|
* @return {ImageStyle} The cloned style.
|
|
* @api
|
|
*/
|
|
clone(): ImageStyle;
|
|
/**
|
|
* Get the symbolizer opacity.
|
|
* @return {number} Opacity.
|
|
* @api
|
|
*/
|
|
getOpacity(): number;
|
|
/**
|
|
* Determine whether the symbolizer rotates with the map.
|
|
* @return {boolean} Rotate with map.
|
|
* @api
|
|
*/
|
|
getRotateWithView(): boolean;
|
|
/**
|
|
* Get the symoblizer rotation.
|
|
* @return {number} Rotation.
|
|
* @api
|
|
*/
|
|
getRotation(): number;
|
|
/**
|
|
* Get the symbolizer scale.
|
|
* @return {number|import("../size.js").Size} Scale.
|
|
* @api
|
|
*/
|
|
getScale(): number | import("../size.js").Size;
|
|
/**
|
|
* Get the symbolizer scale array.
|
|
* @return {import("../size.js").Size} Scale array.
|
|
*/
|
|
getScaleArray(): import("../size.js").Size;
|
|
/**
|
|
* Get the displacement of the shape
|
|
* @return {Array<number>} Shape's center displacement
|
|
* @api
|
|
*/
|
|
getDisplacement(): Array<number>;
|
|
/**
|
|
* Get the declutter mode of the shape
|
|
* @return {"declutter"|"obstacle"|"none"|undefined} Shape's declutter mode
|
|
* @api
|
|
*/
|
|
getDeclutterMode(): "declutter" | "obstacle" | "none" | undefined;
|
|
/**
|
|
* Get the anchor point in pixels. The anchor determines the center point for the
|
|
* symbolizer.
|
|
* @abstract
|
|
* @return {Array<number>} Anchor.
|
|
*/
|
|
getAnchor(): Array<number>;
|
|
/**
|
|
* Get the image element for the symbolizer.
|
|
* @abstract
|
|
* @param {number} pixelRatio Pixel ratio.
|
|
* @return {HTMLCanvasElement|HTMLVideoElement|HTMLImageElement} Image element.
|
|
*/
|
|
getImage(pixelRatio: number): HTMLCanvasElement | HTMLVideoElement | HTMLImageElement;
|
|
/**
|
|
* @abstract
|
|
* @return {HTMLCanvasElement|HTMLVideoElement|HTMLImageElement} Image element.
|
|
*/
|
|
getHitDetectionImage(): HTMLCanvasElement | HTMLVideoElement | HTMLImageElement;
|
|
/**
|
|
* Get the image pixel ratio.
|
|
* @param {number} pixelRatio Pixel ratio.
|
|
* @return {number} Pixel ratio.
|
|
*/
|
|
getPixelRatio(pixelRatio: number): number;
|
|
/**
|
|
* @abstract
|
|
* @return {import("../ImageState.js").default} Image state.
|
|
*/
|
|
getImageState(): any;
|
|
/**
|
|
* @abstract
|
|
* @return {import("../size.js").Size} Image size.
|
|
*/
|
|
getImageSize(): import("../size.js").Size;
|
|
/**
|
|
* Get the origin of the symbolizer.
|
|
* @abstract
|
|
* @return {Array<number>} Origin.
|
|
*/
|
|
getOrigin(): Array<number>;
|
|
/**
|
|
* Get the size of the symbolizer (in pixels).
|
|
* @abstract
|
|
* @return {import("../size.js").Size} Size.
|
|
*/
|
|
getSize(): import("../size.js").Size;
|
|
/**
|
|
* Set the displacement.
|
|
*
|
|
* @param {Array<number>} displacement Displacement.
|
|
* @api
|
|
*/
|
|
setDisplacement(displacement: Array<number>): void;
|
|
/**
|
|
* Set the opacity.
|
|
*
|
|
* @param {number} opacity Opacity.
|
|
* @api
|
|
*/
|
|
setOpacity(opacity: number): void;
|
|
/**
|
|
* Set whether to rotate the style with the view.
|
|
*
|
|
* @param {boolean} rotateWithView Rotate with map.
|
|
* @api
|
|
*/
|
|
setRotateWithView(rotateWithView: boolean): void;
|
|
/**
|
|
* Set the rotation.
|
|
*
|
|
* @param {number} rotation Rotation.
|
|
* @api
|
|
*/
|
|
setRotation(rotation: number): void;
|
|
/**
|
|
* Set the scale.
|
|
*
|
|
* @param {number|import("../size.js").Size} scale Scale.
|
|
* @api
|
|
*/
|
|
setScale(scale: number | import("../size.js").Size): void;
|
|
/**
|
|
* @abstract
|
|
* @param {function(import("../events/Event.js").default): void} listener Listener function.
|
|
*/
|
|
listenImageChange(listener: (arg0: import("../events/Event.js").default) => void): void;
|
|
/**
|
|
* Load not yet loaded URI.
|
|
* @abstract
|
|
*/
|
|
load(): void;
|
|
/**
|
|
* @abstract
|
|
* @param {function(import("../events/Event.js").default): void} listener Listener function.
|
|
*/
|
|
unlistenImageChange(listener: (arg0: import("../events/Event.js").default) => void): void;
|
|
}
|
|
//# sourceMappingURL=Image.d.ts.map
|