component.d.ts 3.0 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980
  1. /**
  2. * @license
  3. * Copyright 2019 Google Inc.
  4. *
  5. * Permission is hereby granted, free of charge, to any person obtaining a copy
  6. * of this software and associated documentation files (the "Software"), to deal
  7. * in the Software without restriction, including without limitation the rights
  8. * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  9. * copies of the Software, and to permit persons to whom the Software is
  10. * furnished to do so, subject to the following conditions:
  11. *
  12. * The above copyright notice and this permission notice shall be included in
  13. * all copies or substantial portions of the Software.
  14. *
  15. * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16. * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17. * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  18. * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19. * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  20. * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  21. * THE SOFTWARE.
  22. */
  23. import { MDCComponent } from '@material/base/component';
  24. import { MDCCheckboxFactory } from '@material/checkbox/component';
  25. import { MDCDataTableFoundation } from './foundation';
  26. /** MDC Data Table */
  27. export declare class MDCDataTable extends MDCComponent<MDCDataTableFoundation> {
  28. static attachTo(root: HTMLElement): MDCDataTable;
  29. private headerRowCheckbox;
  30. private rowCheckboxList;
  31. private checkboxFactory;
  32. private linearProgress;
  33. private headerRow;
  34. private content;
  35. private handleHeaderRowCheckboxChange;
  36. private handleRowCheckboxChange;
  37. private headerRowClickListener;
  38. private handleContentClick;
  39. initialize(checkboxFactory?: MDCCheckboxFactory): void;
  40. initialSyncWithDOM(): void;
  41. /**
  42. * Re-initializes header row checkbox and row checkboxes when selectable rows
  43. * are added or removed from table.
  44. */
  45. layout(): void;
  46. /**
  47. * @return Returns array of header row cell elements.
  48. */
  49. getHeaderCells(): HTMLElement[];
  50. /**
  51. * @return Returns array of row elements.
  52. */
  53. getRows(): HTMLElement[];
  54. /**
  55. * @return Returns array of selected row ids.
  56. */
  57. getSelectedRowIds(): Array<string | null>;
  58. /**
  59. * Sets selected row ids. Overwrites previously selected rows.
  60. * @param rowIds Array of row ids that needs to be selected.
  61. */
  62. setSelectedRowIds(rowIds: string[]): void;
  63. /**
  64. * Shows progress indicator when data table is in loading state.
  65. */
  66. showProgress(): void;
  67. /**
  68. * Hides progress indicator after data table is finished loading.
  69. */
  70. hideProgress(): void;
  71. destroy(): void;
  72. getDefaultFoundation(): MDCDataTableFoundation;
  73. private getRowByIndex;
  74. private getRowIdByIndex;
  75. private handleHeaderRowClick;
  76. private getSortStatusMessageBySortValue;
  77. private getLinearProgressElement;
  78. private getLinearProgress;
  79. private getRowIdByRowElement;
  80. }