PivotTableExportSettings class [PHP]

	Properties	Description
	IgnorePaging	Enable or disable a pivot export settings' paging.

	Methods	Description
	config	Set main config for a pivot's export settings.
	changeText	Set text replacing for a pivot's export settings.
	htmlStyle	Set html styles for a pivot's export settings.
	htmlProperty	Set html properties for a pivot's export settings.

IgnorePagingTop

bool IgnorePaging

Enable or disable a pivot's export setting paging.

Default value : false

Allowed values :

true : Export all data without paging.
false : Export only current page.

Demo :

- Export

Show/Hide Code

<?php				
    $pivot->ExportSettings->IgnorePaging = TRUE;
?>

Supported from version: 1.0.0.0

configTop

self config(array $_config)

Set main config for a pivot's export settings.

Allowed $_config's values :

array("fileName" => String) : Set the exported file name.
array("template" => String."{KoolPivotTable}".String) : Set exported file's template.
array("showFilterZone" => boolean) : Enable or disable showing filter zone.
array("caseSensitive" => boolean) : Enable or disable case sensitive for changeText method.
array("pdf" =>
array(

"pageOrientation"=>"L"/"P",

"pageDimension"=>array(Number,Number),

"font"=>array(
"family" => String,

"style" => "normal"/"bold"/"italic",

"size" => Number

),

)
) : Set exported PDF file's settings.

Show/Hide Code

<?php	   
    $_htmlTemplate = <<<EOF
    <head>
        <title>An XHTML 1.0 Strict standard template</title>
        <meta http-equiv="content-type" 
                content="text/html;charset=utf-8" />
    </head>
        <body>
            My prefix in html code.<br>
 
            {KoolPivotTable}
 
            My postfix in html code.<br>
        </body>
    EOF;            
    $pivot->ExportSettings->config(
        array(
            "fileName" => "MyKoolPivotTableExport",
            "template" => $_htmlTemplate,
            "showFilterZone" => FALSE,
            "caseSensitive" => TRUE,
            "pdf" => array(
                "pageOrientation" => "L",
                "pageDimension" => array(600, 360),
                "font" => array(
                    "family" => 'FreeSans', 
                    "style" => "bold", 
                    "size" => 10
                ),
            )
        )
    );
?>

Supported from version: 1.0.0.0

changeTextTop

self changeText(array $_replace)

Set text replacing for a pivot's export settings.

Allowed $_replace's values :

array(String => String) : Set replaced text.

Show/Hide Code

<?php	               
    $pivot->ExportSettings->changeText(
        array(
            "cars"=>"Automobiles", 
            "column fields"=>"Fields column",
            "Row fields"=>"Fields row",        
        )
    );
?>

Supported from version: 1.0.0.0

htmlStyleTop

self htmlStyle(array $_styles)

Set html styles for a pivot's export settings. Applicable for HTML and PDF.

Allowed $_styles's values :

array("table" => String) : Set the table's style.
array("totalRow" => String) : Set the total rows' style.
array("totalColumn" => String) : Set the total columns' style.
array("dataCell" => String) : Set the data cells' style.
array("emptyDataCell" => String) : Set the empty data cells' style.
array("expandedCell" => String) : Set the expanded header cells' style.
array("cell" => String) : Set all the cells' style.
array("rowHeader" => String) : Set the row headers' style.
array("columnHeader" => String) : Set the column headers' style.

Show/Hide Code

<?php	               
    $pivot->ExportSettings->htmlStyle(
        array(
            "table" => "border:1px solid grey;"
                    .  "border-collapse:collapse;color:black;",
            "totalRow" => "background-color:lightblue; font-weight:bold;",
            "totalColumn" => "background-color:lightblue; font-weight:bold;",
            "dataCell" => "text-align:right;",
            "emptyDataCell" => "text-align:center;",
            "cell" => "padding:5px; border:1px solid grey;",
        )
    );
?>

Supported from version: 1.0.0.0

htmlPropertyTop

self htmlProperty(array $_properties)

Set html properties for a pivot's export settings. Applicable for HTML, PDF and Word.

Allowed $_properties's values :

array("table" => array()) : Set the table's properties.
array("totalRow" => array()) : Set the total rows' properties.
array("totalColumn" => array()) : Set the total columns' properties.
array("dataCell" => array()) : Set the data cells' properties.
array("emptyDataCell" => array()) : Set the empty data cells' properties.
array("expandedCell" => array()) : Set the expanded header cells' properties.
array("cell" => array()) : Set all the cells' properties.
array("rowHeader" => array()) : Set the row headers' properties.
array("columnHeader" => array()) : Set the column headers' properties.

Show/Hide Code

<?php	               
    $pivot->ExportSettings->htmlProperty(
        array(
            "table" => array(
                "border" => "1", 
                "cellspacing" => "0",
            )
        )
    );
?>

Supported from version: 1.0.0.0

PivotTableExportSettings class [PHP]

Summary

Properties Detail

Methods Detail