Lawtext core references

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

Class: Container

Defined in: core/src/node/container/index.ts:60 

Constructors

Constructor

new Container(options): Container

Defined in: core/src/node/container/index.ts:76 

Parameters

options

ContainerOptions

Returns

Container

Properties

allSentenceEnvs

allSentenceEnvs: SentenceEnv[]

Defined in: core/src/node/container/index.ts:74 

children

children: Container[] = []

Defined in: core/src/node/container/index.ts:71 

containerID

readonly containerID: string

Defined in: core/src/node/container/index.ts:63 

el

readonly el: EL

Defined in: core/src/node/container/index.ts:61 

name

readonly name: string | null

Defined in: core/src/node/container/index.ts:65 

num

readonly num: string | null

Defined in: core/src/node/container/index.ts:66 

parent

parent: Container | null = null

Defined in: core/src/node/container/index.ts:70 

sentenceRange

sentenceRange: [number, number]

Defined in: core/src/node/container/index.ts:68 

subChildren

subChildren: Container[] = []

Defined in: core/src/node/container/index.ts:73 

subParent

subParent: Container | null = null

Defined in: core/src/node/container/index.ts:72 

type

readonly type: ContainerType

Defined in: core/src/node/container/index.ts:64 

Methods

addChild()

addChild(child): Container

Defined in: core/src/node/container/index.ts:105 

Parameters

child

Container

Returns

Container

ancestorChildren()

ancestorChildren(func): IterableIterator<Container>

Defined in: core/src/node/container/index.ts:144 

Parameters

func

(container) => boolean

Returns

IterableIterator<Container>

ancestorChildrenSub()

ancestorChildrenSub(func): IterableIterator<Container>

Defined in: core/src/node/container/index.ts:193 

Parameters

func

(container) => boolean

Returns

IterableIterator<Container>

closest()

closest(func): Container | null

Defined in: core/src/node/container/index.ts:124 

Parameters

func

(container) => boolean

Returns

Container | null

closestSub()

closestSub(func): Container | null

Defined in: core/src/node/container/index.ts:179 

Parameters

func

(container) => boolean

Returns

Container | null

find()

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

Defined in: core/src/node/container/index.ts:224 

Parameters

func?

(container) => boolean

cut?

(container) => boolean

Returns

Container | null

findAll()

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

Defined in: core/src/node/container/index.ts:231 

Parameters

func?

(container) => boolean

cut?

(container) => boolean

Returns

IterableIterator<Container>

findAncestorChildren()

findAncestorChildren(func): Container | null

Defined in: core/src/node/container/index.ts:140 

Parameters

func

(container) => boolean

Returns

Container | null

findAncestorChildrenSub()

findAncestorChildrenSub(func): Container | null

Defined in: core/src/node/container/index.ts:189 

Parameters

func

(container) => boolean

Returns

Container | null

iterate()

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

Defined in: core/src/node/container/index.ts:242 

Parameters

func?

(container) => boolean

cut?

(container) => boolean

Returns

IterableIterator<Container>

iterateReverse()

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

Defined in: core/src/node/container/index.ts:251 

Parameters

func?

(container) => boolean

cut?

(container) => boolean

Returns

IterableIterator<Container>

linealAscendant()

linealAscendant(func?): Container[]

Defined in: core/src/node/container/index.ts:134 

Parameters

func?

(container) => boolean

Returns

Container[]

next()

next(func): Container | null

Defined in: core/src/node/container/index.ts:150 

Parameters

func

(container) => boolean

Returns

Container | null

nextAll()

nextAll(func): IterableIterator<Container>

Defined in: core/src/node/container/index.ts:154 

Parameters

func

(container) => boolean

Returns

IterableIterator<Container>

nextAllSub()

nextAllSub(func): IterableIterator<Container>

Defined in: core/src/node/container/index.ts:203 

Parameters

func

(container) => boolean

Returns

IterableIterator<Container>

nextSub()

nextSub(func): Container | null

Defined in: core/src/node/container/index.ts:199 

Parameters

func

(container) => boolean

Returns

Container | null

parents()

parents(func?): IterableIterator<Container>

Defined in: core/src/node/container/index.ts:128 

Parameters

func?

(container) => boolean

Returns

IterableIterator<Container>

parentsSub()

parentsSub(func): IterableIterator<Container>

Defined in: core/src/node/container/index.ts:183 

Parameters

func

(container) => boolean

Returns

IterableIterator<Container>

prev()

prev(func): Container | null

Defined in: core/src/node/container/index.ts:162 

Parameters

func

(container) => boolean

Returns

Container | null

prevAll()

prevAll(func): IterableIterator<Container>

Defined in: core/src/node/container/index.ts:166 

Parameters

func

(container) => boolean

Returns

IterableIterator<Container>

prevAllSub()

prevAllSub(func): IterableIterator<Container>

Defined in: core/src/node/container/index.ts:216 

Parameters

func

(container) => boolean

Returns

IterableIterator<Container>

prevSub()

prevSub(func): Container | null

Defined in: core/src/node/container/index.ts:212 

Parameters

func

(container) => boolean

Returns

Container | null

thisOrClosest()

thisOrClosest(func): Container | null

Defined in: core/src/node/container/index.ts:119 

Parameters

func

(container) => boolean

Returns

Container | null

thisOrClosestSub()

thisOrClosestSub(func): Container | null

Defined in: core/src/node/container/index.ts:174 

Parameters

func

(container) => boolean

Returns

Container | null