Interface HonuaMapPackageWidget

A renderer-neutral widget/component declared by the package.

type is an open string rather than a closed union: the widget catalogue belongs to the host application, and closing it here would make every new component a breaking change to the artifact. Unknown types are carried through the round trip and ignored by hosts that cannot render them.

interface HonuaMapPackageWidget {
    config?: Record<string, unknown>;
    label?: string;
    position?:
        | "top-left"
        | "top-right"
        | "bottom-left"
        | "bottom-right";
    type: string;
    visible?: boolean;
    widgetId: string;
}

Properties

config? label? position? type visible? widgetId

Properties

Optionalconfig

config?: Record<string, unknown>

Widget-specific configuration, carried through unmodified.

Optionallabel

label?: string

Optionalposition

position?:
    | "top-left"
    | "top-right"
    | "bottom-left"
    | "bottom-right"

type

type: string

Widget kind, e.g. legend, layer-list, basemap-gallery, search.

Optionalvisible

visible?: boolean

Whether the widget starts visible. Defaults to true when omitted.

widgetId

widgetId: string

Settings

Member Visibility

On This Page

Properties