Class Background

constructor

• new Background(board): Background

• Creates a new background image and overlay

  Parameters

  • board: Board

    The [[Board]]

  Returns Background

image

overlay

nodes

• get nodes(): (Image | Rect)[]

• Returns background nodes which includes image and overlay

  Returns (Image | Rect)[]

fill

• fill(color): void

• Updates color of overlay

  Parameters

  • color: string

    The given color in Hex or RGB

  Returns void

getPosition

• getPosition(): {
      x: number;
      y: number;
  }

• Returns current position of background

  Returns {
      x: number;
      y: number;
  }

  • x: number

  • y: number

setImageFromFile

• setImageFromFile(file, options?): Promise<void>

• Loads the background image from given file

  Parameters

  • file: File

    The image file
  • Optional options: Partial<BackgroundOptions>

    The background options

  Returns Promise<void>

setImageFromUrl

• setImageFromUrl(url, options?): Promise<void>

• Loads the background image from url

  Parameters

  • url: string

    The image url
  • options: Partial<BackgroundOptions> = ...

    The background options

  Returns Promise<void>