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

NgDocOverlayRef

Generic types:T

No documentation has been provided.

Constructor

No documentation has been provided.

Presentation
constructor(
	readonly overlayRef: OverlayRef, 
	private readonly overlayConfig: NgDocOverlayConfig, 
	readonly overlayContainer: NgDocOverlayContainer, 
	private readonly ngZone: NgZone, 
	private readonly router?: Router | undefined, 
	private readonly location?: Location_2 | undefined
): NgDocOverlayRef<T>;
Parameters
NameTypeDescription
r
overlayRef
OverlayRef
r
overlayConfig
NgDocOverlayConfig
r
overlayContainer
NgDocOverlayContainer
r
ngZone
NgZone
r
router
Router | undefined
r
location
Location_2 | undefined

Accessors

get hasAttached

Overlay has attached

Presentation
get hasAttached(): boolean;
Type

boolean

get isFocused

Overlay has focus

Presentation
get isFocused(): boolean;
Type

boolean

get isOpened

Overlay is opened

Presentation
get isOpened(): boolean;
Type

boolean

Methods

afterClose()

No documentation has been provided.

Presentation
afterClose(): Observable<T | null>;
Returns
Observable<T | null>

afterOpen()

No documentation has been provided.

Presentation
afterOpen(): Observable<void>;
Returns

beforeClose()

No documentation has been provided.

Presentation
beforeClose(): Observable<T | null>;
Returns
Observable<T | null>

beforeOpen()

No documentation has been provided.

Presentation
beforeOpen(): Observable<void>;
Returns

close()

Closes overlay

Presentation
close(closeResult?: T | undefined): void;
Parameters
NameTypeDescription
closeResult
T | undefined
Returns
void

focus()

Sets focus to overlay

Presentation
focus(): void;
Returns
void

positionChanges()

No documentation has been provided.

Presentation
positionChanges(): Observable<ConnectedOverlayPositionChange>;
Returns
Observable<ConnectedOverlayPositionChange>