Options
All
  • Public
  • Public/Protected
  • All
Menu

ngTable API Reference

Index

Modules

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

ColumnFieldContext

ColumnFieldContext: ColumnFieldContext

The scope available to a table column getter

DataResult

DataResult: T | IDataRowGroup<T>

DataResults

DataResults: T[] & { visibleColumnCount: number; }

The augmented data row array displayed by the table. Note: this array is made available to the table templete as the $data field

DynamicTableColField

DynamicTableColField: IDynamicTableColFieldFunc<T> | T

EventSelector

EventSelector: NgTableParams<T> | IEventSelectorFunc

Alias for the types that can be used to filter events

FilterComparator

FilterComparator: boolean | IFilterComparatorFunc<T>

FilterLayout

FilterLayout: "stack" | "horizontal"

GroupSort

GroupSort: SortDirection | ""

GroupedDataResults

GroupedDataResults: IDataRowGroup<T>[] & { visibleColumnCount: number; }

The augmented grouped data row array displayed by the table Note: this array is made available to the table templete as the $groups field

Grouping

Grouping: IGroupValues | IGroupingFunc<T>

Private Memento

Memento: object

Type declaration

  • Optional groupSortDirection?: string
  • params: IParamValues<T>

SelectData

SelectData: ISelectOption[] | ISelectDataFunc

SortDirection

SortDirection: "asc" | "desc"

Variables

$

$: JQueryStatic

jQuery

jQuery: JQueryStatic

ngTableBrowserModule

ngTableBrowserModule: IModule = angular.module('ngTable-browser', []).directive('ngTable', ngTable).service('ngTableColumn', NgTableColumn).directive('ngTableColumnsBinding', ngTableColumnsBinding).controller('ngTableController', NgTableController).directive('ngTableDynamic', ngTableDynamic).provider('ngTableFilterConfig', NgTableFilterConfigProvider).directive('ngTableFilterRow', ngTableFilterRow).controller('ngTableFilterRowController', NgTableFilterRowController).directive('ngTableGroupRow', ngTableGroupRow).controller('ngTableGroupRowController', NgTableGroupRowController).directive('ngTablePagination', ngTablePagination).directive('ngTableSelectFilterDs', ngTableSelectFilterDs).directive('ngTableSorterRow', ngTableSorterRow).controller('ngTableSorterRowController', NgTableSorterRowController)

ngTableCoreModule

ngTableCoreModule: IModule = angular.module('ngTable-core', []).provider('ngTableDefaultGetData', NgTableDefaultGetDataProvider).factory('ngTableDefaultGetGroups', ngTableDefaultGetGroups).value('ngTableDefaults',ngTableDefaults).service('ngTableEventsChannel', NgTableEventsChannel).service('ngTableSettings', NgTableSettings).run(NgTableParams.init)

ngTableModule

ngTableModule: IModule = ng1.module('ngTable', [ngTableCoreModule.name, ngTableBrowserModule.name])

templateUrl

templateUrl: unknown = require('./sorterRow.html')

ngTable: Table + Angular JS ngTable: Table + Angular JS ngTable: Table + Angular JS

author

Vitalii Savchuk esvit666@gmail.com

url

https://github.com/esvit/ng-table/

license

New BSD License http://creativecommons.org/licenses/BSD/

author

Vitalii Savchuk esvit666@gmail.com

url

https://github.com/esvit/ng-table/

license

New BSD License http://creativecommons.org/licenses/BSD/

author

Vitalii Savchuk esvit666@gmail.com

url

https://github.com/esvit/ng-table/

license

New BSD License http://creativecommons.org/licenses/BSD/

Functions

Private convertSortToOrderBy

Private getPath

  • getPath(obj: object, ks: string | string[]): any

Private isGroupingFun

  • isGroupingFun(val: string | Grouping): boolean

Private isNumber

  • isNumber(n: any): boolean

Private isScopeLike

  • isScopeLike(object: any): boolean

ngTable

  • Directive that instantiates NgTableController.

    ngdoc

    directive

    name

    ngTable

    example
    <table ng-table="$ctrl.tableParams" show-filter="true" class="table table-bordered">
 <tr ng-repeat="user in $data">
     <td data-title="'Name'" sortable="'name'" filter="{ 'name': 'text' }">
         {{user.name}}
     </td>
     <td data-title="'Age'" sortable="'age'" filter="{ 'age': 'text' }">
         {{user.age}}
     </td>
 </tr>
</table>

    Parameters

    Returns IDirective

ngTableColumnsBinding

  • One-way data binds the $columns array generated by ngTable/ngTableDynamic to the specified expression. This allows the $columns array created for the table to be accessed outside of the html table markup.

    ngdoc

    directive

    example
    <table ng-table="$ctrl.tableParams" class="table" ng-table-columns-binding="$ctlr.tableColumns">

    Type parameters

    • T

    Parameters

    Returns IDirective

ngTableDefaultGetGroups

ngTableDynamic

  • A dynamic version of the ngTable directive that accepts a dynamic list of columns definitions to render

    ngdoc

    directive

    example
    <table ng-table-dynamic="$ctrl.tableParams with $ctrl.cols" class="table">
 <tr ng-repeat="row in $data">
   <td ng-repeat="col in $columns">{{row[col.field]}}</td>
 </tr>
</table>

    Returns IDirective

ngTableFilterRow

  • ngTableFilterRow(): object

  • directive that renders the filter header row for a table

    ngdoc

    directive

    example
    <ng-table-filter-row></ng-table-filter-row>

    Returns object

    • controller: string
    • controllerAs: string
    • replace: boolean
    • restrict: string
    • scope: boolean
    • templateUrl: unknown

ngTableGroupRow

  • ngTableGroupRow(): object

  • directive that renders the group header row for a table

    ngdoc

    directive

    example
    <ng-table-group-row></ng-table-group-row>

    Returns object

    • controller: string
    • controllerAs: string
    • replace: boolean
    • restrict: string
    • scope: boolean
    • templateUrl: unknown

ngTablePagination

  • ngTablePagination<T>($compile: ng1.ICompileService, $document: ng1.IDocumentService, ngTableEventsChannel: NgTableEventsChannel): ng1.IDirective

ngTableSelectFilterDs

  • ngTableSelectFilterDs(): ng1.IDirective

  • Takes the array returned by $column.filterData and makes it available as $selectData on the $scope.

    The resulting $selectData array will contain an extra item that is suitable to represent the user "deselecting" an item from a <select> tag

    This directive is is focused on providing a datasource to an ngOptions directive

    Returns ng1.IDirective

ngTableSorterRow

  • ngTableSorterRow(): object

  • directive that renders the sorting header row for a table

    ngdoc

    directive

    example
    <ng-table-sorter-row></ng-table-sorter-row>

    Returns object

    • controller: string
    • controllerAs: string
    • replace: boolean
    • restrict: string
    • scope: boolean
    • templateUrl: unknown

Object literals

ngTableDefaults

ngTableDefaults: object

Default values for ngTable

params

params: object

Type declaration

settings

settings: object

Type declaration

Generated using TypeDoc