Last updated

API / geotoolkit / scene / exports / AbstractPaperFormat / AbstractPaperFormat

Class: AbstractPaperFormat

exports.AbstractPaperFormat.AbstractPaperFormat

Abstract Paper Format class

Hierarchy

Table of contents

Constructors
Methods

Contents

Constructors

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

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

Parameters

Name Type Description
namestringpaper name
widthnumberpaper width
heightnumberpaper height
topnumberpaper top margin
rightnumberpaper right margin
bottomnumberpaper bottom margin
leftnumberpaper left margin
unitAbstractUnitpaper measure unit
orientationPaperOrientationpaper orientation
Methods

getBottom

getBottom(): number

get bottom margin

Returns

number

bottom margin


getClassName

getClassName(): string

Returns

string


getDimension

getDimension(): Dimension

get dimension

Returns

Dimension

dimension


getHeight

getHeight(): number

get paper height

Returns

number

height


getLeft

getLeft(): number

get left margin

Returns

number

left margin


getName

getName(): string

get the paper name

Returns

string

paper name


getOrientation

getOrientation(): PaperOrientation

get paper orientation

Returns

PaperOrientation

orientation


getRight

getRight(): number

get right margin

Returns

number

right margin


getTop

getTop(): number

get top margin

Returns

number

top margin


getUnit

getUnit(): AbstractUnit

get paper unit

Returns

AbstractUnit

unit


getWidth

getWidth(): number

get paper width

Returns

number

width


getClassName

Static getClassName(): string

Returns

string