Class IgxOverlayService

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

実装

  • OnDestroy

コンストラクター

プロパティ

animationStarting: EventEmitter<OverlayAnimationEventArgs> = ...

オーバーレイ アニメーションが開始する直前に発生します。

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

オーバーレイ コンテンツが閉じて、すべてのアニメーションが完了した後に発生します。

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

オーバーレイ コンテンツが閉じ始める直前に発生します。

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

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

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

コンテンツがオーバーレイに追加される前に発行します。

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

オーバーレイコンテンツが開いて、すべてのアニメーションが完了した後に発生します。

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

オーバーレイ コンテンツが開き始める直前に発生します。

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

メソッド

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

    返却

    作成されたオーバーレイの ID です。detach が呼び出されるまで有効です。

    パラメーター

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

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

    返却 string

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

    返却

    作成されたオーバーレイの ID です。detach が呼び出されるまで有効です。

    非推奨

    14.0.0 では非推奨になりました。attach(component, viewContainerRef, settings) オーバーロードを使用してください。

    パラメーター

    • component: Type<any>

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

    • Optional settings: OverlaySettings

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

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

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

      • componentFactoryResolver: ComponentFactoryResolver
      • injector: Injector

    返却 string

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

    パラメーター

    • component: Type<any>

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

    • viewContainerRef: ViewContainerRef

      作成されたコンポーネントのホスト ビューが挿入されるコンテナへの参照です。

    • Optional settings: OverlaySettings

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

    返却 string

  • パラメーターとして提供された ID を持つコンポーネントを位置変更します。

    パラメーター

    • id: string

      オーバーレイを再配置する id です。

      this.overlay.reposition(id);
      

    返却 void

  • 対応する軸に沿って指定した量のみコンテンツをオフセットします。

    パラメーター

    • id: string

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

    • deltaX: number

      水平方向のオフセット量

    • deltaY: number

      垂直方向のオフセット量

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

    返却 void

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

    返却

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

    パラメーター

    • Optional position: AbsolutePosition

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

    • Optional outlet: ElementRef<any> | IgxOverlayOutletDirective

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

    返却 OverlaySettings

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

    返却

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

    パラメーター

    • target: HTMLElement | Point

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

    • Optional position: RelativePosition

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

    • Optional strategy: RelativePositionStrategy

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

    返却 OverlaySettings