API / geotoolkit / scene / exports / CustomPaperFormat / CustomPaperFormat
exports.CustomPaperFormat.CustomPaperFormat
Custom paper format
↳
CustomPaperFormat
Constructors
- [new CustomPaperFormat(name, width, height, top, bottom, left, right, unit, orientation)](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit.scene.exports.custompaperformat.custompaperformat.md#new custompaperformat(name, width, height, top, bottom, left, right, unit, orientation))
Methods
Constructors
• new CustomPaperFormat(name, width, height, top, bottom, left, right, unit, orientation)
| Name | Type |
|---|---|
name | string |
width | number |
height | number |
top | number |
bottom | number |
left | number |
right | number |
unit | AbstractUnit |
orientation | PaperOrientation |
PaperFormat.constructor
Methods
▸ getBottom(): number
get bottom margin
number
bottom margin
▸ getClassName(): string
string
▸ getDimension(): Dimension
get dimension
dimension
▸ getHeight(): number
get paper height
number
height
▸ getLeft(): number
get left margin
number
left margin
▸ getName(): string
get the paper name
string
paper name
▸ getOrientation(): PaperOrientation
get paper orientation
orientation
▸ getRight(): number
get right margin
number
right margin
▸ getTop(): number
get top margin
number
top margin
▸ getUnit(): AbstractUnit
get paper unit
unit
▸ getWidth(): number
get paper width
number
width
▸ setBottom(bottom): CustomPaperFormat
set bottom margin
| Name | Type | Description |
|---|---|---|
bottom | number | bottom margin |
this
▸ setDimension(dimension): CustomPaperFormat
set dimension
| Name | Type | Description |
|---|---|---|
dimension | Dimension | paper dimension |
this
▸ setHeight(height): CustomPaperFormat
set paper height
| Name | Type | Description |
|---|---|---|
height | number | paper height |
this
▸ setLeft(left): CustomPaperFormat
set left margin
| Name | Type | Description |
|---|---|---|
left | number | left margin |
this
▸ setName(name): CustomPaperFormat
set the paper name
| Name | Type | Description |
|---|---|---|
name | string | paper name |
this
▸ setOrientation(orientation): CustomPaperFormat
set paper orientation
| Name | Type | Description |
|---|---|---|
orientation | PaperOrientation | paper orientation |
this
▸ setRight(right): CustomPaperFormat
set right margin
| Name | Type | Description |
|---|---|---|
right | number | right margin |
this
▸ setTop(top): CustomPaperFormat
set top margin
| Name | Type | Description |
|---|---|---|
top | number | top margin |
this
▸ setUnit(unit): CustomPaperFormat
set paper unit
| Name | Type | Description |
|---|---|---|
unit | AbstractUnit | paper unit |
this
▸ setWidth(width): CustomPaperFormat
set paper width
| Name | Type | Description |
|---|---|---|
width | number | paper width |
this
▸ Static getClassName(): string
string