PivotTable field list

Initialization

The field list, also known as Pivot Schema Designer, allows you to add, rearrange, filter, and remove fields to show the data in the pivot grid as exactly you want.

Based on the data source and relational bound to the pivot grid control, the PivotTable field list will be automatically populated with the cube information or field names. The PivotTable field list provides an Excel like appearance and behavior.

To initialize the PivotTable field list, first you should define a “div” tag with an appropriate “id” attribute which acts as a container for the widget. Then, you can initialize the PivotTable field list by using the “ejPivotSchemaDesigner” method.

Client mode

  • html
  • <html>
    //...
    
    <body>
    
        <!--Create a tag which acts as a container for PivotGrid-->
        <div id="PivotGrid1" style="width: 55%; height: 670px; overflow: scroll; float: left;"></div>
    
        <!--Create a tag which acts as a container for PivotTable Field List-->
        <div id="PivotSchemaDesigner1" style="height:650px;width:40%;"></div>
    
        <script type="text/javascript">
    
        // Datasource
    
          $(function() {
            $("#PivotGrid1").ejPivotGrid({
                dataSource: {
                    data: pivotData,
                    rows: [{
                        fieldName: "Country",
                        fieldCaption: "Country"
                    }, {
                        fieldName: "State",
                        fieldCaption: "State"
                    }],
                    columns: [{
                        fieldName: "Product",
                        fieldCaption: "Product"
                    }],
                    values: [{
                        fieldName: "Amount",
                        fieldCaption: "Amount"
                    }, {
                        fieldName: "Quantity",
                        fieldCaption: "Quantity"
                    }],
                    filters: [{
                        fieldName: "Date",
                        fieldCaption: "Date"
                    }]
                },
                renderSuccess: "RenderFieldList",
            });
        });
    
        function RenderFieldList(args) {
            $("#PivotSchemaDesigner1").ejPivotSchemaDesigner({
                pivotControl: args,
                layout: ej.PivotSchemaDesigner.Layouts.Excel
            });
        }
        </script>
    
    </body>
    
    </html>

    Field list support in JavaScript pivot grid control with client mode

    Server mode

  • html
  • <html>
    //...
    
    <body>
    
        <!--Create a tag which acts as a container for PivotGrid-->
        <div id="PivotGrid1" style="width: 55%; height: 670px; overflow: scroll; float: left;"></div>
    
        <!--Create a tag which acts as a container for PivotTable Field List-->
        <div id="PivotSchemaDesigner1" style="height:650px;width:40%;">
        </div>
    
        <script type="text/javascript">
            $(function() {
                $("#PivotGrid1").ejPivotGrid({
                    url: "/RelationalService",
                    afterServiceInvoke: "onServiceInvokes"
                });
            });
    
            function onServiceInvokes(args) {
                //Initialize PivotTable Field List
                if (args.action == "initialize")
                    $("#PivotSchemaDesigner1").ejPivotSchemaDesigner({
                        pivotControl: this,
                        layout: ej.PivotSchemaDesigner.Layouts.Excel
                    });
            }
        </script>
    </body>
    
    </html>

    Field list support in JavaScript pivot grid control with server mode

    NOTE

    The url property is used to connect the service by using the specified URL for any server updates.

    Service Method Settings

    The serviceMethods allows the user to set custom name for service methods at service-end.

  • html
  • <script type="text/javascript">
    
    $("#PivotSchemaDesigner1").ejPivotSchemaDesigner({
    
        serviceMethods: { initialize: "InitializeGrid"}
    
        });
    
    </script>

    The following table will explain the available service methods in the pivot schema designer:

    Service Methods Description
    fetchMembers It is responsible for getting the values for the tree-view in the filter dialog.
    filtering It is responsible for filtering operation in the field list.
    memberExpand It is responsible for the server-side action when expanding members in the field list.
    nodeDropped It is responsible for the server-side action when dropping a node into the field list.
    nodeStateModified It is responsible for the server-side action when changing the checked state of a node in the field list.
    removeButton It is responsible for button removing operation in the field list.

    NOTE

    The customObject property in pivot schema designer is used to pass additional information between the client-end and the service-end.

    Layout

    The top portion of the layout shows field or cube items in a categorized way. They can be dynamically added to the report either by drag and drop option or through the simple check box selection.

    On item(s) selection, they will be placed in the row section except numeric based item(s) or measures, which will alone be placed in the value section, by default.

    The bottom portion of the layout is segregated as follows:

    • Report filter: Filters an item(s) placed in the particular position of the layout.
    • Value section: The value label usually displays the numeric value item(s) present in the report.
    • Column section: Displays the item(s) as column header and values in the pivot grid control.
    • Row section: Displays the item(s) as row header and values in the pivot grid control.

    Height of the pivot schema designer

    The height property is used to set the height of the pivot schema designer.

  • html
  • $("#PivotSchemaDesigner1").ejPivotSchemaDesigner({
    
         height: "630px"
    
         });

    Width of the pivot schema designer

    The width property is used to set the width of the pivot schema designer.

  • html
  • $("#PivotSchemaDesigner1").ejPivotSchemaDesigner({
    
         width: "415px"
    
         });

    Types of layout in pivot schema designer

    The layout property is used to set the layout for pivot schema designer. The following table will explain the available types in the pivot schema designer along with the pivot grid.

    Layout Description
    Excel To set the layout as same in the Excel.
    Normal To set normal layout for the field list.

    UI interactions

    By drag and drop

    You can alter the report on fly through the drag-and-drop operation. You can drag any item from the field list and drop it into the column, row, value, or filter section available at the bottom of the field list.

    Drag and drop in field list of JavaScript pivot grid control

    NOTE

    You can enable/disable the drag and drop operation by using the enableDragDrop property.

    By drag and drop to grid headers

    You can also drag and drop elements from the field list to grid headers.

    Drag and drop in grouping bar of JavaScript pivot grid control

    Drag and drop in grouping bar of JavaScript pivot grid control

    Drag and drop in grouping bar of JavaScript pivot grid control

    By tree view selection

    You can alter the report on fly through the check and uncheck option as an alternate. By default, fields will be added to the row label when checked.

    Filtering in field list of JavaScript pivot grid control

    By context menu

    You can also alter the report by using the context menu.

    Context menu in pivot button of field list

    Context menu in tree view elements of field list

    Searching values

    The search option in the field list allows you to search a specific value that needs to be filtered from the list of values in the filter pop-up window.

    Shows tree drop icon to open member editor dialog in field list

    Shows searching in member editor dialog through field list

    Filtering

    Values can be filtered by checking/unchecking the check box besides them, in the filter pop-up window. At least, one value should be present in checked state while filtering. Otherwise “Ok” will be disabled.

    Tree drop icon in field list of JavaScript pivot grid control

    Filtering in field list of JavaScript pivot grid control

    Defer update

    Defer update in the field list allows you to refresh the control on-demand and not during every UI operation. This operation can be enabled/disabled through enableDeferUpdate property internally.