Welcome to the Substance API docs.

Below you find a full index of classes, components and modules. Use the find dialog of your webbrowser to look up class, methods and properties.

Classes

AbstractEditor

new AbstractEditor()

AnnotationCommand

new AnnotationCommand()

this.getAnnotationType()

this.getAnnotationData()

this.isDisabled(annos, sel)

this.canCreate(annos, sel)

this.canFuse(annos, sel)

this.canDelete(annos, sel)

this.canExpand(annos, sel)

this.canTruncate(annos, sel)

this.getCommandState()

this.execute()

this._applyTransform()

Command

new Command()

this.getName()

this.getCommandState(params, context)

this.execute(params, context)

Configurator

new Configurator()

this.defineSchema(schema)

this.addNode(NodeClass)

this.addConverter(type, converter)

this.addImporter(type, ImporterClass)

this.addExporter(type, ExporterClass)

this.addComponent(nodeType, ComponentClass)

this.addIcon(iconName, options)

this.addLabel(labelName, label)

this.addSeed(seed)

this.addEditingBehavior()

this.import(pkg, options)

ContainerSelection

new ContainerSelection()

this.getContainer()

this.collapse(direction)

this.getNodeIds()

this.getFragments()

this.splitIntoPropertySelections()

DOMImporter

new DOMImporter()

this.convertContainer(elements, containerId)

this.convertElement(el)

this.annotatedText(el, path, options)

this.plainText(el)

this.customText()

this.nextId(a)

this._wrapInlineElementsIntoBlockElement(childIterator)

this._createDefaultBlockElement(el)

this._trimTextContent($el)

Document

new Document()

this.getSchema()

this.contains()

this.get(path)

this.getNodes()

this.import(importer)

this.create(plain)

this.delete(nodeId)

this.set(property, newValue)

this.update(property, diff)

this.addIndex(name, index)

this.getIndex(name)

this.createSelection(sel)

this.loadSeed()

this.toJSON()

DocumentNode

new DocumentNode()

this.getDocument()

this.hasParent()

this.getParent()

this.getRoot()

this.hasChildren()

this.getChildIndex()

this.getChildAt()

this.getChildCount()

this.isBlock()

this.isText()

this.isInline()

isBlock

isText

isPropertyAnnotation

isContainerAnnotation

isInline

EditAnnotationCommand

new EditAnnotationCommand()

this.getCommandState()

Editing

this.switchTextType(args)

EventEmitter

this.emit(event, ...arguments)

this.on(event, method, context)

this.off(event, method, context)

InsertInlineNodeCommand

new InsertInlineNodeCommand()

this.getCommandState()

this.execute()

NodeIndex

this.select()

this.create(node)

this.delete(node)

this.update(node)

this.reset()

this.clone()

NodeIndex.create(prototype)

NodeIndex.filterByType(type)

PropertyAnnotation

PropertySelection

new PropertySelection()

this.toJSON()

this.collapse(direction)

this.getPath()

this.isInsideOf(other, strict)

this.contains(other, strict)

this.overlaps(other, strict)

this.isRightAlignedWith(other)

this.isLeftAlignedWith(other)

this.expand(other)

this.truncateWith(other)

this.createWithNewRange(startOffset, endOffset)

this.getFragments()

ProseEditor

ScrollPane

this.getHeight()

this.getContentHeight()

this.getContentElement()

this.getScrollableElement()

this.getScrollPosition()

this.getPanelOffsetForElement(el)

this.scrollTo(componentId)

Selection

new Selection()

this.getDocument()

this.attach(doc)

this.isNull()

this.isPropertySelection()

this.isContainerSelection()

this.isNodeSelection()

this.isCollapsed()

this.isReverse()

this.equals()

this.toString()

this.toJSON()

this.getFragments()

nullSelection

SpellCheckCommand

Surface

new Surface()

TextNode

TransactionDocument

new TransactionDocument()

VirtualElement

new VirtualElement()

this.ref(ref)

VirtualElement.createElement(elementType, props)

Modules

platform