rlayers/dist/control/RControlBase.d.ts

React Components for OpenLayers

import React, { PropsWithChildren } from 'react';
import { Control as Control } from 'ol/control';
import { Options as OLOptions } from 'ol/control/Control';
import { RContextType } from '../context';
import { RlayersBase } from '../REvent';
/**
 * @propsfor RControl
 */
export interface RControlProps extends PropsWithChildren<unknown> {
    /**
     * Optional CSS class name
     */
    className?: string;
    /**
     * Destination element if the control is to be rendered outside the main map element
     */
    target?: React.RefObject<HTMLElement>;
}
export interface RControlOptions extends OLOptions {
    className?: string;
}
/**
 * An abstract class serving as base for all controls, not meant to be used directly
 */
export default class RControlBase<P extends RControlProps, S> extends RlayersBase<P, S> {
    ol: Control;
    constructor(props: Readonly<P>, context?: React.Context<RContextType>);
    toOLProps(props: P): RControlOptions;
    protected refresh(prevProps?: P): void;
    componentDidMount(): void;
    componentWillUnmount(): void;
}
//# sourceMappingURL=RControlBase.d.ts.map