Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://js.devexpress.com/Vue/Documentation/ApiReference/UI_Components/dxPivotGrid/Methods/ below:

Vue PivotGrid Methods | Vue Documentation

This section describes the methods that can be used to manipulate the PivotGrid UI component.

Postpones rendering that can negatively affect performance until the endUpdate() method is called.

The beginUpdate() and endUpdate() methods reduce the number of renders in cases where extra rendering can negatively affect performance.

Binds a Chart to the PivotGrid.

The Chart to be bound to the PivotGrid.
Accepts the Chart's instance, jQuery element or container selector.

The Chart's configuration.

Object structure:

Boolean

Default Value: true.
Specifies whether to alternate data fields in the resulting chart.
Applies only if the PivotGrid contains multiple data fields.

Function

Allows you to customize the Chart's appearance.

Function

Allows you to customize the series.

String

Default Value: "splitAxes".
Accepts one of the following values:

• "singleAxis" - Values of all data fields are displayed on a single value axis.
• "splitAxes" - Each data field gets an individual value axis. Applies only if putDataFieldsInto is "series".
• "splitPanes" - Each data field gets an individual pane. Applies only if putDataFieldsInto is "series".

Applies only if the PivotGrid contains several data fields.

Boolean

Default Value: false.
If true, row field values go to the chart arguments and column field values form series. If false - vice versa.

Function

Allows you to process cell data before the Chart visualizes it.

String

Default Value: "series".
Accepts one of the following values:

• "args" - Data fields constitute chart arguments.
• "series" - Data fields constitute chart series.

Unbinds the Chart. If null, then binding failed.

The customizeChart, customizeSeries, and processCell fields of the integrationOptions object are functions. They accept arguments whose structure is described below.

• customizeChart

  customizeChart: function (chartOptions) {
      // Change chart properties here
      return chartOptions; // This line is optional
  }

  The chartOptions object has the following structure:

  Field name Type Description valueAxis Array Allows you to customize the automatically-created value axes. Each object in this array can contain fields described in the valueAxis property description. When this array holds several objects, use their name field to identify the axis. panes Array Allows you to customize the automatically-created panes. Each object in this array can contain fields described in the panes property description. When this array holds several objects, use their name field to identify the pane.

  You can also specify any other Chart properties in this object, except dataSource and seriesTemplate.

• customizeSeries

  customizeSeries: function (seriesName, seriesOptions) {
      // Change series properties here
      return seriesOptions; // This line is optional
  }

  The seriesName argument is a string that allows you to identify a series. The seriesOptions argument is an object with the following structure:

  Field name Type Description axis String The name of the axis to which the series belongs. Has a value only when the chart has multiple axes. pane String The name of the pane the series occupies. Has a value only when the chart has multiple panes.

  You can also specify any other series properties in this object.

• processCell

  processCell: function (cellData) {
      // Process data here
      return cellData; // This line is optional
  }

  The cellData object has the following structure:

  Field name Type Description rowPath Array The path to the data cell by row field values. rowPathFormatted Array Same as rowPath, but with format and customizeText applied. rowFields Array Contains objects that are row fields. maxRowLevel Number A zero-based index that indicates the lowest expanded row level. Equals 0 when the pivot grid has no row fields, 1 when all rows are collapsed, 2 when at least one first-level row is expanded, etc. columnPath Array The path to the data cell by column field values. columnPathFormatted Array Same as columnPath, but with format and customizeText applied. columnFields Array Contains objects that are column fields. maxColumnLevel Number A zero-based index that indicates the lowest expanded column level. Equals 0 when the pivot grid has no column fields, 1 when all columns are collapsed, 2 when at least one first-level column is expanded, etc. dataFields Array Contains objects that are data fields. dataValues Array Data of the current cell. Contains more than one value if the pivot grid has multiple data fields. dataIndex Number A zero-based index that indicates which data field and value from the dataFields and dataValues arrays are currently processed. visible Boolean Indicates whether the current cell will be passed to the chart. true if the cell belongs to the deepest expanded level. chartDataItem Object The resulting item passed to the Chart's data source. This object's structure is described in the table below.

  The chartDataItem object has the following structure:

  Field name Type Description series String The name of the series to which the data item belongs. arg Number | String | Date The argument of the data item. val Number | String | Date The value of the data item.

Main article: Integration with Chart

View Demo

Specifies the device-dependent default configuration properties for this component.

The component's default device properties.

Object structure:

Device

Function

Device parameters.
When you specify a function, get information about the current device from the argument. Return true if the properties should be applied to the device.

Object

Options to be applied.

defaultOptions is a static method that the UI component class supports. The following code demonstrates how to specify default properties for all instances of the PivotGrid UI component in an application executed on the desktop.

DevExpress.ui.dxPivotGrid.defaultOptions({ 
    device: { deviceType: "desktop" },
    options: {
        // Here go the PivotGrid properties
    }
});

import PivotGrid, { Properties } from "devextreme/ui/pivot_grid";
// ...
export class AppComponent {
    constructor () {
        PivotGrid.defaultOptions<Properties>({
            device: { deviceType: "desktop" },
            options: {
                // Here go the PivotGrid properties
            }
        });
    }
}

<template>
    <div>
        <DxPivotGrid id="pivotGrid1" />
        <DxPivotGrid id="pivotGrid2" />
    </div>
</template>
<script>
import DxPivotGrid from "devextreme-vue/pivot-grid";
import PivotGrid from "devextreme/ui/pivot_grid";

PivotGrid.defaultOptions({
    device: { deviceType: "desktop" },
    options: {
        // Here go the PivotGrid properties
    }
});

export default {
    components: {
        DxPivotGrid
    }
}
</script>

import dxPivotGrid from "devextreme/ui/pivot_grid";
import PivotGrid from "devextreme-react/pivot-grid";

dxPivotGrid.defaultOptions({
    device: { deviceType: "desktop" },
    options: {
        // Here go the PivotGrid properties
    }
});

export default function App() {
    return (
        <div>
            <PivotGrid id="pivotGrid1" />
            <PivotGrid id="pivotGrid2" />
        </div>
    )
}

You can also set rules for multiple device types:

const devicesConfig = [
    { deviceType: 'desktop' },
    { deviceType: 'tablet' },
    { deviceType: 'phone' },
];

devicesConfig.forEach(deviceConfig => {
    DevExpress.ui.dxPivotGrid.defaultOptions({ 
        device: deviceConfig,
        options: {
            // Here go the PivotGrid properties
        }
    });
});

import PivotGrid, { Properties } from "devextreme/ui/pivot_grid";
// ...
export class AppComponent {
    constructor () {
        const devicesConfig = [
            { deviceType: 'desktop' },
            { deviceType: 'tablet' },
            { deviceType: 'phone' },
        ];

        devicesConfig.forEach(deviceConfig => {
            PivotGrid.defaultOptions<Properties>({
                device: deviceConfig,
                options: {
                    // Here go the PivotGrid properties
                }
            });
        });
    }
}

<template>
    <div>
        <DxPivotGrid />
    </div>
</template>
<script>
import DxPivotGrid from "devextreme-vue/pivot-grid";
import PivotGrid from "devextreme/ui/pivot_grid";

const devicesConfig = [
    { deviceType: 'desktop' },
    { deviceType: 'tablet' },
    { deviceType: 'phone' },
];

devicesConfig.forEach(deviceConfig => {
    PivotGrid.defaultOptions({
        device: deviceConfig,
        options: {
            // Here go the PivotGrid properties
        }
    });
});

export default {
    components: {
        DxPivotGrid
    }
}
</script>

import dxPivotGrid from "devextreme/ui/pivot_grid";
import PivotGrid from "devextreme-react/pivot-grid";

const devicesConfig = [
    { deviceType: 'desktop' },
    { deviceType: 'tablet' },
    { deviceType: 'phone' },
];

devicesConfig.forEach(deviceConfig => {
    dxPivotGrid.defaultOptions({
        device: deviceConfig,
        options: {
            // Here go the PivotGrid properties
        }
    });
});

export default function App() {
    return (
        <div>
            <PivotGrid />
        </div>
    )
}

Disposes of all the resources allocated to the PivotGrid instance.

After calling this method, remove the DOM element associated with the UI component:

$("#myPivotGrid").dxPivotGrid("dispose");
$("#myPivotGrid").remove();

Use conditional rendering instead of this method:

<dx-pivot-grid ...
    *ngIf="condition">
</dx-pivot-grid>

Use conditional rendering instead of this method:

<template>
    <DxPivotGrid ...
        v-if="condition">
    </DxPivotGrid>
</template>

<script>
import DxPivotGrid from 'devextreme-vue/pivot-grid';

export default {
    components: {
        DxPivotGrid
    }
}
</script>

Use conditional rendering instead of this method:

import React from 'react';

import PivotGrid from 'devextreme-react/pivot-grid';

function DxPivotGrid(props) {
    if (!props.shouldRender) {
        return null;
    }

    return (
        <PivotGrid ... >    
        </PivotGrid>
    );
}

class App extends React.Component {
    render() {
        return (
            <DxPivotGrid shouldRender="condition" />
        );
    }
}
export default App;

Gets the root UI component element.

Refreshes the UI component after a call of the beginUpdate() method.

The beginUpdate() and endUpdate() methods reduce the number of renders in cases where extra rendering can negatively affect performance.

Sets focus on the UI component.

Gets the PivotGridDataSource instance.

This method is commonly used to link the pivot grid with the PivotGridFieldChooser UI component.

Gets the Popup instance of the field chooser window.

Use this method to show and hide the field chooser window programmatically. The code below demonstrates how you can display the field chooser from code.

pivotGrid.getFieldChooserPopup().show();

Gets the instance of a UI component found using its DOM node.

The UI component's container.

The UI component's instance.

getInstance is a static method that the UI component class supports. The following code demonstrates how to get the PivotGrid instance found in an element with the myPivotGrid ID:

// Modular approach
import PivotGrid from "devextreme/ui/pivot_grid";
...
let element = document.getElementById("myPivotGrid");
let instance = PivotGrid.getInstance(element) as PivotGrid;

// Non-modular approach
let element = document.getElementById("myPivotGrid");
let instance = DevExpress.ui.dxPivotGrid.getInstance(element);

• 3rd-Party Frameworks Integration API

Gets the UI component's instance. Use it to access other methods of the UI component.

This UI component's instance.

Detaches all event handlers from a single event.

The object for which this method is called.

Detaches a particular event handler from a single event.

The event's name.

The event's handler.

The object for which this method is called.

Subscribes to an event.

The event's name.

The event's handler.

The object for which this method is called.

Use this method to subscribe to one of the events listed in the Events section.

Subscribes to events.

Events with their handlers: { "eventName1": handler1, "eventName2": handler2, ...}

The object for which this method is called.

Use this method to subscribe to several events with one method call. Available events are listed in the Events section.

Gets the value of a single property.

The property's name or full path.

Return Value: any

This property's value.

Updates the value of a single property.

The property's name or full path.

optionValue: any

This property's new value.

Updates the values of several properties.

Options with their new values.

Renders the component again without reloading data. Use the method to update the component's markup and appearance dynamically.

Resets a property to its default value.

Updates the UI component to the size of its content.

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4