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 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
Display settings for the overlay, such as positioning and scroll/close behavior.
Id of the created overlay. Valid until detach is called.
Generates Id. Provide this Id when call show(id) method
Component Type to show in overlay
Display settings for the overlay, such as positioning and scroll/close behavior.
Optional reference to an object containing Injector and ComponentFactoryResolver that can resolve the component's factory
Id of the created overlay. Valid until detach is called.
Remove overlay with the provided id.
Id of the overlay to remove
this.overlay.detach(id);
Remove all the overlays.
this.overlay.detachAll();
Hides the component with the ID provided as a parameter.
this.overlay.hide(id);
Hides all the components and the overlay.
this.overlay.hideAll();
Repositions the component with ID provided as a parameter.
Id to reposition overlay for
this.overlay.reposition(id);
Offsets the content along the corresponding axis by the provided amount
Id to offset overlay for
Amount of offset in horizontal direction
Amount of offset in vertical direction
this.overlay.setOffset(id, deltaX, deltaY);
Shows the overlay for provided id.
Id to show overlay for
Display settings for the overlay, such as positioning and scroll/close behavior.
Creates 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
Non-modal overlay settings based on Global or Container position strategy and the provided position.
Creates 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.
Non-modal overlay settings based on the provided target, strategy and position.
Documentation The overlay service allows users to show components on overlay div above all other elements in the page.