Class ImageParagraph

Hierarchy

Paragraph
- ImageParagraph

Index

Constructors

constructor

Accessors

Methods

Constructors

constructor

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

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

Accessors

Borders

get Borders(): Border

Inherited from Paragraph.Borders
- Defined in file/paragraph/paragraph.ts:37
Returns Border

IsDeleted

get IsDeleted(): boolean

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

Run

get Run(): PictureRun

- Defined in file/paragraph/image.ts:19
Returns PictureRun

paragraphProperties

get paragraphProperties(): ParagraphProperties

Inherited from Paragraph.paragraphProperties
- Defined in file/paragraph/paragraph.ts:33
Returns ParagraphProperties

Methods

addBookmark

addBookmark(bookmark: Bookmark): Paragraph

Inherited from Paragraph.addBookmark
- Defined in file/paragraph/paragraph.ts:56
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:51
Parameters
- hyperlink: Hyperlink
Returns Paragraph

addImage

addImage(image: Image): PictureRun

Inherited from Paragraph.addImage
- Defined in file/paragraph/paragraph.ts:70
Parameters
- image: Image
Returns PictureRun

addRun

addRun(run: Run): Paragraph

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

addRunToFront

addRunToFront(run: Run): Paragraph

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

addSequentialIdentifier

addSequentialIdentifier(identifier: string): Paragraph

Inherited from Paragraph.addSequentialIdentifier
- Defined in file/paragraph/paragraph.ts:249
Parameters
- identifier: string
Returns Paragraph

addTabStop

addTabStop(run: Run): Paragraph

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

bidirectional

bidirectional(): Paragraph

Inherited from Paragraph.bidirectional
- Defined in file/paragraph/paragraph.ts:239
Returns Paragraph

bullet

bullet(indentLevel?: number): Paragraph

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

center

center(): Paragraph

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

centerTabStop

centerTabStop(position: number, leader?: LeaderType): Paragraph

Inherited from Paragraph.centerTabStop
- Defined in file/paragraph/paragraph.ts:177
Parameters
- position: number
- Optional leader: LeaderType
Returns Paragraph

contextualSpacing

contextualSpacing(value: boolean): Paragraph

Inherited from Paragraph.contextualSpacing
- Defined in file/paragraph/paragraph.ts:214
Parameters
- value: boolean
Returns Paragraph

createBorder

createBorder(): Paragraph

Inherited from Paragraph.createBorder
- Defined in file/paragraph/paragraph.ts:41
Returns Paragraph

createTextRun

createTextRun(text: string): TextRun

Inherited from Paragraph.createTextRun
- Defined in file/paragraph/paragraph.ts:64
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:137
Returns Paragraph

end

end(): Paragraph

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

heading1

heading1(): Paragraph

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

heading2

heading2(): Paragraph

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

heading3

heading3(): Paragraph

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

heading4

heading4(): Paragraph

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

heading5

heading5(): Paragraph

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

heading6

heading6(): Paragraph

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

indent

indent(attrs: IIndentAttributesProperties): Paragraph

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

justified

justified(): Paragraph

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

keepLines

keepLines(): Paragraph

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

keepNext

keepNext(): Paragraph

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

left

left(): Paragraph

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

leftTabStop

leftTabStop(position: number, leader?: LeaderType): Paragraph

Inherited from Paragraph.leftTabStop
- Defined in file/paragraph/paragraph.ts:167
Parameters
- position: number
- Optional leader: LeaderType
Returns Paragraph

maxRightTabStop

maxRightTabStop(leader?: LeaderType): Paragraph

Inherited from Paragraph.maxRightTabStop
- Defined in file/paragraph/paragraph.ts:162
Parameters
- Optional leader: LeaderType
Returns Paragraph

pageBreak

pageBreak(): Paragraph

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

pageBreakBefore

pageBreakBefore(): Paragraph

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

prepForXml

prepForXml(): IXmlableObject | undefined

Inherited from XmlComponent.prepForXml

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

referenceFootnote

referenceFootnote(id: number): Paragraph

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

right

right(): Paragraph

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

rightTabStop

rightTabStop(position: number, leader?: LeaderType): Paragraph

Inherited from Paragraph.rightTabStop
- Defined in file/paragraph/paragraph.ts:172
Parameters
- position: number
- Optional leader: LeaderType
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:194
Parameters
- numberId: number
- indentLevel: number
Returns Paragraph

setNumbering

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

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

spacing

spacing(params: ISpacingProperties): Paragraph

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

start

start(): Paragraph

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

style

style(styleId: string): Paragraph

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

thematicBreak

thematicBreak(): Paragraph

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

title

title(): Paragraph

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

Generated using TypeDoc