ListWalker

• _higherIndent : boolean

  private

  module:list/list/utils/listwalker~ListWalker#_higherIndent

  Whether blocks with a higher indent level than the start block should be included in the result.

  See source (with github icon)

• _includeSelf : boolean

  private

  module:list/list/utils/listwalker~ListWalker#_includeSelf

  Whether start block should be included in the result (if it's matching other criteria).

  See source (with github icon)

• _isForward : boolean

  private

  module:list/list/utils/listwalker~ListWalker#_isForward

  The iterating direction.

  See source (with github icon)

• _lowerIndent : boolean

  private

  module:list/list/utils/listwalker~ListWalker#_lowerIndent

  Whether blocks with a lower indent level than the start block should be included in the result.

  See source (with github icon)

• _referenceIndent : number

  private

  module:list/list/utils/listwalker~ListWalker#_referenceIndent

  The reference indent. Initialized by the indent of the start block.

  See source (with github icon)

• _sameAttributes : Array<string>

  private

  module:list/list/utils/listwalker~ListWalker#_sameAttributes

  Additional attributes that must be the same for each block.

  See source (with github icon)

• _sameIndent : boolean

  private

  module:list/list/utils/listwalker~ListWalker#_sameIndent

  Whether blocks with the same indent level as the start block should be included in the result.

  See source (with github icon)

• _startElement : ModelNode

  private

  module:list/list/utils/listwalker~ListWalker#_startElement

  The start list item block element.

  See source (with github icon)

• constructor( startElement, options )

  module:list/list/utils/listwalker~ListWalker#constructor

  Creates a document list iterator.

  See source (with github icon)

  Parameters

  startElement : ModelNode

  The start list item block element.

  options : ListWalkerOptions

• Symbol.iterator() → Iterator<ListElement>

  module:list/list/utils/listwalker~ListWalker#Symbol.iterator

  Iterable interface.

  See source (with github icon)

  Returns

  Iterator<ListElement>

• _getStartNode() → null | ModelNode

  private

  module:list/list/utils/listwalker~ListWalker#_getStartNode

  Returns the model element to start iterating.

  See source (with github icon)

  Returns

  null | ModelNode

Static methods

• first( startElement, options ) → null | ListElement

  static

  module:list/list/utils/listwalker~ListWalker.first

  Performs only first step of iteration and returns the result.

  See source (with github icon)

  Parameters

  startElement : ModelNode

  The start list item block element.

  options : ListWalkerOptions

  Returns

  null | ListElement