PivotField class [PHP]

AllowFilteringTop

bool AllowFiltering

Enable or disable pivot's filtering.

Show/Hide Code

<?php				
    $field->AllowFiltering = true;
?>

Supported from version: 1.0.0.0

AllowReorderTop

bool AllowReorder

Enable or disable a pivot field's reordering.

Show/Hide Code

<?php				
    $field->AllowReorder = true;
?>

Supported from version: 1.0.0.0

AllowSortingTop

bool AllowSorting

Enable or disable a pivot field's sorting.

Show/Hide Code

<?php				
    $field->AllowSorting = true;
?>

Supported from version: 1.0.0.0

ExceptionListTop

array ExceptionList

Get or set a pivot field's filter's exception list.

Show/Hide Code

<?php				
    $field->ExceptionList = array("Classic Cars");
?>

Supported from version: 1.0.0.0

ExpandTop

bool Expand

Get or set a pivot field's expanding property.

Show/Hide Code

<?php				
    $field->Expand = true; //false
?>

Supported from version: 1.0.0.0

FieldNameTop

String FieldName

Get or set a pivot field's name.

Show/Hide Code

<?php				
    $field->FieldName = "customerName";
?>

Supported from version: 1.0.0.0

FiltersTop

object Filters

Get or set a pivot field's filters.

Show/Hide Code

<?php				
    $filter = $field->Filters;
?>

Supported from version: 1.0.0.0

FormatStringTop

String FormatString

Get or set format string for a data field.

Show/Hide Code

<?php		
    $field = new PivotSumField("dollar_sales");
    $field->FormatString = "{n}";
?>

Supported from version: 1.0.0.0

HeaderTextWrapTop

bool HeaderTextWrap

Enable or disable pivot's displaying text wrap.

Show/Hide Code

<?php				
    $field->HeaderTextWrap = false;
?>

Supported from version: 1.0.0.0

IncludeAllTop

bool IncludeAll

Enable or disable pivot's IncludeAll property.

Show/Hide Code

<?php				
    $field->IncludeAll = true; //false
?>

Supported from version: 1.0.0.0

SortTop

String Sort

Get or set a pivot field's default sorting direction.

Show/Hide Code

<?php				
    $field->Sort = "asc"; //"desc"
?>

Supported from version: 1.0.0.0

TextTop

String Text

Get or set a pivot field's displaying text.

Show/Hide Code

<?php				
    $field->Text = "Customer Name";
?>

Supported from version: 1.0.0.0

TooltipTop

String Tooltip

Enable or disable pivot's tooltip.

Show/Hide Code

<?php				
    $field->Tooltip = "Customer Name";
?>

Supported from version: 1.0.0.0

PivotFieldTop

PivotField PivotField()

Create a PivotField object.

Show/Hide Code

<?php	               
    $field = new PivotField("customerName");
?>

Supported from version: 1.0.0.0

PivotSumFieldTop

PivotField PivotSumField()

Create a PivotSumField object.

Show/Hide Code

<?php	               
    $field = new PivotSumField("dollar_sales");
?>

Supported from version: 1.0.0.0

PivotCountFieldTop

PivotField PivotCountField()

Create a PivotCountField object.

Show/Hide Code

<?php	               
    $field = new PivotCountField("orderID");
?>

Supported from version: 1.0.0.0

PivotAverageFieldTop

PivotField PivotAverageField()

Create a PivotAverageField object.

Show/Hide Code

<?php	               
    $field = new PivotAverageField("dollar_sales");
?>

Supported from version: 1.0.0.0

PivotMinFieldTop

PivotField PivotMinField()

Create a PivotMinField object.

Show/Hide Code

<?php	               
    $field = new PivotMinField("dollar_sales");
?>

Supported from version: 1.0.0.0

PivotMaxFieldTop

PivotField PivotMaxField()

Create a PivotMaxField object.

Show/Hide Code

<?php	               
    $field = new PivotMaxField("dollar_sales");
?>

Supported from version: 1.0.0.0

PivotPercentageSumFieldTop

PivotField PivotPercentageSumField()

Create a PivotPercentageSumField object.

Show/Hide Code

<?php	               
    $field = new PivotPercentageSumField("dollar_sales");
?>

Supported from version: 1.0.0.0

PivotPercentageCountFieldTop

PivotField PivotPercentageCountField()

Create a PivotPercentageCountField object.

Show/Hide Code

<?php	               
    $field = new PivotPercentageCountField("orderID");
?>

Supported from version: 1.0.0.0

AddFilterTop

void AddFilter()

Add a filter to a pivot field's filter.

Show/Hide Code

<?php	               
    $field->AddFilter(array("=", "Classic Cars"));
    $field->AddFilter(array("top_N", "5")); //New filters: "top_N", "bottom_N", "top_percent", "bottom_percent"
?>

Supported from version: 1.0.0.0

AddExceptionTop

void AddException()

Add an exception value to a pivot field's exception list.

Show/Hide Code

<?php	               
    $field->AddException("Vintage Cars");
?>

Supported from version: 1.0.0.0

setValueMapTop

self setValueMap(PivotIValueMap $valueMap)

Set a value map for a pivot field.

Show/Hide Code

<?php	               
    $field->setValueMap(new firstLetterMap("customerName"));
?>

Supported from version: 1.0.0.0

getValueMapTop

PivotIValueMap getValueMap()

Get the PivotIValueMap object of a pivot field.

Show/Hide Code

<?php	               
    $map = $field->getValueMap();
?>

Supported from version: 1.0.0.0