React Sparkline Methods

This section describes the methods that can be used in code to manipulate objects related to the Bullet UI component.

beginUpdate()

Prevents the UI component from refreshing until the endUpdate() method is called.

The beginUpdate() and endUpdate() methods prevent the UI component from excessive updates when you are changing multiple UI component settings at once. After the beginUpdate() method is called, the UI component does not update its UI until the endUpdate() method is called.

jQuery

Call Methods

Angular

Call Methods

Vue

Call Methods

React

Call Methods

dispose()

Disposes of all the resources allocated to the Sparkline instance.

jQuery

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

JavaScript

$("#mySparkline").dxSparkline("dispose");
$("#mySparkline").remove();

Angular

Use conditional rendering instead of this method:

app.component.html

<dx-sparkline ...
    *ngIf="condition">
</dx-sparkline>

Vue

Use conditional rendering instead of this method:

App.vue

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

<script>
import DxSparkline from 'devextreme-vue/sparkline';

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

React

Use conditional rendering instead of this method:

App.js

import React from 'react';

import Sparkline from 'devextreme-react/sparkline';

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

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

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

element()

Gets the root UI component element.

Return Value:

HTMLElement | jQuery

An HTML element or a jQuery element when you use jQuery.

jQuery

Call Methods

Angular

Call Methods

Vue

Call Methods

React

Call Methods

endUpdate()

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

Main article: beginUpdate()

jQuery

Call Methods

Angular

Call Methods

Vue

Call Methods

React

Call Methods

exportTo(fileName, format)

Exports the UI component.

Parameters:

fileName:

String

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

format:

String

The file's format. One of 'PNG', 'PDF', 'JPEG', 'SVG' and 'GIF'.
PNG is used if the browser does not support exporting to the specified format.

getDataSource()

Gets the DataSource instance.

Return Value:

DataSource

The DataSource instance.

NOTE

This method returns the DataSource instance even if the UI component's dataSource property was given a simple array.

jQuery

Call Methods

Angular

Call Methods

Vue

Call Methods

React

Call Methods

getInstance(element)

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

Parameters:

element:

DOM Node

|

jQuery

The UI component's container.

Return Value:

Object

The UI component's instance.

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

// Modular approach
import Sparkline from "devextreme/viz/sparkline";
...
let element = document.getElementById("mySparkline");
let instance = Sparkline.getInstance(element) as Sparkline;

// Non-modular approach
let element = document.getElementById("mySparkline");
let instance = DevExpress.viz.dxSparkline.getInstance(element);