API / geotoolkit / scene / exports / PaperFormatFactory / PaperFormatFactory
exports.PaperFormatFactory.PaperFormatFactory
Paper format factory
Constructors
Methods
▸ getClassName(): string
string
▸ getPaper(paperformat, unit?, orientation?): AbstractPaperFormat
Return an instance of paper format.
| Name | Type | Description |
|---|---|---|
paperformat | string | AbstractPaperFormat | PaperOptions | paper format |
Optional unit | string | AbstractUnit | optional |
Optional orientation | PaperOrientation | optional |
result
▸ getPaperList(): string[]
Return the list of all papers supported by the factory.
string[]
paperList all of the supported paper types
▸ registerNewPaperFormat(newPaper): void
Register a custom paper format to the paper format factory. The paper format must extend AbstractPaperFormat.
Throws
Error if paper is not an instance of AbstractPaperFormat
| Name | Type | Description |
|---|---|---|
newPaper | CustomPaperFormat | custom paper format |
void
▸ Static getClassName(): string
string
▸ Static getInstance(): PaperFormatFactory
Return the instance of paper format factory. Will build new one if one has not been constructed.
format factory