Class OverlayItem

constructor

• new OverlayItem(
      key: string,
      label: string,
      visible: boolean,
      index: number,
  ): OverlayItem

  Parameters

  • key: string
  • label: string
  • visible: boolean
  • index: number

  Returns OverlayItem

Staticcreate2d

• create2d(
      key: string,
      label: string,
      visible: boolean,
      index: number,
  ): OverlayItem

  Creates a new 2D overlay item with the specified properties.

  Parameters

  • key: string

    A unique identifier for the overlay item.

  • label: string

    A descriptive label for the overlay item.

  • visible: boolean

    A boolean indicating whether the overlay item is visible.

  • index: number

    The index position of the overlay item.

  Returns OverlayItem

  A new instance of OverlayItem initialized with the provided properties.

setValue

• setValue(updatedValue: string): void

  Updates the current value of the instance and synchronizes it with an external overlay system.

  Parameters

  • updatedValue: string

    The new value to set for this instance.

  Returns void

setVisible

• setVisible(state: boolean): void

  Sets the visibility state of the current object

  Parameters

  • state: boolean

    A boolean indicating the desired visibility state. true to make the object visible, false to hide it.

  Returns void

key

label

visible

index

value