@vertigis/viewer-spec
Version:
VertiGIS Viewer Specification
34 lines (33 loc) • 1.06 kB
TypeScript
import type { Action } from "@vertigis/arcgis-extensions/support/Action";
import type { ModelProperties } from "./ModelProperties.js";
/**
* Properties that can be used to initialize a {@link Layout}.
*/
export interface LayoutProperties extends ModelProperties {
/**
* The URL of the layout XML (Either a URL or definition must be provided).
*/
url?: string;
/**
* Application-defined tags associated with the layout, e.g. "handheld" or
* "high-contrast". An application might use these tags to choose a layout
* when there are multiple to choose from.
*/
tags?: string[];
/**
* The stringified layout XML (Either a URL or definition must be provided).
*/
definition?: string;
/**
* An action that will be performed when the layout has loaded.
*/
onLayoutLoading?: Action;
/**
* An action that will be performed when the layout is about to load.
*/
onLayoutLoaded?: Action;
/**
* The user-friendly title of the layout.
*/
title?: string;
}