Lawtext core references / core/src/node/container / Container

Class: Container

core/src/node/container.Container

Table of contents

Constructors

• constructor

Properties

• children
• containerID
• el
• name
• num
• parent
• sentenceRange
• subChildren
• subParent
• type

Methods

• addChild
• ancestorChildren
• ancestorChildrenSub
• closest
• closestSub
• find
• findAll
• findAncestorChildren
• findAncestorChildrenSub
• iterate
• iterateReverse
• linealAscendant
• next
• nextAll
• nextAllSub
• nextSub
• parents
• parentsSub
• prev
• prevAll
• prevAllSub
• prevSub
• thisOrClosest
• thisOrClosestSub

Constructors

constructor

• new Container(options): Container

Parameters

Returns

Container

Defined in

core/src/node/container/index.ts:74 (opens in a new tab)

Properties

children

• children: Container[] = []

Defined in

core/src/node/container/index.ts:70 (opens in a new tab)

containerID

• Readonly containerID: string

Defined in

core/src/node/container/index.ts:62 (opens in a new tab)

el

• Readonly el: EL

Defined in

core/src/node/container/index.ts:60 (opens in a new tab)

name

• Readonly name: null | string

Defined in

core/src/node/container/index.ts:64 (opens in a new tab)

num

• Readonly num: null | string

Defined in

core/src/node/container/index.ts:65 (opens in a new tab)

parent

• parent: null | Container = null

Defined in

core/src/node/container/index.ts:69 (opens in a new tab)

sentenceRange

• sentenceRange: [number, number]

Defined in

core/src/node/container/index.ts:67 (opens in a new tab)

subChildren

• subChildren: Container[] = []

Defined in

core/src/node/container/index.ts:72 (opens in a new tab)

subParent

• subParent: null | Container = null

Defined in

core/src/node/container/index.ts:71 (opens in a new tab)

type

• Readonly type: ContainerType

Defined in

core/src/node/container/index.ts:63 (opens in a new tab)

Methods

addChild

▸ addChild(child): Container

Parameters

Returns

Container

Defined in

core/src/node/container/index.ts:101 (opens in a new tab)

ancestorChildren

▸ ancestorChildren(func): IterableIterator<Container>

Parameters

Returns

IterableIterator<Container>

Defined in

core/src/node/container/index.ts:140 (opens in a new tab)

ancestorChildrenSub

▸ ancestorChildrenSub(func): IterableIterator<Container>

Parameters

Returns

IterableIterator<Container>

Defined in

core/src/node/container/index.ts:189 (opens in a new tab)

closest

▸ closest(func): null | Container

Parameters

Returns

null | Container

Defined in

core/src/node/container/index.ts:120 (opens in a new tab)

closestSub

▸ closestSub(func): null | Container

Parameters

Returns

null | Container

Defined in

core/src/node/container/index.ts:175 (opens in a new tab)

find

▸ find(func?, cut?): null | Container

Parameters

Returns

null | Container

Defined in

core/src/node/container/index.ts:220 (opens in a new tab)

findAll

▸ findAll(func?, cut?): IterableIterator<Container>

Parameters

Returns

IterableIterator<Container>

Defined in

core/src/node/container/index.ts:227 (opens in a new tab)

findAncestorChildren

▸ findAncestorChildren(func): null | Container

Parameters

Returns

null | Container

Defined in

core/src/node/container/index.ts:136 (opens in a new tab)

findAncestorChildrenSub

▸ findAncestorChildrenSub(func): null | Container

Parameters

Returns

null | Container

Defined in

core/src/node/container/index.ts:185 (opens in a new tab)

iterate

▸ iterate(func?, cut?): IterableIterator<Container>

Parameters

Returns

IterableIterator<Container>

Defined in

core/src/node/container/index.ts:238 (opens in a new tab)

iterateReverse

▸ iterateReverse(func?, cut?): IterableIterator<Container>

Parameters

Returns

IterableIterator<Container>

Defined in

core/src/node/container/index.ts:247 (opens in a new tab)

linealAscendant

▸ linealAscendant(func?): Container[]

Parameters

Returns

Container[]

Defined in

core/src/node/container/index.ts:130 (opens in a new tab)

next

▸ next(func): null | Container

Parameters

Returns

null | Container

Defined in

core/src/node/container/index.ts:146 (opens in a new tab)

nextAll

▸ nextAll(func): IterableIterator<Container>

Parameters

Returns

IterableIterator<Container>

Defined in

core/src/node/container/index.ts:150 (opens in a new tab)

nextAllSub

▸ nextAllSub(func): IterableIterator<Container>

Parameters

Returns

IterableIterator<Container>

Defined in

core/src/node/container/index.ts:199 (opens in a new tab)

nextSub

▸ nextSub(func): null | Container

Parameters

Returns

null | Container

Defined in

core/src/node/container/index.ts:195 (opens in a new tab)

parents

▸ parents(func?): IterableIterator<Container>

Parameters

Returns

IterableIterator<Container>

Defined in

core/src/node/container/index.ts:124 (opens in a new tab)

parentsSub

▸ parentsSub(func): IterableIterator<Container>

Parameters

Returns

IterableIterator<Container>

Defined in

core/src/node/container/index.ts:179 (opens in a new tab)

prev

▸ prev(func): null | Container

Parameters

Returns

null | Container

Defined in

core/src/node/container/index.ts:158 (opens in a new tab)

prevAll

▸ prevAll(func): IterableIterator<Container>

Parameters

Returns

IterableIterator<Container>

Defined in

core/src/node/container/index.ts:162 (opens in a new tab)

prevAllSub

▸ prevAllSub(func): IterableIterator<Container>

Parameters

Returns

IterableIterator<Container>

Defined in

core/src/node/container/index.ts:212 (opens in a new tab)

prevSub

▸ prevSub(func): null | Container

Parameters

Returns

null | Container

Defined in

core/src/node/container/index.ts:208 (opens in a new tab)

thisOrClosest

▸ thisOrClosest(func): null | Container

Parameters

Returns

null | Container

Defined in

core/src/node/container/index.ts:115 (opens in a new tab)

thisOrClosestSub

▸ thisOrClosestSub(func): null | Container

Parameters

Returns

null | Container

Defined in

core/src/node/container/index.ts:170 (opens in a new tab)