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

VertiGIS Viewer Specification

import type { Event } from "../Event.js";
import { EventRegistry } from "../EventRegistry.js";
/**
 * Arguments for the "layout.loaded" event.
 */
export interface Page {
}
/**
 * The margin thickness.
 */
export interface Thickness {
}
/**
 * Arguments for the "layout.margin-changed" event.
 */
export interface LayoutMarginChangedArgs {
    /**
     * The new margin thickness.
     */
    margin: Thickness;
}
export declare class LayoutEvents extends EventRegistry {
    protected readonly _prefix = "layout";
    /**
     * Raised when a layout is finished being displayed. Mobile only.
     *
     * @mobileOnly
     */
    get displayed(): Event;
    /**
     * Raised when a layout is loaded. Mobile only.
     *
     * @mobileOnly
     */
    get loaded(): Event<Page>;
    /**
     * Raised when a layout is unloaded (typically so that a new layout can be
     * loaded). Mobile only.
     *
     * @mobileOnly
     */
    get unloaded(): Event;
    /**
     * Raised when a layout's margin values have been updated. Mobile only.
     *
     * @mobileOnly
     */
    get marginChanged(): Event<LayoutMarginChangedArgs>;
}