Class RenderOptions

constructor

• new RenderOptions(options?: Options): RenderOptions

  Create a RenderOptions instance. Instead of creating an instance in new mode, use create to create an instance.

  Parameters

  • Optionaloptions: Options

    Create a RenderOptions instance with the specified options.

  Returns RenderOptions

  Example

  const renderOptions = await RenderOptions.create();
  Copy

options

_colorToHex

• _colorToHex(color: number): Promise<string>

  Converts a numeric color value to hex color string.

  Parameters

  • color: number

    The numeric color value to convert.

  Returns Promise<string>

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

_hexToColor

• _hexToColor(hexColor: string): Promise<number>

  Parameters

  • hexColor: string

  Returns Promise<number>

destroy

• destroy(): Promise<void>

  destroy the current object.

  Returns Promise<void>

getBackColor

• getBackColor(): Promise<string>

  Gets the background color.

  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.

  Returns Promise<number>

  A promise that resolves to the color mode.

getForeColor

• getForeColor(): Promise<string>

  Gets the foreground color.

  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.

  Returns Promise<string>

  A promise that resolves to the render flag.

setBackColor

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

  Sets the background color.

  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.

  Parameters

  • mode: number

    The color mode to set.

    • DefineConst.FPD_RENDER_COLOR_NORMAL Normal color rendering.
    • DefineConst.FPD_RENDER_COLOR_GRAY Gray color rendering.
    • DefineConst.FPD_RENDER_COLOR_TWOCOLOR Two-color rendering.
    • DefineConst.FPD_RENDER_COLOR_ALPHA Alpha color rendering.
    • DefineConst.FPD_RENDER_COLOR_CUSTOM Custom color rendering.

  Returns Promise<void>

  A promise that resolves when the color mode is set.

setForeColor

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

  Sets the foreground color.

  Parameters

  • color: string

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

  Returns Promise<void>

  A promise that resolves when the foreground color is set.

setRenderFlag

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

  Sets the render flag.

  Parameters

  • flag: number

    The render flag to set. See DefineConst.FPD_RENDER_CLEARTYPE = 0x01 DefineConst.FPD_RENDER_PRINTGRAPHICTEXT = 0x02 DefineConst.FPD_RENDER_FORCE_DOWNSAMPLE = 0x04 DefineConst.FPD_RENDER_PRINTPREVIEW = 0x08 DefineConst.FPD_RENDER_BGR_STRIPE = 0x10 DefineConst.FPD_RENDER_NO_NATIVETEXT = 0x00000020 DefineConst.FPD_RENDER_FORCE_HALFTONE = 0x40 DefineConst.FPD_RENDER_RECT_AA = 0x80 DefineConst.FPD_RENDER_FILL_FULLCOVER = 0x00000100 DefineConst.FPD_RENDER_PRINTIMAGETEXT = 0x00000200 DefineConst.FPD_RENDER_OVERPRINT = 0x00000400 DefineConst.FPD_RENDER_THINLINE = 0x00000800 DefineConst.FPD_RENDER_ENHANCEZEROLINE = 0x00001000 DefineConst.FPD_RENDER_MONO_FORCE_DOWNSAMPLE = 0x00002000 DefineConst.FPD_RENDER_NOTEXTSMOOTH = 0x10000000 DefineConst.FPD_RENDER_NOPATHSMOOTH = 0x20000000 DefineConst.FPD_RENDER_NOIMAGESMOOTH = 0x40000000 DefineConst.FPD_RENDER_IMAGEINTERPOL = 0x80000000 DefineConst.FPD_RENDER_LIMITEDIMAGECACHE = 0x01000000 DefineConst.FPD_RENDER_TEXTKNOCKOUT = 0x00010000 DefineConst.FPD_RENDER_COLORREPLACE_TEXT = 0x00000001 DefineConst.FPD_RENDER_COLORREPLACE_PATH = 0x00000002 DefineConst.FPD_RENDER_COLORREPLACE_TEXT_ONLYBLACK = 0x00000100 DefineConst.FPD_RENDER_COLORREPLACE_PATH_ONLYBLACK = 0x00000200 DefineConst.FPD_RENDER_ENABLE_JPX_DOWNSAMPLE = 0x00200000

  Returns Promise<void>

  A promise that resolves when the render flag is set.

Staticcreate

• create(options?: Options): Promise<RenderOptionsType>

  Creates a RenderOptions instance.

  Parameters

  • Optionaloptions: Options

    The configuration options required for creation, containing necessary initialization information.

  Returns Promise<RenderOptionsType>

  A promise that resolves to a RenderOptions instance.