ViewAttributeElement

class

Attribute elements are used to represent formatting elements in the view (think – <b>, <span style="font-size: 2em">, etc.). Most often they are created when downcasting model text attributes.

Editing engine does not define a fixed HTML DTD. This is why a feature developer needs to choose between various types (container element, attribute element, empty element, etc) when developing a feature.

To create a new attribute element instance use the ViewDowncastWriter#createAttributeElement() method.

See source

Properties

_classes : undefined | ViewTokenList
readonlyinherited

Set of classes associated with element instance.

Note that this is just an alias for this._attrs.get( 'class' );

See source (with github icon)
_styles : undefined | StylesMap
readonlyinherited

Normalized styles.

Note that this is just an alias for this._attrs.get( 'style' );

See source (with github icon)
childCount : number
readonlyinherited

Number of element's children.

See source (with github icon)
document : ViewDocument
readonlyinherited

The document instance to which this node belongs.

See source (with github icon)
id : null | string | number
readonly

Element identifier. If set, it is used by isSimilar, and then two elements are considered similar if, and only if they have the same id.

See source (with github icon)
index : null | number
readonlyinherited

Index of the node in the parent element or null if the node has no parent.

Accessing this property throws an error if this node's parent element does not contain it. This means that view tree got broken.

See source (with github icon)
isEmpty : boolean
readonlyinherited

Is true if there are no nodes inside this element, false otherwise.

See source (with github icon)
name : string
readonlyinherited

Name of the element.

See source (with github icon)
nextSibling : null | ViewNode
readonlyinherited

Node's next sibling, or null if it is the last child.

See source (with github icon)
parent : null | ViewElement | ViewDocumentFragment
readonlyinherited

Parent element. Null by default. Set by _insertChild.

See source (with github icon)
previousSibling : null | ViewNode
readonlyinherited

Node's previous sibling, or null if it is the first child.

See source (with github icon)
priority : number
readonly

Element priority. Decides in what order elements are wrapped by ViewDowncastWriter.

See source (with github icon)
root : ViewElement | ViewDocumentFragment
readonlyinherited

Top-most ancestor of the node. If the node has no parent it is the root itself.

See source (with github icon)
_id : null | string | number
internalreadonly

Element identifier. If set, it is used by isSimilar, and then two elements are considered similar if, and only if they have the same _id.

See source (with github icon)
_priority : number
internalreadonly

Element priority. Decides in what order elements are wrapped by ViewDowncastWriter.

See source (with github icon)
_unsafeAttributesToRender : Array<string>
internalreadonlyinherited

A list of attribute names that should be rendered in the editing pipeline even though filtering mechanisms implemented in the ViewDomConverter (for instance, shouldRenderAttribute) would filter them out.

These attributes can be specified as an option when the element is created by the ViewDowncastWriter. To check whether an unsafe an attribute should be permitted, use the shouldRenderUnsafeAttribute method.

See source (with github icon)
_clonesGroup : null | Set<ViewAttributeElement>
privatereadonly

Keeps all the attribute elements that have the same ids and still exist in the view tree.

This property is managed by ViewDowncastWriter.

See source (with github icon)

Static properties

DEFAULT_PRIORITY : number
readonlystatic

See source (with github icon)

Methods

constructor( document, name, [ attrs ], [ children ] )
protected

module:engine/view/attributeelement~ViewAttributeElement#constructor
Creates an attribute element.

See source (with github icon)

Parameters

document : ViewDocument

The document instance to which this element belongs.

name : string

Node name.

[ attrs ] : ViewElementAttributes

Collection of attributes.

[ children ] : ViewNode | Iterable<ViewNode>

A list of nodes to be inserted into created element.

Related:
- ViewDowncastWriter#createAttributeElement
- ViewElement
delegate( events ) → EmitterMixinDelegateChain
inherited

module:engine/view/attributeelement~ViewAttributeElement#delegate
Delegates selected events to another Emitter. For instance:
```
emitterA.delegate( 'eventX' ).to( emitterB );
emitterA.delegate( 'eventX', 'eventY' ).to( emitterC );
```
Copy code
then eventX is delegated (fired by) emitterB and emitterC along with data:
```
emitterA.fire( 'eventX', data );
```
Copy code
and eventY is delegated (fired by) emitterC along with data:
```
emitterA.fire( 'eventY', data );
```
Copy code
See source (with github icon)

Parameters

events : Array<string>

Event names that will be delegated to another emitter.

Returns

EmitterMixinDelegateChain
findAncestor( patterns ) → null | ViewElement
inherited

module:engine/view/attributeelement~ViewAttributeElement#findAncestor
Returns ancestor element that match specified pattern. Provided patterns should be compatible with Matcher as it is used internally.

See source (with github icon)

Parameters

patterns : Array<MatcherPattern | ( element: ViewElement ) => boolean>

Patterns used to match correct ancestor. See Matcher.

Returns

null | ViewElement

Found element or null if no matching ancestor was found.

Related:
- Matcher
fire( eventOrInfo, args ) → GetEventInfo<TEvent>[ 'return' ]
inherited

Fires an event, executing all callbacks registered for it.

The first parameter passed to callbacks is an EventInfo object, followed by the optional args provided in the fire() method call.

See source (with github icon)

Type parameters

TEvent : extends BaseEvent

The type describing the event. See BaseEvent.

Parameters

eventOrInfo : GetNameOrEventInfo<TEvent>

The name of the event or EventInfo object if event is delegated.

args : TEvent[ 'args' ]

Additional arguments to be passed to the callbacks.

Returns

GetEventInfo<TEvent>[ 'return' ]

By default the method returns undefined. However, the return value can be changed by listeners through modification of the evt.return's property (the event info is the first param of every callback).
getAncestors( options = { [options.includeSelf], [options.parentFirst] } ) → Array<ViewNode | ViewDocumentFragment>
inherited

Returns ancestors array of this node.

See source (with github icon)

Parameters

options : object

Options object.

Properties

[ options.includeSelf ] : boolean

When set to true this node will be also included in parent's array.

[ options.parentFirst ] : boolean

When set to true, array will be sorted from node's parent to root element, otherwise root element will be the first item in the array.

Defaults to {}

Returns

Array<ViewNode | ViewDocumentFragment>

Array with ancestors.
getAttribute( key ) → undefined | string
inherited

Gets attribute by key. If attribute is not present - returns undefined.

See source (with github icon)

Parameters

key : string

Attribute key.

Returns

undefined | string

Attribute value.
getAttributeKeys() → IterableIterator<string>
inherited

Returns an iterator that contains the keys for attributes. Order of inserting attributes is not preserved.

See source (with github icon)

Returns

IterableIterator<string>

Keys for attributes.
getAttributes() → IterableIterator<tuple>
inherited

Returns iterator that iterates over this element's attributes.

Attributes are returned as arrays containing two items. First one is attribute key and second is attribute value. This format is accepted by native Map object and also can be passed in Node constructor.

See source (with github icon)

Returns

IterableIterator<tuple>
getChild( index ) → undefined | ViewNode
inherited

Gets child at the given index.

See source (with github icon)

Parameters

index : number

Index of child.

Returns

undefined | ViewNode

Child node.
getChildIndex( node ) → number
inherited

Gets index of the given child node. Returns -1 if child node is not found.

See source (with github icon)

Parameters

node : ViewNode

Child node.

Returns

number

Index of the child node.
getChildren() → IterableIterator<ViewNode>
inherited

Gets child nodes iterator.

See source (with github icon)

Returns

IterableIterator<ViewNode>

Child nodes iterator.
getClassNames() → IterableIterator<string>
inherited

Returns iterator that contains all class names.

See source (with github icon)

Returns

IterableIterator<string>
getCommonAncestor( node, options = { [options.includeSelf] } ) → null | ViewElement | ViewDocumentFragment
inherited

Returns a ViewElement or ViewDocumentFragment which is a common ancestor of both nodes.

See source (with github icon)

Parameters

node : ViewNode

The second node.

options : object

Options object.

Properties

[ options.includeSelf ] : boolean

When set to true both nodes will be considered "ancestors" too. Which means that if e.g. node A is inside B, then their common ancestor will be B.

Defaults to {}

Returns

null | ViewElement | ViewDocumentFragment
getCustomProperties() → IterableIterator<tuple>
inherited

Returns an iterator which iterates over this element's custom properties. Iterator provides [ key, value ] pairs for each stored property.

See source (with github icon)

Returns

IterableIterator<tuple>
getCustomProperty( key ) → unknown
inherited

Returns the custom property value for the given key.

See source (with github icon)

Parameters

key : string | symbol

Returns

unknown
getElementsWithSameId() → Set<ViewAttributeElement>

Returns all attribute elements that has the same id and are in the view tree (were not removed).

Note: If this element has been removed from the tree, returned set will not include it.

Throws attribute-element-get-elements-with-same-id-no-id if this element has no id.

See source (with github icon)

Returns

Set<ViewAttributeElement>

Set containing all the attribute elements with the same id that were added and not removed from the view tree.
getFillerOffset() → null | number
inherited

Returns block filler offset or null if block filler is not needed.

See source (with github icon)

Returns

null | number
getIdentity() → string
inherited

module:engine/view/attributeelement~ViewAttributeElement#getIdentity
Returns identity string based on element's name, styles, classes and other attributes. Two elements that are similar will have same identity string. It has the following format:
```
'name class="class1,class2" style="style1:value1;style2:value2" attr1="val1" attr2="val2"'
```
Copy code
For example:
```
const element = writer.createContainerElement( 'foo', {
	banana: '10',
	apple: '20',
	style: 'color: red; border-color: white;',
	class: 'baz'
} );

// returns 'foo class="baz" style="border-color:white;color:red" apple="20" banana="10"'
element.getIdentity();
```
Copy code
Note: Classes, styles and other attributes are sorted alphabetically.

See source (with github icon)

Returns

string
getNormalizedStyle( property ) → undefined | StyleValue
inherited

module:engine/view/attributeelement~ViewAttributeElement#getNormalizedStyle
Returns a normalized style object or single style value.

For an element with style set to: margin:1px 2px 3em;
```
element.getNormalizedStyle( 'margin' ) );
```
Copy code
will return:
```
{
	top: '1px',
	right: '2px',
	bottom: '3em',
	left: '2px'    // a normalized value from margin shorthand
}
```
Copy code
and reading for single style value:
```
styles.getNormalizedStyle( 'margin-left' );
```
Copy code
Will return a 2px string.

Note: This method will return normalized values only if a particular style processor rule is enabled. See StylesMap#getNormalized() for details.

See source (with github icon)

Parameters

property : string

Name of CSS property

Returns

undefined | StyleValue

`getPath() → Array<number>`
inherited

module:engine/view/attributeelement~ViewAttributeElement#getPath

Gets a path to the node. The path is an array containing indices of consecutive ancestors of this node, beginning from root, down to this node's index.

const abc = downcastWriter.createText( 'abc' );
const foo = downcastWriter.createText( 'foo' );
const h1 = downcastWriter.createElement( 'h1', null, downcastWriter.createText( 'header' ) );
const p = downcastWriter.createElement( 'p', null, [ abc, foo ] );
const div = downcastWriter.createElement( 'div', null, [ h1, p ] );
foo.getPath(); // Returns [ 1, 3 ]. `foo` is in `p` which is in `div`. `p` starts at offset 1, while `foo` at 3.
h1.getPath(); // Returns [ 0 ].
div.getPath(); // Returns [].

See source

Returns

Array<number>: The path.

getStyle( property ) → undefined | string
inherited

module:engine/view/attributeelement~ViewAttributeElement#getStyle
Returns style value for the given property name. If the style does not exist undefined is returned.

Note: This method can work with normalized style names if a particular style processor rule is enabled. See StylesMap#getAsString() for details.

For an element with style set to 'margin:1px':
```
// Enable 'margin' shorthand processing:
editor.data.addStyleProcessorRules( addMarginStylesRules );

const element = view.change( writer => {
	const element = writer.createElement();
	writer.setStyle( 'margin', '1px' );
	writer.setStyle( 'margin-bottom', '3em' );

	return element;
} );

element.getStyle( 'margin' ); // -> 'margin: 1px 1px 3em;'
```
Copy code
See source (with github icon)

Parameters

property : string

Returns

undefined | string
getStyleNames( [ expand ] ) → Array<string>
inherited

Returns an array that contains all style names.

See source (with github icon)

Parameters

[ expand ] : boolean

Expand shorthand style properties and return all equivalent style representations.

Returns

Array<string>
hasAttribute( key, [ token ] ) → boolean
inherited

Returns a boolean indicating whether an attribute with the specified key exists in the element.

See source (with github icon)

Parameters

key : string

Attribute key.

[ token ] : string

Returns

boolean

true if attribute with the specified key exists in the element, false otherwise.
hasClass( className ) → boolean
inherited

module:engine/view/attributeelement~ViewAttributeElement#hasClass
Returns true if class is present. If more then one class is provided - returns true only when all classes are present.
```
element.hasClass( 'foo' ); // Returns true if 'foo' class is present.
element.hasClass( 'foo', 'bar' ); // Returns true if 'foo' and 'bar' classes are both present.
```
Copy code
See source (with github icon)

Parameters

className : Array<string>

Returns

boolean
hasStyle( property ) → boolean
inherited

module:engine/view/attributeelement~ViewAttributeElement#hasStyle
Returns true if style keys are present. If more then one style property is provided - returns true only when all properties are present.
```
element.hasStyle( 'color' ); // Returns true if 'border-top' style is present.
element.hasStyle( 'color', 'border-top' ); // Returns true if 'color' and 'border-top' styles are both present.
```
Copy code
See source (with github icon)

Parameters

property : Array<string>

Returns

boolean
is( type ) → this is ViewElement | ViewAttributeElement | ViewContainerElement | ViewEditableElement | ViewEmptyElement | ViewRawElement | ViewRootEditableElement | ViewUIElement
inherited

module:engine/view/attributeelement~ViewAttributeElement#is:ELEMENT
Checks whether this object is of type ViewElement or its subclass.
```
element.is( 'element' ); // -> true
element.is( 'node' ); // -> true
element.is( 'view:element' ); // -> true
element.is( 'view:node' ); // -> true

element.is( 'model:element' ); // -> false
element.is( 'documentSelection' ); // -> false
```
Copy code
Assuming that the object being checked is an element, you can also check its name:
```
element.is( 'element', 'img' ); // -> true if this is an <img> element
text.is( 'element', 'img' ); -> false
```
Copy code
See source (with github icon)

Parameters

type : 'element' | 'view:element'

Returns

this is ViewElement | ViewAttributeElement | ViewContainerElement | ViewEditableElement | ViewEmptyElement | ViewRawElement | ViewRootEditableElement | ViewUIElement

`is( type ) → this is ViewContainerElement | ViewEditableElement | ViewRootEditableElement`
inherited

module:engine/view/attributeelement~ViewAttributeElement#is:CONTAINER_ELEMENT

Checks whether this object is of type ViewContainerElement or its subclass.

containerElement.is( 'containerElement' ); // -> true
containerElement.is( 'element' ); // -> true
containerElement.is( 'node' ); // -> true
containerElement.is( 'view:containerElement' ); // -> true
containerElement.is( 'view:element' ); // -> true
containerElement.is( 'view:node' ); // -> true

containerElement.is( 'model:element' ); // -> false
containerElement.is( 'documentFragment' ); // -> false

Assuming that the object being checked is a container element, you can also check its name:

containerElement.is( 'element', 'div' ); // -> true if this is a div container element
containerElement.is( 'contaienrElement', 'div' ); // -> same as above
text.is( 'element', 'div' ); -> false

See source

Parameters

type : 'containerElement' | 'view:containerElement'

Returns

this is ViewContainerElement | ViewEditableElement | ViewRootEditableElement

`is( type ) → this is ViewAttributeElement`
inherited

module:engine/view/attributeelement~ViewAttributeElement#is:ATTRIBUTE_ELEMENT

Checks whether this object is of type ViewAttributeElement.

attributeElement.is( 'attributeElement' ); // -> true
attributeElement.is( 'element' ); // -> true
attributeElement.is( 'node' ); // -> true
attributeElement.is( 'view:attributeElement' ); // -> true
attributeElement.is( 'view:element' ); // -> true
attributeElement.is( 'view:node' ); // -> true

attributeElement.is( 'model:element' ); // -> false
attributeElement.is( 'documentFragment' ); // -> false

Assuming that the object being checked is an attribute element, you can also check its name:

attributeElement.is( 'element', 'b' ); // -> true if this is a bold element
attributeElement.is( 'attributeElement', 'b' ); // -> same as above
text.is( 'element', 'b' ); -> false

See source

Parameters

type : 'attributeElement' | 'view:attributeElement'

Returns

this is ViewAttributeElement

`is( type ) → this is ViewRawElement`
inherited

module:engine/view/attributeelement~ViewAttributeElement#is:RAW_ELEMENT

Checks whether this object is of type ViewRawElement.

rawElement.is( 'rawElement' ); // -> true
rawElement.is( 'element' ); // -> true
rawElement.is( 'node' ); // -> true
rawElement.is( 'view:rawElement' ); // -> true
rawElement.is( 'view:element' ); // -> true
rawElement.is( 'view:node' ); // -> true

rawElement.is( 'model:element' ); // -> false
rawElement.is( 'documentFragment' ); // -> false

Assuming that the object being checked is a raw element, you can also check its name:

rawElement.is( 'img' ); // -> true if this is an img element
rawElement.is( 'rawElement', 'img' ); // -> same as above
text.is( 'img' ); -> false

See source

Parameters

type : 'rawElement' | 'view:rawElement'

Returns

this is ViewRawElement

`is( type ) → this is ViewEmptyElement`
inherited

module:engine/view/attributeelement~ViewAttributeElement#is:EMPTY_ELEMENT

Checks whether this object is of type ViewEmptyElement.

emptyElement.is( 'emptyElement' ); // -> true
emptyElement.is( 'element' ); // -> true
emptyElement.is( 'node' ); // -> true
emptyElement.is( 'view:emptyElement' ); // -> true
emptyElement.is( 'view:element' ); // -> true
emptyElement.is( 'view:node' ); // -> true

emptyElement.is( 'model:element' ); // -> false
emptyElement.is( 'documentFragment' ); // -> false

Assuming that the object being checked is an empty element, you can also check its name:

emptyElement.is( 'element', 'img' ); // -> true if this is a img element
emptyElement.is( 'emptyElement', 'img' ); // -> same as above
text.is( 'element', 'img' ); -> false

See source

Parameters

type : 'emptyElement' | 'view:emptyElement'

Returns

this is ViewEmptyElement

`is( type ) → this is ViewEditableElement | ViewRootEditableElement`
inherited

module:engine/view/attributeelement~ViewAttributeElement#is:EDITABLE_ELEMENT

Checks whether this object is of type ViewEditableElement or its subclass.

editableElement.is( 'editableElement' ); // -> true
editableElement.is( 'element' ); // -> true
editableElement.is( 'node' ); // -> true
editableElement.is( 'view:editableElement' ); // -> true
editableElement.is( 'view:element' ); // -> true
editableElement.is( 'view:node' ); // -> true

editableElement.is( 'model:element' ); // -> false
editableElement.is( 'documentFragment' ); // -> false

Assuming that the object being checked is an editbale element, you can also check its name:

editableElement.is( 'element', 'div' ); // -> true if this is a div element
editableElement.is( 'editableElement', 'div' ); // -> same as above
text.is( 'element', 'div' ); -> false

See source

Parameters

type : 'editableElement' | 'view:editableElement'

Returns

this is ViewEditableElement | ViewRootEditableElement

is( type ) → this is ViewDocumentFragment
inherited

module:engine/view/attributeelement~ViewAttributeElement#is:DOCUMENT_FRAGMENT
hecks whether this object is of type ViewDocumentFragment.
```
docFrag.is( 'documentFragment' ); // -> true
docFrag.is( 'view:documentFragment' ); // -> true

docFrag.is( 'model:documentFragment' ); // -> false
docFrag.is( 'element' ); // -> false
docFrag.is( 'node' ); // -> false
```
Copy code
See source (with github icon)

Parameters

type : 'documentFragment' | 'view:documentFragment'

Returns

this is ViewDocumentFragment
is( type ) → this is ViewDocumentSelection
inherited

module:engine/view/attributeelement~ViewAttributeElement#is:DOCUMENT_SELECTION
Checks whether this object is of type ViewDocumentSelection.
```
`docSelection.is( 'selection' ); // -> true
docSelection.is( 'documentSelection' ); // -> true
docSelection.is( 'view:selection' ); // -> true
docSelection.is( 'view:documentSelection' ); // -> true

docSelection.is( 'model:documentSelection' ); // -> false
docSelection.is( 'element' ); // -> false
docSelection.is( 'node' ); // -> false
```
Copy code
See source (with github icon)

Parameters

type : 'documentSelection' | 'view:documentSelection'

Returns

this is ViewDocumentSelection
is( type ) → this is ViewSelection | ViewDocumentSelection
inherited

module:engine/view/attributeelement~ViewAttributeElement#is:SELECTION
Checks whether this object is of type ViewSelection or ViewDocumentSelection.
```
selection.is( 'selection' ); // -> true
selection.is( 'view:selection' ); // -> true

selection.is( 'model:selection' ); // -> false
selection.is( 'element' ); // -> false
selection.is( 'range' ); // -> false
```
Copy code
See source (with github icon)

Parameters

type : 'selection' | 'view:selection'

Returns

this is ViewSelection | ViewDocumentSelection
is( type ) → this is ViewRange
inherited

module:engine/view/attributeelement~ViewAttributeElement#is:RANGE
Checks whether this object is of type ViewRange.
```
range.is( 'range' ); // -> true
range.is( 'view:range' ); // -> true

range.is( 'model:range' ); // -> false
range.is( 'element' ); // -> false
range.is( 'selection' ); // -> false
```
Copy code
See source (with github icon)

Parameters

type : 'range' | 'view:range'

Returns

this is ViewRange
is( type ) → this is ViewPosition
inherited

module:engine/view/attributeelement~ViewAttributeElement#is:POSITION
Checks whether this object is of type ViewPosition.
```
position.is( 'position' ); // -> true
position.is( 'view:position' ); // -> true

position.is( 'model:position' ); // -> false
position.is( 'element' ); // -> false
position.is( 'range' ); // -> false
```
Copy code
See source (with github icon)

Parameters

type : 'position' | 'view:position'

Returns

this is ViewPosition
is( type ) → this is ViewTextProxy
inherited

module:engine/view/attributeelement~ViewAttributeElement#is:TEXT_PROXY
Checks whether this object is of type ViewTextProxy.
```
textProxy.is( '$textProxy' ); // -> true
textProxy.is( 'view:$textProxy' ); // -> true

textProxy.is( 'model:$textProxy' ); // -> false
textProxy.is( 'element' ); // -> false
textProxy.is( 'range' ); // -> false
```
Copy code
Note: Until version 20.0.0 this method wasn't accepting '$textProxy' type. The legacy 'textProxy' type is still accepted for backward compatibility.

See source (with github icon)

Parameters

type : '$textProxy' | 'view:$textProxy'

Returns

this is ViewTextProxy
is( type ) → this is ViewText
inherited

module:engine/view/attributeelement~ViewAttributeElement#is:TEXT
Checks whether this object is of type ViewText.
```
text.is( '$text' ); // -> true
text.is( 'node' ); // -> true
text.is( 'view:$text' ); // -> true
text.is( 'view:node' ); // -> true

text.is( 'model:$text' ); // -> false
text.is( 'element' ); // -> false
text.is( 'range' ); // -> false
```
Copy code
See source (with github icon)

Parameters

type : '$text' | 'view:$text'

Returns

this is ViewText

`is( type ) → this is ViewUIElement`
inherited

module:engine/view/attributeelement~ViewAttributeElement#is:UI_ELEMENT

Checks whether this object is of type ViewUIElement.

uiElement.is( 'uiElement' ); // -> true
uiElement.is( 'element' ); // -> true
uiElement.is( 'node' ); // -> true
uiElement.is( 'view:uiElement' ); // -> true
uiElement.is( 'view:element' ); // -> true
uiElement.is( 'view:node' ); // -> true

uiElement.is( 'model:element' ); // -> false
uiElement.is( 'documentFragment' ); // -> false

Assuming that the object being checked is an ui element, you can also check its name:

uiElement.is( 'element', 'span' ); // -> true if this is a span ui element
uiElement.is( 'uiElement', 'span' ); // -> same as above
text.is( 'element', 'span' ); -> false

See source

Parameters

type : 'uiElement' | 'view:uiElement'

Returns

this is ViewUIElement

`is( type ) → this is ViewRootEditableElement`
inherited

module:engine/view/attributeelement~ViewAttributeElement#is:ROOT_ELEMENT

Checks whether this object is of type ViewRootEditableElement.

rootEditableElement.is( 'rootElement' ); // -> true
rootEditableElement.is( 'editableElement' ); // -> true
rootEditableElement.is( 'element' ); // -> true
rootEditableElement.is( 'node' ); // -> true
rootEditableElement.is( 'view:editableElement' ); // -> true
rootEditableElement.is( 'view:element' ); // -> true
rootEditableElement.is( 'view:node' ); // -> true

rootEditableElement.is( 'model:element' ); // -> false
rootEditableElement.is( 'documentFragment' ); // -> false

Assuming that the object being checked is a root editable element, you can also check its name:

rootEditableElement.is( 'element', 'div' ); // -> true if this is a div root editable element
rootEditableElement.is( 'rootElement', 'div' ); // -> same as above
text.is( 'element', 'div' ); -> false

See source

Parameters

type : 'rootElement' | 'view:rootElement'

Returns

this is ViewRootEditableElement

is( type, name ) → boolean
inherited

Checks whether the object is of type ViewContainerElement or its subclass and has the specified name.

See source (with github icon)

Type parameters

N : extends string

Parameters

type : 'containerElement' | 'view:containerElement'

name : N

Returns

boolean
is( type, name ) → boolean
inherited

Checks whether the object is of type ViewRootEditableElement and has the specified name.

See source (with github icon)

Type parameters

N : extends string

Parameters

type : 'rootElement' | 'view:rootElement'

name : N

Returns

boolean
is( type, name ) → boolean
inherited

Checks whether the object is of type ViewUIElement and has the specified name.

See source (with github icon)

Type parameters

N : extends string

Parameters

type : 'uiElement' | 'view:uiElement'

name : N

Returns

boolean
is( type, name ) → boolean
inherited

Checks whether the object is of type ViewRawElement and has the specified name.

See source (with github icon)

Type parameters

N : extends string

Parameters

type : 'rawElement' | 'view:rawElement'

name : N

Returns

boolean
is( type, name ) → boolean
inherited

Checks whether the object is of type ViewEmptyElement has the specified name.

See source (with github icon)

Type parameters

N : extends string

Parameters

type : 'emptyElement' | 'view:emptyElement'

name : N

Returns

boolean
is( type, name ) → boolean
inherited

Checks whether the object is of type ViewEditableElement or its subclass and has the specified name.

See source (with github icon)

Type parameters

N : extends string

Parameters

type : 'editableElement' | 'view:editableElement'

name : N

Returns

boolean
is( type, name ) → boolean
inherited

Checks whether the object is of type ViewAttributeElement and has the specified name.

See source (with github icon)

Type parameters

N : extends string

Parameters

type : 'attributeElement' | 'view:attributeElement'

name : N

Returns

boolean
is( type, name ) → boolean
inherited

Checks whether the object is of type ViewElement or its subclass and has the specified name.

See source (with github icon)

Type parameters

N : extends string

Parameters

type : 'element' | 'view:element'

name : N

Returns

boolean
is( type ) → this is ViewText | ViewNode | ViewElement | ViewAttributeElement | ViewContainerElement | ViewEditableElement | ViewEmptyElement | ViewRawElement | ViewRootEditableElement | ViewUIElement
inherited

module:engine/view/attributeelement~ViewAttributeElement#is:NODE
Checks whether this object is of type ViewNode or its subclass.

This method is useful when processing view objects that are of unknown type. For example, a function may return a ViewDocumentFragment or a ViewNode that can be either a text node or an element. This method can be used to check what kind of object is returned.
```
someObject.is( 'element' ); // -> true if this is an element
someObject.is( 'node' ); // -> true if this is a node (a text node or an element)
someObject.is( 'documentFragment' ); // -> true if this is a document fragment
```
Copy code
Since this method is also available on a range of model objects, you can prefix the type of the object with model: or view: to check, for example, if this is the model's or view's element:
```
viewElement.is( 'view:element' ); // -> true
viewElement.is( 'model:element' ); // -> false
```
Copy code
By using this method it is also possible to check a name of an element:
```
imgElement.is( 'element', 'img' ); // -> true
imgElement.is( 'view:element', 'img' ); // -> same as above, but more precise
```
Copy code
See source (with github icon)

Parameters

type : 'node' | 'view:node'

Returns

this is ViewText | ViewNode | ViewElement | ViewAttributeElement | ViewContainerElement | ViewEditableElement | ViewEmptyElement | ViewRawElement | ViewRootEditableElement | ViewUIElement
isAfter( node ) → boolean
inherited

Returns whether this node is after given node. false is returned if nodes are in different trees (for example, in different ViewDocumentFragments).

See source (with github icon)

Parameters

node : ViewNode

Node to compare with.

Returns

boolean
isAttached() → boolean
inherited

Returns true if the node is in a tree rooted in the document (is a descendant of one of its roots).

See source (with github icon)

Returns

boolean
isBefore( node ) → boolean
inherited

Returns whether this node is before given node. false is returned if nodes are in different trees (for example, in different ViewDocumentFragments).

See source (with github icon)

Parameters

node : ViewNode

Node to compare with.

Returns

boolean
isSimilar( otherElement ) → boolean

module:engine/view/attributeelement~ViewAttributeElement#isSimilar
Checks if this element is similar to other element.

If none of elements has set id, then both elements should have the same name, attributes and priority to be considered as similar. Two similar elements can contain different set of children nodes.

If at least one element has id set, then both elements have to have the same id value to be considered similar.

Similarity is important for ViewDowncastWriter. For example:
- two following similar elements can be merged together into one, longer element,
- unwrap checks similarity of passed element and processed element to decide whether processed element should be unwrapped,
- etc.
See source (with github icon)

Parameters

otherElement : ViewElement

Returns

boolean
listenTo( emitter, event, callback, [ options ] ) → void
inherited

module:engine/view/attributeelement~ViewAttributeElement#listenTo:BASE_EMITTER
Registers a callback function to be executed when an event is fired in a specific (emitter) object.

Events can be grouped in namespaces using :. When namespaced event is fired, it additionally fires all callbacks for that namespace.
```
// myEmitter.on( ... ) is a shorthand for myEmitter.listenTo( myEmitter, ... ).
myEmitter.on( 'myGroup', genericCallback );
myEmitter.on( 'myGroup:myEvent', specificCallback );

// genericCallback is fired.
myEmitter.fire( 'myGroup' );
// both genericCallback and specificCallback are fired.
myEmitter.fire( 'myGroup:myEvent' );
// genericCallback is fired even though there are no callbacks for "foo".
myEmitter.fire( 'myGroup:foo' );
```
Copy code
An event callback can stop the event and set the return value of the fire method.

See source (with github icon)

Type parameters

TEvent : extends BaseEvent

The type describing the event. See BaseEvent.

Parameters

emitter : Emitter

The object that fires the event.

event : TEvent[ 'name' ]

The name of the event.

callback : GetCallback<TEvent>

The function to be called on event.

[ options ] : GetCallbackOptions<TEvent>

Additional options.

Returns

void
off( event, callback ) → void
inherited

Stops executing the callback on the given event. Shorthand for this.stopListening( this, event, callback ).

See source (with github icon)

Parameters

event : string

The name of the event.

callback : Function

The function to stop being called.

Returns

void
on( event, callback, [ options ] ) → void
inherited

Registers a callback function to be executed when an event is fired.

Shorthand for this.listenTo( this, event, callback, options ) (it makes the emitter listen on itself).

See source (with github icon)

Type parameters

TEvent : extends BaseEvent

The type descibing the event. See BaseEvent.

Parameters

event : TEvent[ 'name' ]

The name of the event.

callback : GetCallback<TEvent>

The function to be called on event.

[ options ] : GetCallbackOptions<TEvent>

Additional options.

Returns

void
once( event, callback, [ options ] ) → void
inherited

Registers a callback function to be executed on the next time the event is fired only. This is similar to calling on followed by off in the callback.

See source (with github icon)

Type parameters

TEvent : extends BaseEvent

The type descibing the event. See BaseEvent.

Parameters

event : TEvent[ 'name' ]

The name of the event.

callback : GetCallback<TEvent>

The function to be called on event.

[ options ] : GetCallbackOptions<TEvent>

Additional options.

Returns

void
shouldRenderUnsafeAttribute( attributeName ) → boolean
inherited

Decides whether an unsafe attribute is whitelisted and should be rendered in the editing pipeline even though filtering mechanisms like shouldRenderAttribute say it should not.

Unsafe attribute names can be specified when creating an element via ViewDowncastWriter.

See source (with github icon)

Parameters

attributeName : string

The name of the attribute to be checked.

Returns

boolean
stopDelegating( [ event ], [ emitter ] ) → void
inherited

module:engine/view/attributeelement~ViewAttributeElement#stopDelegating
Stops delegating events. It can be used at different levels:
- To stop delegating all events.
- To stop delegating a specific event to all emitters.
- To stop delegating a specific event to a specific emitter.
See source (with github icon)

Parameters

[ event ] : string

The name of the event to stop delegating. If omitted, stops it all delegations.

[ emitter ] : Emitter

(requires event) The object to stop delegating a particular event to. If omitted, stops delegation of event to all emitters.

Returns

void
stopListening( [ emitter ], [ event ], [ callback ] ) → void
inherited

module:engine/view/attributeelement~ViewAttributeElement#stopListening:BASE_STOP
Stops listening for events. It can be used at different levels:
- To stop listening to a specific callback.
- To stop listening to a specific event.
- To stop listening to all events fired by a specific object.
- To stop listening to all events fired by all objects.
See source (with github icon)

Parameters

[ emitter ] : Emitter

The object to stop listening to. If omitted, stops it for all objects.

[ event ] : string

(Requires the emitter) The name of the event to stop listening to. If omitted, stops it for all events from emitter.

[ callback ] : Function

(Requires the event) The function to be removed from the call list for the given event.

Returns

void
toJSON() → unknown

Converts ViewAttributeElement instance to plain object and returns it.

See source (with github icon)

Returns

unknown

ViewAttributeElement instance converted to plain object.
_addClass( className ) → void
internalinherited

module:engine/view/attributeelement~ViewAttributeElement#_addClass
Adds specified class.
```
element._addClass( 'foo' ); // Adds 'foo' class.
element._addClass( [ 'foo', 'bar' ] ); // Adds 'foo' and 'bar' classes.
```
Copy code
See source (with github icon)

Parameters

className : ArrayOrItem<string>

Returns

void

Fires
- change
Related:
- ViewDowncastWriter#addClass
_appendChild( items ) → number
internalinherited

module:engine/view/attributeelement~ViewAttributeElement#_appendChild
Insert a child node or a list of child nodes at the end of this node and sets the parent of these nodes to this element.

See source (with github icon)

Parameters

items : string | ViewItem | Iterable<( string | ViewItem )>

Items to be inserted.

Returns

number

Number of appended nodes.

Fires
- change
Related:
- ViewDowncastWriter#insert
_canMergeAttributesFrom( otherElement ) → boolean
internal

Used by _mergeAttributesFrom to verify if the given element can be merged without conflicts into this element.

See source (with github icon)

Parameters

otherElement : ViewAttributeElement

Returns

boolean
_canSubtractAttributesOf( otherElement ) → boolean
internal

Used by _subtractAttributesOf to verify if the given element attributes can be fully subtracted from this element.

See source (with github icon)

Parameters

otherElement : ViewAttributeElement

Returns

boolean
_clone( deep ) → this
internal

Clones provided element with priority.

See source (with github icon)

Parameters

deep : boolean

If set to true clones element and all its children recursively. When set to false, element will be cloned without any children.

Defaults to false

Returns

this

Clone of this element.
_collectAttributesMatch( patterns, match, [ exclude ] ) → boolean
internalinherited

module:engine/view/attributeelement~ViewAttributeElement#_collectAttributesMatch
Used by the Matcher to collect matching attribute tuples (attribute name and optional token).

Normalized patterns can be used in following ways:
- to match any attribute name with any or no value:
```
patterns: [
	[ true, true ]
]
```
Copy code
- to match a specific attribute with any value:
```
patterns: [
	[ 'required', true ]
]
```
Copy code
- to match an attribute name with a RegExp with any value:
```
patterns: [
	[ /h[1-6]/, true ]
]
```
Copy code
```
- to match a specific attribute with the exact value:
```
Copy code
```
patterns: [
	[ 'rel', 'nofollow' ]
]
```
Copy code
```
- to match a specific attribute with a value matching a RegExp:
```
Copy code
```
patterns: [
	[ 'src', /^https/ ]
]
```
Copy code
```
- to match an attribute name with a RegExp and the exact value:
```
Copy code
```
patterns: [
	[ /^data-property-/, 'foobar' ],
]
```
Copy code
```
- to match an attribute name with a RegExp and match a value with another RegExp:
```
Copy code
```
patterns: [
	[ /^data-property-/, /^foo/ ]
]
```
Copy code
```
- to match a specific style property with the value matching a RegExp:
```
Copy code
```
patterns: [
	[ 'style', 'font-size', /px$/ ]
]
```
Copy code
```
- to match a specific class (class attribute is tokenized so it matches tokens individually):
```
Copy code
```
patterns: [
	[ 'class', 'foo' ]
]
```
Copy code
See source (with github icon)

Parameters

patterns : Array<NormalizedPropertyPattern>

An array of normalized patterns (tuples of 2 or 3 items depending on if tokenized attribute value match is needed).

match : Array<tuple>

An array to populate with matching tuples.

[ exclude ] : Array<string>

Array of attribute names to exclude from match.

Returns

boolean

true if element matches all patterns. The matching tuples are pushed to the match array.
_fireChange( type, node, [ data ] = { data.index } ) → void
internalinherited

module:engine/view/attributeelement~ViewAttributeElement#_fireChange
See source (with github icon)

Parameters

type : ViewDocumentChangeType

Type of the change.

node : ViewNode

Changed node.

[ data ] : object

Additional data.

Properties

data.index : number

Returns

void

Fires
- change
_getConsumables( [ key ], [ token ] ) → ViewNormalizedConsumables
internalinherited

Used by the ViewConsumable to collect the ViewNormalizedConsumables for the element.

When key and token parameters are provided the output is filtered for the specified attribute and it's tokens and related tokens.

See source (with github icon)

Parameters

[ key ] : string

Attribute name.

[ token ] : string

Reference token to collect all related tokens.

Returns

ViewNormalizedConsumables
_insertChild( index, items ) → number
internalinherited

module:engine/view/attributeelement~ViewAttributeElement#_insertChild
Inserts a child node or a list of child nodes on the given index and sets the parent of these nodes to this element.

See source (with github icon)

Parameters

index : number

Position where nodes should be inserted.

items : string | ViewItem | Iterable<( string | ViewItem )>

Items to be inserted.

Returns

number

Number of inserted nodes.

Fires
- change
Related:
- ViewDowncastWriter#insert
_mergeAttributesFrom( otherElement ) → void
internalinherited

Merges attributes of a given element into the element. This includes also tokenized attributes like style and class.

Note that you should make sure there are no conflicts before merging (see _canMergeAttributesFrom).

This method is used by the ViewDowncastWriter while down-casting an ViewAttributeElement to merge it with other ViewAttributeElement.

See source (with github icon)

Parameters

otherElement : ViewElement

Returns

void
_remove() → void
internalinherited

Removes node from parent.

See source (with github icon)

Returns

void
_removeAttribute( key, [ tokens ] ) → boolean
internalinherited

module:engine/view/attributeelement~ViewAttributeElement#_removeAttribute
Removes attribute from the element.

See source (with github icon)

Parameters

key : string

Attribute key.

[ tokens ] : ArrayOrItem<string>

Attribute value tokens to remove. The whole attribute is removed if not specified.

Returns

boolean

Returns true if an attribute existed and has been removed.

Fires
- change
Related:
- ViewDowncastWriter#removeAttribute
_removeChildren( index, howMany ) → Array<ViewNode>
internalinherited

module:engine/view/attributeelement~ViewAttributeElement#_removeChildren
Removes number of child nodes starting at the given index and set the parent of these nodes to null.

See source (with github icon)

Parameters

index : number

Number of the first node to remove.

howMany : number

Number of nodes to remove.

Defaults to 1

Returns

Array<ViewNode>

The array of removed nodes.

Fires
- change
Related:
- ViewDowncastWriter#remove
_removeClass( className ) → void
internalinherited

module:engine/view/attributeelement~ViewAttributeElement#_removeClass
Removes specified class.
```
element._removeClass( 'foo' );  // Removes 'foo' class.
element._removeClass( [ 'foo', 'bar' ] ); // Removes both 'foo' and 'bar' classes.
```
Copy code
See source (with github icon)

Parameters

className : ArrayOrItem<string>

Returns

void

Fires
- change
Related:
- ViewDowncastWriter#removeClass
_removeCustomProperty( key ) → boolean
internalinherited

module:engine/view/attributeelement~ViewAttributeElement#_removeCustomProperty
Removes the custom property stored under the given key.

See source (with github icon)

Parameters

key : string | symbol

Returns

boolean

Returns true if property was removed.

Related:
- ViewDowncastWriter#removeCustomProperty
_removeStyle( property ) → void
internalinherited

module:engine/view/attributeelement~ViewAttributeElement#_removeStyle
Removes specified style.
```
element._removeStyle( 'color' );  // Removes 'color' style.
element._removeStyle( [ 'color', 'border-top' ] ); // Removes both 'color' and 'border-top' styles.
```
Copy code
Note: This method can work with normalized style names if a particular style processor rule is enabled. See StylesMap#remove() for details.

See source (with github icon)

Parameters

property : ArrayOrItem<string>

Returns

void

Fires
- change
Related:
- ViewDowncastWriter#removeStyle
_setAttribute( key, value, overwrite ) → void
internalinherited

module:engine/view/attributeelement~ViewAttributeElement#_setAttribute
Adds or overwrite attribute with a specified key and value.

See source (with github icon)

Parameters

key : string

Attribute key.

value : unknown

Attribute value.

overwrite : boolean

Whether tokenized attribute should override the attribute value or just add a token.

Defaults to true

Returns

void

Fires
- change
Related:
- ViewDowncastWriter#setAttribute
_setCustomProperty( key, value ) → void
internalinherited

module:engine/view/attributeelement~ViewAttributeElement#_setCustomProperty
Sets a custom property. Unlike attributes, custom properties are not rendered to the DOM, so they can be used to add special data to elements.

See source (with github icon)

Parameters

key : string | symbol

value : unknown

Returns

void

Related:
- ViewDowncastWriter#setCustomProperty
_setStyle( properties ) → void
internalinherited

module:engine/view/attributeelement~ViewAttributeElement#_setStyle:OBJECT
Adds style to the element.
```
element._setStyle( {
	color: 'red',
	position: 'fixed'
} );
```
Copy code
Note: This method can work with normalized style names if a particular style processor rule is enabled. See StylesMap#set() for details.

See source (with github icon)

Parameters

properties : Record<string, string>

Object with key - value pairs.

Returns

void

Fires
- change
Related:
- ViewDowncastWriter#setStyle
_setStyle( property, value ) → void
internalinherited

module:engine/view/attributeelement~ViewAttributeElement#_setStyle:KEY_VALUE
Adds style to the element.
```
element._setStyle( 'color', 'red' );
```
Copy code
Note: This method can work with normalized style names if a particular style processor rule is enabled. See StylesMap#set() for details.

See source (with github icon)

Parameters

property : string

Property name.

value : string

Value to set.

Returns

void

Fires
- change
Related:
- ViewDowncastWriter#setStyle
_subtractAttributesOf( otherElement ) → void
internalinherited

Removes (subtracts) corresponding attributes of the given element from the element. This includes also tokenized attributes like style and class. All attributes, classes and styles from given element should be present inside the element being unwrapped.

Note that you should make sure all attributes could be subtracted before subtracting them (see _canSubtractAttributesOf).

This method is used by the ViewDowncastWriter while down-casting an ViewAttributeElement to unwrap the ViewAttributeElement.

See source (with github icon)

Parameters

otherElement : ViewElement

Returns

void

Events

change( eventInfo, changedNode, [ data ] )
inherited

Fired when list of elements children, attributes or text changes.

Change event is bubbled – it is fired on all ancestors.

All change events as the first parameter receive the node that has changed (the node for which children, attributes or text changed).

If change:children event is fired, there is an additional second parameter, which is an object with additional data related to change.

See source (with github icon)

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

changedNode : ViewNode

[ data ] : object
change:attributes( eventInfo, changedNode, [ data ] )
inherited

Fired when list of elements children, attributes or text changes.

Change event is bubbled – it is fired on all ancestors.

All change events as the first parameter receive the node that has changed (the node for which children, attributes or text changed).

If change:children event is fired, there is an additional second parameter, which is an object with additional data related to change.

See source (with github icon)

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

changedNode : ViewNode

[ data ] : object
change:children( eventInfo, changedNode, [ data ] )
inherited

Fired when list of elements children, attributes or text changes.

Change event is bubbled – it is fired on all ancestors.

All change events as the first parameter receive the node that has changed (the node for which children, attributes or text changed).

If change:children event is fired, there is an additional second parameter, which is an object with additional data related to change.

See source (with github icon)

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

changedNode : ViewNode

[ data ] : object
change:text( eventInfo, changedNode, [ data ] )
inherited

Fired when list of elements children, attributes or text changes.

Change event is bubbled – it is fired on all ancestors.

All change events as the first parameter receive the node that has changed (the node for which children, attributes or text changed).

If change:children event is fired, there is an additional second parameter, which is an object with additional data related to change.

See source (with github icon)

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

changedNode : ViewNode

[ data ] : object

ViewAttributeElement

Properties

_classes : undefined | ViewTokenList readonlyinherited

_styles : undefined | StylesMap readonlyinherited

childCount : number readonlyinherited

document : ViewDocument readonlyinherited

id : null | string | number readonly

index : null | number readonlyinherited

isEmpty : boolean readonlyinherited

name : string readonlyinherited

nextSibling : null | ViewNode readonlyinherited

parent : null | ViewElement | ViewDocumentFragment readonlyinherited

previousSibling : null | ViewNode readonlyinherited

priority : number readonly

root : ViewElement | ViewDocumentFragment readonlyinherited

_id : null | string | number internalreadonly

_priority : number internalreadonly

_unsafeAttributesToRender : Array<string> internalreadonlyinherited

_clonesGroup : null | Set<ViewAttributeElement> Lock icon privatereadonly

Static properties

DEFAULT_PRIORITY : number readonlystatic

Methods

constructor( document, name, [ attrs ], [ children ] ) protected

Parameters

Related:

delegate( events ) → EmitterMixinDelegateChain inherited

Parameters

Returns

findAncestor( patterns ) → null | ViewElement inherited

Parameters

Returns

Related:

fire( eventOrInfo, args ) → GetEventInfo<TEvent>[ 'return' ] inherited

Type parameters

Parameters

Returns

getAncestors( options = { [options.includeSelf], [options.parentFirst] } ) → Array<ViewNode | ViewDocumentFragment> inherited

Parameters

Returns

getAttribute( key ) → undefined | string inherited

Parameters

Returns

getAttributeKeys() → IterableIterator<string> inherited

Returns

getAttributes() → IterableIterator<tuple> inherited

Returns

getChild( index ) → undefined | ViewNode inherited

Parameters

Returns

getChildIndex( node ) → number inherited

Parameters

Returns

getChildren() → IterableIterator<ViewNode> inherited

Returns

getClassNames() → IterableIterator<string> inherited

Returns

getCommonAncestor( node, options = { [options.includeSelf] } ) → null | ViewElement | ViewDocumentFragment inherited

Parameters

Returns

getCustomProperties() → IterableIterator<tuple> inherited

Returns

getCustomProperty( key ) → unknown inherited

Parameters

Returns

getElementsWithSameId() → Set<ViewAttributeElement>

Returns

getFillerOffset() → null | number inherited

Returns

getIdentity() → string inherited

Returns

getNormalizedStyle( property ) → undefined | StyleValue inherited

Parameters

Returns

getPath() → Array<number> inherited

Returns

getStyle( property ) → undefined | string inherited

Parameters

Returns

getStyleNames( [ expand ] ) → Array<string> inherited

Parameters

`_classes : undefined | ViewTokenList`
readonlyinherited

`_styles : undefined | StylesMap`
readonlyinherited

`childCount : number`
readonlyinherited

`document : ViewDocument`
readonlyinherited

`id : null | string | number`
readonly

`index : null | number`
readonlyinherited

`isEmpty : boolean`
readonlyinherited

`name : string`
readonlyinherited

`nextSibling : null | ViewNode`
readonlyinherited

`parent : null | ViewElement | ViewDocumentFragment`
readonlyinherited

`previousSibling : null | ViewNode`
readonlyinherited

`priority : number`
readonly

`root : ViewElement | ViewDocumentFragment`
readonlyinherited

`_id : null | string | number`
internalreadonly

`_priority : number`
internalreadonly

`_unsafeAttributesToRender : Array<string>`
internalreadonlyinherited

`_clonesGroup : null | Set<ViewAttributeElement>`
privatereadonly

`DEFAULT_PRIORITY : number`
readonlystatic

`constructor( document, name, [ attrs ], [ children ] )`
protected

`delegate( events ) → EmitterMixinDelegateChain`
inherited

`findAncestor( patterns ) → null | ViewElement`
inherited

`fire( eventOrInfo, args ) → GetEventInfo<TEvent>[ 'return' ]`
inherited

`getAncestors( options = { [options.includeSelf], [options.parentFirst] } ) → Array<ViewNode | ViewDocumentFragment>`
inherited

`getAttribute( key ) → undefined | string`
inherited

`getAttributeKeys() → IterableIterator<string>`
inherited

`getAttributes() → IterableIterator<tuple>`
inherited

`getChild( index ) → undefined | ViewNode`
inherited

`getChildIndex( node ) → number`
inherited

`getChildren() → IterableIterator<ViewNode>`
inherited

`getClassNames() → IterableIterator<string>`
inherited

`getCommonAncestor( node, options = { [options.includeSelf] } ) → null | ViewElement | ViewDocumentFragment`
inherited

`getCustomProperties() → IterableIterator<tuple>`
inherited

`getCustomProperty( key ) → unknown`
inherited

`getElementsWithSameId() → Set<ViewAttributeElement>`

`getFillerOffset() → null | number`
inherited

`getIdentity() → string`
inherited

`getNormalizedStyle( property ) → undefined | StyleValue`
inherited

`getPath() → Array<number>`
inherited

`getStyle( property ) → undefined | string`
inherited

`getStyleNames( [ expand ] ) → Array<string>`
inherited

`hasAttribute( key, [ token ] ) → boolean`
inherited

`hasClass( className ) → boolean`
inherited

`hasStyle( property ) → boolean`
inherited

`is( type ) → this is ViewElement | ViewAttributeElement | ViewContainerElement | ViewEditableElement | ViewEmptyElement | ViewRawElement | ViewRootEditableElement | ViewUIElement`
inherited

`is( type ) → this is ViewContainerElement | ViewEditableElement | ViewRootEditableElement`
inherited

`is( type ) → this is ViewAttributeElement`
inherited

`is( type ) → this is ViewRawElement`
inherited

`is( type ) → this is ViewEmptyElement`
inherited

`is( type ) → this is ViewEditableElement | ViewRootEditableElement`
inherited

`is( type ) → this is ViewDocumentFragment`
inherited

`is( type ) → this is ViewDocumentSelection`
inherited

`is( type ) → this is ViewSelection | ViewDocumentSelection`
inherited

`is( type ) → this is ViewRange`
inherited

`is( type ) → this is ViewPosition`
inherited

`is( type ) → this is ViewTextProxy`
inherited

`is( type ) → this is ViewText`
inherited

`is( type ) → this is ViewUIElement`
inherited

`is( type ) → this is ViewRootEditableElement`
inherited

`is( type, name ) → boolean`
inherited

`is( type, name ) → boolean`
inherited

`is( type, name ) → boolean`
inherited

`is( type, name ) → boolean`
inherited