Демонстрация сортировки мат-таблицы не работает

108

Я пытаюсь заставить mat-tableсортировку работать локально, и хотя я могу заставить данные отображаться должным образом, нажатие на строку заголовка не приводит к сортировке, как в онлайн-примерах (вообще ничего не происходит). Я пытаюсь заставить эту демонстрацию работать локально: https://material.angular.io/components/sort/overview https://plnkr.co/edit/XF5VxOSEBxMTd9Yb3ZLA?p=preview

Я создал новый проект с Angular CLI, а затем выполнил следующие шаги: https://material.angular.io/guide/getting-started

Вот мои локальные файлы:

app.module.ts

import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';
import { MatSort, MatTableModule } from '@angular/material';

import { AppComponent } from './app.component';
import { TableSortingExample } from './table-sorting-example';

@NgModule({
  declarations: [
    AppComponent,
    TableSortingExample,
    MatSort
  ],
  imports: [
    BrowserModule,
    MatTableModule
  ],
  providers: [],
  bootstrap: [AppComponent]
})
export class AppModule { }

app.component.ts

import { Component } from '@angular/core';

@Component({
  selector: 'app-root',
  templateUrl: './app.component.html',
  styleUrls: ['./app.component.css']
})
export class AppComponent {
  title = 'app';
}

app.component.html

<div style="text-align:center">
  <h1>
    Welcome to {{title}}!
  </h1>
  <table-sorting-example></table-sorting-example>
</div>

таблица-сортировка-example.html

<div class="example-container mat-elevation-z8">
  <mat-table #table [dataSource]="dataSource" matSort>

    <!--- Note that these columns can be defined in any order.
          The actual rendered columns are set as a property on the row definition" -->

    <!-- ID Column -->
    <ng-container matColumnDef="userId">
      <mat-header-cell *matHeaderCellDef mat-sort-header> ID </mat-header-cell>
      <mat-cell *matCellDef="let row"> {{row.id}} </mat-cell>
    </ng-container>

    <!-- Progress Column -->
    <ng-container matColumnDef="progress">
      <mat-header-cell *matHeaderCellDef mat-sort-header> Progress </mat-header-cell>
      <mat-cell *matCellDef="let row"> {{row.progress}}% </mat-cell>
    </ng-container>

    <!-- Name Column -->
    <ng-container matColumnDef="userName">
      <mat-header-cell *matHeaderCellDef mat-sort-header> Name </mat-header-cell>
      <mat-cell *matCellDef="let row"> {{row.name}} </mat-cell>
    </ng-container>

    <!-- Color Column -->
    <ng-container matColumnDef="color">
      <mat-header-cell *matHeaderCellDef mat-sort-header> Color </mat-header-cell>
      <mat-cell *matCellDef="let row" [style.color]="row.color"> {{row.color}} </mat-cell>
    </ng-container>

    <mat-header-row *matHeaderRowDef="displayedColumns"></mat-header-row>
    <mat-row *matRowDef="let row; columns: displayedColumns;"></mat-row>
  </mat-table>
</div>


<!-- Copyright 2017 Google Inc. All Rights Reserved.
    Use of this source code is governed by an MIT-style license that
    can be found in the LICENSE file at http://angular.io/license -->

таблица-сортировка-example.ts

import {Component, ViewChild} from '@angular/core';
import {DataSource} from '@angular/cdk/collections';
import {MatSort} from '@angular/material';
import {BehaviorSubject} from 'rxjs/BehaviorSubject';
import {Observable} from 'rxjs/Observable';
import 'rxjs/add/operator/startWith';
import 'rxjs/add/observable/merge';
import 'rxjs/add/operator/map';

/**
 * @title Table with sorting
 */
@Component({
  selector: 'table-sorting-example',
  styleUrls: ['table-sorting-example.css'],
  templateUrl: 'table-sorting-example.html',
})
export class TableSortingExample {
  displayedColumns = ['userId', 'userName', 'progress', 'color'];
  exampleDatabase = new ExampleDatabase();
  dataSource: ExampleDataSource | null;

  @ViewChild(MatSort) sort: MatSort;

  ngOnInit() {
    this.dataSource = new ExampleDataSource(this.exampleDatabase, this.sort);
  }
}

/** Constants used to fill up our data base. */
const COLORS = ['maroon', 'red', 'orange', 'yellow', 'olive', 'green', 'purple',
  'fuchsia', 'lime', 'teal', 'aqua', 'blue', 'navy', 'black', 'gray'];
const NAMES = ['Maia', 'Asher', 'Olivia', 'Atticus', 'Amelia', 'Jack',
  'Charlotte', 'Theodore', 'Isla', 'Oliver', 'Isabella', 'Jasper',
  'Cora', 'Levi', 'Violet', 'Arthur', 'Mia', 'Thomas', 'Elizabeth'];

export interface UserData {
  id: string;
  name: string;
  progress: string;
  color: string;
}

/** An example database that the data source uses to retrieve data for the table. */
export class ExampleDatabase {
  /** Stream that emits whenever the data has been modified. */
  dataChange: BehaviorSubject<UserData[]> = new BehaviorSubject<UserData[]>([]);
  get data(): UserData[] { return this.dataChange.value; }

  constructor() {
    // Fill up the database with 100 users.
    for (let i = 0; i < 100; i++) { this.addUser(); }
  }

  /** Adds a new user to the database. */
  addUser() {
    const copiedData = this.data.slice();
    copiedData.push(this.createNewUser());
    this.dataChange.next(copiedData);
  }

  /** Builds and returns a new User. */
  private createNewUser() {
    const name =
      NAMES[Math.round(Math.random() * (NAMES.length - 1))] + ' ' +
      NAMES[Math.round(Math.random() * (NAMES.length - 1))].charAt(0) + '.';

    return {
      id: (this.data.length + 1).toString(),
      name: name,
      progress: Math.round(Math.random() * 100).toString(),
      color: COLORS[Math.round(Math.random() * (COLORS.length - 1))]
    };
  }
}

/**
 * Data source to provide what data should be rendered in the table. Note that the data source
 * can retrieve its data in any way. In this case, the data source is provided a reference
 * to a common data base, ExampleDatabase. It is not the data source's responsibility to manage
 * the underlying data. Instead, it only needs to take the data and send the table exactly what
 * should be rendered.
 */
export class ExampleDataSource extends DataSource<any> {
  constructor(private _exampleDatabase: ExampleDatabase, private _sort: MatSort) {
    super();
  }

  /** Connect function called by the table to retrieve one stream containing the data to render. */
  connect(): Observable<UserData[]> {
    const displayDataChanges = [
      this._exampleDatabase.dataChange,
      this._sort.sortChange,
    ];

    return Observable.merge(...displayDataChanges).map(() => {
      return this.getSortedData();
    });
  }

  disconnect() {}

  /** Returns a sorted copy of the database data. */
  getSortedData(): UserData[] {
    const data = this._exampleDatabase.data.slice();
    if (!this._sort.active || this._sort.direction == '') { return data; }

    return data.sort((a, b) => {
      let propertyA: number|string = '';
      let propertyB: number|string = '';

      switch (this._sort.active) {
        case 'userId': [propertyA, propertyB] = [a.id, b.id]; break;
        case 'userName': [propertyA, propertyB] = [a.name, b.name]; break;
        case 'progress': [propertyA, propertyB] = [a.progress, b.progress]; break;
        case 'color': [propertyA, propertyB] = [a.color, b.color]; break;
      }

      let valueA = isNaN(+propertyA) ? propertyA : +propertyA;
      let valueB = isNaN(+propertyB) ? propertyB : +propertyB;

      return (valueA < valueB ? -1 : 1) * (this._sort.direction == 'asc' ? 1 : -1);
    });
  }
}


/**  Copyright 2017 Google Inc. All Rights Reserved.
 Use of this source code is governed by an MIT-style license that
 can be found in the LICENSE file at http://angular.io/license */

Кто-нибудь знает, почему он отображается как онлайн-таблица, но не имеет функции сортировки?

Avern
источник
Сначала я бы отладил приложение. Есть ошибки? запустите ng test --sm=falseи посмотрите, что получится.
k.vincent
Он работает для меня без сортировки @ViewChild (MatSort): MatSort; Любая причина ?
user123456

Ответы:

201

Для всех, у кого может быть эта проблема: проблема заключалась в том, что я неправильно прочитал ссылку на API на веб-сайте angular материалов, в той части, в которой говорилось, что мне нужно импортировать MatSortModule. После того, как я изменил свой список импорта в app.module.ts на

imports: [
    BrowserModule,
    MatTableModule,
    MatSortModule
  ],

это сработало нормально

Avern
источник
45
в документации этот модуль не упоминается. material.angular.io/components/table/overview#sorting я тоже потратил на это час.
Sonic Soul,
8
это нормально, в заголовке можно щелкнуть по тексту, и значок тоже есть, но сортировка по-прежнему не работает.
SPnL
3
Проверьте BrowserAnimationsModuleтакже импортируется в app.module.ts
Augustas
2
Могу я сказать, что они ублюдки? Я потратил 1 час, пытаясь понять, почему мой ViewChild не работает. Разве они не могут импортировать / экспортировать этот MatSortModule из MatTableModule ??
Sampgun
7
Я импортировал MatSortModuleи BrowserAnimationsModule, и я убедился, что значение matColumnDef соответствует имени свойства, но я все еще не могу заставить его что-либо делать.
Trevor
136

У меня была проблема, что функция сортировки работала, но сортировка не выполнялась должным образом. Я понял, что matColumnDefу свойства my должно быть то же имя, на class / interfaceкоторое я ссылаюсь matCellDef.

Согласно документации Angular Material :

По умолчанию MatTableDataSource сортирует с предположением, что имя отсортированного столбца совпадает с именем свойства данных, отображаемого в столбце.

Например:

<ng-container matColumnDef="name"> 
    <mat-header-cell *matHeaderCellDef mat-sort-header> NAME </mat-header-cell>
    <mat-cell *matCellDef="let row"> {{row.name}} </mat-cell>
</ng-container>

nameВ matColumnDefдирективе должно быть таким же , как nameиспользуемая в <mat-cell>компоненте.

Андре Евангелиста
источник
1
На что в вашем примере вы ссылаетесь? Было бы полезно увидеть и ваш интерфейс для сравнения.
isherwood 02
1
Я использовал «Id» в качестве имени столбца, тогда как у объекта был «id». Разница в регистре заключалась в том, что он не запускался (из-за промаха рефакторинга). Теперь проблема решена. Спасибо
NitinSingh
2
Спасибо, очень полезно.
Bohao LI
2
@NitinSingh, что, если вам нужно вызвать функцию element, например эту `{{row.getName ()}}`
codentary
2
Я полностью должен вам пиво, потому что я какое-то время застревал на этой проблеме, и этот комментарий устранил мою проблему.
Ноэль
103

Если таблица находится внутри * ngIf, она не будет работать. Он будет работать, если его изменить на [скрытый]

айхтут
источник
34
!!! ВЫ СОХРАНИТЕ МОЙ ДЕНЬ !!! Используйте вместо <div *ngIf="xxx"> от<div [hidden]="!xxx">
Mark
1
Могу подтвердить, у меня это тоже сработало. Спасибо, зерги!
закрытие
1
Большое вам спасибо, это стоило мне столько времени !!
themightylc
1
Или просто установите источник данных в ngAfterViewInit вместо ngOnInit
user3666653
1
Это самая «скрытая» проблема, которая могла произойти, спасибо за решение! документация могла бы предупредить об этом
Raycherr
37

Имя matColumnDef и имя фактического значения * matCellDef должны совпадать

Пример:

<ng-container matColumnDef="oppNo">
    <th mat-header-cell *matHeaderCellDef mat-sort-header>Opportunity Number</th>
    <td mat-cell *matCellDef="let element">{{element.oppNo}}</td>
</ng-container>

В моем случае oppNo совпадает с именем matColumnDef и именем * matCellDef, и сортировка работает нормально.

Сидду
источник
Интересный. Так было и со мной. Но знаете ли вы настоящую причину этого или это на самом деле своего рода «ошибка»?
ReturnTable
22

У меня работает сортировка в блоке тайм-аута,

dataSource = new MatTableDataSource(this.articleService.getAllArticles());
setTimeout(() => {
  this.tableDataSource.sort = this.sort;
  this.tableDataSource.paginator = this.paginator;
});

Если вы не хотите использовать крючки lifecykle.

Чандрахасан
источник
1
глупый взлом, но он работает, есть идеи, почему он не работает без тайм-аута?
Рубен
Я слишком долго пробовал все остальное, думая, что схожу с ума. Работал как шарм!
willpnw
4
Действительно плохой способ сделать это. Это работает, потому что вы даете некоторое время пройти после инициализации компонента, чтобы был создан источник данных, а затем вы добавляете сортировку и пагинатор. Лучше всего переместить построение источника данных в ngOnInit, а затем переместить назначения сортировки и пагинатора в AfterViewInit. Вот для чего существуют хуки жизненного цикла.
Селам
21

Я тоже столкнулся с этой проблемой. Поскольку вам нужно дождаться определения дочернего AfterViewInitэлемента , вы должны реализовать и использовать , а не onInit.

  ngAfterViewInit (){
    this.dataSource.sort = this.sort;
  }
flashape
источник
Потрясающие ! Спасибо
Шашанк Вивек
Я использую таблицу с сортировкой, фильтрацией и разбивкой на страницы. Вы хоть понимаете, почему должна быть определена только сортировка ngAfterViewInit? Остальное работало от ngOnInit. Просто чтобы попытаться понять, это исправлено благодаря вам
Николас М.
14

Я потратил часы на эту проблему. Прочитав несколько потоков, вот шаги, которые я сделал.

  1. Как упоминалось в @avern , вам необходимо импортироватьMatSortModule .
  2. Убедитесь, что вы НЕ заключаете таблицу в *ngIf. Измените его , [hidden]как @zerg рекомендуется . (Я не понимаю почему)

Надеюсь это поможет.

ягодные чаки
источник
Он потратил мой день, чтобы выяснить проблему, и глупо не показывает никаких ошибок.
суреха шелаке,
11

Мое решение состояло в том, чтобы исправить несколько вещей (в основном объединить большинство решений на этой странице).

Что нужно проверить:

  1. BrowserModule, MatTableModule, MatSortModule Модули следует импортировать в файл корневых модулей.
  2. Убедитесь, что вы использовали MatTableDatasource класс и передайте в него массив данных в качестве параметра.
  3. Убедитесь, что ваша таблица не вложена в *ngIf=....директиву. Вместо этого используйте другие условные операции (все еще не понимаю, почему).
Самуэль Мутеми
источник
3

Для меня сработала замена * ngIf атрибутом [hidden] для тега mat-table. Как опубликовать это как ошибку в сообществе Angular Material?

Гаурав Кохиркар
источник
3

Я исправил это в своем сценарии, назвав данные таблицы с тем же именем, что и * matColumnDef. Например:

<!-- Name Column -->
<ng-container matColumnDef="name">
  <mat-header-cell *matHeaderCellDef mat-sort-header> Name </mat-header-cell>
  <mat-cell *matCellDef="let row"> {{row.name}} </mat-cell>
</ng-container>

Вместо

<!-- Name Column -->
    <ng-container matColumnDef="userName">
      <mat-header-cell *matHeaderCellDef mat-sort-header> Name </mat-header-cell>
      <mat-cell *matCellDef="let row"> {{row.name}} </mat-cell>
    </ng-container>
Спексы
источник
3

У меня было 2 проблемы.

  1. Имена matColumnDef и matCellDef -> разные
  2. Я получал данные из службы. Сортировка ngOnInit не работала. Заменено на

    ngAfterViewInit () {this.dataSource.sort = this.sort; }

Радж Каннан Ийяппан
источник
2

Я нашел этот старый блог, который помог мне заставить его работать: https://www.jeffryhouser.com/index.cfm/2018/10/23/Five-Reasons-My-ngMaterial-Table-wont-sort

  1. Обязательно импортируйте MatSortModule
  2. Укажите matSortзаголовок
  3. Убедитесь, что ваш источник данных заключен в MatTableDataSource
    • Это тот, который помог мне разобраться (понять? Разобраться ). В шаблоне я имел в виду массив напрямую ( <table mat-table [dataSource]="this.products" matSort>), но мне следовало использовать объект источника данных, который я инициализировал в коде ( <table mat-table [dataSource]="this.dataSource" matSort>). Источник данных инициализируется какdataSource = new MatTableDataSource(this.products)
  4. Сообщите источнику данных о вашей сортировке в ngOnInit/ngAfterViewInit
  5. Напишите свой собственный сорт, если не хотите использовать MatTableDataSource
Кумахейяма
источник
1

Если ваша таблица находится внутри * ngIf и вы думаете, что это имеет какое-то отношение к тому, что она не сортирует вашу таблицу, то указание вашей собственной sortingDataAccessorфункции может решить проблему, как это было со мной. У меня есть таблица внутри нескольких * ngIfs, и вынимать ее из этих * ngIfs не имело смысла:

`ngAfterViewInit(): void {
        this.matchesDataSource.sort = this.sort;
        this.matchesDataSource.sortingDataAccessor = previewMatchSortingFn;
    }`

`export function previewMatchSortingFn(item: Match, header: string): string | number {
    switch (header) {
        case 'home':
            return item.homeTeam.name;
        case 'away':
            return item.awayTeam.name;
        case 'date':
            if (item.dateTime) {
                // this will return the number representation of the date
                return item.dateTime.valueOf();
            }
            return;
        default:
            break;
    }
}`
О.МиКох
источник
1

Одна из причин, по которой MatSort может не работать, - это когда он добавляется в источник данных (т.е. this.dataSource.sort = this.sort) до того, как он определен. Для этого может быть несколько причин:

  1. если вы добавите сортировку в ngOnInit. На этом этапе шаблон еще не отрисован, поэтому MatSort, который вы получаете, @ViewChild(MatSort, { static: true }) sort: MatSort;не определен и, по понятным причинам, ничего не сделает. Решение этой проблемы - перейти this.dataSource.sort = sortк ngAfterViewInit. Когда вызывается ngAfterViewInit, ваш компонент отображается, и должен быть определен MatSort.

  2. когда вы используете * ngIf, это ваш шаблон в элементе таблицы или один, если это родительские элементы, и этот * ngIf приводит к тому, что ваша таблица не отображается в момент, когда вы пытаетесь установить MatSort. Например, если у вас есть *ngIf="dataSource.data.length > 0"элемент таблицы (чтобы отображать его только при наличии данных), и вы устанавливаете this.dataSource.sort = this.sortсразу после того, как вы установили this.dataSource.dataсвои данные. Вид компонента еще не будет повторно отрисован, поэтому MatSort все равно будет неопределенным.

Для того , чтобы получить MatSort на работу и по- прежнему условно показать таблицу вы можете решить , чтобы заменить *ngIfс , [hidden]как указано в нескольких других ответах. Однако, если вы хотите сохранить оператор * ngIf, вы можете использовать следующее решение. Это решение работает для Angular 9, я не тестировал его в предыдущих версиях, поэтому не уверен, работает ли оно там.

Я нашел это решение здесь: https://github.com/angular/components/issues/10205

Вместо того, чтобы поставить:

@ViewChild(MatSort) sort: MatSort;

используйте сеттер для matSort. Этот установщик сработает, как только matSort изменится в вашем представлении (т.е. определен в первый раз), он не сработает, когда вы измените свою сортировку, щелкнув стрелки. Это будет выглядеть так:

@ViewChild(MatSort) set matSort(sort: MatSort) {
    this.dataSource.sort = sort;
}

Если у вас есть другие функции, которые (программно) изменяют сортировку, я не уверен, сработает ли она снова, я не тестировал это. Если вы не хотите, чтобы сортировка устанавливалась только в том случае, если сортировка не определена, вы можете сделать что-то вроде этого:

@ViewChild(MatSort) set matSort(sort: MatSort) {
    if (!this.dataSource.sort) {
        this.dataSource.sort = sort;
    }
}
Эмми
источник
0

На самом деле имя matColumnDef (т.е. имя столбца) и имя вашего свойства класса / интерфейса должны быть одинаковыми, чтобы он работал.

Иногда мы не можем изменить имя нашего свойства класса / интерфейса, в этом случае мы можем реализовать настраиваемую сортировку, как показано ниже.

let say your columns  as  ['id', 'name'] and 
your class/interface  as  ['userId', 'name']

если мы выполним сортировку по столбцу id, это не сработает. Попробуйте использовать настраиваемую сортировку

this.dataSource.sortingDataAccessor = (item,property)=>{

 // where item is your class/interface data
 // where property is your column name

       switch(property){
           case 'id' : return item.userId
           default: return item[property];
        }
}
Kasee ​​Nadh Reddy Bojja
источник
0

Для всех, кто не понимает, что эти наименования должны быть одинаковыми, я провел небольшое тестирование:

Это будет работать (имя свойства такое же, как у столбца def):

<ng-container matColumnDef="version">
    <th mat-header-cell *matHeaderCellDef mat-sort-header> Version </th>
    <td mat-cell *matCellDef="let element"> {{element.version}} </td>
</ng-container>

displayedColumns: string[] = ['version']

Это НЕ будет работать (имя свойства не совпадает с именем столбца def):

<ng-container matColumnDef="version2">
    <th mat-header-cell *matHeaderCellDef mat-sort-header> Version </th>
    <td mat-cell *matCellDef="let element"> {{element.version}} </td>
</ng-container>

displayedColumns: string[] = ['version2']

Fyi, это тоже НЕ работает (длина свойства):

<ng-container matColumnDef="length">
    <th mat-header-cell *matHeaderCellDef mat-sort-header> Version </th>
    <td mat-cell *matCellDef="let element"> {{element.ids.length}} </td>
</ng-container>

displayedColumns: string[] = ['length']

И это тоже не так:

<ng-container matColumnDef="ids.length">
    <th mat-header-cell *matHeaderCellDef mat-sort-header> Version </th>
    <td mat-cell *matCellDef="let element"> {{element.ids.length}} </td>
</ng-container>

displayedColumns: string[] = ['ids.length']
WtFudgE
источник
-1

Посмотрите, есть ли у вас ошибки javascript в консоли. Возможно, что-то еще не удалось выполнить до инициализации сортировки.

Ε Г И І И О
источник