CubePivotField Class

File
wijmo.olap.js
Module
wijmo.olap
Base Class
PivotField
Show
   

Extends the PivotField class to represent a field in a server-based cube data source.

Constructor

Properties

Methods

Events

Constructor

constructor

constructor(engine: PivotEngine, binding: string, header?: string, options?: any): CubePivotField

Initializes a new instance of the PivotField class.

Parameters
Returns
CubePivotField

Properties

aggregate

Gets or sets how the field should be summarized.

Inherited From
PivotField
Type
Aggregate

binding

Gets or sets the name of the property the field is bound to.

Inherited From
PivotField
Type
string

collectionView

Gets the ICollectionView bound to this field.

Inherited From
PivotField
Type
ICollectionView

dataType

Gets or sets the data type of the field.

Inherited From
PivotField
Type
DataType

descending

Gets or sets a value that determines whether keys should be sorted in descending order for this field.

Inherited From
PivotField
Type
boolean

dimensionType

Gets or sets the dimension type of the field.

Type
DimensionType

engine

Gets a reference to the PivotEngine that owns this PivotField.

Inherited From
PivotField
Type
PivotEngine

filter

Gets a reference to the PivotFilter used to filter values for this field.

Inherited From
PivotField
Type
PivotFilter

format

Gets or sets the format to use when displaying field values.

Inherited From
PivotField
Type
string

isActive

Gets or sets a value that determines whether this field is currently being used in the view.

Setting this property to true causes the field to be added to the view's rowFields or valueFields, depending on the field's data type.

Inherited From
PivotField
Type
boolean

isContentHtml

Gets or sets a value indicating whether items in this field contain HTML content rather than plain text.

Inherited From
PivotField
Type
boolean

key

Gets the key for this CubePivotField.

For this type of field, the key is the field's binding.

Type
string

parentField

Gets this field's parent field.

When you drag the same field into the Values list multiple times, copies of the field are created so you can use the same binding with different parameters. The copies keep a reference to their parent fields.

Inherited From
PivotField
Type
PivotField

showAs

Gets or sets how the field results should be formatted.

Inherited From
PivotField
Type
ShowAs

subFields

Gets this field's child fields.

Type
CubePivotField[]

weightField

Gets or sets the PivotField used as a weight for calculating aggregates on this field.

If this property is set to null, all values are assumed to have weight one.

This property allows you to calculate weighted averages and totals. For example, if the data contains a 'Quantity' field and a 'Price' field, you could use the 'Price' field as a value field and the 'Quantity' field as a weight. The output would contain a weighted average of the data.

Inherited From
PivotField
Type
PivotField

width

Gets or sets the preferred width to be used for showing this field in the user interface.

Inherited From
PivotField
Type
number

wordWrap

Gets or sets a value that indicates whether the content of this field should be allowed to wrap within cells.

Inherited From
PivotField
Type
boolean

Methods

onPropertyChanged

onPropertyChanged(e: PropertyChangedEventArgs): void

Raises the propertyChanged event.

Parameters
Inherited From
PivotField
Returns
void

Events

propertyChanged

Occurs when the value of a property in this Range changes.

Inherited From
PivotField
Arguments
PropertyChangedEventArgs