PdfShapeElement | Syncfusion TypeScript

Base class for the main shapes.

Hierarchy

PdfLayoutElement
- PdfShapeElement
  - PdfDrawElement

Index

Properties

Accessors

Methods

Properties

beginPageLayout

beginPageLayout: Function

endPageLayout

endPageLayout: Function

Accessors

Private raiseBeginPageLayout

get raiseBeginPageLayout(): boolean

Inherited from PdfTextElement.raiseBeginPageLayout
- Defined in implementation/graphics/figures/layout-element.ts:30
Gets a value indicating whether the start page layout event should be raised.

Returns boolean

Private raiseEndPageLayout

get raiseEndPageLayout(): boolean

Inherited from PdfTextElement.raiseEndPageLayout
- Defined in implementation/graphics/figures/layout-element.ts:37
Gets a value indicating whether the ending page layout event should be raised.

Returns boolean

Methods

drawGraphicsHelper

drawGraphicsHelper(graphics: PdfGraphics, location: PointF): void

- Defined in implementation/graphics/figures/base/pdf-shape-element.ts:28
drawGraphicsHelper the graphics.

Parameters
- graphics: PdfGraphics
- location: PointF
Returns void

Private drawHelper

drawHelper(page: PdfPage, location: PointF): PdfLayoutResult
drawHelper(page: PdfPage, x: number, y: number): PdfLayoutResult
drawHelper(page: PdfPage, layoutRectangle: RectangleF): PdfLayoutResult
drawHelper(page: PdfPage, location: PointF, format: PdfLayoutFormat): PdfLayoutResult
drawHelper(page: PdfPage, x: number, y: number, format: PdfLayoutFormat): PdfLayoutResult
drawHelper(page: PdfPage, layoutRectangle: RectangleF, embedFonts: boolean): PdfLayoutResult
drawHelper(page: PdfPage, layoutRectangle: RectangleF, format: PdfLayoutFormat): PdfLayoutResult

Inherited from PdfTextElement.drawHelper
- Defined in implementation/graphics/figures/layout-element.ts:55
Draws the element on the page with the specified page and "PointF" class

Parameters
- page: PdfPage
- location: PointF
Returns PdfLayoutResult
Inherited from PdfTextElement.drawHelper
- Defined in implementation/graphics/figures/layout-element.ts:60
Draws the element on the page with the specified page and pair of coordinates

Parameters
- page: PdfPage
- x: number
- y: number
Returns PdfLayoutResult
Inherited from PdfTextElement.drawHelper
- Defined in implementation/graphics/figures/layout-element.ts:65
Draws the element on the page with the specified page and "RectangleF" class

Parameters
- page: PdfPage
- layoutRectangle: RectangleF
Returns PdfLayoutResult
Inherited from PdfTextElement.drawHelper
- Defined in implementation/graphics/figures/layout-element.ts:70
Draws the element on the page with the specified page, "PointF" class and layout format

Parameters
- page: PdfPage
- location: PointF
- format: PdfLayoutFormat
Returns PdfLayoutResult
Inherited from PdfTextElement.drawHelper
- Defined in implementation/graphics/figures/layout-element.ts:75
Draws the element on the page with the specified page, pair of coordinates and layout format

Parameters
- page: PdfPage
- x: number
- y: number
- format: PdfLayoutFormat
Returns PdfLayoutResult
Inherited from PdfTextElement.drawHelper
- Defined in implementation/graphics/figures/layout-element.ts:80
Draws the element on the page.

Parameters
- page: PdfPage
- layoutRectangle: RectangleF
- embedFonts: boolean
Returns PdfLayoutResult
Inherited from PdfTextElement.drawHelper
- Defined in implementation/graphics/figures/layout-element.ts:85
Draws the element on the page with the specified page, "RectangleF" class and layout format

Parameters
- page: PdfPage
- layoutRectangle: RectangleF
- format: PdfLayoutFormat
Returns PdfLayoutResult

Protected Abstract drawInternal

drawInternal(graphics: PdfGraphics): void

- Defined in implementation/graphics/figures/base/pdf-shape-element.ts:54
Parameters
- graphics: PdfGraphics
Returns void

Private drawShapeHelper

drawShapeHelper(graphics: PdfGraphics, x: number, y: number): void

- Defined in implementation/graphics/figures/base/pdf-shape-element.ts:38
drawShapeHelper the graphics.

Parameters
- graphics: PdfGraphics
- x: number
- y: number
Returns void

Private getBounds

getBounds(): RectangleF

- Defined in implementation/graphics/figures/base/pdf-shape-element.ts:20
Gets the bounds.

Returns RectangleF

Private Abstract getBoundsInternal

getBoundsInternal(): RectangleF

- Defined in implementation/graphics/figures/base/pdf-shape-element.ts:59
Returns a rectangle that bounds this element.

Returns RectangleF

Private layout

layout(param: PdfLayoutParams): PdfLayoutResult

Overrides PdfLayoutElement.layout
- Defined in implementation/graphics/figures/base/pdf-shape-element.ts:64
Layouts the element.

Parameters
- param: PdfLayoutParams
Returns PdfLayoutResult

onBeginPageLayout

onBeginPageLayout(args: PdfGridBeginPageLayoutEventArgs | BeginPageLayoutEventArgs): void

Inherited from PdfTextElement.onBeginPageLayout
- Defined in implementation/graphics/figures/layout-element.ts:41
Parameters
- args: PdfGridBeginPageLayoutEventArgs | BeginPageLayoutEventArgs
Returns void

onEndPageLayout

onEndPageLayout(args: PdfGridEndPageLayoutEventArgs | EndPageLayoutEventArgs): void

Inherited from PdfTextElement.onEndPageLayout
- Defined in implementation/graphics/figures/layout-element.ts:46
Parameters
- args: PdfGridEndPageLayoutEventArgs | EndPageLayoutEventArgs
Returns void

Generated using TypeDoc

Hierarchy

Index

Properties

Accessors

Methods

Properties

beginPageLayout

endPageLayout

Accessors

Private raiseBeginPageLayout

Returns boolean

Private raiseEndPageLayout

Returns boolean

Methods

drawGraphicsHelper

Parameters

graphics: PdfGraphics

location: PointF

Returns void

Private drawHelper

Parameters

page: PdfPage

location: PointF

Returns PdfLayoutResult

Parameters

page: PdfPage

x: number

y: number

Returns PdfLayoutResult

Parameters

page: PdfPage

layoutRectangle: RectangleF

Returns PdfLayoutResult

Parameters

page: PdfPage

location: PointF

format: PdfLayoutFormat

Returns PdfLayoutResult

Parameters

page: PdfPage

x: number

y: number

format: PdfLayoutFormat

Returns PdfLayoutResult

Parameters

page: PdfPage

layoutRectangle: RectangleF

embedFonts: boolean

Returns PdfLayoutResult

Parameters

page: PdfPage

layoutRectangle: RectangleF

format: PdfLayoutFormat

Returns PdfLayoutResult

Protected Abstract drawInternal

Parameters

graphics: PdfGraphics

Returns void

Private drawShapeHelper

Parameters

graphics: PdfGraphics

x: number

y: number

Returns void

Private getBounds

Returns RectangleF

Private Abstract getBoundsInternal

Returns RectangleF

Private layout

Parameters

param: PdfLayoutParams

Returns PdfLayoutResult

onBeginPageLayout

Parameters

args: PdfGridBeginPageLayoutEventArgs | BeginPageLayoutEventArgs

Returns void

onEndPageLayout

Parameters

args: PdfGridEndPageLayoutEventArgs | EndPageLayoutEventArgs

Returns void