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.

66 lines
2.1 KiB

export default ZoomToExtent;
export type Options = {
/**
* Class name.
*/
className?: string | undefined;
/**
* Specify a target if you want the control
* to be rendered outside of the map's viewport.
*/
target?: string | HTMLElement | undefined;
/**
* Text label to use for the button.
* Instead of text, also an element (e.g. a `span` element) can be used.
*/
label?: string | HTMLElement | undefined;
/**
* Text label to use for the button tip.
*/
tipLabel?: string | undefined;
/**
* The extent to zoom to. If undefined the validity
* extent of the view projection is used.
*/
extent?: import("../extent.js").Extent | undefined;
};
/**
* @typedef {Object} Options
* @property {string} [className='ol-zoom-extent'] Class name.
* @property {HTMLElement|string} [target] Specify a target if you want the control
* to be rendered outside of the map's viewport.
* @property {string|HTMLElement} [label='E'] Text label to use for the button.
* Instead of text, also an element (e.g. a `span` element) can be used.
* @property {string} [tipLabel='Fit to extent'] Text label to use for the button tip.
* @property {import("../extent.js").Extent} [extent] The extent to zoom to. If undefined the validity
* extent of the view projection is used.
*/
/**
* @classdesc
* A button control which, when pressed, changes the map view to a specific
* extent. To style this control use the css selector `.ol-zoom-extent`.
*
* @api
*/
declare class ZoomToExtent extends Control {
/**
* @param {Options} [options] Options.
*/
constructor(options?: Options | undefined);
/**
* @type {?import("../extent.js").Extent|null}
* @protected
*/
protected extent: (import("../extent.js").Extent | null) | null;
/**
* @param {MouseEvent} event The event to handle
* @private
*/
private handleClick_;
/**
* @protected
*/
protected handleZoomToExtent(): void;
}
import Control from "./Control.js";
//# sourceMappingURL=ZoomToExtent.d.ts.map