Emitted just before the overlay animation start.
animationStarting(event: OverlayAnimationEventArgs){
const animationStarting = event;
}
Emitted after the overlay content is closed and all animations are finished.
closed(event: OverlayEventArgs){
const closed = event;
}
Emitted just before the overlay content starts to close.
closing(event: OverlayCancelableEventArgs){
const closing = event;
}
Emitted after the content is appended to the overlay, and before animations are started.
contentAppended(event: OverlayEventArgs){
const contentAppended = event;
}
Emitted before the content is appended to the overlay.
contentAppending(event: OverlayEventArgs){
const contentAppending = event;
}
Emitted after the overlay content is opened and all animations are finished.
opened(event: OverlayEventArgs){
const opened = event;
}
Emitted just before the overlay content starts to open.
opening(event: OverlayCancelableEventArgs){
const opening = event;
}
Generates Id. Provide this Id when call show(id) method
(optional): Display settings for the overlay, such as positioning and scroll/close behavior.
Generates Id. Provide this Id when call show(id) method
Note created instance is in root scope, prefer the viewContainerRef overload when local injection context is needed.
Component Type to show in overlay
(optional): Create settings for the overlay, such as positioning and scroll/close behavior.
Includes also an optional Injector to add to the created dynamic component's injectors.
Generates an Id. Provide this Id when calling the show(id) method
Component Type to show in overlay
Reference to the container where created component's host view will be inserted
(optional): Display settings for the overlay, such as positioning and scroll/close behavior.
Offsets the content along the corresponding axis by the provided amount with optional offsetMode that determines whether to add (by default) or set the offset values
Id to offset overlay for
Amount of offset in horizontal direction
Amount of offset in vertical direction
Determines whether to add (by default) or set the offset values with OffsetMode.Add and OffsetMode.Set
this.overlay.setOffset(id, deltaX, deltaY, offsetMode);
Shows the overlay for provided id.
Id to show overlay for
Display settings for the overlay, such as positioning and scroll/close behavior.
StaticcreateCreates overlay settings with global or container position strategy and preset position settings
Preset position settings. Default position is 'center'
The outlet container to attach the overlay to
StaticcreateCreates overlay settings with auto, connected or elastic position strategy and preset position settings
Attaching target for the component to show
Preset position settings. By default the element is positioned below the target, left aligned.
The relative position strategy to be applied to the overlay settings. Default is Auto positioning strategy.
Documentation The overlay service allows users to show components on overlay div above all other elements in the page.