@openscd/oscd-api
    Preparing search index...

    Interface Plugin

    OpenSCD core communicates the data necessary for editing SCL documents by setting the following properties on the plugin's DOM Element

    interface Plugin {
        doc?: XMLDocument;
        docName?: string;
        docs: Record<string, XMLDocument>;
        docVersion: unknown;
        editor: Transactor<EditV2>;
        locale: string;
    }
    Index

    Properties

    doc? docName? docs docVersion editor locale

    Properties

    doc?: XMLDocument

    The XMLDocument currently being edited, if any.

    docName?: string

    The name of the currently edited document, if any.

    docs: Record<string, XMLDocument>

    A map of document names to their loaded XMLDocument instances.

    docVersion: unknown

    changes value when the document is modified.

    editor: Transactor<EditV2>
    locale: string

    The end user's selected locale.

    Settings

    Member Visibility

    On This Page

    Properties