Interface CompatEventPayloads

Well-known event payload types for the compat layer event bus.

interface CompatEventPayloads {
    feature-layer.definition-expression-changed: {
        definitionExpression: undefined | string;
        layerId: string;
    };
    feature-layer.destroyed: {
        id: string;
    };
    feature-layer.edits: {
        layerId: string;
        result: unknown;
    };
    feature-layer.failed: {
        error: unknown;
        id: string;
        layerId: number;
        serviceId: string;
    };
    feature-layer.labeling-changed: {
        layerId: string;
    };
    feature-layer.labels-visible-changed: {
        labelsVisible: boolean;
        layerId: string;
    };
    feature-layer.legend-enabled-changed: {
        layerId: string;
        legendEnabled: boolean;
    };
    feature-layer.loaded: {
        id: string;
        layerId: number;
        serviceId: string;
    };
    feature-layer.loading: {
        id: string;
        layerId: number;
        serviceId: string;
    };
    feature-layer.out-fields-changed: {
        layerId: string;
        outFields: undefined | string[];
    };
    feature-layer.popup-template-changed: {
        layerId: string;
    };
    feature-layer.refreshed: {
        id: string;
        layerId: number;
        serviceId: string;
    };
    feature-layer.renderer-changed: {
        layerId: string;
    };
    feature-layer.scale-range-changed: {
        layerId: string;
        maxScale: number;
        minScale: number;
    };
    feature-layer.time-extent-change: {
        layerId: string;
        timeExtent: undefined | {
            end: Date;
            start: Date;
        };
    };
    layer.opacity-changed: {
        layerId: string;
        opacity: number;
        serviceId?: string;
        sublayerId?: number;
    };
    layer.visibility-changed: {
        layerId: string;
        serviceId?: string;
        sublayerId?: number;
        visible: boolean;
    };
    widget-kit.missing: {
        api: "registerHonuaWidgetKit";
        docs: string;
        message: string;
        tagName: string;
    };
}

Properties

feature-layer.definition-expression-changed feature-layer.destroyed feature-layer.edits feature-layer.failed feature-layer.labeling-changed feature-layer.labels-visible-changed feature-layer.legend-enabled-changed feature-layer.loaded feature-layer.loading feature-layer.out-fields-changed feature-layer.popup-template-changed feature-layer.refreshed feature-layer.renderer-changed feature-layer.scale-range-changed feature-layer.time-extent-change layer.opacity-changed layer.visibility-changed widget-kit.missing

Properties

feature-layer.definition-expression-changed

feature-layer.definition-expression-changed: {
    definitionExpression: undefined | string;
    layerId: string;
}

feature-layer.destroyed

feature-layer.destroyed: {
    id: string;
}

feature-layer.edits

feature-layer.edits: {
    layerId: string;
    result: unknown;
}

feature-layer.failed

feature-layer.failed: {
    error: unknown;
    id: string;
    layerId: number;
    serviceId: string;
}

feature-layer.labeling-changed

feature-layer.labeling-changed: {
    layerId: string;
}

feature-layer.labels-visible-changed

feature-layer.labels-visible-changed: {
    labelsVisible: boolean;
    layerId: string;
}

feature-layer.legend-enabled-changed

feature-layer.legend-enabled-changed: {
    layerId: string;
    legendEnabled: boolean;
}

feature-layer.loaded

feature-layer.loaded: {
    id: string;
    layerId: number;
    serviceId: string;
}

feature-layer.loading

feature-layer.loading: {
    id: string;
    layerId: number;
    serviceId: string;
}

feature-layer.out-fields-changed

feature-layer.out-fields-changed: {
    layerId: string;
    outFields: undefined | string[];
}

feature-layer.popup-template-changed

feature-layer.popup-template-changed: {
    layerId: string;
}

feature-layer.refreshed

feature-layer.refreshed: {
    id: string;
    layerId: number;
    serviceId: string;
}

feature-layer.renderer-changed

feature-layer.renderer-changed: {
    layerId: string;
}

feature-layer.scale-range-changed

feature-layer.scale-range-changed: {
    layerId: string;
    maxScale: number;
    minScale: number;
}

feature-layer.time-extent-change

feature-layer.time-extent-change: {
    layerId: string;
    timeExtent: undefined | {
        end: Date;
        start: Date;
    };
}

layer.opacity-changed

layer.opacity-changed: {
    layerId: string;
    opacity: number;
    serviceId?: string;
    sublayerId?: number;
}

layer.visibility-changed

layer.visibility-changed: {
    layerId: string;
    serviceId?: string;
    sublayerId?: number;
    visible: boolean;
}

widget-kit.missing

widget-kit.missing: {
    api: "registerHonuaWidgetKit";
    docs: string;
    message: string;
    tagName: string;
}

Emitted the first time a compat widget shim tries to mount its delegated web component while no widget kit is registered (see esri-compat/widget-host.ts). Without a kit the shims stay state-model-only and their container renders nothing, so this is the machine-readable half of the one-time console.warn the host emits.

Subscribe before constructing widgets: the diagnostic fires once per runtime and re-arms only when registerHonuaWidgetKit is called again.

Type declaration

  • api: "registerHonuaWidgetKit"

    The API the application must call to fix this.

  • docs: string

    Documentation entry describing the required registration step.

  • message: string

    The same human-readable text written to console.warn.

  • tagName: string

    Delegation tag the shim failed to mount (e.g. honua-legend).

Settings

Member Visibility

On This Page

Properties