Angular Tree Grid Toolbar
Ignite UI for Angular의 트리 그리드는 다음을 제공합니다. IgxGridToolbarComponent
이는 본질적으로 다음을 위한 컨테이너입니다. UI 운영. Angular 도구 모음은 Angular 구성 요소, 즉 트리 그리드의 상단에 있으며 수평 크기와 일치합니다. 도구 모음 컨테이너는 다음 트리 그리드 기능에 대해 사전 정의된 UI 컨트롤을 호스팅할 수 있습니다.
- 열 숨기기
- 열 고정
- 엑셀 내보내기
- 고급 필터링
또는 다른 사용자 정의 콘텐츠. 도구 모음과 사전 정의된 UI 구성 요소는 Angular 이벤트를 지원하고 개발자를 위한 API를 노출합니다.
Angular Toolbar Grid Example
사전 정의된 actions
및 title
UI 구성 요소는 <igx-grid-toolbar>
내부에 추가되며 해당 그리드 기능과의 기본 상호 작용을 제공하는 도구 모음을 갖는 데 모두 필요합니다.
<igx-tree-grid [data]="data" primaryKey="ID" foreignKey="ParentID" [autoGenerate]="true">
<igx-grid-toolbar>
<igx-grid-toolbar-title>Tree Grid Toolbar</igx-grid-toolbar-title>
<igx-grid-toolbar-actions>
<igx-grid-toolbar-advanced-filtering><igx-grid-toolbar-advanced-filtering>
<igx-grid-toolbar-hiding></igx-grid-toolbar-hiding>
<igx-grid-toolbar-pinning></igx-grid-toolbar-pinning>
<igx-grid-toolbar-exporter></igx-grid-toolbar-exporter>
</igx-grid-toolbar-actions>
</igx-grid-toolbar>
</igx-tree-grid>
참고: 위의 코드 조각에서 볼 수 있듯이 사전 정의된
actions
UI 구성 요소는<igx-grid-toolbar-actions>
컨테이너에 래핑되어 있습니다. 이렇게 하면 도구 모음 제목이 도구 모음 왼쪽에 정렬되고 작업이 도구 모음 오른쪽에 정렬됩니다.
물론, 각 UI는 서로 독립적으로 추가될 수도 있고 전혀 추가되지 않을 수도 있습니다. 이렇게 하면 도구 모음 컨테이너가 비어 있게 렌더링됩니다.
<igx-tree-grid [data]="data" primaryKey="ID" foreignKey="ParentID" [autoGenerate]="true">
<igx-grid-toolbar>
</igx-grid-toolbar>
</igx-tree-grid>
각 기본 UI 구성 요소를 포괄적으로 살펴보려면 아래 기능 섹션을 계속 읽어보세요.
특징
도구 모음은 그리드 전체에 영향을 미치는 논리/상호 작용을 분리하는 데 유용합니다. 위에 표시된 대로 그리드에서 데이터 제어, 열 숨기기, 열 고정, 고급 필터링 및 내보내기를 위한 기본 구성 요소를 제공하도록 구성할 수 있습니다. 이러한 기능은 Ignite UI for Angular의 카드 구성 요소와 유사한 패턴을 따르면 서로 독립적으로 활성화할 수 있습니다. 아래에는 도구 모음의 주요 기능과 각 기능에 대한 예제 코드가 나열되어 있습니다.
Title
그리드의 도구 모음 제목 설정은 IgxGridToolbarTitleComponent 를 사용하여 수행됩니다. 사용자는 간단한 텍스트부터 보다 복잡한 템플릿까지 무엇이든 제공할 수 있습니다.
<igx-grid-toolbar>
<igx-grid-toolbar-title>Grid toolbar title</igx-grid-toolbar-title>
</igx-grid-toolbar>
Actions
도구 모음은 사용자가 상위 그리드와 관련하여 작업/상호 작용을 배치할 수 있는 특정 컨테이너를 노출합니다. 도구 모음의 제목 부분과 마찬가지로 사용자는 기본 도구 모음 상호 작용 구성 요소를 포함하여 해당 템플릿 부분 내에 무엇이든 제공할 수 있습니다.
<igx-grid-toolbar>
<igx-grid-toolbar-actions>
<button igxButton>Action</button>
<igx-select></igx-select>
...
</igx-grid-toolbar-actions>
</igx-grid-toolbar>
이제 각 작업은 overlaySettings
입력을 사용하여 작업 대화 상자의 오버레이 설정을 변경하는 방법을 노출합니다. 예:
<igx-grid-toolbar-actions>
<igx-grid-toolbar-pinning [overlaySettings]="overlaySettingsScaleCenter"></igx-grid-toolbar-pinning>
<igx-grid-toolbar-hiding [overlaySettings]="overlaySettingsAuto"></igx-grid-toolbar-hiding>
</igx-grid-toolbar-actions>
public data: any[];
public positionStrategyScaleCenter = new GlobalPositionStrategy({
openAnimation: scaleInCenter,
closeAnimation: scaleOutCenter
});
public overlaySettingsScaleCenter = {
positionStrategy: this.positionStrategyScaleCenter,
scrollStrategy: new AbsoluteScrollStrategy(),
modal: true,
closeOnEscape: true
};
public positionStrategyAuto = new AutoPositionStrategy();
public overlaySettingsAuto = {
positionStrategy: this.positionStrategyAuto,
scrollStrategy: new AbsoluteScrollStrategy(),
modal: false,
closeOnEscape: false
};
constructor() {
this.data = athletesData;
}
기본 overlaySettings는 Absolute 스크롤 전략과 함께 ConnectedPositionStrategy를 사용하고, 모달은 false로 설정되며, 이스케이프 시 닫기 및 외부 클릭 상호 작용 시 닫기가 활성화됩니다.
Column pinning
도구 모음 고정 구성 요소는 그리드의 열 고정과 상호 작용하기 위한 기본 UI를 제공합니다. 구성 요소는 구성 요소 제목, 구성 요소 입력을 위한 자리 표시자 및 드롭다운 자체의 높이와 같은 UI 사용자 정의를 위한 여러 입력 속성뿐만 아니라 도구 모음이 포함된 상위 그리드를 사용하여 즉시 작동하도록 설정됩니다.
<igx-grid-toolbar>
<igx-grid-toolbar-actions>
<igx-grid-toolbar-pinning
title="Grid pinned columns"
prompt="Filter column collection"
columnListHeight="400px"
>
</igx-grid-toolbar-pinning>
</igx-grid-toolbar-actions>
</igx-grid-toolbar>
Column hiding
도구 모음 숨기기 구성요소는 열 숨기기와 상호작용하기 위한 기본 UI를 제공합니다. 구성 요소 제목, 구성 요소 입력을 위한 자리 표시자, 드롭다운 자체의 높이 등 UI 사용자 지정을 위한 동일한 입력 속성을 노출합니다.
<igx-grid-toolbar>
<igx-grid-toolbar-actions>
<igx-grid-toolbar-hiding
title="Grid column hiding"
prompt="Filter column collection"
columnListHeight="400px"
>
</igx-grid-toolbar-hiding>
</igx-grid-toolbar-actions>
</igx-grid-toolbar>
Advanced filtering
도구 모음 고급 필터링 구성 요소는 고급 필터링 기능을 위한 기본 UI를 제공합니다. 구성 요소는 버튼의 기본 텍스트를 변경하는 방법을 노출합니다.
<igx-grid-toolbar>
<igx-grid-toolbar-actions>
<igx-grid-toolbar-advanced-filtering>Custom text for the toggle button</igx-grid-toolbar-advanced-filtering>
</igx-grid-toolbar-actions>
</igx-grid-toolbar>
Data exporting
나머지 도구 모음 작업과 마찬가지로 내보내기는 즉시 사용 가능한 도구 모음 내보내기 구성 요소를 통해 제공됩니다. 내보내기 구성요소는 대상 데이터 형식(Excel CSV)에 대한 해당 서비스를 사용하고 있습니다. 즉, 종속성 주입 체인을 통해 해당 서비스가 제공되지 않으면 구성 요소는 아무것도 내보낼 수 없습니다. Angular의 DI에 대해 복습이 필요한 경우 공식 가이드를 확인하세요. 다음은 애플리케이션에 대한 모든 내보내기 서비스를 활성화하는 방법을 보여주는 샘플 조각입니다.
// app.module.ts
import { IgxExcelExporterService, IgxCsvExporterService } from 'igniteui-angular';
// import { IgxExcelExporterService, IgxCsvExporterService } from '@infragistics/igniteui-angular'; for licensed package
@NgModule({
...
providers: [IgxExcelExporterService, IgxCsvExporterService ]
})
export class AppModule { ... }
Note
v12.2.1 이상에서는 내보내기 서비스가 루트에서 제공됩니다. 즉, 더 이상 AppModule 공급자에서 이를 선언할 필요가 없습니다.
도구 모음 내보내기 구성 요소는 UI와 내보내기 환경을 모두 사용자 지정하기 위한 여러 입력 속성을 노출합니다. 표시 텍스트 변경부터 드롭다운 옵션 활성화/비활성화, 생성된 파일 이름 사용자 정의까지 다양합니다. 자세한 내용은 도구 모음 내보내기 구성요소에 대한 API 문서를 참조하세요.
다음은 Angular 템플릿을 통해 사용자 정의할 수 있는 일부 옵션을 보여주는 스니펫입니다.
<igx-grid-toolbar>
<igx-grid-toolbar-actions>
<igx-grid-toolbar-exporter
<!-- If active, enables the csv export entry in the dropdown UI -->
[exportCSV]="csvExportEnabled"
<!-- If active, enables the excel export entry in the dropdown UI -->
[exportExcel]="excelExportEnabled"
<!-- The name of the generated export file without the file extension -->
filename="exported_data"
>
Custom text for the exporter button
<span excelText>Custom text for the excel export entry</span>
<span csvText>Custom text for the CSV export entry</span>
</igx-grid-toolbar-exporter>
</igx-grid-toolbar-actions>
</igx-grid-toolbar>
내보낸 파일 이름을 변경하는 것 외에도 사용자는 도구 모음Exporting 이벤트를 기다리고 이벤트 속성에서 옵션 항목을 사용자 정의하여 내보내기 옵션을 추가로 구성할 수 있습니다.
Note
기본적으로 CSV로 내보낼 때 내보내기는 쉼표 구분 기호를 사용하여 내보내고 출력 파일에 '.csv' 확장자를 사용합니다. 내보내기 이벤트를 구독하거나 내보내기 옵션 필드의 값을 변경하여 이러한 내보내기 매개변수를 사용자 정의할 수 있습니다. 이벤트 인수의 취소 필드를 true로 설정하여 내보내기 프로세스를 취소할 수도 있습니다.
다음 코드 조각은 도구 모음 내보내기 이벤트를 구독하고 내보내기 옵션을 구성하는 방법을 보여줍니다.
<igx-tree-grid (toolbarExporting)="configureExport($event)" ></igx-tree-grid>
configureExport(args: IGridToolbarExportEventArgs) {
const options: IgxExporterOptionsBase = args.options;
options.fileName = `Report_${new Date().toDateString()}`;
if (options instanceof IgxExcelExporterOptions) {
options.columnWidth = 10;
} else {
options.fileType = CsvFileTypes.TSV;
options.valueDelimiter = '\t';
}
args.exporter.columnExporting.subscribe((columnArgs: IColumnExportingEventArgs) => {
// Don't export image field
columnArgs.cancel = columnArgs.header === 'Name';
});
}
다음 샘플은 내보낸 파일을 사용자 정의하는 방법을 보여줍니다.
Exporting Indicator
기본 도구 모음 내보내기 구성 요소를 사용하는 경우 내보내기 작업이 발생할 때마다 작업이 진행되는 동안 도구 모음에 진행률 표시기가 표시됩니다. 또한 사용자는 도구 모음 showProgress 속성을 설정하고 장기 실행 작업에 사용하거나 그리드에서 발생하는 작업을 나타내는 또 다른 방법으로 사용할 수 있습니다. 아래 샘플에는 진행률 표시줄을 볼 수 있도록 데이터 내보내기에 필요한 시간을 늘리기 위해 상당한 양의 데이터가 사용됩니다. 또한 그리드에서 장기 실행 작업을 시뮬레이션하는 또 다른 버튼이 있습니다.
Custom Content
Note
이는 이전 도구 모음 템플릿 지시문을 대체합니다. v11 이전 버전에서 마이그레이션하는 경우 마이그레이션에서 템플릿 콘텐츠 이동이 처리됩니다. 단, 템플릿 내 바인딩은 당사에서 처리하지 않으므로 마이그레이션 완료 후 수정된 템플릿 파일을 반드시 다시 확인하시기 바랍니다.
도구 모음 구성 요소의 작업 부분이 특정 사용 사례에 충분하지 않은 경우 도구 모음 자체에는 사용자가 추가 UI를 제공할 수 있는 일반 콘텐츠 프로젝션이 있습니다. 사용자가 API 호출 또는 바인딩을 위해 해당 그리드 인스턴스가 필요한 경우 템플릿 참조 변수를 만들 수 있습니다.
다음은 샘플 스니펫입니다.
<igx-tree-grid #gridRef ...>
...
<igx-grid-toolbar>
<igx-grid-toolbar-title>{{ titleBinding }}</igx-grid-toolbar-title>
<!--
Everything between the toolbar tags except the default toolbar components/directives
will be projected as custom content.
-->
<button igxButton="flat" igxRipple (click)="#gridRef.clearSort()">
<igx-icon fontSet="material">clear</igx-icon>
Clear Sort
</button>
<igx-grid-toolbar-actions>
...
</igx-grid-toolbar-actions>
</igx-grid-toolbar>
</igx-tree-grid>
다음 샘플은 열 헤더를 클릭하여 정렬 설정을 지우기 위해 도구 모음에 추가 버튼을 추가하는 방법을 보여줍니다.
스타일링
툴바 스타일링을 시작하려면 모든 테마 기능과 구성 요소 믹스인이 있는 인덱스 파일을 가져와야 합니다.
@use "igniteui-angular/theming" as *;
// IMPORTANT: Prior to Ignite UI for Angular version 13 use:
// @import '~igniteui-angular/lib/core/styles/themes/index';
먼저 새로운 팔레트를 만들어 보겠습니다.
$my-dark-palette: palette(
$primary: #2466ff,
$secondary: #FFCD0F,
$surface: #2a2b2f,
$grays: #fff,
);
$my-dark-color: color($my-dark-palette, 'surface');
이제 grid-toolbar-theme
확장하는 새 테마를 생성하고 $background-color
및 $title-text-color
매개변수를 수정합니다.
$dark-grid-toolbar-theme: grid-toolbar-theme(
$palette: $my-dark-palette,
$background-color: $my-dark-color,
$title-text-color: color($my-dark-palette, 'secondary'),
$dropdown-background: $my-dark-color,
);
도구 모음의 열 작업 메뉴에 테마를 지정하려면 column-actions-theme
구성 요소의 테마를 변경해야 합니다.
$dark-column-actions-theme: column-actions-theme(
$palette: $my-dark-palette,
$title-color: color($my-dark-palette, 'secondary'),
$background-color: color($my-dark-palette, 'surface')
);
열 작업은 igx-button, igx-checkbox 및 igx-input-group과 같은 다른 구성 요소를 사용하므로 새 도구 모음 테마와 일치하도록 해당 테마를 변경해야 합니다.
$dark-button-theme: button-theme(
$palette: $my-dark-palette,
$outlined-background: color($my-dark-palette, 'secondary'),
$outlined-hover-background: color($my-dark-palette, 'grays', 100),
$outlined-hover-text-color: color($my-dark-palette, 'secondary')
);
$dark-checkbox-theme: checkbox-theme(
$palette: $my-dark-palette,
$tick-color: $my-dark-color,
);
$dark-input-group-theme: input-group-theme(
$palette: $my-dark-palette
);
마지막 단계는 새로 생성된 테마를 포함하는 것입니다.
:host {
@include grid-toolbar($dark-grid-toolbar-theme);
@include column-actions($dark-column-actions-theme);
@include checkbox($dark-checkbox-theme);
@include input-group($dark-input-group-theme);
@include button($dark-button-theme);
}
Note
$legacy-support
false(default)
로 설정된 경우 다음과 같은 구성 요소 CSS 변수를 포함합니다.
:host {
@include css-vars($dark-grid-toolbar-theme);
@include css-vars($dark-column-actions-theme);
@include css-vars($dark-checkbox-theme);
@include css-vars($dark-input-group-theme);
@include css-vars($dark-button-theme);
}
Note
구성 요소가 Emulated
ViewEncapsulation을 사용하는 경우::ng-deep
사용하여 이 캡슐화를 penetrate
해야 합니다.
:host {
::ng-deep {
@include grid-toolbar($dark-grid-toolbar-theme);
@include column-actions($dark-column-actions-theme);
@include checkbox($dark-checkbox-theme);
@include input-group($dark-input-group-theme);
@include button($dark-button-theme);
}
}
Demo
API References
Grid Toolbar 서비스에는 아래에 나열된 몇 가지 API가 더 있습니다.
IgxGridToolbarActionsComponent
IgxGridToolbarAdvancedFilteringComponent
IgxGridToolbarComponent
IgxGridToolbarExporterComponent
IgxGridToolbarHidingComponent
IgxGridToolbarPinningComponent
IgxGridToolbarTitleComponent
IgxTreeGridComponent
events:
Styles: