jqdatatables

README

Revel jQuery DataTables package

This is package is designed to provide functions to work with server processing requests from jQuery DataTables. Package supports Revel Web-framework for request data binding.

Status

Currently packages supports ONLY GET requests binding, no POST requests support yet.

Documentation

Index

• func ColumnsToDataMap(columns []*JqTableColumn) map[string]*JqTableColumn
• type ColumnByIndex
  • func (a ColumnByIndex) Len() int
  • func (a ColumnByIndex) Less(i, j int) bool
  • func (a ColumnByIndex) Swap(i, j int)
• type JqTableColumn
• type JqTableColumnDirection
  • func (d JqTableColumnDirection) Valid() bool
• type JqTableOrder
• type JqTableRequest
  • func BindJqDataTableRequest(params *revel.Params) JqTableRequest
• type JqTableResponse
• type JqTableSearch
• type OrderByIndex
  • func (a OrderByIndex) Len() int
  • func (a OrderByIndex) Less(i, j int) bool
  • func (a OrderByIndex) Swap(i, j int)

Functions

func ColumnsToDataMap

func ColumnsToDataMap(columns []*JqTableColumn) map[string]*JqTableColumn

Converts columns array to the map

Types

type ColumnByIndex

type ColumnByIndex []*JqTableColumn

func (ColumnByIndex) Len

func (a ColumnByIndex) Len() int

func (ColumnByIndex) Less

func (a ColumnByIndex) Less(i, j int) bool

func (ColumnByIndex) Swap

func (a ColumnByIndex) Swap(i, j int)

type JqTableColumn

type JqTableColumn struct {
	Index      int
	Data       string
	Name       string
	Searchable bool
	Orderable  bool
	Search     JqTableSearch
}

jQuery DataTable table column model

type JqTableColumnDirection

type JqTableColumnDirection string

const (
	ORDER_ASC  JqTableColumnDirection = "asc"
	ORDER_DESC JqTableColumnDirection = "desc"
)

func (JqTableColumnDirection) Valid

func (d JqTableColumnDirection) Valid() bool

type JqTableOrder

type JqTableOrder struct {
	//Order
	Index int

	//Column index
	ColumnIndex int

	//JqDataTable column instance
	Column *JqTableColumn

	//Sorting direction
	Direction JqTableColumnDirection
}

jQuery DataTable order model

type JqTableRequest

type JqTableRequest struct {
	//Number of current draw action (serial)
	Draw int

	//Ammount of records to skip
	Start int

	//Ammount of records to take
	Length int

	//Columns information from the script
	Columns []*JqTableColumn

	//Columns ordering information from the script
	Order []*JqTableOrder

	//Current search parameters
	Search JqTableSearch
}

jQuery DataTable request model

func BindJqDataTableRequest

func BindJqDataTableRequest(params *revel.Params) JqTableRequest

BindJqDataTableRequest binds jQuery DataTables AJAX request to a JqTableRequest model

type JqTableResponse

type JqTableResponse struct {
	Draw            int `json:"draw"`
	RecordsTotal    int `json:"recordsTotal"`
	RecordsFiltered int `json:"recordsFiltered"`

	Data interface{} `json:"data"`
}

JQuery DataTables object source response

type JqTableSearch

type JqTableSearch struct {
	//Value to search
	Value string

	//Set if we should use regular expression
	Regex bool
}

jQuery DataTables table search model

type OrderByIndex

type OrderByIndex []*JqTableOrder

func (OrderByIndex) Len

func (a OrderByIndex) Len() int

func (OrderByIndex) Less

func (a OrderByIndex) Less(i, j int) bool

func (OrderByIndex) Swap

func (a OrderByIndex) Swap(i, j int)