Options
All
  • Public
  • Public/Protected
  • All
Menu

The ScratchPad class creates a scratch pad display object and adds it to the stage.

Hierarchy

  • ScratchPad

Index

Constructors

Accessors

Methods

Constructors

constructor

  • new ScratchPad(width: number, height: number, markerSize: number): ScratchPad
  • Parameters

    • width: number
    • height: number
    • markerSize: number

    Returns ScratchPad

Accessors

isShowing

  • get isShowing(): boolean
  • Returns boolean

onClose

  • get onClose(): Function
  • set onClose(callback: Function): void
  • Get the function callback that is invoked when the scratch pad is closed

    Returns Function

    Callback Function

  • Set a function callback that is invoked when the scratch pad is closed

    Parameters

    • callback: Function

      Function to invoke, if defined. Use "() => function" notation to ensure 'this' context is correctly preserved.

    Returns void

    Callback Function

Methods

clear

  • clear(): void
  • Clear the tracer object

    Returns void

destroy

  • destroy(): void
  • Explicitely delete any allocated resources

    Returns void

hide

  • hide(): void
  • Hide/close the scratch pad

    Returns void

show

  • show(problem?: DisplayObject): void
  • Show the scratch pad

    Parameters

    • Optional problem: DisplayObject

    Returns void