mobility-toolbox-js/ol/controls/CopyrightControl.d.ts

Toolbox for JavaScript applications in the domains of mobility and logistics.

import Control from 'ol/control/Control';
import type { MapEvent } from 'ol';
import type { Options } from 'ol/control/Control';
export type CopyrightControlOptions = {
    className?: 'string';
    format?: (copyrights: string[]) => string;
} & Options;
/**
 * Display layer's copyrights. Adding the possibility to format them as you wish.
 *
 * @example
 * import { Map } from 'ol';
 * import { CopyrightControl } from 'mobility-toolbox-js/ol';
 *
 * const map = new Map({
 *   target: 'map',
 * });
 *
 * const control = new CopyrightControl();
 * map.addControl(control);
 *
 *
 * @see <a href="/example/ol-realtime>OpenLayers Realtime layer example</a>
 *
 * @extends {ol/control/Control~Control}
 *
 */
declare class CopyrightControl extends Control {
    format: (copyrights: string[]) => string;
    /**
     * Constructor.
     *
     * @param {Object} options
     * @param {Function} format Function used to format the list of copyrights available to a single string. By default join all the copyrights with a |.
     * @public
     */
    constructor(options?: CopyrightControlOptions);
    render({ frameState }: MapEvent): void;
}
export default CopyrightControl;