Last updated

API / geotoolkit / scene / exports / PaperFormat / PaperFormat

Class: PaperFormat

exports.PaperFormat.PaperFormat

Paper format

Hierarchy

Table of contents

Constructors
Methods

Contents

Constructors

new PaperFormat(name, width, height, top, bottom, left, right, unit, orientation)

new PaperFormat(name, width, height, top, bottom, left, right, unit, orientation)

Parameters

Name Type
namestring
widthnumber
heightnumber
topnumber
bottomnumber
leftnumber
rightnumber
unitAbstractUnit
orientationPaperOrientation

Overrides

AbstractPaperFormat.constructor

Methods

getBottom

getBottom(): number

get bottom margin

Returns

number

bottom margin

Inherited from

AbstractPaperFormat.getBottom


getClassName

getClassName(): string

Returns

string

Inherited from

AbstractPaperFormat.getClassName


getDimension

getDimension(): Dimension

get dimension

Returns

Dimension

dimension

Inherited from

AbstractPaperFormat.getDimension


getHeight

getHeight(): number

get paper height

Returns

number

height

Inherited from

AbstractPaperFormat.getHeight


getLeft

getLeft(): number

get left margin

Returns

number

left margin

Inherited from

AbstractPaperFormat.getLeft


getName

getName(): string

get the paper name

Returns

string

paper name

Inherited from

AbstractPaperFormat.getName


getOrientation

getOrientation(): PaperOrientation

get paper orientation

Returns

PaperOrientation

orientation

Inherited from

AbstractPaperFormat.getOrientation


getRight

getRight(): number

get right margin

Returns

number

right margin

Inherited from

AbstractPaperFormat.getRight


getTop

getTop(): number

get top margin

Returns

number

top margin

Inherited from

AbstractPaperFormat.getTop


getUnit

getUnit(): AbstractUnit

get paper unit

Returns

AbstractUnit

unit

Inherited from

AbstractPaperFormat.getUnit


getWidth

getWidth(): number

get paper width

Returns

number

width

Inherited from

AbstractPaperFormat.getWidth


getClassName

Static getClassName(): string

Returns

string

Inherited from

AbstractPaperFormat.getClassName