Class IgxOverlayService

Documentation The overlay service allows users to show components on overlay div above all other elements in the page.

Hierarchy

Hierarchy

  • IgxOverlayService

Implements

  • OnDestroy

Constructors

  • Parameters

    • _factoryResolver: ComponentFactoryResolver
    • _appRef: ApplicationRef
    • _injector: Injector
    • builder: AnimationBuilder
    • document: any
    • _zone: NgZone
    • platformUtil: PlatformUtil
    • animationService: AnimationService

    Returns IgxOverlayService

Properties

animationStarting: EventEmitter<OverlayAnimationEventArgs> = ...

Emitted just before the overlay animation start.

animationStarting(event: OverlayAnimationEventArgs){
const animationStarting = event;
}
closed: EventEmitter<OverlayEventArgs> = ...

Emitted after the overlay content is closed and all animations are finished.

closed(event: OverlayEventArgs){
const closed = event;
}
closing: EventEmitter<OverlayClosingEventArgs> = ...

Emitted just before the overlay content starts to close.

closing(event: OverlayCancelableEventArgs){
const closing = event;
}
contentAppended: EventEmitter<OverlayEventArgs> = ...

Emitted after the content is appended to the overlay, and before animations are started.

contentAppended(event: OverlayEventArgs){
const contentAppended = event;
}
opened: EventEmitter<OverlayEventArgs> = ...

Emitted after the overlay content is opened and all animations are finished.

opened(event: OverlayEventArgs){
const opened = event;
}
opening: EventEmitter<OverlayCancelableEventArgs> = ...

Emitted just before the overlay content starts to open.

opening(event: OverlayCancelableEventArgs){
const opening = event;
}

Methods

  • Generates Id. Provide this Id when call show(id) method

    Returns

    Id of the created overlay. Valid until detach is called.

    Parameters

    • element: ElementRef<any>
    • Optional settings: OverlaySettings

      Display settings for the overlay, such as positioning and scroll/close behavior.

    Returns string

  • Generates Id. Provide this Id when call show(id) method

    Returns

    Id of the created overlay. Valid until detach is called.

    Parameters

    • component: Type<any>

      Component Type to show in overlay

    • Optional settings: OverlaySettings

      Display settings for the overlay, such as positioning and scroll/close behavior.

    • Optional moduleRef: {
          componentFactoryResolver: ComponentFactoryResolver;
          injector: Injector;
      }

      Optional reference to an object containing Injector and ComponentFactoryResolver that can resolve the component's factory

      • componentFactoryResolver: ComponentFactoryResolver
      • injector: Injector

    Returns string

  • Offsets the content along the corresponding axis by the provided amount

    Parameters

    • id: string

      Id to offset overlay for

    • deltaX: number

      Amount of offset in horizontal direction

    • deltaY: number

      Amount of offset in vertical direction

      this.overlay.setOffset(id, deltaX, deltaY);
      

    Returns void