@yandex/ymaps3-types
Version:
Types for ymaps3 maps library
40 lines (39 loc) • 1.26 kB
TypeScript
import type { EasingFunctionDescription } from "../../../common/types";
import type { CustomVuefyOptions } from "../../../modules/vuefy";
/**
* YMapZoomControl props
*/
type YMapZoomControlProps = {
/** Easing function for map location animation */
easing?: EasingFunctionDescription;
/** Map location animate duration */
duration?: number;
};
declare const defaultProps: Readonly<{
duration: 200;
}>;
type DefaultProps = typeof defaultProps;
/**
* Display zoom control on a map.
*
* @example
* ```javascript
* const controls = new YMapControls({position: 'right'});
* const {YMapZoomControl} = await ymaps3.import('@yandex/ymaps3-controls@0.0.1');
* const zoomControl = new YMapZoomControl();
* controls.addChild(zoomControl);
* map.addChild(controls);
* ```
*/
declare class YMapZoomControl extends ymaps3.YMapComplexEntity<YMapZoomControlProps, DefaultProps> {
static [ymaps3.optionsKeyVuefy]: CustomVuefyOptions<YMapZoomControl>;
static defaultProps: Readonly<{
duration: 200;
}>;
private _control;
private _zoom;
protected _onAttach(): void;
protected _onUpdate(props: YMapZoomControlProps): void;
protected _onDetach(): void;
}
export { YMapZoomControl, YMapZoomControlProps };