tmsTable

tmsTable - небольшой плагин для удобного представления табличных данных на сайте.

Примечание - хочется отметить пару нюансов в представленном примере. Вся обработка (упорядочивание, фильтрация) данных должна проводиться на стороне сервера любыми удобными средствами. Поэтому server-side не рассматривается. В данном примере в качестве источника данных представлен статичный data.json, поэтому часть функционала не столь наглядно проиллюстрирована. Замените на реального провайдера данных и все сразу станет работать правильно.

##Возможности##

Версия 25.05.14:

• Отображение данных из локального массива или из удаленного источника

• AJAX - подгрузка данных

• Возможность сортировки данных (включение/отключение сортировки по колонкам)

• Возможность навигации по страницам

• Обработка Click | DblClick событий у строк таблицы

• Возможность настройки ширины колонок

• Возможность добавления стилей к экземплярам таблиц

• Неограниченное количество таблиц на одной странице

• Возможность создания своего декоратора ячейки таблицы

• Возможность постобработки строки после ее вставки в таблицу

• Возможность мультиселекта строк

• Возможность получения данных исходного объекта строки по индексу строки

• Возможность сокрытия апки и подвала таблицы

• Возможность доплнять POST запрос к серверу своими параметрами через postVars ##Зависимости##

• JQuery

tmsTable изначально задуман как удобный инструмент, который не должен требовать много усилий по настройке и интеграции в страницы сайта. Как следствие зависит только от jQuery.

##Использование##

tmsTable может работать с 2 типами данных

• array - локальные данные в массиве объектов (не является приоритетом разработки)
• jsonp - данные на удаленном хосте. данные в формате json

Подключение требуемых файлов:

Аскетично:

<link rel="stylesheet" href="css/tmsTable.css">
<script src="js/jquery-1.10.2.min.js" type="application/x-javascript"></script>
<script src="js/tmsTable.js" type="application/x-javascript"></script>

С элементами bootstrap 3

<link rel="stylesheet" href="bootstrap/dist/css/bootstrap.min.css">
<link rel="stylesheet" href="bootstrap/dist/css/bootstrap-theme.min.css">
<link rel="stylesheet" href="css/tmsTable.css">

<script src="js/jquery-1.10.2.min.js" type="application/x-javascript"></script>
<script src="bootstrap/dist/js/bootstrap.min.js"></script>
<script src="js/tmsTable.js" type="application/x-javascript"></script>

Для создания таблицы на странице сайта нужно определить контейнер, который будет содержать табличку

<div id="json_ttt"></div>

Далее нужно понять с каким типом данных мы работаем. Для простоты буду рассматривать jsonp поскольку он будет нужен в подавляющем большинстве сллучаев.

<script>
json_params = {
        id: 'json_ttt'
        , class: 'table table-bordered table-striped table-hover'
        , col_names: ['id', 'title', 'date']
        , dataType: 'jsonp'
        , url: 'data.json'
        , order_direction: 'asc'
        , order_by: 'title'
        , cols: [
            {index: 'id', name: 'id', width: 100}
            , {index: 'title', name: 'title',  decorator: function(rowId, rowData, rowObject, cellvalue){ return '<b>'+cellvalue+'<b>';}}
            , {index: 'date', name: 'date', width: 100}
        ]
//        , dblClick: function (rowId, rowData) {
//            console.log(rowId, rowData);
//        }
//        , click: function (rowId, rowData) {
//            console.log(rowId, rowData);
//        }
		, selectable: true
		, rowNum: 20 // default row nums
        , rowNums: [10, 20, 50]  // avaliable row nums for selector in table footer
//        ,afterInsertRow: function(rowId, rowData, rowObject ){rowObject.css('color','orange') }
    };
    
var json_tbl = new tmsTable(json_params)
json_tbl.render();
</script>

###Опции###

id - идентификатор контейнера таблицы
class - дополнительные css-классы для стилизации таблички
col_names - наименования колонок таблицы
dataType - тип провайдера данных
url - источник данных *(только для jsonp)*
order_direction - тип упорядочивания выборки asc | desc
order_by - index по которому будет производиться упорядочивание (берется из блока cols. Если order_by не задан, то упорядочивание будет по первой колонке)
cols - Блок позволяющий задать отображение данных в таблице.
selectable - задает возможность создавать выборки в таблице
dblClick: function (rowId, rowData) - определяет событие на событие doubleclick по строке таблицы 
click: function (rowId, rowData) - определяет событие на событие click по строке таблицы 
afterInsertRow: function(rowId, rowData, rowObject ) - постобработчик срабатывает после добавления строки в таблицу
rowNum - количество строк для запроса с сервера. Default: 10
rowNums - список из возможных значений rowNum для селектора в подвале страницы. Необязательный параметр.
show_table_header - boolean [Default:true] - показывать или нет шапку таблицы
show_table_fooler - boolean [Default:true] - показывать или нет подвал таблицы
postVars: Object  - пары key->value, которые будут посылаться дополнительно вместе с POST параметрами  

####Опции cols####

name - уникальное имя колонки таблицы
index - id определяющий источник данных в приходящем json
width - рациональный параметр, задающий ширину колонки. Задавать можно с указанием размерности (px|%) или без. Если размерность не задана, то считается что размер указан в px
sortable - boolean [default: true] - указывает на возможность сортировки данных по данной колонке
decorator: function(rowId, rowData, rowObject, cellvalue) - декоратор ячейки таблицы
align: определяет выравнивание текста в столбце [опционально]. center | justify | left | right | start | end

####Методы####

getSelectedIndexes: function() - возвращает массив индексов выбранных строк. Если должны быть выбраны все строки таблицы, то возвращает [-1]
getRowData: function(index) - возвращает объект данных строки по ее индексу
reloadRows: function() - обновляет дынные таблицы
goToPage: function(int) - Осуществляет вывод данных для указанной страницы данных. 
onSortOrderChange: function(order_by, order_dir) - обрабатывает событие - сменя порядка сортировки по клику на имяколонки в таблице. Возвращает true|false. false - отменяет дальнейшую обработку события смены порядка сортировки, позволяя реализовать собственную логику.