Class Text

Hierarchy

Container
- Text

Constructors

constructor

new Text(text: string, options: TextOptions): Text
Parameters
- text: string
- options: TextOptions
Returns Text
Overrides Container.constructor
- Defined in DocPageContainerText.ts:20

Properties

ALIGNMENT_TO_WPERC_HPERC

ALIGNMENT_TO_WPERC_HPERC: {
    bottom: number[];
    bottomleft: number[];
    bottomright: number[];
    center: number[];
    left: number[];
    right: number[];
    top: number[];
    topleft: number[];
    topright: number[];
} = ...

Type declaration

bottom: number[]
bottomleft: number[]
bottomright: number[]
center: number[]
left: number[]
right: number[]
top: number[]
topleft: number[]
topright: number[]

DEFAULT_COLOR

DEFAULT_COLOR: string = 'black'

DEFAULT_SIZE

DEFAULT_SIZE: string = '7mm'

DEFAULT_TEXT_PIVOT_POSITION

DEFAULT_TEXT_PIVOT_POSITION: number[] = ...

HEIGHT_DEFAULT

HEIGHT_DEFAULT: number = 1.0

PIVOT_DEFAULT

PIVOT_DEFAULT: ContainerAlignment = 'center'

POSITION_DEFAULT

POSITION_DEFAULT: ContainerAlignment = 'center'

WIDTH_DEFAULT

WIDTH_DEFAULT: number = 1.0

_caption

_caption: string

_content

_content: any

_contentAlign

_contentAlign: ContainerAlignment

_frame

_frame: Frame

_height

_height: number

_heightRelativeTo

_heightRelativeTo: ContainerSizeRelativeTo = 'page-content-area'

_index

_index: number

_options

_options: TextOptions = {}

_page

_page: Page

_parent

_parent: Container

_pivot

_pivot: number[]

_position

_position: number[]

_text

_text: string

_type

_type: ContainerType

_width

_width: number

_widthRelativeTo

_widthRelativeTo: ContainerSizeRelativeTo = 'page-content-area'

_zoomLevel

_zoomLevel: ScaleInput

_zoomRelativeTo

_zoomRelativeTo: ZoomRelativeTo

name

name: string

Methods

_calculateAbsHeight

_calculateAbsHeight(): number
Transform from relative height (to page or page-content-area) to absolute (in DocUnits)

Returns number
Inherited from Container._calculateAbsHeight
- Defined in DocPageContainer.ts:206

_calculateAbsWidth

_calculateAbsWidth(): number
Transform from relative width (to page or page-content-area) to absolute (in DocUnits)

Returns number
Inherited from Container._calculateAbsWidth
- Defined in DocPageContainer.ts:198

_setColor

_setColor(color: string): void
Convert to Color hex with chroma
Parameters
- color: string
Returns void
- Defined in DocPageContainerText.ts:52

_setDefaults

_setDefaults(): void
with Text Container width/height is less important than position and size - reflect this in setting to null by default

Returns void
Overrides Container._setDefaults
- Defined in DocPageContainerText.ts:30

_setSize

_setSize(size: string | number): void
Set size of text in traditional 'points'. Real doc units (mm,cm,inch) are converted to points
Parameters
- size: string | number
Returns void
- Defined in DocPageContainerText.ts:46

_toContainerData

_toContainerData(): ContainerData
Output raw Container data

Returns ContainerData
Inherited from Container._toContainerData
- Defined in DocPageContainer.ts:215

height

height(n: WidthHeightInput): void
Set height of this Container. Either in percentage ([0-1]) of width or in % or units
Parameters
- n: WidthHeightInput
Returns void
Inherited from Container.height
- Defined in DocPageContainer.ts:140

on

on(page: Page): Container
Parameters
- page: Page
Returns Container
Inherited from Container.on
- Defined in DocPageContainer.ts:122

pivot

pivot(p: Position): Container
Set pivot with a ContainerAlignment ('top', 'topright') or percentage of width and height [x,y]
Parameters
- p: Position
Returns Container
Inherited from Container.pivot
- Defined in DocPageContainer.ts:164

position

position(p: Position): Container
Set position with a ContainerAlignment ('top', 'topright') or percentage of width and height [x,y]
Parameters
- p: Position
Returns Container
Inherited from Container.position
- Defined in DocPageContainer.ts:148

scale

scale(factor: ScaleInput): void
Set zoom level relative to world size of Shapes
Parameters
- factor: ScaleInput
Returns void
Inherited from Container.scale
- Defined in DocPageContainer.ts:187

setOptions

setOptions(options?: TextOptions): void
Set options and defaults
Parameters
- options: TextOptions = {}
Returns void
- Defined in DocPageContainerText.ts:39

toData

toData(): any
Returns any
Overrides Container.toData
- Defined in DocPageContainerText.ts:66

width

width(n: WidthHeightInput): void
Set width of this Container. Either in percentage ([0-1]) of (page or content) width or in % or units
Parameters
- n: WidthHeightInput
Returns void
Inherited from Container.width
- Defined in DocPageContainer.ts:132

zoom

zoom(factor: number): void
Set zoom level (which is relative to view container size)
Parameters
- factor: number
Returns void
Inherited from Container.zoom
- Defined in DocPageContainer.ts:179

Class Text

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

text: string

options: TextOptions

Returns Text

Properties

ALIGNMENT_TO_WPERC_HPERC

Type declaration

bottom: number[]

bottomleft: number[]

bottomright: number[]

center: number[]

left: number[]

right: number[]

top: number[]

topleft: number[]

topright: number[]

DEFAULT_COLOR

DEFAULT_SIZE

DEFAULT_TEXT_PIVOT_POSITION

HEIGHT_DEFAULT

PIVOT_DEFAULT

POSITION_DEFAULT

WIDTH_DEFAULT

_caption

_content

_contentAlign

_frame

_height

_heightRelativeTo

_index

_options

_page

_parent

_pivot

_position

_text

_type

_width

_widthRelativeTo

_zoomLevel

_zoomRelativeTo

name

Methods

_calculateAbsHeight

Returns number

_calculateAbsWidth

Returns number

_setColor

Parameters

color: string

Returns void

_setDefaults

Returns void

_setSize

Parameters

size: string | number

Returns void

_toContainerData

Returns ContainerData

height

Parameters

n: WidthHeightInput

Returns void

on

Parameters

page: Page

Returns Container

pivot

Parameters

p: Position

Returns Container

position