クラス IgxChipComponent

階層

実装

  • DoCheck
  • OnInit

コンストラクタ

constructor

プロパティ

animateOnRelease

animateOnRelease: boolean = true

要素が解放されたときにドラッグ可能な要素のアニメーションを有効/無効にする @Input プロパティ。 デフォルトで true に設定されます。

<igx-chip [id]="'igx-chip-1'" [draggable]="true" [animateOnRelease]="false"></igx-chip>

cdr

cdr: ChangeDetectorRef

data

data: any

チップに関連するデータを保存する @Input プロパティ。

<igx-chip [data]="{ value: 'Country' }"></igx-chip>

disabled

disabled: boolean = false

IgxChipComponent が無効かどうかを定義する @Input プロパティ。 無効な場合、クリックまたはタブでフォーカス、クリックまたはスペースで選択、ドラッグなどのユーザー インタラクションを制限します。 デフォルトで false に設定されます。

<igx-chip [id]="chip.id" [disabled]="true"></igx-chip>

dragDirective

dragDirective: IgxDragDirective

IgxChipComponent がドラッグ動作のために使う IgxDragDirective の参照を含むプロパティ。

<igx-chip [id]="chip.id" [draggable]="true"></igx-chip>
onMoveStart(event: IBaseChipEventArgs){
    let dragDirective = event.owner.dragDirective;
}

draggable

draggable: boolean = false

IgxChipComponent の位置を変更するためにドラッグできるかどうかを定義する @Input プロパティ。 デフォルトで false に設定されます。

<igx-chip [id]="'igx-chip-1'" [draggable]="true"></igx-chip>

elementRef

elementRef: ElementRef

hideBaseOnDrag

hideBaseOnDrag: boolean = true

ドラッグされた基本要素の非表示を有効または無効にする @Input プロパティ。 デフォルトで true に設定されます。

<igx-chip [id]="'igx-chip-1'" [draggable]="true" [hideBaseOnDrag]="false"></igx-chip>

id

id: string = `igx-chip-${CHIP_ID++}`

id 属性の値を設定する @Input プロパティ。提供されていない場合、自動的に生成されます。

<igx-chip [id]="'igx-chip-1'"></igx-chip>

onClick

onClick: EventEmitter<IChipClickEventArgs> = new EventEmitter<IChipClickEventArgs>()

IgxChipComponent がクリックされたときにイベントを発生します。 クリックした IgxChipComponent およびイベントをキャンセルするかどうかを返します。

chipClick(event: IChipClickEventArgs){
    let clickedChip = event.owner;
}
<igx-chip #myChip [id]="'igx-chip-1'" [draggable]="true" (onClick)="chipClick($event)">

onDensityChanged

onDensityChanged: EventEmitter<IDensityChangedEventArgs> = new EventEmitter<IDensityChangedEventArgs>()

onDragEnter

onDragEnter: EventEmitter<IChipEnterDragAreaEventArgs> = new EventEmitter<IChipEnterDragAreaEventArgs>()

IgxChipComponentIgxChipsAreaComponent に入ったときにイベントを発生します。 ターゲットの IgxChipComponent、ドラッグしている IgxChipComponent、および元のドロップ イベント引数を返します。

chipEnter(event: IChipEnterDragAreaEventArgs){
    let targetChip = event.targetChip;
}
<igx-chip #myChip [id]="'igx-chip-1'" [draggable]="true" (onDragEnter)="chipEnter($event)">

onKeyDown

onKeyDown: EventEmitter<IChipKeyDownEventArgs> = new EventEmitter<IChipKeyDownEventArgs>()

IgxChipComponent のキーボード ナビゲーションが使用されるときにイベントを発生します。 フォーカス/選択した IgxChipComponent、イベントをキャンセルするかどうかを返します。 Alt、shift、controlshiftcontrol キーが押されていてキー名が押されたかどうか。

chipKeyDown(event: IChipKeyDownEventArgs){
    let keyDown = event.key;
}
<igx-chip #myChip [id]="'igx-chip-1'" [draggable]="true" (onKeyDown)="chipKeyDown($event)">

onMoveEnd

onMoveEnd: EventEmitter<IBaseChipEventArgs> = new EventEmitter<IBaseChipEventArgs>()

IgxChipComponent の移動が終了するときにイベントを発生します。 移動した IgxChipComponent を返します。

moveEnded(event: IBaseChipEventArgs){
    let movedChip = event.owner;
}
<igx-chip #myChip [id]="'igx-chip-1'" [draggable]="true" (onMoveEnd)="moveEnded($event)">

onMoveStart

onMoveStart: EventEmitter<IBaseChipEventArgs> = new EventEmitter<IBaseChipEventArgs>()

IgxChipComponent の移動が開始するときにイベントを発生します。 移動している IgxChipComponent を返します。

moveStarted(event: IBaseChipEventArgs){
    let movingChip = event.owner;
}
<igx-chip #myChip [id]="'igx-chip-1'" [draggable]="true" (onMoveStart)="moveStarted($event)">

onRemove

onRemove: EventEmitter<IBaseChipEventArgs> = new EventEmitter<IBaseChipEventArgs>()

IgxChipComponent が削除されたときにイベントを発生します。 Returns the removed IgxChipComponent.

remove(event: IBaseChipEventArgs){
    let removedChip = event.owner;
}
<igx-chip #myChip [id]="'igx-chip-1'" [draggable]="true" (onRemove)="remove($event)">

onSelection

onSelection: EventEmitter<IChipSelectEventArgs> = new EventEmitter<IChipSelectEventArgs>()

IgxChipComponent が選択/選択解除されたときにイベントを発生します。 選択したチップへの参照、イベントをキャンセルするかどうか、次の選択状態を返します。 イベントがインタラクションでトリガーされた場合に originalEvent が提供されます。それ以外の場合、originalEventnull です。

chipSelect(event: IChipSelectEventArgs){
    let selectedChip = event.owner;
}
<igx-chip #myChip [id]="'igx-chip-1'" [selectable]="true" (onSelection)="chipSelect($event)">

onSelectionDone

onSelectionDone: EventEmitter<IBaseChipEventArgs> = new EventEmitter<IBaseChipEventArgs>()

IgxChipComponent が選択/選択解除され、関連するアニメーションとトランジションが終了すると、イベントが発生します。

chipSelectEnd(event: IBaseChipEventArgs){
    let selectedChip = event.owner;
}
<igx-chip #myChip [id]="'igx-chip-1'" [selectable]="true" (onSelectionDone)="chipSelectEnd($event)">

removable

removable: boolean = false

IgxChipComponent が [削除] ボタンを描画し、削除イベントを発生するかどうかを定義する @Input プロパティ。 デフォルトで false に設定されます。

<igx-chip [id]="'igx-chip-1'" [draggable]="true" [removable]="true"></igx-chip>

removeIcon

removeIcon: TemplateRef<any>

チップが削除ボタンに適用するデフォルト アイコンをオーバーライドする @Input プロパティ。

<igx-chip [id]="chip.id" [removable]="true" [removeIcon]="iconTemplate"></igx-chip>
<ng-template #iconTemplate><igx-icon>delete</igx-icon></ng-template>

selectIcon

selectIcon: TemplateRef<any>

選択時にチップが適用するデフォルト アイコンをオーバーライドする @Input プロパティ。

<igx-chip [id]="chip.id" [selectable]="true" [selectIcon]="iconTemplate"></igx-chip>
<ng-template #iconTemplate><igx-icon>done_outline</igx-icon></ng-template>

selectable

selectable: boolean = false

IgxChipComponent がクリックまたはナビゲーションで選択可能かどうかを定義する @Input プロパティ。 デフォルトで false に設定されます。

<igx-chip [id]="chip.id" [draggable]="true" [removable]="true" [selectable]="true"></igx-chip>

アクセサー

chipTabindex

  • get chipTabindex(): 0 | ""

color

  • get color(): any
  • set color(newColor: any): void
  • IgxChipComponent の背景色を返します。

    @ViewChild('myChip')
    public chip: IgxChipComponent;
    ngAfterViewInit(){
        let chipColor = this.chip.color;
    }

    返却 any

  • IgxChipComponent の背景色を設定する @Input プロパティ。 color プロパティは文字列、rgb、および16 進数をサポートします。

    <igx-chip #myChip [id]="'igx-chip-1'" [color]="'#ff0000'"></igx-chip>

    パラメーター

    • newColor: any

    返却 void

displayDensity

selected

  • get selected(): boolean
  • set selected(newValue: boolean): void
  • IgxChipComponent が選択されるかどうかを返します。

    @ViewChild('myChip')
    public chip: IgxChipComponent;
    selectedChip(){
        let selectedChip = this.chip.selected;
    }

    双方向データ バインディング:

    <igx-chip #myChip [id]="'igx-chip-1'" [selectable]="true" [(selected)]="model.isSelected">

    返却 boolean

  • IgxChipComponent の選択状態を設定します。

    <igx-chip #myChip [id]="'igx-chip-1'" [selectable]="true" [selected]="true">

    双方向データ バインディング:

    <igx-chip #myChip [id]="'igx-chip-1'" [selectable]="true" [(selected)]="model.isSelected">

    パラメーター

    • newValue: boolean

    返却 void

メソッド

ngDoCheck

  • ngDoCheck(): void

onRemoveMouseDown

  • onRemoveMouseDown(event: PointerEvent | MouseEvent): void

onSelectTransitionDone

  • onSelectTransitionDone(event: any): void