Interface AsukaEngineApi

Runtime rendering-engine helpers exposed through designer.util.engine.

interface AsukaEngineApi {
    getCapabilities: (() => AsukaRenderEngineCapabilities);
    getCurrent: (() => AsukaRenderEngine);
    getDefaultKind: (() => AsukaRenderEngineKind);
    getForView: ((viewId?: null | string) => AsukaRenderEngine);
    getKind: (() => AsukaRenderEngineKind);
    getViewKind: ((viewId?: null | string) => AsukaRenderEngineKind);
    isLoaded: ((kind?: null | AsukaRenderEngineKind) => boolean);
    setDefaultKind: ((kind: AsukaRenderEngineKind) => AsukaRenderEngineKind);
    setViewKind: ((viewId: string, kind: AsukaRenderEngineKind) => void);
}

Properties

Return high-level capabilities exposed by the active engine.

getCurrent: (() => AsukaRenderEngine)

Return the common renderer contract for the active view.

getDefaultKind: (() => AsukaRenderEngineKind)

Return the default engine used by new views.

getForView: ((viewId?: null | string) => AsukaRenderEngine)

Return the common renderer contract for a specific view.

Return the active view engine kind.

getViewKind: ((viewId?: null | string) => AsukaRenderEngineKind)

Return the engine kind for a specific view, or the active view when omitted.

isLoaded: ((kind?: null | AsukaRenderEngineKind) => boolean)

Return true when an engine of this kind currently has a mounted runtime.

Change the default engine used by new views.

setViewKind: ((viewId: string, kind: AsukaRenderEngineKind) => void)

Change one view engine without changing the document content.