Interface: IQArtworkRenderOptions
core/artwork.IQArtworkRenderOptions
Artwork render options
Table of contents
Properties
- autoPause
- center
- clearScreenBefore
- data
- display
- encoding
- filename
- mode
- pageLength
- processMCI
- speed
- x
- y
Properties
autoPause
• Optional autoPause: boolean
Defined in
center
• Optional center: "auto" | "horizontal" | "vertical" | "both" | "none"
Centering mode for artwork positioning based on screen resolution.
- ‘auto’: Center if artwork is smaller than screen (default)
- ‘horizontal’: Center horizontally only
- ‘vertical’: Center vertically only
- ‘both’: Always center both axes
- ‘none’: No centering, render at 1,1 (legacy behavior)
Defined in
clearScreenBefore
• Optional clearScreenBefore: boolean
Defined in
data
• Optional data: any
Defined in
display
• Optional display: "line" | "character" | "instant"
Display style: ‘line’ renders line-by-line, ‘character’ renders char-by-char, ‘instant’ renders all at once
Defined in
encoding
• Optional encoding: "utf8" | "cp437"
Output encoding for the artwork.
- ‘cp437’: Send raw CP437 bytes (for BBS terminals like SyncTERM)
- ‘utf8’: Convert CP437 to UTF-8 (for modern terminals like xterm) Defaults to ‘cp437’ for traditional BBS compatibility.
Defined in
filename
• Optional filename: string
Defined in
mode
• Optional mode: "line" | "character" | "instant"
Deprecated
Use ‘display’ instead
Defined in
pageLength
• Optional pageLength: number
Defined in
processMCI
• Optional processMCI: boolean
Process MCI/pipe codes in artwork. Defaults to true for BBS compatibility.
Defined in
speed
• Optional speed: number
Defined in
x
• Optional x: number
Explicit X position (1-indexed). Overrides centering.
Defined in
y
• Optional y: number
Explicit Y position (1-indexed). Overrides centering.