Class Image

Hierarchy

Paragraph
- Image

Index

Constructors

constructor

Properties

Accessors

isDeleted

Constructors

constructor

new Image(imageData: IMediaData, drawingOptions?: IDrawingOptions): Image

Overrides Paragraph.constructor
- Defined in file/paragraph/image.ts:7
Parameters
- imageData: IMediaData
- Optional drawingOptions: IDrawingOptions
Returns Image

Properties

Protected deleted

deleted: boolean = false

Protected root

root: Array<BaseXmlComponent | string>

Protected rootKey

rootKey: string

Accessors

isDeleted

get isDeleted(): boolean

Inherited from BaseXmlComponent.isDeleted
- Defined in file/xml-components/base.ts:13
Returns boolean

Methods

addBookmark

addBookmark(bookmark: Bookmark): Paragraph

Inherited from Paragraph.addBookmark
- Defined in file/paragraph/paragraph.ts:43
Parameters
- bookmark: Bookmark
Returns Paragraph

addChildElement

addChildElement(child: XmlComponent | string): XmlComponent

Inherited from XmlComponent.addChildElement
- Defined in file/xml-components/xml-component.ts:34
Parameters
- child: XmlComponent | string
Returns XmlComponent

addHyperLink

addHyperLink(hyperlink: Hyperlink): Paragraph

Inherited from Paragraph.addHyperLink
- Defined in file/paragraph/paragraph.ts:38
Parameters
- hyperlink: Hyperlink
Returns Paragraph

addRun

addRun(run: Run): Paragraph

Inherited from Paragraph.addRun
- Defined in file/paragraph/paragraph.ts:33
Parameters
- run: Run
Returns Paragraph

addRunToFront

addRunToFront(run: Run): Paragraph

Inherited from Paragraph.addRunToFront
- Defined in file/paragraph/paragraph.ts:215
Parameters
- run: Run
Returns Paragraph

bidi

bidi(): Paragraph

Inherited from Paragraph.bidi
- Defined in file/paragraph/paragraph.ts:220
Returns Paragraph

bullet

bullet(indentLevel?: number): Paragraph

Inherited from Paragraph.bullet
- Defined in file/paragraph/paragraph.ts:168
Parameters
- Default value indentLevel: number = 0
Returns Paragraph

center

center(): Paragraph

Inherited from Paragraph.center
- Defined in file/paragraph/paragraph.ts:98
Returns Paragraph

centerTabStop

centerTabStop(position: number): Paragraph

Inherited from Paragraph.centerTabStop
- Defined in file/paragraph/paragraph.ts:163
Parameters
- position: number
Returns Paragraph

createPictureRun

createPictureRun(imageData: IMediaData): PictureRun

Inherited from Paragraph.createPictureRun
- Defined in file/paragraph/paragraph.ts:57
Parameters
- imageData: IMediaData
Returns PictureRun

createTextRun

createTextRun(text: string): TextRun

Inherited from Paragraph.createTextRun
- Defined in file/paragraph/paragraph.ts:51
Parameters
- text: string
Returns TextRun

delete

delete(): void

Inherited from XmlComponent.delete
- Defined in file/xml-components/xml-component.ts:40
Returns void

distribute

distribute(): Paragraph

Inherited from Paragraph.distribute
- Defined in file/paragraph/paragraph.ts:123
Returns Paragraph

end

end(): Paragraph

Inherited from Paragraph.end
- Defined in file/paragraph/paragraph.ts:118
Returns Paragraph

heading1

heading1(): Paragraph

Inherited from Paragraph.heading1
- Defined in file/paragraph/paragraph.ts:63
Returns Paragraph

heading2

heading2(): Paragraph

Inherited from Paragraph.heading2
- Defined in file/paragraph/paragraph.ts:68
Returns Paragraph

heading3

heading3(): Paragraph

Inherited from Paragraph.heading3
- Defined in file/paragraph/paragraph.ts:73
Returns Paragraph

heading4

heading4(): Paragraph

Inherited from Paragraph.heading4
- Defined in file/paragraph/paragraph.ts:78
Returns Paragraph

heading5

heading5(): Paragraph

Inherited from Paragraph.heading5
- Defined in file/paragraph/paragraph.ts:83
Returns Paragraph

heading6

heading6(): Paragraph

Inherited from Paragraph.heading6
- Defined in file/paragraph/paragraph.ts:88
Returns Paragraph

indent

indent(attrs: object): Paragraph

Inherited from Paragraph.indent
- Defined in file/paragraph/paragraph.ts:190
Parameters
- attrs: object
Returns Paragraph

justified

justified(): Paragraph

Inherited from Paragraph.justified
- Defined in file/paragraph/paragraph.ts:128
Returns Paragraph

keepLines

keepLines(): Paragraph

Inherited from Paragraph.keepLines
- Defined in file/paragraph/paragraph.ts:205
Returns Paragraph

keepNext

keepNext(): Paragraph

Inherited from Paragraph.keepNext
- Defined in file/paragraph/paragraph.ts:200
Returns Paragraph

left

left(): Paragraph

Inherited from Paragraph.left
- Defined in file/paragraph/paragraph.ts:103
Returns Paragraph

leftTabStop

leftTabStop(position: number): Paragraph

Inherited from Paragraph.leftTabStop
- Defined in file/paragraph/paragraph.ts:153
Parameters
- position: number
Returns Paragraph

maxRightTabStop

maxRightTabStop(): Paragraph

Inherited from Paragraph.maxRightTabStop
- Defined in file/paragraph/paragraph.ts:148
Returns Paragraph

pageBreak

pageBreak(): Paragraph

Inherited from Paragraph.pageBreak
- Defined in file/paragraph/paragraph.ts:138
Returns Paragraph

pageBreakBefore

pageBreakBefore(): Paragraph

Inherited from Paragraph.pageBreakBefore
- Defined in file/paragraph/paragraph.ts:143
Returns Paragraph

prepForXml

prepForXml(): IXmlableObject

Inherited from XmlComponent.prepForXml

Overrides BaseXmlComponent.prepForXml
- Defined in file/xml-components/xml-component.ts:13
Returns IXmlableObject

referenceFootnote

referenceFootnote(id: number): Paragraph

Inherited from Paragraph.referenceFootnote
- Defined in file/paragraph/paragraph.ts:210
Parameters
- id: number
Returns Paragraph

right

right(): Paragraph

Inherited from Paragraph.right
- Defined in file/paragraph/paragraph.ts:108
Returns Paragraph

rightTabStop

rightTabStop(position: number): Paragraph

Inherited from Paragraph.rightTabStop
- Defined in file/paragraph/paragraph.ts:158
Parameters
- position: number
Returns Paragraph

scale

scale(factorX: number, factorY?: undefined | number): void

- Defined in file/paragraph/image.ts:15
Parameters
- factorX: number
- Optional factorY: undefined | number
Returns void

setCustomNumbering

setCustomNumbering(numberId: number, indentLevel: number): Paragraph

Inherited from Paragraph.setCustomNumbering
- Defined in file/paragraph/paragraph.ts:180
Parameters
- numberId: number
- indentLevel: number
Returns Paragraph

setNumbering

setNumbering(numbering: Num, indentLevel: number): Paragraph

Inherited from Paragraph.setNumbering
- Defined in file/paragraph/paragraph.ts:174
Parameters
- numbering: Num
- indentLevel: number
Returns Paragraph

spacing

spacing(params: ISpacingProperties): Paragraph

Inherited from Paragraph.spacing
- Defined in file/paragraph/paragraph.ts:195
Parameters
- params: ISpacingProperties
Returns Paragraph

start

start(): Paragraph

Inherited from Paragraph.start
- Defined in file/paragraph/paragraph.ts:113
Returns Paragraph

style

style(styleId: string): Paragraph

Inherited from Paragraph.style
- Defined in file/paragraph/paragraph.ts:185
Parameters
- styleId: string
Returns Paragraph

thematicBreak

thematicBreak(): Paragraph

Inherited from Paragraph.thematicBreak
- Defined in file/paragraph/paragraph.ts:133
Returns Paragraph

title

title(): Paragraph

Inherited from Paragraph.title
- Defined in file/paragraph/paragraph.ts:93
Returns Paragraph

Generated using TypeDoc