Documentation

PivotField
in package

Read-only representation of a single field within a pivot table.

A pivot field describes how one of the source cache fields is used in the pivot table: which axis it is placed on (row, column, page/filter or data), and, for value fields, which aggregation function is applied.

Tags
see
PivotTable

Table of Contents

Constants

AXIS_COLUMN  = 'axisCol'
AXIS_NONE  = ''
AXIS_PAGE  = 'axisPage'
AXIS_ROW  = 'axisRow'
AXIS_VALUES  = 'axisValues'
SUBTOTAL_AVERAGE  = 'average'
SUBTOTAL_COUNT  = 'count'
SUBTOTAL_COUNT_NUMS  = 'countNums'
SUBTOTAL_MAX  = 'max'
SUBTOTAL_MIN  = 'min'
SUBTOTAL_PRODUCT  = 'product'
SUBTOTAL_STD_DEV  = 'stdDev'
SUBTOTAL_STD_DEV_P  = 'stdDevp'
SUBTOTAL_SUM  = 'sum'
SUBTOTAL_VAR  = 'var'
SUBTOTAL_VAR_P  = 'varp'

Methods

__construct()  : mixed
getAxis()  : string
getDataFieldCaption()  : string|null
getIndex()  : int
getName()  : string
getSubtotal()  : string|null
isDataField()  : bool
setAxis()  : self
setDataField()  : self
setDataFieldCaption()  : self
setName()  : self
setSubtotal()  : self

Constants

AXIS_COLUMN

public mixed AXIS_COLUMN = 'axisCol'

AXIS_VALUES

public mixed AXIS_VALUES = 'axisValues'

SUBTOTAL_AVERAGE

public mixed SUBTOTAL_AVERAGE = 'average'

SUBTOTAL_COUNT

public mixed SUBTOTAL_COUNT = 'count'

SUBTOTAL_COUNT_NUMS

public mixed SUBTOTAL_COUNT_NUMS = 'countNums'

SUBTOTAL_PRODUCT

public mixed SUBTOTAL_PRODUCT = 'product'

SUBTOTAL_STD_DEV

public mixed SUBTOTAL_STD_DEV = 'stdDev'

SUBTOTAL_STD_DEV_P

public mixed SUBTOTAL_STD_DEV_P = 'stdDevp'

SUBTOTAL_VAR_P

public mixed SUBTOTAL_VAR_P = 'varp'

Methods

__construct()

public __construct(int $index[, string $name = '' ]) : mixed
Parameters
$index : int
$name : string = ''

getAxis()

public getAxis() : string
Return values
string

getDataFieldCaption()

public getDataFieldCaption() : string|null
Return values
string|null

getIndex()

public getIndex() : int
Return values
int

getName()

public getName() : string
Return values
string

getSubtotal()

public getSubtotal() : string|null
Return values
string|null

isDataField()

public isDataField() : bool
Return values
bool

setAxis()

public setAxis(string $axis) : self
Parameters
$axis : string
Return values
self

setDataField()

public setDataField(bool $dataField) : self
Parameters
$dataField : bool
Return values
self

setDataFieldCaption()

public setDataFieldCaption(string|null $dataFieldCaption) : self
Parameters
$dataFieldCaption : string|null
Return values
self

setName()

public setName(string $name) : self
Parameters
$name : string
Return values
self

setSubtotal()

public setSubtotal(string|null $subtotal) : self
Parameters
$subtotal : string|null
Return values
self 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results