React Bullet Props

Default Value: false

Cannot be used in themes.

elementAttr

Specifies the attributes to be attached to the widget's root element.

Type:

Default Value: {}

jQuery

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

Angular

HTML

TypeScript

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

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

ASP.NET MVC Controls

Razor C#

Razor VB

@(Html.DevExtreme().Bullet()
    .ElementAttr("class", "class-name")
    // ===== or =====
    .ElementAttr(new {
        @id = "elementId",
        @class = "class-name"
    })
    // ===== or =====
    .ElementAttr(new Dictionary<string, object>() {
        { "id", "elementId" },
        { "class", "class-name" }
    })

)

@(Html.DevExtreme().Bullet() _
    .ElementAttr("class", "class-name")
    ' ===== or =====
    .ElementAttr(New With {
        .id = "elementId",
        .class = "class-name"
    })
    ' ===== or =====
    .ElementAttr(New Dictionary(Of String, Object) From {
        { "id", "elementId" },
        { "class", "class-name" }
    })
)

endScaleValue

Specifies an end value for the invisible scale.

Type:

Default Value: undefined

Cannot be used in themes.

The primary, target and zero values of the Bullet widget are held within a range. This range is represented by an invisible scale. To specify the boundary values of this scale, set the startScaleValue and endScaleValue options.

Specify the same start and end scale values for several bullets when you display them in a column so that they can be compared visually.

margin

Generates space around the widget.

Type:

WidgetMargin DevExtreme ChartJS

jQuery

index.js

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

Angular

app.component.html

app.component.ts

app.module.ts

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

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 { DxBulletModule } from 'devextreme-angular';

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

Vue

App.vue

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

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

import DxBullet, {
    DxMargin 
} from 'devextreme-vue/bullet';

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

React

App.js

import React from 'react';

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

import Bullet, {
    Margin 
} from 'devextreme-react/bullet';

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

onDisposing

A function that is executed before the widget is disposed of.

Type:

Function parameters:

e:

Information about the event.

Object structure:

Name

Type

Description

component

The widget's instance.

element

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

model

The model data. Available only if you use Knockout.

Default Value: null

onDrawn

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

Type:

Function parameters:

e:

Information about the event.

Object structure:

Name

Type

Description

component

The widget's instance.

element

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

model

The model data. Available only if you use Knockout.

Default Value: null

Cannot be used in themes.

onExported

A function that is executed after the widget is exported.

Type:

Function parameters:

e:

Information about the event.

Object structure:

Name

Type

Description

component

The widget's instance.

element

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

model

The model data. Available only if you use Knockout.

Default Value: null

onExporting

A function that is executed before the widget is exported.

Type:

Function parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
cancel	Boolean	Allows you to prevent exporting.
component	Bullet	The widget's instance.
element	HTMLElement \| jQuery	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
fileName	String	The name of the file to which the widget is about to be exported.
format	String	The resulting file format. One of PNG, PDF, JPEG, SVG and GIF.
model	Object	The model data. Available only if you use Knockout.

Default Value: null

onFileSaving

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

Type:

Function parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
cancel	Boolean	Allows you to prevent file saving.
component	Bullet	The widget's instance.
data	BLOB	Exported data as a BLOB.
element	HTMLElement \| jQuery	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
fileName	String	The name of the file to be saved.
format	String	The format of the file to be saved. Possible Values: 'PNG' \| 'PDF' \| 'JPEG' \| 'SVG' \| 'GIF'

Default Value: null

onIncidentOccurred

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

Type:

Function parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
component	Bullet	The widget's instance.
element	HTMLElement \| jQuery	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
model	Object	The model data. Available only if you use Knockout.
target	any	Information on the occurred incident.

Default Value: null

The widget 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 option 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 widget that produced the error or warning.
version
The used DevExtreme version.

onInitialized

A function used in JavaScript frameworks to save the widget instance.

Type:

Function parameters:

e:

Information about the event.

Object structure:

Name

Type

Description

component

The widget's instance.

element

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

Default Value: null

onOptionChanged

A function that is executed after a widget option is changed.

Type:

Function parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
model	Object	The model data. Available only if you use Knockout.
fullName	String	The path to the modified option that includes all parent options.
element	HTMLElement \| jQuery	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
component	Bullet	The widget's instance.
name	String	The modified option if it belongs to the first level. Otherwise, the first-level option it is nested into.
value	any	The modified option's new value.

Default Value: null

onTooltipHidden

A function that is executed when a tooltip becomes hidden.

Type:

Function parameters:

e:

Information about the event.

Object structure:

Name

Type

Description

component

The widget's instance.

element

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

model

The model data. Available only if you use Knockout.

Default Value: null

Cannot be used in themes.

onTooltipShown

A function that is executed when a tooltip appears.

Type:

Function parameters:

e:

Information about the event.

Object structure:

Name

Type

Description

component

The widget's instance.

element

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

model

The model data. Available only if you use Knockout.

Default Value: null

Cannot be used in themes.

pathModified

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

Type:

Default Value: false

Cannot be used in themes.

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

rtlEnabled

Switches the widget to a right-to-left representation.

Type:

Default Value: false

Cannot be used in themes.

When this option is set to true, the widget 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.

JavaScript

DevExpress.config({
    rtlEnabled: true
});

showTarget

Specifies whether or not to show the target line.

Type:

Default Value: true

showZeroLevel

Specifies whether or not to show the line indicating zero on the invisible scale.

Type:

Default Value: true

size

Specifies the widget's size in pixels.

Type:

Default Value: undefined

By default, the widget occupies the entire area of the container. If you need to set a particular size for the widget, different from the container's size, assign a height and width in pixels to height and width properties of the size object.

Using the size object, you can hide the widget. For this purpose, simply assign 0 to both the height and width of the widget.

NOTE

The size configuration object reserves space for the main widget elements, while displaying a tooltip may require extra space. To reserve the area around the widget for the tooltip, you can apply a margin to the widget's container.

startScaleValue

Specifies a start value for the invisible scale.

Type:

Default Value: 0

Cannot be used in themes.

The main, target and zero values of the Bullet widget are contained within a range. This range is represented by an invisible scale. To specify the boundary values of this scale, set the startScaleValue and endScaleValue options.

Specify the same start and end scale values for several bullets when you display them in a column so that they can be comparable visually.

target

Specifies the value indicated by the target line.

Type:

Default Value: 0

Cannot be used in themes.

targetColor

Specifies a color for both the target and zero level lines.

Type:

String

Default Value: '#666666'

This option supports the following colors:

Hexadecimal colors
RGB colors
RGBA colors
Predefined/cross-browser color names
Predefined SVG colors

To specify a color for the bullet bar, use the color option.

targetWidth

Specifies the width of the target line.

Type:

Default Value: 4

theme

Sets the name of the theme the widget uses.

Type:

String

Default Value: 'generic.light'

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

NOTE

The following themes were deprecated or renamed: 'android5.light', ios7.default, 'win8.white', 'win8.black', 'win8.light', 'win8.dark', 'win10.white', 'win10.black', 'win10.light', 'win10.dark'. In new applications, use themes listed in the accepted values.

Use the VizTheme enum to specify this option when the widget is used as an ASP.NET MVC 5 Control or a DevExtreme-Based ASP.NET Core Control. This enum accepts the following values: GenericLight, GenericDark, GenericContrast, GenericCarmine, GenericDarkMoon, GenericSoftBlue, GenericDarkViolet, GenericGreenMist, MaterialBlueLight, MaterialLimeLight, MaterialOrangeLight, MaterialPurpleLight, MaterialTealLight.

tooltip

Configures the tooltip.

Type:

A tooltip is a miniature rectangle displaying widget data. The tooltip appears when the end-user hovers the cursor over the widget. You can enable/disable the tooltip, change its appearance and format its text using fields of the tooltip configuration object.

NOTE

The tooltip is displayed outside the widget's container. If you plan to use the tooltip, make sure there is enough space around your widget to display it. For example, you can apply a margin to the widget's container to reserve the area around the widget for the tooltip.

value

Specifies the primary value indicated by the bullet bar.

Type: