rlayers/dist/RMap.d.ts

React Components for OpenLayers

import { PropsWithChildren } from 'react';
import { Map, MapBrowserEvent, MapEvent } from 'ol';
import RenderEvent from 'ol/render/Event';
import BaseEvent from 'ol/events/Event';
import { Extent } from 'ol/extent';
import { Coordinate } from 'ol/coordinate';
import { ProjectionLike } from 'ol/proj';
import { RlayersBase } from './REvent';
/** Center and zoom level */
export type RView = {
    /** Center of the map */
    center: Coordinate;
    /** Zoom level, 0 is the whole world, 28 is maximum resolution */
    zoom: number;
    /**
     * Optional resolution in meters per pixel
     *
     * When set, it takes precedence over the zoom level
     *
     * @default zoom
     */
    resolution?: number;
};
/**
 * @propsfor RMap
 */
export interface RMapProps extends PropsWithChildren<unknown> {
    /** The initial view parameters - {center, zoom}, reset only on full component reload */
    initial: RView;
    /** External view state with React semantics */
    view?: [RView, (view: RView) => void];
    /** CSS class */
    className?: string;
    /** Width when not using CSS */
    width?: number | string;
    /** Height when not using CSS */
    height?: number | string;
    /**
     * Do not include any default controls. Cannot be changed once set.
     * @default false
     */
    noDefaultControls?: boolean;
    /**
     * Do not include any default interactions. Cannot be changed once set.
     * @default false
     */
    noDefaultInteractions?: boolean;
    /** View projection
     * @default 'ESPG:3857'
     */
    projection?: ProjectionLike;
    /** Called immediately on click */
    onClick?: (this: RMap, e: MapBrowserEvent<UIEvent>) => boolean | void;
    /** Called on single click when the double click timer has expired */
    onSingleClick?: (this: RMap, e: MapBrowserEvent<UIEvent>) => boolean | void;
    /** Called on double click */
    onDblClick?: (this: RMap, e: MapBrowserEvent<UIEvent>) => boolean | void;
    /** Called when the user starts panning the map */
    onMoveStart?: (this: RMap, e: MapBrowserEvent<UIEvent>) => boolean | void;
    /** Called when the user stops panning the map */
    onMoveEnd?: (this: RMap, e: MapBrowserEvent<UIEvent>) => boolean | void;
    /** Called on every pointer move when dragging, `e.preventDefault()`
     * can be used to stop OpenLayers from also panning the map */
    onPointerDrag?: (this: RMap, e: MapBrowserEvent<UIEvent>) => boolean | void;
    /** Called on every pointer movement, use with care */
    onPointerMove?: (this: RMap, e: MapBrowserEvent<UIEvent>) => boolean | void;
    /** Called after a layer has been rendered */
    onPostRender?: (this: RMap, e: MapEvent) => boolean | void;
    /** Called before layers are composed */
    onPreCompose?: (this: RMap, e: RenderEvent) => boolean | void;
    /** Called after layers are composed */
    onPostCompose?: (this: RMap, e: RenderEvent) => boolean | void;
    /** Called after completely rendering the map */
    onRenderComplete?: (this: RMap, e: RenderEvent) => boolean | void;
    /** Called on every change */
    onChange?: (this: RMap, e: BaseEvent) => void;
    /** A set of properties that can be accessed later by .get()/.getProperties() */
    properties?: Record<string, unknown>;
    /** Extent of the map, cannot be dynamically modified
     * @default world
     */
    extent?: Extent;
    /** Minimum resolution, cannot be dynamically modified */
    minResolution?: number;
    /** Maximum resolution, cannot be dynamically modified */
    maxResolution?: number;
    /**
     * If true, the view will always animate to the closest zoom level after an interaction;
     * false means intermediary zoom levels are allowed.
     * @default false
     */
    constrainResolution?: boolean;
    /** Minimum zoom level */
    minZoom?: number;
    /** Maximum zoom level */
    maxZoom?: number;
    /**
     * Allow rotation of the map.
     * Cannot be updated once the map is created.
     *
     * @default true
     */
    enableRotation?: boolean;
    /**
     * Rotation constraint. false means no constraint. true means no constraint, but snap to zero near zero.
     * A number constrains the rotation to that number of values.
     * For example, 4 will constrain the rotation to 0, 90, 180, and 270 degrees.
     * Cannot be updated once the map is created.
     *
     * @default true
     */
    constrainRotation?: boolean | number;
}
/**
 * Main map component
 *
 * All other components, except `RStyle` should be part of an `RMap`
 */
export default class RMap extends RlayersBase<RMapProps, Record<string, never>> {
    ol: Map;
    private target;
    constructor(props: Readonly<RMapProps>);
    componentDidMount(): void;
    private updateView;
    protected refresh(prevProps?: RMapProps): void;
    render(): JSX.Element;
}
//# sourceMappingURL=RMap.d.ts.map