API: Core

OverlayRef

Class reference for OverlayRef.

Overview

class OverlayRef

Name	Type	Description
`readonly closed$`	`Observable<void>`
`readonly mounted$`	`Observable<HTMLElement>`
`readonly position$`	`Observable<OverlayPosition>`
`readonly position`	`OverlayPosition \| null`	The most recent position while open (`null` before the first measurement and after close).
`readonly isOpen`	`boolean`

open(): void

close(): void

toggle(): void

setVirtualAnchor(anchor: OverlayVirtualAnchor): void

Parameter	Type	Optional	Description
`anchor`	`OverlayVirtualAnchor`

setAnchor(anchor: OverlayAnchor): void

Parameter	Type	Optional	Description
`anchor`	`OverlayAnchor`

updatePosition(): void

destroy(): void