Class Page

Hierarchy

Page

Index

Constructors

Properties

DEFAULT_PADDING DEFAULT_SIZE PAGE_ISO_SIZE_TO_WIDTH_HEIGHT_MM _containers _doc _document _height _orientation _padding _size _units _variables _width name

Methods

_containerExists _sizeToWidthHeight add height orientation padding setDefaults size toData width

Constructors

constructor

new Page(doc: Doc, documentName: string, name: string): Page
Parameters
- doc: Doc
- documentName: string
- name: string
Returns Page
- Defined in DocPage.ts:74

Properties

DEFAULT_PADDING

DEFAULT_PADDING: WidthHeightInput = '1cm'

DEFAULT_SIZE

DEFAULT_SIZE: PageSize = 'A4'

PAGE_ISO_SIZE_TO_WIDTH_HEIGHT_MM

PAGE_ISO_SIZE_TO_WIDTH_HEIGHT_MM: {
    A0: {
        h: number;
        w: number;
    };
    A1: {
        h: number;
        w: number;
    };
    A2: {
        h: number;
        w: number;
    };
    A3: {
        h: number;
        w: number;
    };
    A4: {
        h: number;
        w: number;
    };
    A5: {
        h: number;
        w: number;
    };
    A6: {
        h: number;
        w: number;
    };
    A7: {
        h: number;
        w: number;
    };
} = ...

Type declaration

A0: {
h: number;
w: number;
}
- h: number
- w: number
A1: {
h: number;
w: number;
}
- h: number
- w: number
A2: {
h: number;
w: number;
}
- h: number
- w: number
A3: {
h: number;
w: number;
}
- h: number
- w: number
A4: {
h: number;
w: number;
}
- h: number
- w: number
A5: {
h: number;
w: number;
}
- h: number
- w: number
A6: {
h: number;
w: number;
}
- h: number
- w: number
A7: {
h: number;
w: number;
}
- h: number
- w: number

_containers

_containers: AnyContainer[] = []

_doc

_doc: Doc

_document

_document: string

_height

_height: number

_orientation

_orientation: PageOrientation = 'landscape'

_padding

_padding: number[]

_size

_size: PageSize

_units

_units: DocUnits

_variables

_variables: {
[key: string]: any;
} = {}

Type declaration

[key: string]: any

_width

_width: number

name

name: string

Methods

_containerExists

_containerExists(name: string): boolean
Parameters
- name: string
Returns boolean
- Defined in DocPage.ts:193

_sizeToWidthHeight

_sizeToWidthHeight(size: PageSize): void
Transform given ISO page size (A0-A7) to units in document units
Parameters
- size: PageSize
Returns void
- Defined in DocPage.ts:199

add

add(container: AnyContainer): void
Add AnyContainer to page
Parameters
- container: AnyContainer
Returns void
- Defined in DocPage.ts:162

height

height(n: WidthHeightInput): Page
Set height of Page in document units
Parameters
- n: WidthHeightInput
Returns Page
- Defined in DocPage.ts:117

orientation

orientation(): Page
Returns Page
- Defined in DocPage.ts:136

padding

padding(w: WidthHeightInput, h?: WidthHeightInput): Page
Set padding width (left and right) and height (top and bottom) Use relative width/height ([0-1]), number with percentage (5%) or number with real units ('1cm','0.5"')
Parameters
- w: WidthHeightInput
- Optional h: WidthHeightInput
Returns Page
- Defined in DocPage.ts:145

setDefaults

setDefaults(): void
Returns void
- Defined in DocPage.ts:83

size

size(size: PageSize): void
Parameters
- size: PageSize
Returns void
- Defined in DocPage.ts:89

toData

toData(): {
    _entity: string;
    containers: any[];
    docUnits: DocUnits;
    height: number;
    name: string;
    orientation: PageOrientation;
    padding: number[];
    size: PageSize;
    width: number;
}
Returns {
    _entity: string;
    containers: any[];
    docUnits: DocUnits;
    height: number;
    name: string;
    orientation: PageOrientation;
    padding: number[];
    size: PageSize;
    width: number;
}
- _entity: string
- containers: any[]
- docUnits: DocUnits
- height: number
- name: string
- orientation: PageOrientation
- padding: number[]
- size: PageSize
- width: number
- Defined in DocPage.ts:176

width

width(n: WidthHeightInput): Page
Set width of Page in document units
Parameters
- n: WidthHeightInput
Returns Page
- Defined in DocPage.ts:97

Class Page

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

doc: Doc

documentName: string

name: string

Returns Page

Properties

DEFAULT_PADDING

DEFAULT_SIZE

PAGE_ISO_SIZE_TO_WIDTH_HEIGHT_MM

Type declaration

A0: { h: number; w: number; }

h: number

w: number

A1: { h: number; w: number; }

h: number

w: number

A2: { h: number; w: number; }

h: number

w: number

A3: { h: number; w: number; }

h: number

w: number

A4: { h: number; w: number; }

h: number

w: number

A5: { h: number; w: number; }

h: number

w: number

A6: { h: number; w: number; }

h: number

w: number

A7: { h: number; w: number; }

h: number

w: number

_containers

_doc

_document

_height

_orientation

_padding

_size

_units

_variables

Type declaration

[key: string]: any

_width

name

Methods

_containerExists

Parameters

name: string

Returns boolean

_sizeToWidthHeight

Parameters

size: PageSize

Returns void

add

Parameters

container: AnyContainer

Returns void

height

Parameters

n: WidthHeightInput

Returns Page

orientation

Returns Page

padding

Parameters

w: WidthHeightInput

Optional h: WidthHeightInput

Returns Page

setDefaults

A0: {
h: number;
w: number;
}

A1: {
h: number;
w: number;
}

A2: {
h: number;
w: number;
}

A3: {
h: number;
w: number;
}

A4: {
h: number;
w: number;
}

A5: {
h: number;
w: number;
}

A6: {
h: number;
w: number;
}

A7: {
h: number;
w: number;
}

`Optional` h: WidthHeightInput

Returns {
_entity: string;
containers: any[];
docUnits: DocUnits;
height: number;
name: string;
orientation: PageOrientation;
padding: number[];
size: PageSize;
width: number;
}