Class: Artwork
core/artwork.Artwork
Artwork class for rendering ANSI art files with SAUCE metadata support
Table of contents
Constructors
Methods
Constructors
constructor
• new Artwork(basepath, output, programDir?)
Parameters
| Name | Type | Default value |
|---|---|---|
basepath |
string |
undefined |
output |
IQOutput |
undefined |
programDir |
string |
"" |
Defined in
Methods
getContent
▸ getContent(filename): string
Get raw content of artwork file without rendering
Parameters
| Name | Type |
|---|---|
filename |
string |
Returns
string
Defined in
getSauceInfo
▸ getSauceInfo(): null | SAUCEInfo
Get SAUCE metadata for the last rendered artwork
Returns
null | SAUCEInfo
Defined in
render
▸ render(options): IQArtworkRenderFunctions
Render ANSI artwork to the screen
Parameters
| Name | Type |
|---|---|
options |
IQArtworkRenderOptions |
Returns
Defined in
toGraphic
▸ toGraphic(filename, width?, height?, processMCI?): Graphic
Load artwork into a Graphic object instead of rendering
Parameters
| Name | Type | Default value |
|---|---|---|
filename |
string |
undefined |
width? |
number |
undefined |
height? |
number |
undefined |
processMCI |
boolean |
false |