Class IgxCarouselComponent

Ignite UI for Angular Carousel - ヘルプ

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

例:

<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>

実装

  • OnDestroy
  • AfterContentInit

コンストラクター

プロパティ

animationType: CarouselAnimationType = CarouselAnimationType.slide

カルーセルのアニメーション タイプを取得または設定します。 デフォルト値は slide です。

<igx-carousel animationType="none">
<igx-carousel>

IgxCarouselComponent

carouselPaused: EventEmitter<IgxCarouselComponent> = ...

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

<igx-carousel (carouselPaused)="carouselPaused($event)"></igx-carousel>

IgxCarouselComponent

carouselPlaying: EventEmitter<IgxCarouselComponent> = ...

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

<igx-carousel (carouselPlaying)="carouselPlaying($event)"></igx-carousel>

IgxCarouselComponent

cssClass: string = 'igx-carousel'

カルーセル コンポーネントのクラスを返します。

let class =  this.carousel.cssClass;

IgxCarouselComponent

gesturesSupport: boolean = true

カルーセルにジェスチャをサポートするかどうかを制御します。 デフォルト値は true です。

<igx-carousel [gesturesSupport]="false"></igx-carousel>

IgxCarouselComponent

id: string = ...

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

<igx-carousel id="my-first-carousel"></igx-carousel>

IgxCarouselComponent

indicators: boolean = true

カルーセルがインジケーターを表示するかどうかを制御します。 デフォルト値は true です。

<igx-carousel [indicators]="false"></igx-carousel>

IgxCarouselComponent

indicatorsOrientation: CarouselIndicatorsOrientation = CarouselIndicatorsOrientation.end

カルーセル インジケーターの表示モードを取得または設定します。start または end にすることができます。デフォルト値は end です。

<igx-carousel indicatorsOrientation="start">
<igx-carousel>

IgxCarouselComponent

indicatorTemplate: TemplateRef<any> = null

カルーセル インジケーターをレンダリングするときに使用するカスタム テンプレート。

// Set in typescript
const myCustomTemplate: TemplateRef<any> = myComponent.customTemplate;
myComponent.carousel.indicatorTemplate = myCustomTemplate;
<!-- Set in markup -->
<igx-carousel #carousel>
...
<ng-template igxCarouselIndicator let-slide>
<igx-icon *ngIf="slide.active">brightness_7</igx-icon>
<igx-icon *ngIf="!slide.active">brightness_5</igx-icon>
</ng-template>
</igx-carousel>
loop: boolean = true

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

<igx-carousel [loop]="false"></igx-carousel>

IgxCarouselComponent

maximumIndicatorsCount: number = 10

表示できる最大インデックスを制御します。 デフォルト値は 10 です。

<igx-carousel [maximumIndicatorsCount]="5"></igx-carousel>

IgxCarouselComponent

navigation: boolean = true

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

<igx-carousel [navigation]="false"></igx-carousel>

IgxCarouselComponent

nextButtonTemplate: TemplateRef<any> = null

カルーセル「次へ」ボタンをレンダリングするときに使用する必要があるカスタムテンプレート (存在する場合)。

// Set in typescript
const myCustomTemplate: TemplateRef<any> = myComponent.customTemplate;
myComponent.carousel.nextButtonTemplate = myCustomTemplate;
<!-- Set in markup -->
<igx-carousel #carousel>
...
<ng-template igxCarouselNextButton let-disabled>
<button type="button" igxButton="fab" igxRipple="white" [disabled]="disabled">
<igx-icon name="add"></igx-icon>
</button>
</ng-template>
</igx-carousel>
pause: boolean = true

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

 <igx-carousel [pause]="false"></igx-carousel>

IgxCarouselComponent

prevButtonTemplate: TemplateRef<any> = null

カルーセル「前へ」ボタンをレンダリングするときに使用する必要があるカスタムテンプレート (存在する場合)。

// Set in typescript
const myCustomTemplate: TemplateRef<any> = myComponent.customTemplate;
myComponent.carousel.prevButtonTemplate = myCustomTemplate;
<!-- Set in markup -->
<igx-carousel #carousel>
...
<ng-template igxCarouselPrevButton let-disabled>
<button type="button" igxButton="fab" igxRipple="white" [disabled]="disabled">
<igx-icon name="remove"></igx-icon>
</button>
</ng-template>
</igx-carousel>
role: string = 'region'

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

let carouselRole =  this.carousel.role;

IgxCarouselComponent

slideAdded: EventEmitter<ISlideEventArgs> = ...

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

<igx-carousel (slideAdded)="slideAdded($event)"></igx-carousel>

IgxCarouselComponent

slideChanged: EventEmitter<ISlideEventArgs> = ...

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

<igx-carousel (slideChanged)="slideChanged($event)"></igx-carousel>

IgxCarouselComponent

slideRemoved: EventEmitter<ISlideEventArgs> = ...

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

<igx-carousel (slideRemoved)="slideRemoved($event)"></igx-carousel>

IgxCarouselComponent

slides: QueryList<IgxSlideComponent>

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

let slides: QueryList<IgxSlideComponent> = this.carousel.slides;

IgxCarouselComponent

vertical: boolean = false

カルーセルを垂直に配置するかどうかを制御します。 デフォルト値は false です。

<igx-carousel [vertical]="true"></igx-carousel>

IgxCarouselComponent

アクセサー

メソッド