Ooxast NPM | npm.io

Note This repository is automatically generated from the main parser monorepo. Please submit any issues or pull requests there.

ooxast

Type definitions for ooxast (Open Office XML abstract syntax tree), a syntax for abstract syntax trees representing Open Office XML documents in the unist format.

ooxast

What is this?

When should I use this?

Install

This package is ESM only. In Node.js (version 12.20+, 14.14+, 16.0+, 18.0+), install as

pnpm add ooxast
# or with yarn
# yarn add ooxast
# or with npm
# npm install ooxast

Use

API

Index

`Namespaces`

Math

`document`

document

Defined in: src/lib/ooxml/wordprocessingml/main.ts:5007 src/lib/ooxml/wordprocessingml/main.ts:5024

`AbstractNum`

Syntactic units in unist syntax trees are called nodes.

Hierarchy

Node.AbstractNum

Properties

`attributes`

object

{
    w:abstractNumId: string;
}

Type declaration

Member	Type
`w:abstractNumId`	`string`

Defined in: src/lib/ooxml/wordprocessingml/main.ts:15

`children`

(StringTag<"start"> | Lvl | MultiLevelType | StringTag<"name"> | LongHexNumber | StringTag<"numStyleLink"> | StringTag<"styleLink">)[]

Defined in: src/lib/ooxml/wordprocessingml/main.ts:18

`data?`

Data

Information from the ecosystem.

Inherited from: Node.data

Defined in: node_modules/.pnpm/@types+unist\@2.0.6/node_modules/@types/unist/index.d.ts:27

`name`

"w:abstractNum"

Defined in: src/lib/ooxml/wordprocessingml/main.ts:14

`position?`

Position

Location of a node in a source document. Must not be present if a node is generated.

Inherited from: Node.position

Defined in: node_modules/.pnpm/@types+unist\@2.0.6/node_modules/@types/unist/index.d.ts:33

`type`

"element"

The variant of a node.

Overrides: Node.type

Defined in: src/lib/ooxml/wordprocessingml/main.ts:13

`AbstractNumMap`

Properties

`lvl?`

Lvl[]

Defined in: src/lib/ooxml/wordprocessingml/main.ts:22

`multiLevelType?`

MultiLevelType

Defined in: src/lib/ooxml/wordprocessingml/main.ts:23

`name?`

StringTag<"name">

Defined in: src/lib/ooxml/wordprocessingml/main.ts:24

`nsid?`

LongHexNumber

Defined in: src/lib/ooxml/wordprocessingml/main.ts:25

`numStyleLink?`

StringTag<"numStyleLink">

Defined in: src/lib/ooxml/wordprocessingml/main.ts:26

`start?`

StringTag<"start">

Defined in: src/lib/ooxml/wordprocessingml/main.ts:29

`styleLink?`

StringTag<"styleLink">

Defined in: src/lib/ooxml/wordprocessingml/main.ts:27

`tmpl?`

LongHexNumber

Defined in: src/lib/ooxml/wordprocessingml/main.ts:28

`AltChunk`

Syntactic units in unist syntax trees are called nodes.

Hierarchy

Node.AltChunk

Properties

`attributes`

object

{
    w:id?: string;
}

Type declaration

Member	Type
`w:id`?	`string`

Defined in: src/lib/ooxml/wordprocessingml/main.ts:35

`children`

AltChunkPr[]

Defined in: src/lib/ooxml/wordprocessingml/main.ts:38

`data?`

Data

Information from the ecosystem.

Inherited from: Node.data

Defined in: node_modules/.pnpm/@types+unist\@2.0.6/node_modules/@types/unist/index.d.ts:27

`name`

"w:altChunk"

Defined in: src/lib/ooxml/wordprocessingml/main.ts:34

`position?`

Position

Location of a node in a source document. Must not be present if a node is generated.

Inherited from: Node.position

Defined in: node_modules/.pnpm/@types+unist\@2.0.6/node_modules/@types/unist/index.d.ts:33

`type`

"element"

The variant of a node.

Overrides: Node.type

Defined in: src/lib/ooxml/wordprocessingml/main.ts:33

`AltChunkMap`

Properties

`altChunkPr?`

AltChunkPr

Defined in: src/lib/ooxml/wordprocessingml/main.ts:42

`AltChunkPr`

Syntactic units in unist syntax trees are called nodes.

Hierarchy

Node.AltChunkPr

Properties

`attributes`

Record<string, never>

Defined in: src/lib/ooxml/wordprocessingml/main.ts:48

`children`

OnOff<"matchSrc">[]

Defined in: src/lib/ooxml/wordprocessingml/main.ts:49

`data?`

Data

Information from the ecosystem.

Inherited from: Node.data

Defined in: node_modules/.pnpm/@types+unist\@2.0.6/node_modules/@types/unist/index.d.ts:27

`name`

"w:altChunkPr"

Defined in: src/lib/ooxml/wordprocessingml/main.ts:47

`position?`

Position

Location of a node in a source document. Must not be present if a node is generated.

Inherited from: Node.position

Defined in: node_modules/.pnpm/@types+unist\@2.0.6/node_modules/@types/unist/index.d.ts:33

`type`

"element"

The variant of a node.

Overrides: Node.type

Defined in: src/lib/ooxml/wordprocessingml/main.ts:46

`AltChunkPrMap`

Properties

`matchSrc?`

OnOff<"matchSrc">

Defined in: src/lib/ooxml/wordprocessingml/main.ts:53

`Attr`

Syntactic units in unist syntax trees are called nodes.

Hierarchy

Node.Attr

Properties

`attributes`

object

{
    w:name: string;
    w:uri: string;
    w:val: string;
}

Type declaration

Member	Type
`w:name`	`string`
`w:uri`	`string`
`w:val`	`string`

Defined in: src/lib/ooxml/wordprocessingml/main.ts:59

`children`

[]

Defined in: src/lib/ooxml/wordprocessingml/main.ts:64

`data?`

Data

Information from the ecosystem.

Inherited from: Node.data

Defined in: node_modules/.pnpm/@types+unist\@2.0.6/node_modules/@types/unist/index.d.ts:27

`name`

"w:attr"

Defined in: src/lib/ooxml/wordprocessingml/main.ts:58

`position?`

Position

Location of a node in a source document. Must not be present if a node is generated.

Inherited from: Node.position

Defined in: node_modules/.pnpm/@types+unist\@2.0.6/node_modules/@types/unist/index.d.ts:33

`type`

"element"

The variant of a node.

Overrides: Node.type

Defined in: src/lib/ooxml/wordprocessingml/main.ts:57

`Attributes`

Information associated with an element.

Indexable

name: string: string | null | undefined

`AutoCaption`

Syntactic units in unist syntax trees are called nodes.

Hierarchy

Node.AutoCaption

Properties

`attributes`

object

{
    w:caption: string;
    w:name: string;
}

Type declaration

Member	Type
`w:caption`	`string`
`w:name`	`string`

Defined in: src/lib/ooxml/wordprocessingml/main.ts:70

`children`

[]

Defined in: src/lib/ooxml/wordprocessingml/main.ts:74

`data?`

Data

Information from the ecosystem.

Inherited from: Node.data

Defined in: node_modules/.pnpm/@types+unist\@2.0.6/node_modules/@types/unist/index.d.ts:27

`name`

"w:autoCaption"

Defined in: src/lib/ooxml/wordprocessingml/main.ts:69

`position?`

Position

Location of a node in a source document. Must not be present if a node is generated.

Inherited from: Node.position

Defined in: node_modules/.pnpm/@types+unist\@2.0.6/node_modules/@types/unist/index.d.ts:33

`type`

"element"

The variant of a node.

Overrides: Node.type

Defined in: src/lib/ooxml/wordprocessingml/main.ts:68

`AutoCaptions`

Syntactic units in unist syntax trees are called nodes.

Hierarchy

Node.AutoCaptions

Properties

`attributes`

Record<string, never>

Defined in: src/lib/ooxml/wordprocessingml/main.ts:80

`children`

AutoCaption[]

Defined in: src/lib/ooxml/wordprocessingml/main.ts:81

`data?`

Data

Information from the ecosystem.

Inherited from: Node.data

Defined in: node_modules/.pnpm/@types+unist\@2.0.6/node_modules/@types/unist/index.d.ts:27

`name`

"w:autoCaptions"

Defined in: src/lib/ooxml/wordprocessingml/main.ts:79

`position?`

Position

Location of a node in a source document. Must not be present if a node is generated.

Inherited from: Node.position

Defined in: node_modules/.pnpm/@types+unist\@2.0.6/node_modules/@types/unist/index.d.ts:33

`type`

"element"

The variant of a node.

Overrides: Node.type

Defined in: src/lib/ooxml/wordprocessingml/main.ts:78

`AutoCaptionsMap`

Properties

`autoCaption`

AutoCaption[]

Defined in: src/lib/ooxml/wordprocessingml/main.ts:85

`Background`

Syntactic units in unist syntax trees are called nodes.

Hierarchy

Node.Background

Properties

`attributes`

object

{
    w:color?: string;
    w:themeColor?: ThemeColorVal;
    w:themeShade?: string;
    w:themeTint?: string;
}

Type declaration

Member	Type
`w:color`?	`string`
`w:themeColor`?	`ThemeColorVal`
`w:themeShade`?	`string`
`w:themeTint`?	`string`

Defined in: src/lib/ooxml/wordprocessingml/main.ts:91

`children`

Drawing[]

Defined in: src/lib/ooxml/wordprocessingml/main.ts:97

`data?`

Data

Information from the ecosystem.

Inherited from: Node.data

Defined in: node_modules/.pnpm/@types+unist\@2.0.6/node_modules/@types/unist/index.d.ts:27

`name`

"w:background"

Defined in: src/lib/ooxml/wordprocessingml/main.ts:90

`position?`

Position

Location of a node in a source document. Must not be present if a node is generated.

Inherited from: Node.position

Defined in: node_modules/.pnpm/@types+unist\@2.0.6/node_modules/@types/unist/index.d.ts:33

`type`

"element"

The variant of a node.

Overrides: Node.type

Defined in: src/lib/ooxml/wordprocessingml/main.ts:89

`BackgroundMap`

Properties

`drawing?`

Drawing

Defined in: src/lib/ooxml/wordprocessingml/main.ts:101

`Base64Binary`

Syntactic units in unist syntax trees are called nodes.

Hierarchy

Node.Base64Binary

Properties

`attributes`

object

{
    w:val: string;
}

Type declaration

Member	Type
`w:val`	`string`

Defined in: src/lib/ooxml/wordprocessingml/main.ts:107

`children`

[]

Defined in: src/lib/ooxml/wordprocessingml/main.ts:110

`data?`

Data

Information from the ecosystem.

Inherited from: Node.data

Defined in: node_modules/.pnpm/@types+unist\@2.0.6/node_modules/@types/unist/index.d.ts:27

`name`

"w:base64Binary"

Defined in: src/lib/ooxml/wordprocessingml/main.ts:106

`position?`

Position

Location of a node in a source document. Must not be present if a node is generated.

Inherited from: Node.position

Defined in: node_modules/.pnpm/@types+unist\@2.0.6/node_modules/@types/unist/index.d.ts:33

`type`

"element"

The variant of a node.

Overrides: Node.type

Defined in: src/lib/ooxml/wordprocessingml/main.ts:105

`BdoContentRun`

Syntactic units in unist syntax trees are called nodes.

Hierarchy

Node.BdoContentRun

Properties

`attributes`

object

{
    w:val?: DirectionVal;
}

Type declaration

Member	Type
`w:val`?	`DirectionVal`

Defined in: src/lib/ooxml/wordprocessingml/main.ts:116

`children`

(OMath | RunTrackChange<"del"> | RunTrackChange<"ins"> | MarkupRange<"bookmarkEnd"> | never | MarkupRange<"commentRangeEnd"> | MarkupRange<"commentRangeStart"> | CustomXmlRun | Markup<"customXmlDelRangeEnd"> | TrackChange<"customXmlDelRangeStart"> | Markup<"customXmlInsRangeEnd"> | TrackChange<"customXmlInsRangeStart"> | Markup<"customXmlMoveFromRangeEnd"> | TrackChange<"customXmlMoveFromRangeStart"> | Markup<"customXmlMoveToRangeEnd"> | TrackChange<"customXmlMoveToRangeStart"> | SimpleField | Hyperlink | RunTrackChange<"moveFrom"> | MarkupRange<"moveFromRangeEnd"> | never | RunTrackChange<"moveTo"> | MarkupRange<"moveToRangeEnd"> | OMathPara | Perm | never | ProofErr | SdtRun | SmartTagRun | BdoContentRun | R | DirContentRun | Rel<"subDoc">)[]

Defined in: src/lib/ooxml/wordprocessingml/main.ts:119

`data?`

Data

Information from the ecosystem.

Inherited from: Node.data

Defined in: node_modules/.pnpm/@types+unist\@2.0.6/node_modules/@types/unist/index.d.ts:27

`name`

"w:bdoContentRun"

Defined in: src/lib/ooxml/wordprocessingml/main.ts:115

`position?`

Position

Location of a node in a source document. Must not be present if a node is generated.

Inherited from: Node.position

Defined in: node_modules/.pnpm/@types+unist\@2.0.6/node_modules/@types/unist/index.d.ts:33

`type`

"element"

The variant of a node.

Overrides: Node.type

Defined in: src/lib/ooxml/wordprocessingml/main.ts:114

`BdoContentRunMap`

Properties

`bdo?`

BdoContentRun[]

Defined in: src/lib/ooxml/wordprocessingml/main.ts:123

`bookmarkType?`

BookmarkTypes

Defined in: src/lib/ooxml/wordprocessingml/main.ts:124

`customXMLTypes?`

Markup<"customXmlDelRangeEnd"> | TrackChange<"customXmlDelRangeStart"> | Markup<"customXmlInsRangeEnd"> | TrackChange<"customXmlInsRangeStart"> | Markup<"customXmlMoveFromRangeEnd"> | TrackChange<"customXmlMoveFromRangeStart"> | Markup<"customXmlMoveToRangeEnd"> | TrackChange<"customXmlMoveToRangeStart">

Defined in: src/lib/ooxml/wordprocessingml/main.ts:126

`customXml?`

CustomXmlRun[]

Defined in: src/lib/ooxml/wordprocessingml/main.ts:125

`del?`

RunTrackChange<"del">[]

Defined in: src/lib/ooxml/wordprocessingml/main.ts:127

`dir?`

DirContentRun[]

Defined in: src/lib/ooxml/wordprocessingml/main.ts:128

`fldSimple?`

SimpleField[]

Defined in: src/lib/ooxml/wordprocessingml/main.ts:129

`hyperlink?`

Hyperlink[]

Defined in: src/lib/ooxml/wordprocessingml/main.ts:130

`ins?`

RunTrackChange<"ins">[]

Defined in: src/lib/ooxml/wordprocessingml/main.ts:131

`moveFrom?`

RunTrackChange<"moveFrom">[]

Defined in: src/lib/ooxml/wordprocessingml/main.ts:132

`moveFromRangeEnd?`

MarkupRange<"moveFromRangeEnd">[]

Defined in: src/lib/ooxml/wordprocessingml/main.ts:133

`moveFromRangeStart?`

never[]

Defined in: src/lib/ooxml/wordprocessingml/main.ts:134

`moveTo?`

RunTrackChange<"moveTo">[]

Defined in: src/lib/ooxml/wordprocessingml/main.ts:135

`moveToRangeEnd?`

MarkupRange<"moveToRangeEnd">[]

Defined in: src/lib/ooxml/wordprocessingml/main.ts:136

`moveToRangeStart?`

never[]

Defined in: src/lib/ooxml/wordprocessingml/main.ts:137

`oMath?`

OMath[]

Defined in: src/lib/ooxml/wordprocessingml/main.ts:138

`oMathPara?`

OMathPara[]

Defined in: src/lib/ooxml/wordprocessingml/main.ts:139

`permEnd?`

Perm[]

Defined in: src/lib/ooxml/wordprocessingml/main.ts:140

`permStart?`

never[]

Defined in: src/lib/ooxml/wordprocessingml/main.ts:141

`proofErr?`

ProofErr[]

Defined in: src/lib/ooxml/wordprocessingml/main.ts:142

`r?`

R[]

Defined in: src/lib/ooxml/wordprocessingml/main.ts:143

`sdt?`

SdtRun[]

Defined in: src/lib/ooxml/wordprocessingml/main.ts:144

`smartTag?`

SmartTagRun[]

Defined in: src/lib/ooxml/wordprocessingml/main.ts:145

`subDoc?`

Rel<"subDoc">[]

Defined in: src/lib/ooxml/wordprocessingml/main.ts:146

`Body`

Syntactic units in unist syntax trees are called nodes.

Hierarchy

Node.Body

Properties

`attributes`

Record<string, never>

Defined in: src/lib/ooxml/wordprocessingml/main.ts:152

`children`

(OMath | RunTrackChange<"del"> | RunTrackChange<"ins"> | MarkupRange<"bookmarkEnd"> | never | MarkupRange<"commentRangeEnd"> | MarkupRange<"commentRangeStart"> | Markup<"customXmlDelRangeEnd"> | TrackChange<"customXmlDelRangeStart"> | Markup<"customXmlInsRangeEnd"> | TrackChange<"customXmlInsRangeStart"> | Markup<"customXmlMoveFromRangeEnd"> | TrackChange<"customXmlMoveFromRangeStart"> | Markup<"customXmlMoveToRangeEnd"> | TrackChange<"customXmlMoveToRangeStart"> | RunTrackChange<"moveFrom"> | MarkupRange<"moveFromRangeEnd"> | never | RunTrackChange<"moveTo"> | MarkupRange<"moveToRangeEnd"> | OMathPara | Perm | never | ProofErr | CustomXmlBlock | SdtBlock | P | AltChunk | Tbl | SectPr)[]

Defined in: src/lib/ooxml/wordprocessingml/main.ts:153

`data?`

Data

Information from the ecosystem.

Inherited from: Node.data

Defined in: node_modules/.pnpm/@types+unist\@2.0.6/node_modules/@types/unist/index.d.ts:27

`name`

"w:body"

Defined in: src/lib/ooxml/wordprocessingml/main.ts:151

`position?`

Position

Location of a node in a source document. Must not be present if a node is generated.

Inherited from: Node.position

Defined in: node_modules/.pnpm/@types+unist\@2.0.6/node_modules/@types/unist/index.d.ts:33

`type`

"element"

The variant of a node.

Overrides: Node.type

Defined in: src/lib/ooxml/wordprocessingml/main.ts:150

`BodyMap`

Properties

`altChunk?`

AltChunk[]

Defined in: src/lib/ooxml/wordprocessingml/main.ts:157

`bookmarkType?`

BookmarkTypes

Defined in: src/lib/ooxml/wordprocessingml/main.ts:158

`customXMLTypes?`

Markup<"customXmlDelRangeEnd"> | TrackChange<"customXmlDelRangeStart"> | Markup<"customXmlInsRangeEnd"> | TrackChange<"customXmlInsRangeStart"> | Markup<"customXmlMoveFromRangeEnd"> | TrackChange<"customXmlMoveFromRangeStart"> | Markup<"customXmlMoveToRangeEnd"> | TrackChange<"customXmlMoveToRangeStart">

Defined in: src/lib/ooxml/wordprocessingml/main.ts:160

`customXml?`

CustomXmlBlock[]

Defined in: src/lib/ooxml/wordprocessingml/main.ts:159

`del?`

RunTrackChange<"del">[]

Defined in: src/lib/ooxml/wordprocessingml/main.ts:161

`ins?`

RunTrackChange<"ins">[]

Defined in: src/lib/ooxml/wordprocessingml/main.ts:162

`moveFrom?`

RunTrackChange<"moveFrom">[]

Defined in: src/lib/ooxml/wordprocessingml/main.ts:163

`moveFromRangeEnd?`

MarkupRange<"moveFromRangeEnd">[]

Defined in: src/lib/ooxml/wordprocessingml/main.ts:164

`moveFromRangeStart?`

never[]

Defined in: src/lib/ooxml/wordprocessingml/main.ts:165

`moveTo?`

RunTrackChange<"moveTo">[]

Defined in: src/lib/ooxml/wordprocessingml/main.ts:166

`moveToRangeEnd?`

MarkupRange<"moveToRangeEnd">[]

Defined in: src/lib/ooxml/wordprocessingml/main.ts:167

`moveToRangeStart?`

never[]

Defined in: src/lib/ooxml/wordprocessingml/main.ts:168

`oMath?`

OMath[]

Defined in: src/lib/ooxml/wordprocessingml/main.ts:169

`oMathPara?`

OMathPara[]

Defined in: src/lib/ooxml/wordprocessingml/main.ts:170

`p?`

P[]

Defined in: src/lib/ooxml/wordprocessingml/main.ts:171

`permEnd?`

Perm[]

Defined in: src/lib/ooxml/wordprocessingml/main.ts:172

`permStart?`

never[]

Defined in: src/lib/ooxml/wordprocessingml/main.ts:173

`proofErr?`

ProofErr[]

Defined in: src/lib/ooxml/wordprocessingml/main.ts:174

`sdt?`

SdtBlock[]

Defined in: src/lib/ooxml/wordprocessingml/main.ts:175

`sectPr?`

SectPr

Defined in: src/lib/ooxml/wordprocessingml/main.ts:176

`tbl?`

Tbl[]

Defined in: src/lib/ooxml/wordprocessingml/main.ts:177

`BookmarkInterface`

Properties

`bookmarkEnd?`

MarkupRange<"bookmarkEnd">[]

Defined in: src/lib/ooxml/wordprocessingml/main.ts:2753

`bookmarkStart?`

never[]

Defined in: src/lib/ooxml/wordprocessingml/main.ts:2754

`commentRangeEnd?`

MarkupRange<"commentRangeEnd">[]

Defined in: src/lib/ooxml/wordprocessingml/main.ts:2755

`commentRangeStart?`

MarkupRange<"commentRangeStart">[]

Defined in: src/lib/ooxml/wordprocessingml/main.ts:2756

`Border`

Syntactic units in unist syntax trees are called nodes.

Hierarchy

Node.Border

Properties

`attributes`

object

{
    w:color?: string;
    w:frame?: string;
    w:shadow?: string;
    w:space?: string;
    w:sz?: string;
    w:themeColor?: ThemeColorVal;
    w:themeShade?: string;
    w:themeTint?: string;
    w:val: BorderVal;
}

Type declaration

Member	Type
`w:color`?	`string`
`w:frame`?	`string`
`w:shadow`?	`string`
`w:space`?	`string`
`w:sz`?	`string`
`w:themeColor`?	`ThemeColorVal`
`w:themeShade`?	`string`
`w:themeTint`?	`string`
`w:val`	`BorderVal`

Defined in: src/lib/ooxml/wordprocessingml/main.ts:202

`children`

[]

Defined in: src/lib/ooxml/wordprocessingml/main.ts:213

`data?`

Data

Information from the ecosystem.

Inherited from: Node.data

Defined in: node_modules/.pnpm/@types+unist\@2.0.6/node_modules/@types/unist/index.d.ts:27

`name`

"w:bdr"

Defined in: src/lib/ooxml/wordprocessingml/main.ts:201

`position?`

Position

Location of a node in a source document. Must not be present if a node is generated.

Inherited from: Node.position

Defined in: node_modules/.pnpm/@types+unist\@2.0.6/node_modules/@types/unist/index.d.ts:33

`type`

"element"

The variant of a node.

Overrides: Node.type

Defined in: src/lib/ooxml/wordprocessingml/main.ts:200

`Br`

Syntactic units in unist syntax trees are called nodes.

Hierarchy

Node.Br

Properties

`attributes`

object

{
    w:clear?: BrClearVal;
    w:type?: BrTypeVal;
}

Type declaration

Member	Type
`w:clear`?	`BrClearVal`
`w:type`?	`BrTypeVal`

Defined in: src/lib/ooxml/wordprocessingml/main.ts:229

`children`

[]

Defined in: src/lib/ooxml/wordprocessingml/main.ts:233

`data?`

Data

Information from the ecosystem.

Inherited from: Node.data

Defined in: node_modules/.pnpm/@types+unist\@2.0.6/node_modules/@types/unist/index.d.ts:27

`name`

"w:br"

Defined in: src/lib/ooxml/wordprocessingml/main.ts:228

`position?`

Position

Location of a node in a source document. Must not be present if a node is generated.

Inherited from: Node.position

Defined in: node_modules/.pnpm/@types+unist\@2.0.6/node_modules/@types/unist/index.d.ts:33

`type`

"element"

The variant of a node.

Overrides: Node.type

Defined in: src/lib/ooxml/wordprocessingml/main.ts:227

`CalendarType`

Syntactic units in unist syntax trees are called nodes.

Hierarchy

Node.CalendarType

Properties

`attributes`

object

{
    w:val: CalendarTypeVal;
}

Type declaration

Member	Type
`w:val`	`CalendarTypeVal`

Defined in: src/lib/ooxml/wordprocessingml/main.ts:239

`children`

[]

Defined in: src/lib/ooxml/wordprocessingml/main.ts:242

`data?`

Data

Information from the ecosystem.

Inherited from: Node.data

Defined in: node_modules/.pnpm/@types+unist\@2.0.6/node_modules/@types/unist/index.d.ts:27

`name`

"w:calendarType"

Defined in: src/lib/ooxml/wordprocessingml/main.ts:238

`position?`

Position

Location of a node in a source document. Must not be present if a node is generated.

Inherited from: Node.position

Defined in: node_modules/.pnpm/@types+unist\@2.0.6/node_modules/@types/unist/index.d.ts:33

`type`

"element"

The variant of a node.

Overrides: Node.type

Defined in: src/lib/ooxml/wordprocessingml/main.ts:237

`Caption`

Syntactic units in unist syntax trees are called nodes.

Hierarchy

Node.Caption

Properties

`attributes`

object

{
    w:chapNum?: string;
    w:heading?: string;
    w:name: string;
    w:noLabel?: string;
    w:numFmt?: NumberFormatVal;
    w:pos?: CaptionPosVal;
    w:sep?: ChapterSepVal;
}

Type declaration

Member	Type
`w:chapNum`?	`string`
`w:heading`?	`string`
`w:name`	`string`
`w:noLabel`?	`string`
`w:numFmt`?	`NumberFormatVal`
`w:pos`?	`CaptionPosVal`
`w:sep`?	`ChapterSepVal`

Defined in: src/lib/ooxml/wordprocessingml/main.ts:248

`children`

[]

Defined in: src/lib/ooxml/wordprocessingml/main.ts:257

`data?`

Data

Information from the ecosystem.

Inherited from: Node.data

Defined in: node_modules/.pnpm/@types+unist\@2.0.6/node_modules/@types/unist/index.d.ts:27

`name`

"w:caption"

Defined in: src/lib/ooxml/wordprocessingml/main.ts:247

`position?`

Position

Location of a node in a source document. Must not be present if a node is generated.

Inherited from: Node.position

Defined in: node_modules/.pnpm/@types+unist\@2.0.6/node_modules/@types/unist/index.d.ts:33

`type`

"element"

The variant of a node.

Overrides: Node.type

Defined in: src/lib/ooxml/wordprocessingml/main.ts:246

`Captions`

Syntactic units in unist syntax trees are called nodes.

Hierarchy

Node.Captions

Properties

`attributes`

Record<string, never>

Defined in: src/lib/ooxml/wordprocessingml/main.ts:263

`children`

(AutoCaptions | Caption)[]

Defined in: src/lib/ooxml/wordprocessingml/main.ts:264

`data?`

Data

Information from the ecosystem.

Inherited from: Node.data

Defined in: node_modules/.pnpm/@types+unist\@2.0.6/node_modules/@types/unist/index.d.ts:27

`name`

"w:captions"

Defined in: src/lib/ooxml/wordprocessingml/main.ts:262

`position?`

Position

Location of a node in a source document. Must not be present if a node is generated.

Inherited from: Node.position

Defined in: node_modules/.pnpm/@types+unist\@2.0.6/node_modules/@types/unist/index.d.ts:33

`type`

"element"

The variant of a node.

Overrides: Node.type

Defined in: src/lib/ooxml/wordprocessingml/main.ts:261

`CaptionsMap`

Properties

`autoCaptions?`

AutoCaptions

Defined in: src/lib/ooxml/wordprocessingml/main.ts:268

`caption`

Caption[]

Defined in: src/lib/ooxml/wordprocessingml/main.ts:269

`CharacterSpacing`

Syntactic units in unist syntax trees are called nodes.

Hierarchy

Node.CharacterSpacing

Properties

`attributes`

object

{
    w:val: CharacterSpacingVal;
}

Type declaration

Member	Type
`w:val`	`CharacterSpacingVal`

Defined in: src/lib/ooxml/wordprocessingml/main.ts:285

`children`

[]

Defined in: src/lib/ooxml/wordprocessingml/main.ts:288

`data?`

Data

Information from the ecosystem.

Inherited from: Node.data

Defined in: node_modules/.pnpm/@types+unist\@2.0.6/node_modules/@types/unist/index.d.ts:27

`name`

"w:characterSpacing"

Defined in: src/lib/ooxml/wordprocessingml/main.ts:284

`position?`

Position

Location of a node in a source document. Must not be present if a node is generated.

Inherited from: Node.position

Defined in: node_modules/.pnpm/@types+unist\@2.0.6/node_modules/@types/unist/index.d.ts:33

`type`

"element"

The variant of a node.

Overrides: Node.type

Defined in: src/lib/ooxml/wordprocessingml/main.ts:283

`Charset`

Syntactic units in unist syntax trees are called nodes.

Hierarchy

Node.Charset

Properties

`attributes`

object

{
    w:characterSet?: string;
}

Type declaration

Member	Type
`w:characterSet`?	`string`

Defined in: src/lib/ooxml/wordprocessingml/main.ts:294

`children`

[]

Defined in: src/lib/ooxml/wordprocessingml/main.ts:297

`data?`

Data

Information from the ecosystem.

Inherited from: Node.data

Defined in: node_modules/.pnpm/@types+unist\@2.0.6/node_modules/@types/unist/index.d.ts:27

`name`

"w:charset"

Defined in: src/lib/ooxml/wordprocessingml/main.ts:293

`position?`

Position

Location of a node in a source document. Must not be present if a node is generated.

Inherited from: Node.position

Defined in: node_modules/.pnpm/@types+unist\@2.0.6/node_modules/@types/unist/index.d.ts:33

`type`

"element"

The variant of a node.

Overrides: Node.type

Defined in: src/lib/ooxml/wordprocessingml/main.ts:292

`Cnf`

Syntactic units in unist syntax trees are called nodes.

Hierarchy

Node.Cnf

Properties

`attributes`

object

{
    w:evenHBand: string;
    w:evenVBand: string;
    w:firstColumn: string;
    w:firstRow: string;
    w:firstRowFirstColumn: string;
    w:firstRowLastColumn: string;
    w:lastColumn: string;
    w:lastRow: string;
    w:lastRowFirstColumn: string;
    w:lastRowLastColumn: string;
    w:oddHBand: string;
    w:oddVBand: string;
}

Type declaration

Member	Type
`w:evenHBand`	`string`
`w:evenVBand`	`string`
`w:firstColumn`	`string`
`w:firstRow`	`string`
`w:firstRowFirstColumn`	`string`
`w:firstRowLastColumn`	`string`
`w:lastColumn`	`string`
`w:lastRow`	`string`
`w:lastRowFirstColumn`	`string`
`w:lastRowLastColumn`	`string`
`w:oddHBand`	`string`
`w:oddVBand`	`string`

Defined in: src/lib/ooxml/wordprocessingml/main.ts:303

`children`

[]

Defined in: src/lib/ooxml/wordprocessingml/main.ts:317

`data?`

Data

Information from the ecosystem.

Inherited from: Node.data

Defined in: node_modules/.pnpm/@types+unist\@2.0.6/node_modules/@types/unist/index.d.ts:27

`name`

"w:cnf"

Defined in: src/lib/ooxml/wordprocessingml/main.ts:302

`position?`

Position

Location of a node in a source document. Must not be present if a node is generated.

Inherited from: Node.position

Defined in: node_modules/.pnpm/@types+unist\@2.0.6/node_modules/@types/unist/index.d.ts:33

`type`

"element"

The variant of a node.

Overrides: Node.type

Defined in: src/lib/ooxml/wordprocessingml/main.ts:301

`Color`

Syntactic units in unist syntax trees are called nodes.

Hierarchy

Node.Color

Properties

`attributes`

object

{
    w:themeColor?: ThemeColorVal;
    w:themeShade?: string;
    w:themeTint?: string;
    w:val: string;
}

Type declaration

Member	Type
`w:themeColor`?	`ThemeColorVal`
`w:themeShade`?	`string`
`w:themeTint`?	`string`
`w:val`	`string`

Defined in: src/lib/ooxml/wordprocessingml/main.ts:323

`children`

[]

Defined in: src/lib/ooxml/wordprocessingml/main.ts:329

`data?`

Data

Information from the ecosystem.

Inherited from: Node.data

Defined in: node_modules/.pnpm/@types+unist\@2.0.6/node_modules/@types/unist/index.d.ts:27

`name`

"w:color"

Defined in: src/lib/ooxml/wordprocessingml/main.ts:322

`position?`

Position

Location of a node in a source document. Must not be present if a node is generated.

Inherited from: Node.position

Defined in: node_modules/.pnpm/@types+unist\@2.0.6/node_modules/@types/unist/index.d.ts:33

`type`

"element"

The variant of a node.

Overrides: Node.type

Defined in: src/lib/ooxml/wordprocessingml/main.ts:321

`ColorSchemeMapping`

Syntactic units in unist syntax trees are called nodes.

Hierarchy

Node.ColorSchemeMapping

Properties

`attributes`

object

{
    w:accent1: WmlColorSchemeIndexVal;
    w:accent2: WmlColorSchemeIndexVal;
    w:accent3: WmlColorSchemeIndexVal;
    w:accent4: WmlColorSchemeIndexVal;
    w:accent5: WmlColorSchemeIndexVal;
    w:accent6: WmlColorSchemeIndexVal;
    w:bg1: WmlColorSchemeIndexVal;
    w:bg2: WmlColorSchemeIndexVal;
    w:followedHyperlink: WmlColorSchemeIndexVal;
    w:hyperlink: WmlColorSchemeIndexVal;
    w:t1: WmlColorSchemeIndexVal;
    w:t2: WmlColorSchemeIndexVal;
}

Type declaration

Member	Type
`w:accent1`	`WmlColorSchemeIndexVal`
`w:accent2`	`WmlColorSchemeIndexVal`
`w:accent3`	`WmlColorSchemeIndexVal`
`w:accent4`	`WmlColorSchemeIndexVal`
`w:accent5`	`WmlColorSchemeIndexVal`
`w:accent6`	`WmlColorSchemeIndexVal`
`w:bg1`	`WmlColorSchemeIndexVal`
`w:bg2`	`WmlColorSchemeIndexVal`
`w:followedHyperlink`	`WmlColorSchemeIndexVal`
`w:hyperlink`	`WmlColorSchemeIndexVal`
`w:t1`	`WmlColorSchemeIndexVal`
`w:t2`	`WmlColorSchemeIndexVal`

Defined in: src/lib/ooxml/wordprocessingml/main.ts:335

`children`

[]

Defined in: src/lib/ooxml/wordprocessingml/main.ts:349

`data?`

Data

Information from the ecosystem.

Inherited from: Node.data

Defined in: node_modules/.pnpm/@types+unist\@2.0.6/node_modules/@types/unist/index.d.ts:27

`name`

"w:colorSchemeMapping"

Defined in: src/lib/ooxml/wordprocessingml/main.ts:334

`position?`

Position

Location of a node in a source document. Must not be present if a node is generated.

Inherited from: Node.position

Defined in: node_modules/.pnpm/@types+unist\@2.0.6/node_modules/@types/unist/index.d.ts:33

`type`

"element"

The variant of a node.

Overrides: Node.type

Defined in: src/lib/ooxml/wordprocessingml/main.ts:333

`Column`

Syntactic units in unist syntax trees are called nodes.

Hierarchy

Node.Column

Properties

`attributes`

object

{
    w:space?: string;
    w:w?: string;
}

Type declaration

Member	Type
`w:space`?	`string`
`w:w`?	`string`

Defined in: src/lib/ooxml/wordprocessingml/main.ts:355

`children`

[]

Defined in: src/lib/ooxml/wordprocessingml/main.ts:359

`data?`

Data

Information from the ecosystem.

Inherited from: Node.data

Defined in: node_modules/.pnpm/@types+unist\@2.0.6/node_modules/@types/unist/index.d.ts:27

`name`

"w:column"

Defined in: src/lib/ooxml/wordprocessingml/main.ts:354

`position?`

Position

Location of a node in a source document. Must not be present if a node is generated.

Inherited from: Node.position

Defined in: node_modules/.pnpm/@types+unist\@2.0.6/node_modules/@types/unist/index.d.ts:33

`type`

"element"

The variant of a node.

Overrides: Node.type

Defined in: src/lib/ooxml/wordprocessingml/main.ts:353

`Columns`

Syntactic units in unist syntax trees are called nodes.

Hierarchy

Node.Columns

Properties

`attributes`

object

{
    w:equalWidth?: string;
    w:num?: string;
    w:sep?: string;
    w:space?: string;
}

Type declaration

Member	Type
`w:equalWidth`?	`string`
`w:num`?	`string`
`w:sep`?	`string`
`w:space`?	`string`

Defined in: src/lib/ooxml/wordprocessingml/main.ts:365

`children`

Column[]

Defined in: src/lib/ooxml/wordprocessingml/main.ts:371

`data?`

Data

Information from the ecosystem.

Inherited from: Node.data

Defined in: node_modules/.pnpm/@types+unist\@2.0.6/node_modules/@types/unist/index.d.ts:27

`name`

"w:columns"

Defined in: src/lib/ooxml/wordprocessingml/main.ts:364

`position?`

Position

Location of a node in a source document. Must not be present if a node is generated.

Inherited from: Node.position

Defined in: node_modules/.pnpm/@types+unist\@2.0.6/node_modules/@types/unist/index.d.ts:33

`type`

"element"

The variant of a node.

Overrides: Node.type

Defined in: src/lib/ooxml/wordprocessingml/main.ts:363

`ColumnsMap`

Properties

`col?`

Column[]

Defined in: src/lib/ooxml/wordprocessingml/main.ts:375

`CommentMap`

Properties

`altChunk?`

AltChunk[]

Defined in: src/lib/ooxml/wordprocessingml/main.ts:388

`bookmarkType?`

BookmarkTypes

Defined in: src/lib/ooxml/wordprocessingml/main.ts:389

`customXMLTypes?`

Markup<"customXmlDelRangeEnd"> | TrackChange<"customXmlDelRangeStart"> | Markup<"customXmlInsRangeEnd"> | TrackChange<"customXmlInsRangeStart"> | Markup<"customXmlMoveFromRangeEnd"> | TrackChange<"customXmlMoveFromRangeStart"> | Markup<"customXmlMoveToRangeEnd"> | TrackChange<"customXmlMoveToRangeStart">

Defined in: src/lib/ooxml/wordprocessingml/main.ts:391

`customXml?`

CustomXmlBlock[]

Defined in: src/lib/ooxml/wordprocessingml/main.ts:390

`del?`

RunTrackChange<"del">[]

Defined in: src/lib/ooxml/wordprocessingml/main.ts:392

`ins?`

RunTrackChange<"ins">[]

Defined in: src/lib/ooxml/wordprocessingml/main.ts:393

`moveFrom?`

RunTrackChange<"moveFrom">[]

Defined in: src/lib/ooxml/wordprocessingml/main.ts:394

`moveFromRangeEnd?`

MarkupRange<"moveFromRangeEnd">[]

Defined in: src/lib/ooxml/wordprocessingml/main.ts:395(https://github.com/TrialAndErrorOrg/parsers/blob/m

unified syntax-tree docx ooxast reoff ast

utility-types @types/xast @types/unist

@everything-registry/sub-chunk-2380 ooxast-util-citation-plugin ooxast-util-citations ooxast-util-get-style ooxast-util-markup-to-style ooxast-util-parse-bib reoff-cite reoff-clean reoff-markup-to-style reoff-parse-references reoff-rejour reoff-remark reoff-unified-latex @171h/reoff-remark ooxast-util-remove-rsid ooxast-util-to-jast ooxast-util-to-mdast ooxast-util-to-unified-latex @trialanderror/converter-cli

7 months ago

7 months ago

7 months ago

1 year ago

1 year ago

ooxast

Contents

What is this?

When should I use this?

Install

Use

API

Index

Namespaces

document

AbstractNum

Hierarchy

Properties

attributes

Type declaration

children

data?

name

position?

type

AbstractNumMap

Properties

lvl?

multiLevelType?

name?

nsid?

numStyleLink?

start?

styleLink?

tmpl?

AltChunk

Hierarchy

Properties

attributes

Type declaration

children

data?

name

position?

type

AltChunkMap

Properties

altChunkPr?

AltChunkPr

Hierarchy

Properties

attributes

children

data?

name

position?

type

AltChunkPrMap

Properties

matchSrc?

Attr

Hierarchy

Properties

attributes

Type declaration

children

data?

name

position?

type

Attributes

Indexable

AutoCaption

Hierarchy

Properties

attributes

Type declaration

children

data?

name

position?

type

AutoCaptions

Hierarchy

Properties

`Namespaces`

`document`

`AbstractNum`

`attributes`

`children`

`data?`

`name`

`position?`

`type`

`AbstractNumMap`

`lvl?`

`multiLevelType?`

`name?`

`nsid?`

`numStyleLink?`

`start?`

`styleLink?`

`tmpl?`

`AltChunk`

`attributes`

`children`

`data?`

`name`

`position?`

`type`

`AltChunkMap`

`altChunkPr?`

`AltChunkPr`

`attributes`

`children`

`data?`

`name`

`position?`

`type`

`AltChunkPrMap`

`matchSrc?`

`Attr`

`attributes`

`children`

`data?`

`name`

`position?`

`type`

`Attributes`

`AutoCaption`

`attributes`

`children`

`data?`

`name`

`position?`

`type`

`AutoCaptions`

`attributes`

`children`

`data?`

`name`

`position?`

`type`

`AutoCaptionsMap`

`autoCaption`

`Background`

`attributes`

`children`

`data?`

`name`

`position?`

`type`

`BackgroundMap`

`drawing?`

`Base64Binary`

`attributes`

`children`

`data?`

`name`

`position?`

`type`

`BdoContentRun`

`attributes`

`children`

`data?`