Interface RenderOptionsType

interface RenderOptionsType {
    destroy: () => Promise<void>;
    getBackColor: () => Promise<string>;
    getColorMode: () => Promise<number>;
    getForeColor: () => Promise<string>;
    getRenderFlag: () => Promise<string>;
    options?: Options;
    setBackColor: (color: string) => Promise<void>;
    setColorMode: (mode: number) => Promise<void>;
    setForeColor: (color: string) => Promise<void>;
    setRenderFlag: (flag: number) => Promise<void>;
}

Implemented by

Properties

destroy getBackColor getColorMode getForeColor getRenderFlag options? setBackColor setColorMode setForeColor setRenderFlag

Properties

destroy

destroy: () => Promise<void>

destroy the current object.

Type declaration

    • (): Promise<void>

    • Returns Promise<void>

getBackColor

getBackColor: () => Promise<string>

Gets the background color.

Type declaration

    • (): Promise<string>

    • Returns Promise<string>

      A promise that resolves to the background color. Hex color string in the format "#RRGGBB".

getColorMode

getColorMode: () => Promise<number>

Gets the color mode.

Type declaration

    • (): Promise<number>

    • Returns Promise<number>

      A promise that resolves to the color mode.

getForeColor

getForeColor: () => Promise<string>

Gets the foreground color.

Type declaration

    • (): Promise<string>

    • Returns Promise<string>

      A promise that resolves to the foreground color. Hex color string in the format "#RRGGBB".

getRenderFlag

getRenderFlag: () => Promise<string>

Gets the render flag.

Type declaration

    • (): Promise<string>

    • Returns Promise<string>

      A promise that resolves to the render flag.

Optionaloptions

options?: Options

setBackColor

setBackColor: (color: string) => Promise<void>

Sets the background color.

Type declaration

    • (color: string): Promise<void>

    • Parameters

      • color: string

        The background color to set. Hex color string in the format "#RRGGBB".

      Returns Promise<void>

      A promise that resolves when the background color is set.

setColorMode

setColorMode: (mode: number) => Promise<void>

Sets the color mode.

Type declaration

    • (mode: number): Promise<void>

    • Parameters

      • mode: number

        The color mode to set.

      Returns Promise<void>

      A promise that resolves when the color mode is set.

setForeColor

setForeColor: (color: string) => Promise<void>

Sets the foreground color.

Type declaration

    • (color: string): Promise<void>

    • Parameters

      • color: string

        The foreground color to set.

      Returns Promise<void>

      A promise that resolves when the foreground color is set.

setRenderFlag

setRenderFlag: (flag: number) => Promise<void>

Sets the render flag.

Type declaration

    • (flag: number): Promise<void>

    • Parameters

      • flag: number

        The render flag to set.

      Returns Promise<void>

      A promise that resolves when the render flag is set.

Settings

Member Visibility

On This Page

Properties