A newer version of this page is available. Switch to the current version.

jQuery Bullet API

The Bullet UI component is useful when you need to compare a single measure to a target value. The UI component comprises a horizontal bar indicating the measure and a vertical line indicating the target value.

import Bullet from "devextreme/viz/bullet"

Configuration

An object that specifies configuration properties for the Bullet UI component.

Name Description
color

Specifies a color for the bullet bar.

disabled

Specifies whether the UI component responds to user interaction.

elementAttr

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

endScaleValue

Specifies an end value for the invisible scale.

margin

Generates space around the UI component.

onDisposing

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

onDrawn

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

onExported

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

onExporting

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

onFileSaving

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

onIncidentOccurred

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

onInitialized

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

onOptionChanged

A function that is executed after a UI component property is changed.

onTooltipHidden

A function that is executed when a tooltip becomes hidden.

onTooltipShown

A function that is executed when a tooltip appears.

pathModified

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

rtlEnabled

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

showTarget

Specifies whether or not to show the target line.

showZeroLevel

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

size

Specifies the UI component's size in pixels.

startScaleValue

Specifies a start value for the invisible scale.

target

Specifies the value indicated by the target line.

targetColor

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

targetWidth

Specifies the width of the target line.

theme

Sets the name of the theme the UI component uses.

tooltip

Configures the tooltip.

value

Specifies the primary value indicated by the bullet bar.

Methods

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

Name Description
beginUpdate()

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

dispose()

Disposes of all the resources allocated to the Bullet instance.

element()

Gets the root UI component element.

endUpdate()

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

exportTo(fileName, format)

Exports the UI component.

getInstance(element)

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

getSize()

Gets the current UI component size.

instance()

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

off(eventName)

Detaches all event handlers from a single event.

off(eventName, eventHandler)

Detaches a particular event handler from a single event.

on(eventName, eventHandler)

Subscribes to an event.

on(events)

Subscribes to events.

option()

Gets all UI component properties.

option(optionName)

Gets the value of a single property.

option(optionName, optionValue)

Updates the value of a single property.

option(options)

Updates the values of several properties.

print()

Opens the browser's print window.

render()

Redraws the UI component.

resetOption(optionName)

Resets a property to its default value.

svg()

Gets the UI component's SVG markup.

See Also

Events

This section describes events fired by this UI component.

Name Description
disposing

Raised before the UI component is disposed of.

drawn

Raised when the UI component's rendering has finished.

exported

Raised after the UI component is exported.

exporting

Raised before the UI component is exported.

fileSaving

Raised before a file with exported UI component is saved to the user's local storage.

incidentOccurred

Raised when an error or warning occurs.

initialized

Raised only once, after the UI component is initialized.

optionChanged

Raised after a UI component property is changed.

tooltipHidden

Raised when a tooltip becomes hidden.

tooltipShown

Raised when a tooltip appears.

See Also