Namespace for all VisualEditor DataModel classes, static methods and static properties.
Classes
- AbbreviationAnnotation
- DataModel abbreviation annotation.
- AlienBlockNode
- DataModel alien block node.
- AlienInlineNode
- DataModel alien inline node.
- AlienMetaItem
- DataModel alien meta item.
- AlienNode
- DataModel alien node.
- AlienTableCellNode
- DataModel alien table cell node.
- AlignableNode
- A mixin class for Alignable nodes.
- Annotation
- Generic DataModel annotation.
- AnnotationFactory
- DataModel annotation factory.
- AnnotationSet
- Annotation set.
- ArticleNode
- DataModel article node.
- BidiAnnotation
- DataModel bi-di annotation.
- BigAnnotation
- DataModel big annotation.
- BlockImageCaptionNode
- DataModel block image caption node.
- BlockImageNode
- DataModel block image node.
- BlockquoteNode
- DataModel Blockquote node.
- BoldAnnotation
- DataModel bold annotation.
- BranchNode
- DataModel branch node.
- BreakNode
- DataModel break node.
- CenterNode
- DataModel center node.
- Change
- DataModel change.
- CheckListItemNode
- DataModel list item node.
- CheckListNode
- DataModel list node.
- ClassAttributeNode
- DataModel class-attribute node.
- CodeAnnotation
- DataModel code annotation.
- CodeSampleAnnotation
- DataModel code sample annotation.
- CommentAnnotation
- DataModel comment annotation.
- CommentMetaItem
- CommentNode
- ContentBranchNode
- DataModel content branch node.
- Converter
- DataModel converter.
- DataString
- Wrapper class to read document data as a plain text string.
- DatetimeAnnotation
- DataModel datetime annotation.
- DefinitionAnnotation
- DataModel definition annotation.
- DefinitionListItemNode
- DataModel definition list item node.
- DefinitionListNode
- DataModel definition list node.
- DeleteAnnotation
- DataModel delete annotation.
- DivNode
- DataModel div node.
- Document
- DataModel document.
- DocumentNode
- DataModel document node.
- DocumentSlice
- DataModel document slice
- DocumentStore
- ElementLinearData
- Element linear data storage
- FakeCommentNode
Fake comments generated by the converter for the clipboard
<span rel="ve:Comment">is used to to preserve comments in the clipboard- FlatLinearData
- Flat linear data storage
- FocusableNode
- A mixin class for focusable nodes.
- FontAnnotation
- DataModel font annotation.
- GeneratedContentNode
- DataModel generated content node.
- HashValueStore
Ordered append-only hash store, whose values once inserted are immutable
Values are objects, strings or Arrays, and are hashed using an algorithm with low collision probability: values with the same hash can be assumed equal.
- HeadingNode
- DataModel heading node.
- HighlightAnnotation
- DataModel highlight annotation.
- HorizontalRuleNode
- DataModel horizontal rule node.
- ImageNode
- DataModel image node.
- ImportedDataAnnotation
- DataModel imported data (paste/drag and drop) annotation.
- InlineImageNode
- DataModel inline image node.
- InsertAnnotation
- DataModel insert annotation.
- InternalItemNode
- DataModel internal item node.
- InternalList
- DataModel meta item.
- InternalListNode
- DataModel internal list node.
- ItalicAnnotation
- DataModel italic annotation.
- LanguageAnnotation
- DataModel language annotation.
- LeafNode
- DataModel leaf node.
- LinearData
- Generic linear data storage
- LinearSelection
- LinkAnnotation
- DataModel link annotation.
- ListItemNode
- DataModel list item node.
- ListNode
- DataModel list node.
- MetaItem
- DataModel meta item.
- MetaList
- DataModel meta list.
- Model
- Base class for DM models.
- ModelFactory
- DataModel meta item factory.
- ModelRegistry
- Registry for models.
- Node
- Generic DataModel node.
- NodeFactory
- DataModel node factory.
- NullSelection
- ParagraphNode
- DataModel paragraph node.
- PreformattedNode
- DataModel preformatted node.
- QuotationAnnotation
- DataModel quotation annotation.
- RealCommentNode
- RebaseClient
- DataModel rebase client
- RebaseDocState
- DataModel rebase document state
- RebaseServer
- DataModel rebase server
- RemovableAlienMetaItem
- DataModel removable alien meta item.
- ResizableNode
- A mixin class for resizable nodes.
- Scalable
- Scalable object.
- SectionNode
- DataModel section node.
- Selection
- SmallAnnotation
- DataModel small annotation.
- SourceSurfaceFragment
- Surface fragment for editing surfaces in source mode.
- SpanAnnotation
- DataModel span annotation.
- StrikethroughAnnotation
- DataModel strikethrough annotation.
- SubscriptAnnotation
- DataModel subscript annotation.
- SuperscriptAnnotation
- DataModel superscript annotation.
- Surface
DataModel surface for a node within a document
Methods do not check that ranges actually lie inside the surfaced node
- SurfaceFragment
- DataModel surface fragment.
- SurfaceSynchronizer
- DataModel surface synchronizer.
- TableCaptionNode
- DataModel table caption node.
- TableCellNode
- DataModel table cell node.
- TableCellableNode
- DataModel node which can behave as a table cell
- TableMatrix
A helper class that allows random access to the table cells and introduces place-holders for fields occupied by spanning cells, making it a non-sparse representation of the sparse HTML model.
- TableMatrixCell
- An object wrapping a table cell node, augmenting it with row and column indexes.
- TableNode
- DataModel table node.
- TableNodeCellIterator
- A helper class to iterate over the cells of a table node.
- TableRowNode
- DataModel table row node.
- TableSectionNode
- DataModel table section node.
- TableSelection
- TableSlice
- DataModel document slice
- TextNode
- DataModel text node.
- TextStyleAnnotation
- DataModel text style annotation.
- Transaction
Transaction on
ve.dm.ElementLinearData, preservingve.dm.Document tree validityA transaction represents a mapping on
ve.dm.ElementLinearData, from one state (the start state) to another (the end state).- TransactionBuilder
- Transaction builder: build transactions based on current
ve.dm.Document state - TransactionProcessor
- DataModel transaction processor.
- TransactionSquasher
Squasher to create one transaction from multiple transactions applicable in turn
The squashed transaction has the same effect on a document as applying the original transactions in turn, but it may cause rebase conflicts where the original sequence of transactions would not have.
- TransportServer
- Transport server for Socket IO transport
- TreeCursor
- DataModel TreeCursor - a tree walker that tracks the path to the current position.
- TreeModifier
- DataModel tree modifier, following the algorithm in T162762.
- UnderlineAnnotation
- DataModel underline annotation.
- UserInputAnnotation
- DataModel user input annotation.
- VariableAnnotation
- DataModel variable annotation.
- VisualDiff
VisualDiff
Gets the diff between two VisualEditor DataModel DocumentNodes
Methods
ProtocolServer(documentStore, logger)static
#
Protocol server
Handles the abstract protocol without knowing the specific transport
Parameters:
| Name | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
documentStore |
ve.dm.DocumentStore | The persistent storage |
||||||||||||
logger |
Object | Logger class Properties:
|
Protocol server
Handles the abstract protocol without knowing the specific transport