Class FloatingPosition`Abstract`

Abstract FloatingPosition Class to handle the Utils related to positioning elements

Export

Abstract

Implements

Hierarchy-Diagram

UML class diagram of FloatingPosition

Legend

icon for a class in the UML class diagram

class

icon for an abstract class in the UML class diagram

abstract class

icon for an interface in the UML class diagram

interface

icon for a protected property in the UML class diagram

protected property

icon for a public method in the UML class diagram

public method

icon for a protected method in the UML class diagram

protected method

italic abstract property/method

Hierarchy

FloatingPosition
- Providers.OSUI.Utils.FloatingUI

Implements

IFloatingPosition

Index

Properties

eventOnUpdateCallback floatingConfigs isBuilt

Constructors

Methods

getOffsetValue build dispose update setFloatingPosition unsetFloatingPosition

Properties

`Protected` eventOnUpdateCallback

eventOnUpdateCallback: Generic

`Protected` floatingConfigs

floatingConfigs: FloatingPositionConfig

`Protected` isBuilt

isBuilt: boolean

Constructors

constructor

new FloatingPosition(options: FloatingPositionConfig): OSFramework.OSUI.Utils.FloatingPosition.FloatingPosition
Creates an instance of FloatingPosition.

Memberof
FloatingPosition
Parameters
- options: FloatingPositionConfig
Returns OSFramework.OSUI.Utils.FloatingPosition.FloatingPosition
- Defined in OSFramework/OSUI/Utils/FloatingPosition/FloatingPosition.ts:24

Methods

`Protected` getOffsetValue

getOffsetValue(): number
Returns number
- Defined in OSFramework/OSUI/Utils/FloatingPosition/FloatingPosition.ts:31

build

build(): void
Method to build the Util

Memberof
FloatingPosition

Returns void
- Defined in OSFramework/OSUI/Utils/FloatingPosition/FloatingPosition.ts:42

dispose

dispose(): void
Method to destroy the util

Memberof
FloatingPosition

Returns void
- Defined in OSFramework/OSUI/Utils/FloatingPosition/FloatingPosition.ts:52

update

update(options: FloatingPositionConfig): void
Method to update the Util

Memberof
FloatingPosition
Parameters
- options: FloatingPositionConfig
Returns void
- Defined in OSFramework/OSUI/Utils/FloatingPosition/FloatingPosition.ts:62

`Abstract` setFloatingPosition

setFloatingPosition(): void
Mandatory impplementation of method to set floating position

Abstract

Memberof
FloatingPosition

Returns void
Implementation of IFloatingPosition.setFloatingPosition
- Defined in OSFramework/OSUI/Utils/FloatingPosition/FloatingPosition.ts:73

`Abstract` unsetFloatingPosition

unsetFloatingPosition(): void
Mandatory impplementation of method to unset floating position

Abstract

Memberof
FloatingPosition

Returns void
Implementation of IFloatingPosition.unsetFloatingPosition
- Defined in OSFramework/OSUI/Utils/FloatingPosition/FloatingPosition.ts:81