phpGrid

set_col_default()

richard — Sun, 08 Apr 2012 04:03:12 +0000

Parameters:
- $col_name: column name
- $default: column default value
Description:
- Set column default value This option is only valid for Form Editing when adding a new record. User can override this entry.
Example:

1	$dg -> set_col_default('direction', 'top');

set_col_wysiwyg()

richard — Wed, 08 Feb 2012 07:23:11 +0000

* only available in Professional and above.

Parameters:
- $col_name: column name
Description:
- Turns simple text field into word processor by replacing textarea with rich text editor. Should only be used for text fields that allows large amount of text such as notes and comment fields.
Example:

1	$dg->set_col_wysiwyg('comments');

phpGrid Knowledge Base

richard — Fri, 20 Jan 2012 18:14:09 +0000

Please visit phpGrid Knowledge Base on uservoice.

Conditional Format *

richard — Sat, 14 Jan 2012 20:51:16 +0000

* Please note this feature is not available in Lite and Basic versions.

Conditional formatting example using set_conditional_format() method.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

$dg = new C_DataGrid("SELECT * FROM orders", "orderNumber", "orders");

//Format a cell based on the specified condition
$dg->set_conditional_format("orderNumber","CELL",array(
"condition"=>"eq","value"=>"10107","css"=> array("color"=>"#ffffff","background-color"=>"green")));

$dg->set_conditional_format("customerNumber","CELL",array(
"condition"=>"eq","value"=>"141","css"=> array("color"=>"red","background-color"=>"#DCDCDC")));

// Format a row based on the specified condition
$dg->set_conditional_format("comments","ROW",array(
"condition"=>"cn","value"=>"request","css"=> array("color"=>"white","background-color"=>"#4297D7")));

$dg->set_multiselect(true);
$dg -> display();

See Live Example!

Horizontal Scroll

richard — Sat, 14 Jan 2012 20:13:25 +0000

Set parameter $shrinkToFit in set_dimension() to false to enable horizontal scroll when the container width is less than the grid width. The scroll bar will not show when the grid width is equal or less than the container width.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

$dg = new C_DataGrid("SELECT * FROM orders", "orderNumber", "orders");
// change column titles
$dg -> set_col_title("orderNumber", "Order No.");
$dg -> set_col_title("orderDate", "Order Date");
$dg -> set_col_title("shippedDate", "Shipped Date");
$dg -> set_col_title("customerNumber", "Customer No.");
// hide a column
$dg -> set_col_hidden("requiredDate");
// change default caption
$dg -> set_caption("Orders List");
// set export type
$dg -> enable_export('EXCEL');
// enable integrated search
$dg -> enable_search(true);
// set height and weight of datagrid
$dg -> set_dimension(800, 600, false);
// increase pagination size to 40 from default 20
$dg -> set_pagesize(40);

$dg -> display();

See Live Example!

Grid Auto Width

richard — Sat, 14 Jan 2012 20:10:24 +0000

Use enable_autowidth() to set datagrid width as the same as the current page width.

1
2
3
4

$dg = new C_DataGrid("SELECT * FROM orders", "orderNumber", "orders");
$dg->enable_edit('FORM', 'CRUD');
$dg->enable_autowidth(true);
$dg -> display();

See Live Example!

Conditional Value *

richard — Sat, 14 Jan 2012 20:08:01 +0000

* Please note this feature is not available in Lite and Basic versions.

Conditional Value is similar to conditional format (see set_conditional_format but with simplier set of features. Use set_conditional_value() to dynamically display a value when specific condition is met. The conditional value can be text, HTML, or even CSS style.

You can use conditional value with data bar in the same grid.

1
2
3
4
5
6
7
8

.tstyle
{
display:block;background-image:none;margin-right:-2px;margin-left:-2px;height:14px;padding:5px;background-color:green;color:navy;font-weight:bold
}
.fstyle
{
display:block;background-image:none;margin-right:-2px;margin-left:-2px;height:14px;padding:5px;background-color:yellow;color:navy
}

PHP Code

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

$dg = new C_DataGrid("SELECT * FROM joborders", "jobNumber", "joborders");
$dg -> set_col_title("jobNumber", "Job Number");
$dg -> set_col_title("jobDescription", "Description");
$dg -> set_col_title("status", "Status");
$dg -> set_col_title("percentComplete", "Progress (%)");
$dg -> set_col_title("isClosed", "Closed");

$dg->set_conditional_value("isClosed", "==1", array(
"TCellValue"=>"",
"FCellValue"=>""));

$dg->set_conditional_value("status", "=='Complete'", array(
"TCellStyle"=>"tstyle",
"FCellStyle"=>"fstyle"));

$dg->enable_edit('INLINE', 'CRUD');

$dg->set_multiselect(true);
$dg -> set_databar("percentComplete","red");
$dg -> display();

See Live Example!

In-cell Data Bar *

richard — Sat, 14 Jan 2012 20:04:14 +0000

Bar chart is a great way to visualize numeric data. phpGrid now supports bar chart natively without 3rd party plugin using set_databar() method. You can have multiple data bar in a datagrid.

For complex data visualization, we recommend PHP Chart. Please visit PHP Chart for live demo.

1
2
3
4
5
6
7
8
9
10
11
12

$dg = new C_DataGrid("SELECT * FROM joborders", "jobNumber", "joborders");
$dg -> set_col_title("jobNumber", "Job Number");
$dg -> set_col_title("jobDescription", "Description");
$dg -> set_col_title("status", "Status");
$dg -> set_col_title("percentComplete", "Progress (%)");
$dg -> set_col_title("isClosed", "Closed");

$dg -> set_databar("percentComplete","blue");
$dg -> set_databar("jobNumber","blue");
$dg -> enable_edit("INLINE", "CRUD");

$dg -> display();

See Live Example!

setCallBack

richard — Sat, 14 Jan 2012 19:57:21 +0000

Parameters:
- $callback_str: callback string
Description:
- Used for pass setting between 3rd party system and phpGrid using AJAX callback. Read the comments in file callbackstr.php for usage

set_form_dimension()

richard — Sat, 14 Jan 2012 19:54:18 +0000

Parameters:
- $f_width: form width. The default value is ’400px’
- $f_height: form height. The default is -1 so it is automatically adjusted to number of rows.
Description:
- Set edit FORM width and height during edit.
Remark:

The default $f_height value is -1 (negative one) so it is automatically adjusted to number of rows.

Example:

1	$dg->set_form_dimension('500px');