クラス IgxOverlayService

ヘルプ オーバーレイ サービスは、ページのその他すべての要素のオーバーレイ div にコンポーネントを表示できます。

階層

  • IgxOverlayService

実装

  • OnDestroy

コンストラクタ

constructor

  • new IgxOverlayService(_factoryResolver: ComponentFactoryResolver, _appRef: ApplicationRef, _injector: Injector, builder: AnimationBuilder, document: any, _zone: NgZone): IgxOverlayService

プロパティ

onAnimation

onAnimation: EventEmitter<OverlayAnimationEventArgs> = new EventEmitter<OverlayAnimationEventArgs>()

アニメーションを開始する前に発生されます。

onAnimation(event: OverlayAnimationEventArgs){
    const onAnimation = event;
}

onAppended

onAppended: EventEmitter<OverlayEventArgs> = new EventEmitter<OverlayEventArgs>()

コンポーネントがオーバーレイに追加された後、アニメーションが開始される前に生成されます。

onAppended(event: OverlayEventArgs){
    const onAppended = event;
}

onClosed

onClosed: EventEmitter<OverlayEventArgs> = new EventEmitter<OverlayEventArgs>()

コンポーネントが閉じて、すべてのアニメーションが完了した後に発生します。

onClosed(event: OverlayEventArgs){
    const onClosed = event;
}

onClosing

onClosing: EventEmitter<OverlayClosingEventArgs> = new EventEmitter<OverlayClosingEventArgs>()

コンポーネントが閉じられる前に発生されます。

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

onOpened

onOpened: EventEmitter<OverlayEventArgs> = new EventEmitter<OverlayEventArgs>()

コンポーネントが開いて、すべてのアニメーションが完了した後に発生します。

onOpened(event: OverlayEventArgs){
    const onOpened = event;
}

onOpening

onOpening: EventEmitter<OverlayCancelableEventArgs> = new EventEmitter<OverlayCancelableEventArgs>()

コンポーネントが開かれる前に発生されます。

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

メソッド

attach

  • attach(element: ElementRef, settings?: OverlaySettings): string
  • attach(component: Type<any>, settings?: OverlaySettings, moduleRef?: Pick<NgModuleRef<any>, "injector" | "componentFactoryResolver">): string
  • Id を生成します。show(id, settings?) メソッドを呼び出して、id を提供します。

    パラメーター

    • element: ElementRef
    • オプション settings: OverlaySettings

      位置、スクロール/閉じる動作としてオーバーレイの設定を表示します。

    返却 string

    作成したオーバーレイの ID。onClosed が発行されるまで有効です。

  • Id を生成します。show(id, settings?) メソッドを呼び出して、id を提供します。

    パラメーター

    • component: Type<any>

      オーバーレイに 表示されるコンポーネント タイプ。

    • オプション settings: OverlaySettings

      位置、スクロール/閉じる動作としてオーバーレイの設定を表示します。

    • オプション moduleRef: Pick<NgModuleRef<any>, "injector" | "componentFactoryResolver">

      コンポーネントのファクトリを解決できる Injector および ComponentFactoryResolver を含むオブジェクトへのオプションの参照。

    返却 string

    作成したオーバーレイの ID。onClosed が発行されるまで有効です。

hide

  • hide(id: string): void

hideAll

  • hideAll(): void

reposition

  • reposition(id: string): void

setOffset

  • setOffset(id: string, deltaX: number, deltaY: number): void

show

  • 提供されたコンポーネントを表示します。

    パラメーター

    • id: string

      Id to show overlay for

    • オプション settings: OverlaySettings

      位置、スクロール/閉じる動作としてオーバーレイの設定を表示します。

    返却 string

  • 提供されたコンポーネントを表示します。

    @非推奨

    Id の取得に attach(component) を使用します。提供された id で show(id, settings?) を使用します。

    パラメーター

    • component: ElementRef | Type<any>

      オーバーレイに ElementRef またはコンポーネントのタイプを表示します。

    • オプション settings: OverlaySettings

      位置、スクロール/閉じる動作としてオーバーレイの設定を表示します。

    返却 string

    作成したオーバーレイの ID。onClosed が発行されるまで有効です。

    this.overlay.show(element, settings);