@razi91/types-ol-ext/overlay/Placemark.d.ts

Type definitions for ol-ext

import { Overlay } from 'ol';
import { Coordinate } from 'ol/coordinate';

export interface Options {
    color: string;
    backgroundColor: string;
    contentColor: string;
    radius: number;
    popupClass: string;
    onclose: ((...params: any[]) => any) | undefined;
    onshow: ((...params: any[]) => any) | undefined;
}
/**
 * @classdesc
 * A placemark element to be displayed over the map and attached to a single map
 * location. The placemarks are customized using CSS.
 *
 * @example
var popup = new Overlay.Placemark();
map.addOverlay(popup);
popup.show(coordinate);
popup.hide();
*
* @constructor
* @extends {Overlay}
* @param {} options Extend ol/Overlay/Popup options
*	@param {String} options.color placemark color
*	@param {String} options.backgroundColor placemark color
*	@param {String} options.contentColor placemark color
*	@param {Number} options.radius placemark radius in pixel
*	@param {String} options.popupClass the a export class of the overlay to style the popup.
*	@param {function|undefined} options.onclose: callback function when popup is closed
*	@param {function|undefined} options.onshow callback function when popup is shown
* @api stable
 */
export default class Placemark extends Overlay {
    constructor(options: Options);
    /**
     * Set the position and the content of the placemark (hide it before to enable animation).
     * @param {Coordinate|string} coordinate the coordinate of the popup or the HTML content.
     * @param {string|undefined} html the HTML content (undefined = previous content).
     */
    show(coordinate: Coordinate | string, html: string | undefined): void;
    /**
     * Set the placemark color.
     * @param {string} color
     */
    setColor(color: string): void;
    /**
     * Set the placemark background color.
     * @param {string} color
     */
    setBackgroundColor(color: string): void;
    /**
     * Set the placemark content color.
     * @param {string} color
     */
    setContentColor(color: string): void;
    /**
     * Set the placemark export class.
     * @param {string} name
     */
    setClassName(name: string): void;
    /**
     * Set the placemark radius.
     * @param {number} Size Size in pixel
     */
    setRadius(Size: number): void;
}