クラス IgxOverlayService

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

階層

  • IgxOverlayService

実装

  • OnDestroy

Index

コンストラクタ

constructor

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

プロパティ

onAnimation

onAnimation: EventEmitter<OverlayAnimationEventArgs> = ...

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

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

onAppended

onAppended: EventEmitter<OverlayEventArgs> = ...

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

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

onClosed

onClosed: EventEmitter<OverlayEventArgs> = ...

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

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

onClosing

onClosing: EventEmitter<OverlayClosingEventArgs> = ...

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

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

onOpened

onOpened: EventEmitter<OverlayEventArgs> = ...

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

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

onOpening

onOpening: EventEmitter<OverlayCancelableEventArgs> = ...

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

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

メソッド

attach

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

    パラメーター

    • element: ElementRef<any>
    • オプション settings: OverlaySettings

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

    返却 string

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

  • Id を生成します。show(id) メソッドを呼び出すときにこのIDを提供します。

    パラメーター

    • component: Type<any>

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

    • オプション settings: OverlaySettings

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

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

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

    返却 string

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

detach

  • detach(id: string): void

detachAll

  • detachAll(): void

hide

  • hide(id: string, event?: Event): void

hideAll

  • hideAll(): void

reposition

  • reposition(id: string): void

setOffset

  • setOffset(id: string, deltaX: number, deltaY: number): void
  • 対応する軸に沿って指定した量のみコンテンツをオフセットします。

    パラメーター

    • id: string

      オーバーレイをオフセットする ID。

    • deltaX: number

      水平方向のオフセット量。

    • deltaY: number

      垂直方向のオフセット量。

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

    返却 void

show

Static createAbsoluteOverlaySettings

  • グローバルまたはコンテナーの配置ストラテジーとプリセットの位置設定でオーバーレイ設定を作成します。

    パラメーター

    • オプション position: AbsolutePosition

      プリセットの位置設定。デフォルトの位置は 'center' です。

    • オプション outlet: IgxOverlayOutletDirective | ElementRef<any>

      オーバーレイをアタッチするアウトレット コンテナー。

    返却 OverlaySettings

    グローバルまたはコンテナーの配置ストラテジーと提供された位置に基づいた非モーダル オーバーレイ設定。

Static createRelativeOverlaySettings

  • Auto、Connected、または Elastic 配置ストラテジーおよびプリセットの配置設定でオーバーレイ設定を作成します。

    パラメーター

    • target: HTMLElement | Point

      コンポーネントを表示するアタッチ ターゲット。

    • オプション position: RelativePosition

      プリセットの位置設定。デフォルトで、要素はターゲットの下に左揃えで配置されます。

    • オプション strategy: RelativePositionStrategy

      オーバーレイ設定に適用される相対位置ストラテジー。デフォルトは Auto 配置ストラテジーです。

    返却 OverlaySettings

    提供されたターゲット、ストラテジー、および位置に基づいた非モダル オーバーレイ設定。