Getting Started
Writing content
API Documentation
Customization
Recipes
API References Develop
@ng-doc/ui-kit / Class

NgDocOverlayUtils

No documentation has been provided.

Static Methods

static

getConnectedPosition()

No documentation has been provided.

Presentation
static getConnectedPosition(dropdownPositions: NgDocOverlayPosition | NgDocOverlayPosition[], origin: HTMLElement, offset: number = 0, withPointer: boolean = false): ConnectedPosition[];
Parameters
NameTypeDescription
dropdownPositions
NgDocOverlayPosition | NgDocOverlayPosition[]
origin
HTMLElement
offset
number
withPointer
boolean
Returns
ConnectedPosition[]
static

getMarginMultiplier()

No documentation has been provided.

Presentation
static getMarginMultiplier(position: ConnectedPosition): number;
Parameters
NameTypeDescription
position
ConnectedPosition
Returns
number
static

getOffsetMultiplier()

No documentation has been provided.

Presentation
static getOffsetMultiplier(position: ConnectedPosition): number;
Parameters
NameTypeDescription
position
ConnectedPosition
Returns
number
static

getOffsetX()

No documentation has been provided.

Presentation
static getOffsetX(origin: HTMLElement, position: ConnectedPosition): number;
Parameters
NameTypeDescription
origin
HTMLElement
position
ConnectedPosition
Returns
number
static

getOffsetY()

No documentation has been provided.

Presentation
static getOffsetY(origin: HTMLElement, position: ConnectedPosition): number;
Parameters
NameTypeDescription
origin
HTMLElement
position
ConnectedPosition
Returns
number
static

getOverlayPosition()

No documentation has been provided.

Presentation
static getOverlayPosition(positionPair: ConnectionPositionPair): NgDocOverlayPosition;
Parameters
NameTypeDescription
positionPair
ConnectionPositionPair
Returns
static

getPositionAlign()

No documentation has been provided.

Presentation
static getPositionAlign(position: ConnectedPosition): NgDocHorizontalAlign | NgDocVerticalAlign | null;
Parameters
NameTypeDescription
position
ConnectedPosition
Returns
static

getRelativePosition()

No documentation has been provided.

Presentation
static getRelativePosition(pos: NgDocOverlayPosition): NgDocOverlayRelativePosition | null;
Parameters
NameTypeDescription
pos
NgDocOverlayPosition
Returns
static

isCenterPosition()

No documentation has been provided.

Presentation
static isCenterPosition(position: ConnectedPosition): boolean;
Parameters
NameTypeDescription
position
ConnectedPosition
Returns
boolean
static

isVerticalPosition()

No documentation has been provided.

Presentation
static isVerticalPosition(position: ConnectedPosition): boolean;
Parameters
NameTypeDescription
position
ConnectedPosition
Returns
boolean
static

overlayIsOutByX()

No documentation has been provided.

Presentation
static overlayIsOutByX(position: ConnectedPosition): boolean;
Parameters
NameTypeDescription
position
ConnectedPosition
Returns
boolean
static

overlayIsOutByY()

No documentation has been provided.

Presentation
static overlayIsOutByY(position: ConnectedPosition): boolean;
Parameters
NameTypeDescription
position
ConnectedPosition
Returns
boolean
static

toConnectedPosition()

No documentation has been provided.

Presentation
static toConnectedPosition(position: NgDocOverlayPosition): ConnectedPosition;
Parameters
NameTypeDescription
position
NgDocOverlayPosition
Returns
ConnectedPosition
static

toConnectedPositions()

No documentation has been provided.

Presentation
static toConnectedPositions(positions: NgDocOverlayPosition[]): ConnectedPosition[];
Parameters
NameTypeDescription
positions
NgDocOverlayPosition[]
Returns
ConnectedPosition[]