RetroSearch Browse

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

Showing content from https://js.devexpress.com/Documentation/ApiReference/UI_Components/dxChart/Configuration/ below:

Vue Chart Props | Vue Documentation

This section describes properties that configure the contents, behavior and appearance of the Chart UI component.

Specifies adaptive layout properties.

Selector: DxAdaptiveLayout

Type: viz/chart_components/base_chart:BaseChartAdaptiveLayout

Specifies whether to adjust the value axis's visualRange when the argument axis is being zoomed or panned.

Selector: adjust-on-zoom

Default Value: true

When a user zooms or pans the argument axis, the range of displayed series values changes accordingly. To display this entire range without unused space on the value axis, the value axis's visual range gets widened or narrowed.

Set this property to false if the visual range should be constant and equal to the series values' maximum range.

See Also

zoomAndPan

Specifies animation properties.

The UI component animates its elements at the beginning of its lifetime and when the data source changes.

If multiple charts on the page do not fit in the window, the animation may not work smoothly.

Disable

the animation or adjust the markup to fit the charts.

jQuery

$(function() {
    $("#chartContainer").dxChart({
        // ...
        animation: {
            easing: "linear",
            duration: 500,
            maxPointCountSupported: 100
        }
    });
});

Angular

<dx-chart ... >
    <dxo-animation
        easing="linear"
        [duration]="500"
        [maxPointCountSupported]="100">
    </dxo-animation>
</dx-chart>

import { Component } from '@angular/core';

@Component({
    selector: 'app-root',
    templateUrl: './app.component.html',
    styleUrls: ['./app.component.css']
})
export class AppComponent {
    // ...
}

import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';
import { AppComponent } from './app.component';

import { DxChartModule } from 'devextreme-angular';

@NgModule({
    declarations: [
        AppComponent
    ],
    imports: [
        BrowserModule,
        DxChartModule
    ],
    providers: [ ],
    bootstrap: [AppComponent]
})
export class AppModule { }

Vue

<template>
    <DxChart ... >
        <DxAnimation
            easing="linear"
            :duration="500"
            :max-point-count-supported="100"
        />
    </DxChart>
</template>

<script>
import 'devextreme/dist/css/dx.light.css';

import DxChart, {
    DxAnimation
} from 'devextreme-vue/chart';

export default {
    components: {
        DxChart,
        DxAnimation
    },
    // ...
}
</script>

React

import React from 'react';

import 'devextreme/dist/css/dx.light.css';

import Chart, {
    Animation 
} from 'devextreme-react/chart';

class App extends React.Component {
    render() {
        return (
            <Chart ... >
                <Animation
                    easing="linear"
                    duration={500}
                    maxPointCountSupported={100}
                />
            </Chart>
        );
    }
}
export default App;

Specifies the annotation collection.

Annotations are containers for images, text blocks, and custom content that display additional information about the visualized data.

To create annotations, assign an array of objects to the annotations[] property. Each object configures an individual annotation. You can set each annotation's type property to "text", "image", or "custom". Depending on the type, specify the annotation's text, image, template property:

jQuery

$(function() {
    $("#chartContainer").dxChart({
        annotations: [{
            type: "text",
            text: "Annotation text"
        }, {
            type: "image",
            image: "http://image/url/myimage.png"
        }, {
            type: "custom",
            template: function(annotation) {
                const data = annotation.data;
                const $svg = $("<svg>");
                // ...
                // Customize the annotation's markup here
                // ...
                return $svg;
            }
        }]
    });
});

Angular

<dx-chart ... >
    <dxi-annotation
        type="text"
        text="Annotation text">
    </dxi-annotation>
    <dxi-annotation
        type="image"
        image="http://image/url/myimage.png">
    </dxi-annotation>
    <dxi-annotation
        type="custom"
        template="custom-annotation">
    </dxi-annotation>
    <svg *dxTemplate="let annotation of 'custom-annotation'">
        <!-- Declare custom SVG markup here -->
    </svg>
</dx-chart>

import { Component } from '@angular/core';
@Component({
    selector: 'app-root',
    templateUrl: './app.component.html',
    styleUrls: ['./app.component.css']
})
export class AppComponent {
    // ...
}

import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';
import { AppComponent } from './app.component';

import { DxChartModule } from 'devextreme-angular';

@NgModule({
    declarations: [
        AppComponent
    ],
    imports: [
        BrowserModule,
        DxChartModule
    ],
    providers: [ ],
    bootstrap: [AppComponent]
})
export class AppModule { }

Vue

<template>
    <DxChart ... >
        <DxAnnotation
            type="text"
            text="Annotation text"
        />
        <DxAnnotation
            type="image"
            image="http://image/url/myimage.png"
        />
        <DxAnnotation
            type="custom"
            template="custom-annotation"
        />
        <template #custom-annotation="{ data }">
            <svg>
                <!-- Declare custom SVG markup here -->
            </svg>
        </template>
    </DxChart>
</template>

<script>
import DxChart, {
    DxAnnotation
} from 'devextreme-vue/chart';

export default {
    components: {
        DxChart,
        DxAnnotation
    },
    data() {
        // ...
    }
}
</script>

React

import React from 'react';

import Chart, {
    Annotation
} from 'devextreme-react/chart';

function CustomAnnotation(annotation) {
    const data = annotation.data;
    return (
        <svg>
            {/* Declare custom SVG markup here */}
        </svg>
    );
}

export default function App() {
    return (
        <Chart ... >
            <Annotation
                type="text"
                text="Annotation text"
            />
            <Annotation
                type="image"
                image="http://image/url/myimage.png"
            />
            <Annotation
                type="custom"
                render={CustomAnnotation}
            />
        </Chart>
    );
}

Annotations can be unattached or anchored to a chart element. The following list shows how to position them. Chart coordinates (argument, value, axis, series) specify the element that the annotation's arrow points to; pixel coordinates (x and y) specify the position of the annotation's center.

Unanchored annotation

annotations: [{
    x: 100,
    y: 200
}]

Annotation anchored to a chart coordinate

annotations: [{
    argument: new Date(2019, 1, 16),
    value: 15,
    axis: "Value axis 2" // in a chart with multiple value axes
}]

Annotation anchored to a series point

annotations: [{
    argument: new Date(2019, 1, 16),
    series: "Series 1"
}]

Annotation displayed on an axis

annotations: [{ 
    // An annotation on the argument axis 
    argument: new Date(2019, 1, 16)
}, { 
    // An annotation on the value axis 
    value: 15,  
    axis: "Value axis 2" // in a chart with multiple value axes
}]

Mixed anchoring (pixel and chart coordinates used simultaneously)

annotations: [{
    argument: new Date(2019, 1, 16),
    y: 200
}]

When a user long-presses an annotation or hovers the mouse pointer over it, the Chart displays a tooltip.

Objects in the annotations[] array configure individual annotations. To specify properties common for all annotations, use the commonAnnotationSettings object. Individual settings take precedence over common settings.

View Demo

See Also

customizeAnnotation

Configures the argument axis.

The argumentAxis object, which is described here, configures the argument axis individually. To specify common settings for all axes in a chart, use the commonAxisSettings object. Axis-specific settings override common settings.

Specifies whether to hide series point markers automatically to reduce visual clutter.

Selector: auto-hide-point-markers

Default Value: true

Point markers are hidden when:

In a single-series chart, at least half of all point markers overlap adjacent markers.
In a multi-series chart, all point markers of a series overlap adjacent markers and other series markers.

The following image demonstrates the effect of autoHidePointMarkers:

false
true

See Also

series.aggregation

Controls the padding and consequently the width of a group of bars with the same argument using relative units. Ignored if the barGroupWidth property is set.

Selector: bar-group-padding

Default Value: 0.3

This member is exposed by the following entities

This property accepts a value from 0 to 1 that specifies the correlation between the empty space on a bar group's sides and the group's width: 0 - the bar group occupies the whole allocated space; 1 - virtually hides the bar group creating a lot of empty space.

See Also

Specifies a fixed width for groups of bars with the same argument, measured in pixels. Takes precedence over the barGroupPadding property.

Selector: bar-group-width

Default Value: undefined

This member is exposed by the following entities

A bar's maximum width is limited. In single-series charts, it cannot be greater than the interval between two major ticks. In multi-series charts, it depends on the number of bars in the parent group and this group's actual width. See the Specify the Bar Width article for more information.

See Also

barWidth

Specifies settings common for all annotations in the chart.

Selector: DxCommonAnnotationSettings

Settings specified here can be ignored in favor of individual annotation settings specified in the annotations[] array. Refer to the array's description for information on how to configure annotations.

The following code shows the commonAnnotationSettings declaration syntax:

jQuery

$(function() {
    $("#chartContainer").dxChart({
        // ...
        commonAnnotationSettings: {
            tooltipEnabled: false
        }
    });
});

Angular

<dx-chart ... >
    <dx-common-annotation-settings
        [tooltipEnabled]="false">
    </dx-common-annotation-settings>
</dx-chart>

import { Component } from '@angular/core';

@Component({
    selector: 'app-root',
    templateUrl: './app.component.html',
    styleUrls: ['./app.component.css']
})
export class AppComponent {
    // ...
}

import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';
import { AppComponent } from './app.component';

import { DxChartModule } from 'devextreme-angular';

@NgModule({
    declarations: [
        AppComponent
    ],
    imports: [
        BrowserModule,
        DxChartModule
    ],
    providers: [ ],
    bootstrap: [AppComponent]
})
export class AppModule { }

Vue

<template>
    <DxChart ... >
        <DxCommonAnnotationSettings
            :tooltip-enabled="false"
        />
    </DxChart>
</template>

<script>
import DxChart, {
    DxCommonAnnotationSettings
} from 'devextreme-vue/chart';

export default {
    components: {
        DxChart,
        DxCommonAnnotationSettings
    },
    data() {
        // ...
    }
}
</script>

React

import React from 'react';
import Chart, {
    CommonAnnotationSettings
} from 'devextreme-react/chart';

class App extends React.Component {
    render() {
        return (
            <Chart ... >
                <CommonAnnotationSettings
                    tooltipEnabled={false}
                />
            </Chart>
        );
    }
}
export default App;

View Demo

See Also

customizeAnnotation

Defines common settings for both the argument and value axis in a chart.

Selector: DxCommonAxisSettings

The commonAxisSettings object, which is described here, specifies common settings for all axes in a chart. To configure a particular axis, use the argumentAxis or valueAxis object. Axis-specific settings override common settings.

Defines common settings for all panes in a chart.

Selector: DxCommonPaneSettings

A pane is a chart area containing series. If there are many series an a chart, they can be distributed between multiple panes.

The commonPaneSettings object, which is described here, specifies common settings for all panes in the chart. To specify properties of an individual pane, use the objects of the panes array. Individual settings override common settings.

Specifies settings common for all series in the chart.

Selector: DxCommonSeriesSettings

There are three ways to configure a series.

The commonSeriesSettings object
Specifies settings for all series in a chart.
The commonSeriesSettings.%seriesType% (area, line, etc.) object
Specifies settings for all series of the seriesType.
An object in the series array
Specifies settings for an individual series.

You can use these objects together, but note that individual settings override type-specific settings, which in their turn, override common settings.

Specifies background color of the chart container.

Selector: container-background-color

Default Value: '#FFFFFF'

A chart container is a <div> element that contains a Chart control. Certain Chart elements, such as series points in hovered state, have the same color as the container's background color. You may need to change this property value if your page's background color differs from white. Assign this color to the containerBackgroundColor property to ensure that the color of Chart elements is consistent with your page.

If you need to define a background color for the Chart, you can use the elementAttr property to assign a custom CSS class with a defined background color.

See Also

panes.backgroundColor - colors the background of the chart plot.

Configures the crosshair feature.

Crosshair is a pointer represented by two mutually-crossing lines stretched over the entire chart plot. The crosshair helps a user identify the values of the series points precisely. When enabled, the crosshair follows the cursor and snaps to the nearest series point.

To enable the crosshair, set the crosshair.enabled property to true. Assign true to the crosshair.label.visible property as well to make the crosshair labels visible.

Settings specified in the crosshair object apply to both the crosshair lines. If you specify the same settings within the horizontalLine or verticalLine object, they will apply to the particular crosshair line only. Note that individual settings override common ones.

View Demo

Customizes an individual annotation.

Selector: customize-annotation

Function parameters:

The annotation before customizations.

The annotation after customizations.

Default Value: undefined

Cannot be used in themes.

The following code shows how to use the customizeAnnotation function to apply different settings to text and image annotations:

jQuery

$(function() {
    $("#chartContainer").dxChart({
        // ...
        customizeAnnotation: function(annotationItem) {
            if(annotationItem.text) {
                annotationItem.color = "red";
            }
            if(annotationItem.image) {
                annotationItem.color = "blue";
            }
            return annotationItem;
        }
    });
});

Angular

<dx-chart ...
    [customizeAnnotation]="customizeAnnotation">
</dx-chart>

// ...
export class AppComponent {
    customizeAnnotation(annotationItem) {
        if(annotationItem.text) {
            annotationItem.color = "red";
        }
        if(annotationItem.image) {
            annotationItem.color = "blue";
        }
        return annotationItem;
    }
}

import { DxChartModule } from 'devextreme-angular';
// ...
@NgModule({
    imports: [
        // ...
        DxChartModule
    ],
    // ...
})
export class AppModule { }

Vue

<template> 
    <DxChart ...
        :customize-annotation="customizeAnnotation">
    </DxChart>
</template>

<script>
import DxChart from 'devextreme-vue/chart';

export default {
    components: {
        DxChart
    },
    methods: {
        customizeAnnotation(annotationItem) {
            if(annotationItem.text) {
                annotationItem.color = "red";
            }
            if(annotationItem.image) {
                annotationItem.color = "blue";
            }
            return annotationItem;
        }
    }
}
</script>

React

import React from 'react';
import Chart from 'devextreme-react/chart';

export default function App() {
    const customizeAnnotation = (annotationItem) => {
        if(annotationItem.text) {
            annotationItem.color = "red";
        }
        if(annotationItem.image) {
            annotationItem.color = "blue";
        }
        return annotationItem;
    }

    return (
        <Chart ...
            customizeAnnotation={customizeAnnotation}>
        </Chart>
    );
}

ASP.NET MVC Controls

@(Html.DevExtreme().Chart()
    @* ... *@
    .CustomizeAnnotation("customizeAnnotation")
)

<script type="text/javascript">
    function customizeAnnotation(annotationItem) {
        if(annotationItem.text) {
            annotationItem.color = "red";
        }
        if(annotationItem.image) {
            annotationItem.color = "blue";
        }
        return annotationItem;
    }
</script>

See Also

Customizes the appearance of an individual point label.

Selector: customize-label

Function parameters:

Information on the series point.

All point labels in a chart are identical by default, but you can specify a unique appearance for individual labels using the customizeLabel function. This function should return an object with properties that will be changed for a certain label. See the label object for information about all properties available for changing.

The customizeLabel function accepts an object providing information about the series point that the label belongs to. This object contains the following fields.

Field Description argument The argument of the series point. value The value of the series point. tag The tag of the series point. series The series that includes the series point. index The index of the series point in the points array. data An object that contains the series point data.

In the range bar and range area series, the value field is replaced by the following fields.

Field Description rangeValue1 The first value of the series point. rangeValue2 The second value of the series point.

In the financial series (candlestick and stock), the value field is replaced by the following fields.

Field Description openValue The open value of the series point. closeValue The close value of the series point. lowValue The low value of the series point. highValue The high value of the series point. reductionValue The reduction value of the series point.

All fields listed in this description are also exposed by the this object.

View Demo

Customizes the appearance of an individual series point.

Selector: customize-point

Function parameters:

Information on the series point.

By default, all series points in a chart are identical, but you can specify a unique appearance for individual points using the customizePoint function. This function should return an object with properties that will be changed for a certain point. See the point object for information about all properties available for changing.

The hoverMode and selectionMode properties cannot be changed using the customizePoint function, because they do not have anything to do with the appearance of series points.

The customizePoint function accepts an object providing information about the series point. This object contains the following fields.

Field Description argument The argument of the series point. value The value of the series point. tag The tag of the series point. seriesName The name of the series that includes the series point. index The index of the series point in the points array. data An object that contains the series point data.

In the range bar and range area series, the value field is replaced by the following fields.

Field Description rangeValue1 The first value of the series point. rangeValue2 The second value of the series point.

In the financial series (candlestick and stock), the value field is replaced by the following fields.

As an alternative to the function’s parameter you can use the this keyword.

View Demo View on GitHub

Processes data before visualizing it.

Selector: DxDataPrepareSettings

The following code shows the dataPrepareSettings declaration syntax:

jQuery

$(function() {
    $("#chartContainer").dxChart({
        // ...
        dataPrepareSettings: {
            sortingMethod: false
        }
    });
});

Angular

<dx-chart ... >
    <dxo-data-prepare-settings
        [sortingMethod]="false">
    </dxo-data-prepare-settings>
</dx-chart>

import { Component } from '@angular/core';

@Component({
    selector: 'app-root',
    templateUrl: './app.component.html',
    styleUrls: ['./app.component.css']
})
export class AppComponent {
    // ...
}

import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';
import { AppComponent } from './app.component';

import { DxChartModule } from 'devextreme-angular';

@NgModule({
    declarations: [
        AppComponent
    ],
    imports: [
        BrowserModule,
        DxChartModule
    ],
    providers: [ ],
    bootstrap: [AppComponent]
})
export class AppModule { }

Vue

<template>
    <DxChart ... >
        <DxDataPrepareSettings
            :sorting-method="false"
        />
    </DxChart>
</template>

<script>
import 'devextreme/dist/css/dx.light.css';

import DxChart, {
    DxDataPrepareSettings 
} from 'devextreme-vue/chart';

export default {
    components: {
        DxChart,
        DxDataPrepareSettings
    },
    data() {
        // ...
    }
}
</script>

React

import React from 'react';

import 'devextreme/dist/css/dx.light.css';

import Chart, {
    DataPrepareSettings 
} from 'devextreme-react/chart';

class App extends React.Component {
    render() {
        return (
            <Chart ... >
                <DataPrepareSettings
                    sortingMethod={false}
                />
            </Chart>
        );
    }
}
export default App;

Binds the UI component to data.

Selector: data-source

Cannot be used in themes.

The Chart works with collections of objects.

Depending on your data source, bind Chart to data as follows.

Data Array
Assign the array to the dataSource option. View Demo
Read-Only Data in JSON Format
Set the dataSource property to the URL of a JSON file or service that returns JSON data. View Demo
OData
Implement an ODataStore.

Web API, PHP, MongoDB
Use one of the following extensions to enable the server to process data according to the protocol DevExtreme UI components use:

Then, use the createStore method to configure access to the server on the client as shown below. This method is part of DevExtreme.AspNet.Data.

jQuery

$(function() {
    let serviceUrl = "https://url/to/my/service";
    $("#chartContainer").dxChart({
        // ...
        dataSource: DevExpress.data.AspNet.createStore({
            key: "ID",
            loadUrl: serviceUrl + "/GetAction",
            insertUrl: serviceUrl + "/InsertAction",
            updateUrl: serviceUrl + "/UpdateAction",
            deleteUrl: serviceUrl + "/DeleteAction"
        })
    })
});

Angular

import { Component } from '@angular/core';
import CustomStore from 'devextreme/data/custom_store';
import { createStore } from 'devextreme-aspnet-data-nojquery';

@Component({
    selector: 'app-root',
    templateUrl: './app.component.html',
    styleUrls: ['./app.component.css']
})
export class AppComponent {
    store: CustomStore;
    constructor() {
        let serviceUrl = "https://url/to/my/service";
        this.store = createStore({
            key: "ID",
            loadUrl: serviceUrl + "/GetAction",
            insertUrl: serviceUrl + "/InsertAction",
            updateUrl: serviceUrl + "/UpdateAction",
            deleteUrl: serviceUrl + "/DeleteAction"
        })
    }
}

<dx-chart ...
    [dataSource]="store">
</dx-chart>

import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';
import { AppComponent } from './app.component';

import { DxChartModule } from 'devextreme-angular';

@NgModule({
    declarations: [
        AppComponent
    ],
    imports: [
        BrowserModule,
        DxChartModule
    ],
    providers: [],
    bootstrap: [AppComponent]
})
export class AppModule { }

Vue

<template> 
    <DxChart ...
        :data-source="store" />
</template>

<script>
import 'devextreme/dist/css/dx.light.css';

import CustomStore from 'devextreme/data/custom_store';
import { createStore } from 'devextreme-aspnet-data-nojquery';
import { DxChart } from 'devextreme-vue/chart';

export default {
    components: {
        DxChart
    },
    data() {
        const serviceUrl = "https://url/to/my/service";
        const store = createStore({
            key: "ID",
            loadUrl: serviceUrl + "/GetAction",
            insertUrl: serviceUrl + "/InsertAction",
            updateUrl: serviceUrl + "/UpdateAction",
            deleteUrl: serviceUrl + "/DeleteAction"
        });
        return {
            store
        }
    }
}
</script>

React

import React from 'react';
import 'devextreme/dist/css/dx.light.css';

import CustomStore from 'devextreme/data/custom_store';
import { createStore } from 'devextreme-aspnet-data-nojquery';
import Chart from 'devextreme-react/chart';

const serviceUrl = "https://url/to/my/service";
const store = createStore({
    key: "ID",
    loadUrl: serviceUrl + "/GetAction",
    insertUrl: serviceUrl + "/InsertAction",
    updateUrl: serviceUrl + "/UpdateAction",
    deleteUrl: serviceUrl + "/DeleteAction"
});

class App extends React.Component {
    render() {
        return (
            <Chart ...
                dataSource={store} />
        );
    }
}
export default App;

Any other data source
Implement a CustomStore.

Regardless of the data source on the input, the Chart always wraps it in the DataSource object. This object allows you to sort, filter, group, and perform other data shaping operations. To get its instance, call the getDataSource() method.

After providing data, bind series to it.

Review the following notes about data binding:

If you wrap the store into the DataSource object explicitly, set the paginate property to false to prevent data from partitioning.
Field names cannot be equal to this and should not contain the following characters: ., :, [, and ].
Chart does not execute dataSource.sort functions. To implement custom sorting logic, implement columns[].calculateSortValue.

jQuery

The stores are immutable. You cannot change their configurations at runtime. Instead, create a new store or DataSource and assign it to the dataSource property as shown in the following help topic: Get and Set Properties.

Angular

The stores are immutable. You cannot change their configurations at runtime. Instead, create a new store or DataSource and assign it to the dataSource property as shown in the following help topic: Two-Way Property Binding.

Vue

The stores are immutable. You cannot change their configurations at runtime. Instead, create a new store or DataSource and assign it to the dataSource property as shown in the following help topic: Two-Way Property Binding.

React

The stores are immutable. You cannot change their configurations at runtime. Instead, create a new store or DataSource and assign it to the dataSource property as shown in the following help topic: Controlled Mode.

Specifies which pane should be used by default.

Selector: default-pane

Default Value: undefined

Cannot be used in themes.

This property accepts the name of a pane from the panes array. The default pane displays all series with unspecified pane property. If defaultPane is undefined, the last pane in the panes array becomes the default.

Specifies whether the UI component responds to user interaction.

Default Value: false

Cannot be used in themes.

Specifies the global attributes to be attached to the UI component's container element.

Selector: DxElementAttr

Default Value: {}

jQuery

$(function(){
    $("#chartContainer").dxChart({
        // ...
        elementAttr: {
            id: "elementId",
            class: "class-name"
        }
    });
});

Angular

<dx-chart ...
    [elementAttr]="{ id: 'elementId', class: 'class-name' }">
</dx-chart>

import { DxChartModule } from "devextreme-angular";
// ...
export class AppComponent {
    // ...
}
@NgModule({
    imports: [
        // ...
        DxChartModule
    ],
    // ...
})

Vue

<template>
    <DxChart ...
        :element-attr="chartAttributes">
    </DxChart>
</template>

<script>
import DxChart from 'devextreme-vue/chart';

export default {
    components: {
        DxChart
    },
    data() {
        return {
            chartAttributes: {
                id: 'elementId',
                class: 'class-name'
            }
        }
    }
}
</script>

React

import React from 'react';

import Chart from 'devextreme-react/chart';

class App extends React.Component {
    chartAttributes = {
        id: 'elementId',
        class: 'class-name'
    }

    render() {
        return (
            <Chart ...
                elementAttr={this.chartAttributes}>
            </Chart>
        );
    }
}
export default App;

Configures the exporting and printing features.

Selector: DxExport

Type: viz/core/base_widget:BaseWidgetExport

Specifies the properties of a chart's legend.

The Chart UI component can include a legend - an explanatory component that helps you identify a series. Each series is represented by an item on a Legend. An item marker identifies the series color. An item label displays the series title. To set the required position for a legend and its items, to customize the font settings for item labels, and to specify the size of item markers, use the properties of the legend configuration object. To learn more on the legend and its properties, refer to the Legend topic.

Configures the loading indicator.

Selector: DxLoadingIndicator

Type: viz/core/base_widget:BaseWidgetLoadingIndicator

When the UI component is bound to a remote data source, it can display a loading indicator while data is loading.

To enable the automatic loading indicator, set the enabled property to true.

If you want to change the loading indicator's visibility, use the show property or the showLoadingIndicator() and hideLoadingIndicator() methods.

Generates space around the UI component.

Selector: DxMargin

Type: viz/core/base_widget:BaseWidgetMargin

jQuery

$(function() {
    $("#chartContainer").dxChart({
        // ...
        margin: {
            top: 20,
            bottom: 20,
            left: 30,
            right: 30
        }
    });
});

Angular

<dx-chart ... >
    <dxo-margin
        [top]="20"
        [bottom]="20"
        [left]="30"
        [right]="30">
    </dxo-margin>
</dx-chart>

import { Component } from '@angular/core';

@Component({
    selector: 'app-root',
    templateUrl: './app.component.html',
    styleUrls: ['./app.component.css']
})
export class AppComponent {
    // ...
}

import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';
import { AppComponent } from './app.component';

import { DxChartModule } from 'devextreme-angular';

@NgModule({
    declarations: [
        AppComponent
    ],
    imports: [
        BrowserModule,
        DxChartModule
    ],
    providers: [ ],
    bootstrap: [AppComponent]
})
export class AppModule { }

Vue

<template>
    <DxChart ... >
        <DxMargin
            :top="20"
            :bottom="20"
            :left="30"
            :right="30"
        />
    </DxChart>
</template>

<script>
import 'devextreme/dist/css/dx.light.css';

import DxChart, {
    DxMargin 
} from 'devextreme-vue/chart';

export default {
    components: {
        DxChart,
        DxMargin
    },
    // ...
}
</script>

React

import React from 'react';

import 'devextreme/dist/css/dx.light.css';

import Chart, {
    Margin 
} from 'devextreme-react/chart';

class App extends React.Component {
    render() {
        return (
            <Chart ... >
                <Margin
                    top={20}
                    bottom={20}
                    left={30}
                    right={30}
                />
            </Chart>
        );
    }
}
export default App;

Specifies a coefficient determining the diameter of the largest bubble.

Selector: max-bubble-size

Default Value: 0.2

This member is exposed by the following entities

When defining a bubble series, you are required to specify a size field. The largest size value will be represented on the chart by the largest bubble. Its visual diameter will be calculated by the following formula.

d = maxBubbleSize * min(height, width)

Normally, the height and width from this formula equal the size of the UI component container. However, when several panes are used in the UI component, the height and width equal the pane size.

Specifies the diameter of the smallest bubble measured in pixels.

Selector: min-bubble-size

Default Value: 12

This member is exposed by the following entities

When defining a bubble series, you are required to specify a size field. The smallest size value will be represented on the chart by the smallest bubble. To set its visual diameter, specify the minBubbleSize property.

Forces the UI component to treat negative values as zeroes. Applies to stacked-like series only.

Selector: negatives-as-zeroes

Default Value: false

This member is exposed by the following entities

Oftentimes, series data contains negative values. Visualizing such data using stacked-like series may lead to unexpected results. To prevent situations of this kind, assign true to the negativesAsZeroes property, and the UI component will count all negative values as zeroes.

A function that is executed when a label on the argument axis is clicked or tapped.

Selector: @argument-axis-click

Function parameters:

Information about the event.

Object structure:

Default Value: null

Cannot be used in themes.

A function that is executed before the UI component is disposed of.

Selector: @disposing

Function parameters:

Information about the event.

Object structure:

Default Value: null

A function that is executed when all series are ready.

Selector: @done

Function parameters:

Information about the event.

Object structure:

Default Value: null

Cannot be used in themes.

A function that is executed when the UI component's rendering has finished.

Selector: @drawn

Function parameters:

Information about the event.

Object structure:

Default Value: null

Cannot be used in themes.

A function that is executed after the UI component is exported.

Selector: @exported

Function parameters:

Information about the event.

Object structure:

Default Value: null

A function that is executed before the UI component is exported.

Selector: @exporting

Function parameters:

Information about the event.

Object structure:

Name Type Description format

String

The resulting file format. One of PNG, PDF, JPEG, SVG and GIF.

fileName

String

The name of the file to which the UI component is about to be exported.

element

HTMLElement | jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.

component

Chart

The UI component's instance.

Default Value: null

A function that is executed before a file with exported UI component is saved to the user's local storage.

Selector: @file-saving

Function parameters:

Information about the event.

Object structure:

Name Type Description format

String

The format of the file to be saved.
Possible Values: 'PNG' | 'PDF' | 'JPEG' | 'SVG' | 'GIF'

fileName

String

The name of the file to be saved.

element

HTMLElement | jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.

data

BLOB

Exported data as a BLOB.

component

Chart

The UI component's instance.

cancel

Boolean

Allows you to prevent file saving.

Default Value: null

A function that is executed when an error or warning occurs.

Selector: @incident-occurred

Function parameters:

Information about the event.

Object structure:

Default Value: null

The UI component notifies you of errors and warnings by passing messages to the browser console. Each message contains the incident's ID, a brief description, and a link to the Errors and Warnings section where further information about this incident can be found.

The onIncidentOccurred function allows you to handle errors and warnings the way you require. The object passed to it contains the target field. This field provides information about the occurred incident and contains the following properties:

id
The incident's ID. The full list of IDs can be found in the Errors and Warnings section.
type
The incident's type: "error" or "warning".
args
The argument of the incident's message. Depends on the incident. For example, it may be the name of the data source field that was specified incorrectly, or the name of the property that was not set properly.
text
The text passed to the browser's console. Includes the args content, if there is any.
widget
The name of the UI component that produced the error or warning.
version
The used DevExtreme version.

A function used in JavaScript frameworks to save the UI component instance.

Selector: @initialized

Function parameters:

Information about the event.

Object structure:

Default Value: null

Angular

<dx-chart ...
    (onInitialized)="saveInstance($event)">
</dx-chart>

import { Component } from "@angular/core";
import Chart from "devextreme/ui/data_grid";
// ...
export class AppComponent {
    chartInstance: Chart;
    saveInstance (e) {
        this.chartInstance = e.component;
    }
}

Vue

App.vue (Composition API)

<template>
    <div>
        <DxChart ...
            @initialized="saveInstance">
        </DxChart>
    </div>
</template>

<script>
import DxChart from 'devextreme-vue/chart';

export default {
    components: {
        DxChart
    },
    data: function() {
        return {
            chartInstance: null
        };
    },
    methods: {
        saveInstance: function(e) {
            this.chartInstance = e.component;
        }
    }
};
</script>

<template>
    <div>
        <DxChart ...
            @initialized="saveInstance">
        </DxChart>
    </div>
</template>

<script setup>
import DxChart from 'devextreme-vue/chart';

let chartInstance = null;

const saveInstance = (e) => {
    chartInstance = e.component;
}
</script>

React

import Chart from 'devextreme-react/chart';

class App extends React.Component {
    constructor(props) {
        super(props);

        this.saveInstance = this.saveInstance.bind(this);
    }

    saveInstance(e) {
        this.chartInstance = e.component;
    }

    render() {
        return (
            <div>
                <Chart onInitialized={this.saveInstance} />
            </div>
        );
    }
}

See Also

commonPaneSettings - specifies common settings for all panes in a chart.
series.pane - binds a series to a pane.
defaultPane - specifies which pane must be used by default.

Notifies the UI component that it is embedded into an HTML page that uses a tag modifying the path.

Selector: path-modified

Default Value: false

Cannot be used in themes.

If you place the UI component on a page that uses a tag modifying the path (<base>, <iframe>, etc.), some of the UI component elements may get mixed up or disappear. To solve this problem, set the pathModified property to true.

See Also

DevExpress.viz.refreshPaths()

Specifies whether a single point or multiple points can be selected in the chart.

Selector: point-selection-mode

Default Value: 'single'

Specifies whether to redraw the UI component when the size of the container changes or a mobile device rotates.

Selector: redraw-on-resize

Default Value: true

Cannot be used in themes.

When this property is set to true, the UI component will be redrawn automatically in case the size of its container changes.

Specifies whether panes can be resized if other chart elements require more space after zooming or panning.

Selector: resize-panes-on-zoom

Default Value: false

When users zoom the chart, axis labels can be longer. However, they are cut because their allocated space remains the same.

Enable the resizePanesOnZoom property to show the entire labels. In this case, panes are resized to allow more space for labels, and the UI component's layout is recalculated. This can make the axis shift from its position at runtime and cause an issue if you display several charts aligned side by side or under each other.

See Also

adjustOnZoom

Specifies how the chart must behave when series point labels overlap.

Selector: resolve-label-overlapping

Default Value: 'none'

Series point labels display series point values. If your chart contains several series with a large number of points in each, point labels may overlap. In this case, specify how the chart must resolve overlapping using the resolveLabelOverlapping property. To hide certain labels, set this property to 'hide'. Labels to be hidden will be determined automatically. If labels that overlap belong to series points that have the same argument, you can arrange these labels in a stack. For this purpose, set the resolveLabelOverlapping property to 'stack'.

Swaps the axes around making the value axis horizontal and the argument axis vertical.

See Also

commonAxisSettings.inverted - inverts the axes.

Switches the UI component to a right-to-left representation.

Selector: rtl-enabled

Default Value: false

Cannot be used in themes.

When this property is set to true, the UI component text flows from right to left, and the layout of elements is reversed. To switch the entire application/site to the right-to-left representation, assign true to the rtlEnabled field of the object passed to the DevExpress.config(config) method.

DevExpress.config({
    rtlEnabled: true
});

In a right-to-left representation, SVG elements have the

direction

attribute with the

rtl

value. This might cause problems when rendering left-to-right texts. Use this property if you have only right-to-left texts.

Specifies the settings of the scroll bar.

The scroll bar allows a user to pan the chart. To use it, you need to enable zooming and panning in your chart.

By default, the scroll bar is hidden. To make it visible, set the visible field of the scrollBar object to true. Using other fields of this object you can adjust the scroll bar appearance settings, including color, width and opacity.

View Demo

Specifies properties for Chart UI component series.

Selector: DxSeries

Default Value: undefined

Cannot be used in themes.

A series represents a grouping of related data points. The most important characteristic of a series is its type, which determines a particular visual representation of data. You can find more details on each series type in the corresponding topics in the Series help section.

To define a single series, assign an object defining the series to the series configuration object. In the series' object, specify the series type, data source fields, the appearance of the series points and other properties.

To show several series, specify series as an array of objects defining series. If you need to set similar values to properties of several series, use the commonSeriesSettings configuration object. It exposes the properties that can be specified for all series at once and for all series of a particular type at once. Note that the values specified for a series individually (in the series array) override the values that are specified for all series (in the commonSeriesSettings object).

This property is necessary. If you do not need to specify any of the properties within the series object (e.g., when you have specified them within the commonSeriesSettings object), assign at least an empty object to the series field.

Specifies whether a single series or multiple series can be selected in the chart.

Selector: series-selection-mode

Default Value: 'single'

To set the series elements to highlight when a series is selected, set the series selectionMode property.

View Demo

Defines properties for the series template.

Selector: DxSeriesTemplate

Default Value: undefined

Cannot be used in themes.

In most cases, you can organize the array that is assigned to the chart's dataSource property in the following way.

[
    {arg: arg1Value, series1Value: val11, series2Value: val12, ...}
    {arg: arg2Value, series1Value: val21, series2Value: val22, ...}
    ...
    {arg: argNValue, series1Value: valN1, series2Value: valN2, ...}
]

Each object that is included in the array represents an argument value and the values of all series for this argument.

However, there are some scenarios in which you do not know exactly how many series will be added. In these cases, you will not be able to define the data source in the manner detailed above. Instead, define it in the following way.

[
    {seriesName: series1, arg: arg11Value, val: value11 }
    {seriesName: series1, arg: arg12Value, val: value12 }
    ...
    {seriesName: seriesM, arg: argM1Value, val: valueM1 }
    {seriesName: seriesM, arg: argM2Value, val: valueM2 }
    ...
]

If you define a data source in this manner, set the argument and value fields using the argumentField and valueField properties of the commonSeriesSettings configuration object (for all series at once). Then, define a template for the series using the seriesTemplate configuration object. Within this object, set the data source field that specifies the series name to the nameField property.

If you need to specify individual values for properties of a particular series, assign a callback function to the customizeSeries property of the seriesTemplate object.

View Demo

Specifies the UI component's size in pixels.

Selector: DxSize

Type: viz/core/base_widget:BaseWidgetSize

Default Value: {height: 400, width: 400}

You can specify a custom width and height for the component:

Fixed Relative Assign values to the size object's height and width properties or specify a container for the component. Specify a container for the component. The component occupies the container area.

The size object has priority over the container.

Assign 0 to the size object's height and width properties to hide the component.

jQuery

$(function() {
    $("#chartContainer").dxChart({
        // ...
        size: {
            height: 300,
            width: 600
        }
    });
});

Angular

<dx-chart ... >
    <dxo-size
        [height]="300"
        [width]="600">
    </dxo-size>
</dx-chart>

import { Component } from '@angular/core';

@Component({
    selector: 'app-root',
    templateUrl: './app.component.html',
    styleUrls: ['./app.component.css']
})
export class AppComponent {
    // ...
}

import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';
import { AppComponent } from './app.component';

import { DxChartModule } from 'devextreme-angular';

@NgModule({
    declarations: [
        AppComponent
    ],
    imports: [
        BrowserModule,
        DxChartModule
    ],
    providers: [ ],
    bootstrap: [AppComponent]
})
export class AppModule { }

Vue

<template>
    <DxChart ... >
        <DxSize
            :height="300"
            :width="600"
        />
    </DxChart>
</template>

<script>

import DxChart, {
    DxSize
} from 'devextreme-vue/chart';

export default {
    components: {
        DxChart,
        DxSize
    },
    // ...
}
</script>

React

import React from 'react';

import Chart, {
    Size
} from 'devextreme-react/chart';

class App extends React.Component {
    render() {
        return (
            <Chart ... >
                <Size
                    height={300}
                    width={600}
                />
            </Chart>
        );
    }
}
export default App;

Alternatively, you can use CSS to style the UI component's container:

jQuery

$(function() {
    $("#chart").dxChart({
        // ...
    });
});

#chart {
    width: 85%;
    height: 70%;
}

Angular

<dx-chart ...
    id="chart">
</dx-chart>

#chart {
    width: 85%;
    height: 70%;
}

Vue

<template>
    <DxChart ...
        id="chart">
    </DxChart>
</template>

<script>
import DxChart from 'devextreme-vue/chart';

export default {
    components: {
        DxChart
    },
    // ...
}
</script>

<style>
#chart {
    width: 85%;
    height: 70%;
}
</style>

React

import React from 'react';

import Chart from 'devextreme-react/chart';

class App extends React.Component {
    render() {
        return (
            <Chart ...
                id="chart">
            </Chart>
        );
    }
}
export default App;

#chart {
    width: 85%;
    height: 70%;
}

Specifies whether a point should remain in the hover state when the mouse pointer moves away.

Selector: sticky-hovering

Default Value: true

When this property is true, a point remains in the hover state until the mouse pointer moves over to another point or outside the chart plot.

When this property is false, a point remains in the hover state until the mouse pointer moves away from the point.

View Demo

See Also

series.point.hoverMode

Indicates whether or not to synchronize value axes when they are displayed on a single pane.

Selector: synchronize-multi-axes

Default Value: true

When synchronized, the ticks (or grid lines) of all the value axes in a pane are located on the same line.

Sets the name of the theme the UI component uses.

Default Value: 'generic.light'

A theme is a UI component configuration that gives the UI component a distinctive appearance. You can use one of the predefined themes or create a custom one. Changing the property values in the UI component's configuration object overrides the theme's corresponding values.

Configures the UI component's title.

Selector: DxTitle

Type: viz/core/base_widget:BaseWidgetTitle

The UI component's title is a short text that usually indicates what is visualized. If you need to specify the title's text only, assign it directly to the title property. Otherwise, set this property to an object with the text and other fields specified.

The title can be accompanied by a subtitle elaborating on the visualized subject using the title.subtitle object.

View Demo

A tooltip is a miniature rectangle displaying values of a series point. A tooltip appears when the end-user hovers the cursor over a series point. You can enable/disable tooltips, change their appearance and format their text using fields of the tooltip configuration object.

View Demo

Configures the value axis.

The valueAxis object, which is described here, configures the value axis individually. To specify common settings for all axes in a chart, use the commonAxisSettings object. Axis-specific settings override common settings.

View Demo

Configures zooming and panning.

You can enable zooming and panning for the argument and value axes independently. Set the argumentAxis and valueAxis properties to enable zooming, panning, or both for a specific axis.

Users can use the mouse and touch gestures to zoom and pan. The following table illustrates user interaction:

Device Zooming Gestures Panning Gestures Touch-enabled Spread and pinch Vertical or horizontal drag Mouse-equipped Mouse Wheel Vertical or horizontal drag

You can use the allowTouchGestures or allowMouseWheel property to disable touch or mouse support.

Users can also use the mouse to zoom the chart by selecting an area with the drag gesture. Refer the dragToZoom property for more information.

Zooming and panning are related to the visual/whole range concept. Refer to the Visual and Whole Ranges article for more information.

View Demo

See Also

Zooming and Panning
onZoomStart | onZoomEnd
argumentAxis.visualRange | valueAxis.visualRange

Feel free to share topic-related thoughts here. If you have technical questions, please create a support ticket in the DevExpress Support Center. Thank you for the feedback!

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