API: Core
OverlayRef
Class reference for OverlayRef.
Overview
- Kind: Class
- Source: packages/core/src/overlay/overlay-ref.ts:13
Declaration
class OverlayRef
Properties
| Name | Type | Description |
|---|---|---|
readonly closed$ |
Observable<void> |
|
readonly mounted$ |
Observable<HTMLElement> |
|
readonly position$ |
Observable<OverlayPosition> |
|
readonly isOpen |
boolean |
Public methods
open
open(): void
close
close(): void
toggle
toggle(): void
setVirtualAnchor
setVirtualAnchor(anchor: OverlayVirtualAnchor): void
| Parameter | Type | Optional | Description |
|---|---|---|---|
anchor |
OverlayVirtualAnchor |
setAnchor
setAnchor(anchor: OverlayAnchor): void
| Parameter | Type | Optional | Description |
|---|---|---|---|
anchor |
OverlayAnchor |
updatePosition
updatePosition(): void
destroy
destroy(): void