クラス IgxOverlayService

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

階層

  • IgxOverlayService

実装

  • OnDestroy

Index

コンストラクタ

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

プロパティ

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;
}
opened: EventEmitter<OverlayEventArgs> = ...

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

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

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

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

メソッド

  • 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

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

    返却 string

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

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

    パラメーター

    • component: Type<any>

      Component Type to show in overlay

    • オプション settings: OverlaySettings

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

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

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

    返却 string

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

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

    パラメーター

    • 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);
      

    返却 void

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

    パラメーター

    • オプション position: AbsolutePosition

      Preset position settings. Default position is 'center'

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

      The outlet container to attach the overlay to

    返却 OverlaySettings

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

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

    パラメーター

    • target: HTMLElement | Point

      Attaching target for the component to show

    • オプション position: RelativePosition

      Preset position settings. By default the element is positioned below the target, left aligned.

    • オプション strategy: RelativePositionStrategy

      The relative position strategy to be applied to the overlay settings. Default is Auto positioning strategy.

    返却 OverlaySettings

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