Skip to main content

Interface: IOptions

Hierarchy​

Properties​

rootEmSize​

• Optional rootEmSize: number

Default rem size.

Inherited from​

IDocumentOptions.rootEmSize

Defined in​

src/Document/Document.ts:32

emSize​

• Optional emSize: number

Default em size.

Inherited from​

IDocumentOptions.emSize

Defined in​

src/Document/Document.ts:36

createCanvas​

• Optional createCanvas: CreateCanvas

Function to create new canvas.

Inherited from​

IDocumentOptions.createCanvas

Defined in​

src/Document/Document.ts:40

createImage​

• Optional createImage: CreateImage

Function to create new image.

Inherited from​

IDocumentOptions.createImage

Defined in​

src/Document/Document.ts:44

anonymousCrossOrigin​

• Optional anonymousCrossOrigin: boolean

Load images anonymously.

Inherited from​

IDocumentOptions.anonymousCrossOrigin

Defined in​

src/Document/Document.ts:48

fetch​

• Optional fetch: (input: RequestInfo | URL, init?: RequestInit) => Promise<Response>

Type declaration​

â–¸ (input, init?): Promise<Response>

WHATWG-compatible fetch function.

Parameters​
NameType
inputRequestInfo | URL
init?RequestInit
Returns​

Promise<Response>

Inherited from​

IScreenOptions.fetch

Defined in​

src/Parser.ts:10

DOMParser​

• Optional DOMParser: () => DOMParser

Type declaration​

• new DOMParser(): DOMParser

XML/HTML parser from string into DOM Document.

Returns​

DOMParser

Inherited from​

IParserOptions.DOMParser

Defined in​

src/Parser.ts:14

window​

• Optional window: Window

Window object.

Inherited from​

IScreenOptions.window

Defined in​

src/Screen.ts:23

enableRedraw​

• Optional enableRedraw: boolean

Whether enable the redraw.

Inherited from​

IScreenStartOptions.enableRedraw

Defined in​

src/Screen.ts:34

ignoreMouse​

• Optional ignoreMouse: boolean

Ignore mouse events.

Inherited from​

IScreenStartOptions.ignoreMouse

Defined in​

src/Screen.ts:38

ignoreAnimation​

• Optional ignoreAnimation: boolean

Ignore animations.

Inherited from​

IScreenStartOptions.ignoreAnimation

Defined in​

src/Screen.ts:42

ignoreDimensions​

• Optional ignoreDimensions: boolean

Does not try to resize canvas.

Inherited from​

IScreenStartOptions.ignoreDimensions

Defined in​

src/Screen.ts:46

ignoreClear​

• Optional ignoreClear: boolean

Does not clear canvas.

Inherited from​

IScreenStartOptions.ignoreClear

Defined in​

src/Screen.ts:50

scaleWidth​

• Optional scaleWidth: number

Scales horizontally to width.

Inherited from​

IScreenStartOptions.scaleWidth

Defined in​

src/Screen.ts:54

scaleHeight​

• Optional scaleHeight: number

Scales vertically to height.

Inherited from​

IScreenStartOptions.scaleHeight

Defined in​

src/Screen.ts:58

offsetX​

• Optional offsetX: number

Draws at a x offset.

Inherited from​

IScreenStartOptions.offsetX

Defined in​

src/Screen.ts:62

offsetY​

• Optional offsetY: number

Draws at a y offset.

Inherited from​

IScreenStartOptions.offsetY

Defined in​

src/Screen.ts:66

Methods​

forceRedraw​

â–¸ Optional forceRedraw(): boolean

Will call the function on every frame, if it returns true, will redraw.

Returns​

boolean

Inherited from​

IScreenStartOptions.forceRedraw

Defined in​

src/Screen.ts:70