Class Balloon<PT>

constructor

• new Balloon<PT>(
      featurePattern: PT,
      featureElem: HTMLElement,
      options: BalloonOptions,
  ): OSFramework.OSUI.Feature.Balloon.Balloon<PT>

  Type Parameters

  • PT

  Parameters

  • featurePattern: PT
  • featureElem: HTMLElement
  • options: BalloonOptions

  Returns OSFramework.OSUI.Feature.Balloon.Balloon<PT>

isOpen

build

• build(): void

  Method to build the Feature

  Returns void

  Memberof

  Balloon

close

• close(): void

  Method to close the Balloon

  Returns void

  Memberof

  Balloon

dispose

• dispose(): void

  Destroy the Balloon.

  Returns void

  Memberof

  Balloon

open

• open(isOpenedByApi: boolean, arrowKeyPressed?: ArrowDown | ArrowUp): void

  Method to open the Balloon

  Parameters

  • isOpenedByApi: boolean
  • OptionalarrowKeyPressed: ArrowDown | ArrowUp

  Returns void

  Memberof

  Balloon

setBalloonShape

• setBalloonShape(shape?: OSFramework.OSUI.GlobalEnum.ShapeTypes): void

  Method to handle the Shape config css variable

  Parameters

  • Optionalshape: OSFramework.OSUI.GlobalEnum.ShapeTypes

  Returns void

  Memberof

  Balloon

setFloatingBehaviour

• setFloatingBehaviour(isUpdate?: boolean): void

  Method to set the Floating Util

  Parameters

  • OptionalisUpdate: boolean

  Returns void

  Memberof

  Balloon

setFloatingConfigs

• setFloatingConfigs(): void

  Method to set the Floating configs

  Returns void

  Memberof

  Balloon

updateFloatingConfigs

• updateFloatingConfigs(floatingConfigs?: FloatingPositionConfig): void

  Method to update the FloatingUI options

  Parameters

  • OptionalfloatingConfigs: FloatingPositionConfig

  Returns void

  Memberof

  Balloon

updatePositionOption

• updatePositionOption(
      position: OSFramework.OSUI.GlobalEnum.FloatingPosition,
  ): void

  Method to update the Position config on the FloatingUI

  Parameters

  • position: OSFramework.OSUI.GlobalEnum.FloatingPosition

  Returns void

  Memberof

  Balloon