@vertigis/viewer-spec/messaging/registry/bookmark.d.ts

VertiGIS Viewer Specification

import type { Event } from "../Event.js";
import { EventRegistry } from "../EventRegistry.js";
export declare class BookmarkEvents extends EventRegistry {
    protected readonly _prefix = "bookmark";
    /**
     * Raised when a bookmark is added. Mobile only.
     *
     * @mobileOnly
     */
    get added(): Event<BookmarkEventArgs>;
    /**
     * Raised when a bookmark is deleted. Mobile only.
     *
     * @mobileOnly
     */
    get deleted(): Event<BookmarkEventArgs>;
    /**
     * Raised when a bookmark is viewed. Mobile only.
     *
     * @mobileOnly
     */
    get viewed(): Event<BookmarkEventArgs>;
    /**
     * Raised when a bookmark is updated. Mobile only.
     *
     * @mobileOnly
     */
    get updated(): Event<BookmarkEventArgs>;
}
/**
 * Arguments for the bookmark events.
 */
export interface BookmarkEventArgs {
    /**
     * The name of the bookmark.
     */
    name: string;
    /**
     * Indicates whether the bookmark is editable.
     */
    isEditable: boolean;
}