ComponentSettings Object

Description

Component settings.

Syntax

{
   containerID: <string>,
   webSocketURL: <string>,
   [editorSettings: <DocumentEditorSettings>],
   [replaceContainer: <boolean>],
   [domContentLoaded: <function>],
   [containerElement: <HTMLDivElement>]
}

Examples

The following example demonstrates ComponentSettings in a practical document-editing workflow. Component settings.

function inspectComponentSettings(componentSettings) {
    console.log("container id:", componentSettings.containerID);
    console.log("web socket url:", componentSettings.webSocketURL);
    console.log("editor settings:", componentSettings.editorSettings);
    console.log("replace container:", componentSettings.replaceContainer);
}

Members

Properties

Property	Description
containerElement	Optional. The container DIV element. Alternative to containerID. If both are specified, containerElement takes precedence.
containerID	The ID of the editor container DIV element.
domContentLoaded	Optional. Event handler which is fired as soon as the document editor scaffolding has been inserted into the DOM.
editorSettings	Optional. The document editor settings.
replaceContainer	Optional. Replace the container element instead of appending ourselves to it as a child.
webSocketURL	The WebSocket URL.