クラス IgxCarouselComponent

Ignite UI for Angular Carousel - ヘルプ

Ignite UI Carousel はスライド コレクションのブラウズやナビゲーションに使用されます。Slides can contain custom スライドは画像またはカードなどのカスタム コンテンツを含みます。チュートリアルまたはページに分割されるインターフェイスなどに使用できます。 別の全画面要素として使用、またはその他のコンポーネントに含むことができます。 Example:

<igx-carousel>
  <igx-slide>
    <h3>First Slide Header</h3>
    <p>First slide Content</p>
  <igx-slide>
  <igx-slide>
    <h3>Second Slide Header</h3>
    <p>Second Slide Content</p>
</igx-carousel>

階層

  • IgxCarouselComponent

実装

  • OnDestroy

コンストラクタ

constructor

プロパティ

id

id: string = `igx-carousel-${NEXT_ID++}`

カルーセルの id を設定します。 設定されない場合、最初のカルーセル コンポーネントの id"igx-carousel-0" になります。

<igx-carousel id="my-first-carousel"></igx-carousel>
次のメンバー:

IgxCarouselComponent

loop

loop: boolean = true

カルーセルが最後のスライドの後に最初のスライドに戻る (loop) かどうかを設定します。 デフォルト値は true です。

<igx-carousel [loop]="false"></igx-carousel>
次のメンバー:

IgxCarouselComponent

navigation

navigation: boolean = true

カルーセルに左/右のナビゲーション (navigation) ボタンを描画するかどうかを制御します。 デフォルト値は true です。

<igx-carousel [navigation] = "false"></igx-carousel>
次のメンバー:

IgxCarouselComponent

onCarouselPaused

onCarouselPaused: EventEmitter<IgxCarouselComponent> = new EventEmitter<IgxCarouselComponent>()

カルーセルが一時停止された後に発生するイベント。 イベント引数として IgxCarouselComponent への参照を提供します。

<igx-carousel (onCarouselPaused)="onCarouselPaused($event)"></igx-carousel>
次のメンバー:

IgxCarouselComponent

onCarouselPlaying

onCarouselPlaying: EventEmitter<IgxCarouselComponent> = new EventEmitter<IgxCarouselComponent>()

カルーセルが slides の間の移動を再開した後に発生するイベント。 イベント引数として IgxCarouselComponent への参照を提供します。

<igx-carousel (onCarouselPlaying)="onCarouselPlaying($event)"></igx-carousel>
次のメンバー:

IgxCarouselComponent

onSlideAdded

onSlideAdded: EventEmitter<ISlideEventArgs> = new EventEmitter<ISlideEventArgs>()

スライドがカルーセルに追加された後に発生するイベント。 イベント引数として IgxCarouselComponent および IgxSlideComponent への参照を提供します。

<igx-carousel (onSlideAdded)="onSlideAdded($event)"></igx-carousel>
次のメンバー:

IgxCarouselComponent

onSlideChanged

onSlideChanged: EventEmitter<ISlideEventArgs> = new EventEmitter<ISlideEventArgs>()

スライド トランジションが実行された後に発生するイベント。 イベント引数として IgxCarouselComponent および IgxSlideComponent への参照を提供します。

<igx-carousel (onSlideChanged)="onSlideChanged($event)"></igx-carousel>
次のメンバー:

IgxCarouselComponent

onSlideRemoved

onSlideRemoved: EventEmitter<ISlideEventArgs> = new EventEmitter<ISlideEventArgs>()

スライドがカルーセルから削除された後に発生するイベント。 イベント引数として IgxCarouselComponent および IgxSlideComponent への参照を提供します。

<igx-carousel (onSlideRemoved)="onSlideRemoved($event)"></igx-carousel>
次のメンバー:

IgxCarouselComponent

pause

pause: boolean = true

カルーセルがユーザー インタラクションでスライド トランジションを一時停止する (pause) かどうかを設定します。 デフォルト値は true です。

 <igx-carousel [pause]="false"></igx-carousel>
次のメンバー:

IgxCarouselComponent

role

role: string = "region"

カルーセルの role 属性を返します。

let carouselRole =  this.carousel.role;
次のメンバー:

IgxCarouselComponent

slides

slides: IgxSlideComponent[] = []

カルーセルにある slides のコレクション。

let slides: IgxSlideComponent[] = this.carousel.slides;
次のメンバー:

IgxCarouselComponent

アクセサー

current

  • get current(): number
  • 表示しているスライドのインデックス。

    let currentSlideNumber =  this.carousel.current;
    次のメンバー:

    IgxCarouselComponent

    返却 number

interval

  • get interval(): number
  • set interval(value: number): void
  • スライドが変わる前の間隔 (interval) をミリ秒で返します。

    let timeInterval = this.carousel.interval;
    次のメンバー:

    IgxCarouselComponent

    返却 number

  • スライドが変わる前の間隔 (interval) をミリ秒で設定します。 設定されない場合、カルーセルは slides を自動的に変更しません。

    <igx-carousel [interval] = "1000"></igx-carousel>
    次のメンバー:

    IgxCarouselComponent

    パラメーター

    • value: number

    返却 void

isDestroyed

  • get isDestroyed(): boolean
  • カルーセルが破棄されたかどうかを示すブール値を返します。

    let isDestroyed =  this.carousel.isDestroyed;
    次のメンバー:

    IgxCarouselComponent

    返却 boolean

isPlaying

  • get isPlaying(): boolean
  • カルーセルが再生しているかどうかを示すブール値を返します。

    let isPlaying =  this.carousel.isPlaying;
    次のメンバー:

    IgxCarouselComponent

    返却 boolean

nativeElement

  • get nativeElement(): any
  • DOM でカルーセル要素への参照を返します。

    let nativeElement =  this.carousel.nativeElement;
    次のメンバー:

    IgxCarouselComponent

    返却 any

tabIndex

  • get tabIndex(): number
  • カルーセル コンポーネントの tabIndex を返します。

    let tabIndex =  this.carousel.tabIndex;
    次のメンバー:

    IgxCarouselComponent

    返却 number

total

  • get total(): number
  • カルーセルで slides の総数を返します。

    let slideCount =  this.carousel.total;
    次のメンバー:

    IgxCarouselComponent

    返却 number

メソッド

add

get

next

  • next(): void

play

  • play(): void
  • 一時停止状態の場合、カルーセルの再生を再開します。 それ以外の場合、動作しません。

    this.carousel.play();
    }
    次のメンバー:

    IgxCarouselComponent

    返却 void

prev

  • prev(): void

remove

select

  • 指定した direction に移動する指定したスライドのトランジションを実行します。

    this.carousel.select(this.carousel.get(2), Direction.NEXT);
    次のメンバー:

    IgxCarouselComponent

    パラメーター

    返却 void

stop

  • stop(): void
  • pause オプションが true に設定される場合、スライドのトランジションを停止します。 それ以外の場合、動作しません。

     this.carousel.stop();
    }
    次のメンバー:

    IgxCarouselComponent

    返却 void