Class ColorState

constructor

• new ColorState(options?: Options): ColorState

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

  Parameters

  • Optionaloptions: Options

    The options to create a ColorState instance.

  Returns ColorState

  Example

   const colorState = await ColorState.create();
  Copy

options

destroy

• destroy(): Promise<void>

  Destroys the PDF color state object.

  Returns Promise<void>

getFillColor

• getFillColor(): Promise<null | ColorType>

  Gets the filling color.

  Returns Promise<null | ColorType>

  • The filling color.

getStrokeColor

• getStrokeColor(): Promise<null | ColorType>

  Gets the stroking color.

  Returns Promise<null | ColorType>

  • The stroking color.

isNull

• isNull(): Promise<boolean>

  Tests whether the color state object is NULL or not.

  Returns Promise<boolean>

  • Non-zero means NULL, otherwise not NULL.

setFillColor

• setFillColor(clrSpace: ColorSpaceType, value: number[]): Promise<void>

  Sets the filling normal color.

  Parameters

  • clrSpace: ColorSpaceType

    The color space of the filling color.
  • value: number[]

    The color component values in the specified color space.

  Returns Promise<void>

setStrokeColor

• setStrokeColor(clrSpace: ColorSpaceType, value: number[]): Promise<void>

  Sets the stroking color.

  Parameters

  • clrSpace: ColorSpaceType

    The color space of the stroking color.
  • value: number[]

    The color component values in the specified color space.

  Returns Promise<void>

Staticcreate

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

  Creates a new empty PDF color state object.

  Parameters

  • Optionaloptions: Options

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

  Returns Promise<ColorStateType>