@yandex/ymaps3-types
Version:
Types for ymaps3 maps library
54 lines (53 loc) • 1.75 kB
TypeScript
import { YMapGroupEntity } from "../YMapEnities";
/**
* Copyrights position on the map container. By default, 'bottom right'.
* For example, 'top left' or 'bottom right'
* ```javascript
* const map = new ymaps3.YMap(document.getElementById('map-root'), {
* copyrightsPosition: 'top left'
* });
* ```
*/
type YMapCopyrightsPosition = "top left" | "top right" | "bottom left" | "bottom right";
type YMapCopyrightsProps = {
/** Position of copyright on the map */
position?: YMapCopyrightsPosition;
/** Show the map scale next to the map */
showScale?: boolean;
};
declare const defaultProps: Readonly<{
position: YMapCopyrightsPosition;
showScale: false;
}>;
type DefaultProps = typeof defaultProps;
/**
* The copyright display component on the map.
* Data for display uses from the `YMapCoverage` component
*/
declare class YMapCopyrights extends YMapGroupEntity<YMapCopyrightsProps, DefaultProps> {
static defaultProps: Readonly<{
position: YMapCopyrightsPosition;
showScale: false;
}>;
private _containerElement;
private _copyrightsTextElement;
private _agreementLinkElement;
private _logoElement;
private _copyrightsContainer;
private _scaleElement;
private _scaleControl;
private _copyrights;
private _detachDom?;
constructor(props?: YMapCopyrightsProps);
protected _onAttach(): void;
protected _onUpdate(props: Partial<YMapCopyrightsProps>): void;
protected _onDetach(): void;
private _createDom;
private _render;
private _syncTheme;
private _applyCopyrights;
private _computeMaxWidth;
private _rearrange;
private _toggleScaleControl;
}
export { YMapCopyrights, YMapCopyrightsPosition, YMapCopyrightsProps };