Search results

PivotFieldList

Represents the PivotFieldList component.

<div id="pivotfieldlist"></div>
<script>
 var pivotfieldlistObj = new PivotFieldList({ });
 pivotfieldlistObj.appendTo("#pivotfieldlist");
</script>

Properties

allowCalculatedField

boolean

It allows to enable calculated field in Pivot Field List.

Defaults to false

allowDeferLayoutUpdate

boolean

If allowDeferLayoutUpdate is set to true, then it will enable defer layout update to pivotfieldlist.

Defaults to false

cssClass

string

Specifies the CSS class name to be added for Pivot Field List element. User can add single or multiple CSS classes.

Defaults to

dataSource

DataSourceModel

It allows to feed raw data, dataSource and properties to customize the data source

enablePersistence

boolean

Enable or disable persisting component’s state between page reloads.

Defaults to false

enableRtl

boolean

Enable or disable rendering component in right to left direction.

Defaults to false

locale

string

Overrides the global culture and localization value for this component. Default global culture is ‘en-US’.

Defaults to undefined

maxNodeLimitInMemberEditor

number

It allows to set the maximum number of nodes to be displayed in the member editor.

Defaults to 1000

renderMode

string

It allows to render Pivot Field List at fixed or popup mode. The possible values are:

Defaults to ‘Popup’

showValuesButton

boolean

It shows a common button for value fields to move together in column or row axis

Defaults to false

target

HTMLElement | string

Specifies the target element where the Pivot Field List dialog should be displayed. If the user set the specific target element for Pivot Field List, it will be positioned based on the target. The targetID should works only when the Pivot Field List is in ‘Dynamic’ mode.

Defaults to null

Methods

addEventListener

Adds the handler to the given event listener.

Returns void

appendTo

Appends the control within the given HTML element

Parameter Type Description
selector (optional) string | HTMLElement Target element where control needs to be appended

Returns void

dataBind

When invoked, applies the pending property changes immediately to the component.

Returns void

destroy

Destroys the Field Table component.

Returns void

refresh

Applies all the pending property changes and render the component again.

Returns void

removeEventListener

Removes the handler from the given event listener.

Returns void

Inject

Dynamically injects the required modules to the component.

Returns void

Events

created

EmitType<Object>

Triggers when data source is created in the Pivot Field List.

dataBound

EmitType<Object>

Triggers when data source is populated in the Pivot Field List.

destroyed

EmitType<Object>

Triggers when data source is destroyed in the Pivot Field List.

enginePopulated

EmitType<EnginePopulatedEventArgs>

This allows any customization of Pivot Field List properties before pivotengine populate.

enginePopulating

EmitType<EnginePopulatingEventArgs>

This allows any customization of Pivot Field List properties before pivotengine populate.

load

EmitType<LoadEventArgs>

This allows any customization of Pivot Field List properties before rendering.

onFieldDropped

EmitType<FieldDroppedEventArgs>

Triggers when a field getting dropped into any axis.