logo

/github|v4.4.3

Class

new BulletChart(props)

EXTENDS
  • Chart
PARAMETERS
NameTypeDescription

props

Object

PROPERTIES
NameTypeDescription

el

HTMLElement

The target element to create chart.

options

[ Object ]

Options for making Bullet Chart.

PROPERTIES
NameTypeDescription

chart

[ Object ]

PROPERTIES
NameTypeDescription

title

[ stringObject ]

Chart title text or options.

animation

[ booleanObject ]

Whether to use animation and duration when rendering the initial chart.

width

[ numberstring ]

Chart width. 'auto' or if not write, the width of the parent container is followed. 'auto' or if not created, the width of the parent container is followed.

height

[ numberstring ]

Chart height. 'auto' or if not write, the width of the parent container is followed. 'auto' or if not created, the height of the parent container is followed.

series

[ Object ]

PROPERTIES
NameTypeDescription

selectable

boolean = false

Whether to make selectable series or not.

vertical

[ number ]

Whether to use vertical bullet series or not.

dataLabels

[ Object ]

Set the visibility, location, and formatting of dataLabel. For specific information, refer to the DataLabels guide on github.

xAxis

[ Object ]

PROPERTIES
NameTypeDescription

title

[ stringObject ]

Axis title.

rotateLabel

boolean = true

Whether to allow axis label rotation.

date

[ booleanObject ]

Whether the x axis label is of date type. Format option used for date type. Whether the x axis label is of date type. If use date type, format option used for date type.

tick

[ Object ]

Option to adjust tick interval.

label

[ Object ]

Option to adjust label interval.

scale

[ Object ]

Option to adjust axis minimum, maximum, step size.

width

[ number ]

Width of xAxis.

height

[ number ]

Height of xAxis.

yAxis

[ Object ]

PROPERTIES
NameTypeDescription

title

[ stringObject ]

Axis title.

tick

[ Object ]

Option to adjust tick interval.

label

[ Object ]

Option to adjust label interval.

scale

[ Object ]

Option to adjust axis minimum, maximum, step size.

width

[ number ]

Width of yAxis.

height

[ number ]

Height of yAxis.

plot

[ Object ]

PROPERTIES
NameTypeDescription

width

[ number ]

Width of plot.

height

[ number ]

Height of plot.

visible

[ boolean ]

Whether to show plot line.

legend

[ Object ]

PROPERTIES
NameTypeDescription

align

[ string ]

Legend align. 'top', 'bottom', 'right', 'left' is available.

showCheckbox

[ string ]

Whether to show checkbox.

visible

[ boolean ]

Whether to show legend.

width

[ number ]

Width of legend.

item

[ Object ]

and options of the legend item. For specific information, refer to the Legend guide on github.

exportMenu

[ Object ]

PROPERTIES
NameTypeDescription

visible

[ boolean ]

Whether to show export menu.

filename

[ string ]

File name applied when downloading.

tooltip

[ Object ]

PROPERTIES
NameTypeDescription

offsetX

[ number ]

Offset value to move title horizontally.

offsetY

[ number ]

Offset value to move title vertically.

formatter

[ Function ]

Function to format data value.

template

[ Function ]

Function to create custom template. For specific information, refer to the Tooltip guide on github.

responsive

[ Object ]

Rules for changing chart options. For specific information, refer to the Responsive guide on github.

PROPERTIES
NameTypeDescription

animation

[ booleanObject ]

Animation duration when the chart is modified.

rules

[ Array ]

Rules for the Chart to Respond.

lang

[ Object ]

Options for changing the text displayed on the chart or i18n languages.

PROPERTIES
NameTypeDescription

noData

[ Object ]

No Data Layer Text.

theme

[ Object ]

Chart theme options. For specific information, refer to the Bullets Chart guide on github.

PROPERTIES
NameTypeDescription

chart

[ Object ]

Chart font theme.

noData

[ Object ]

No Data Layer Text theme.

series

[ Object ]

Series theme.

title

[ Object ]

Title theme.

xAxis

[ Object ]

X Axis theme.

yAxis

[ Object ]

Y Axis theme.

legend

[ Object ]

Legend theme.

tooltip

[ Object ]

Tooltip theme.

plot

[ Object ]

Plot theme.

exportMenu

[ Object ]

ExportMenu theme.

data

Object

Data for making Bullet Chart.

PROPERTIES
NameTypeDescription

categories

Array.<string>

Categories.

series

Array.<Object>

Series data.

PROPERTIES
NameTypeDescription

name

string

Series name.

data

number

Series data.

markers

Array.<number>

Series markers. It specifies the marker for comparing.

ranges

Array.<Array.<>>

Series ranges. It specifies the range of values that can be compared.

series

Instance Methods

addSeries(data)

Add series.

PARAMETERS
NameTypeDescription

data

Object

Data to be added

PROPERTIES
NameTypeDescription

name

string

Series name

markers

Array.<number>

Series markers. It specifies the marker for comparing.

ranges

Array.<Array.<>>

Series ranges. It specifies the range of values that can be compared.

EXAMPLES
chart.addSeries({
  name: 'newSeries',
  data: 20,
  markers: [28, 2, 15],
  ranges: [
    [-1, 10],
    [10, 20],
    [20, 30],
  ],
});

hideSeriesDataLabel()

Hide series data label.

EXAMPLES
chart.hideSeriesDataLabel();

hideTooltip()

Hide tooltip.

EXAMPLES
chart.hideTooltip();

setData(data)

Convert the chart data to new data.

PARAMETERS
NameTypeDescription

data

Object

Data to be set

EXAMPLES
chart.setData({
  series: [
    {
      name: 'newSeries',
      data: 20,
      markers: [28, 2, 15],
      ranges: [
        [-1, 10],
        [10, 20],
        [20, 30],
      ],
    }
  ]
});

setOptions(options)

Convert the chart options to new options.

PARAMETERS
NameTypeDescription

options

Object

Chart options

EXAMPLES
chart.setOptions({
  chart: {
    width: 500,
    height: 'auto',
    title: 'Energy Usage',
  },
  xAxis: {
    title: 'Month',
  },
  yAxis: {
    title: 'Energy (kWh)',
  },
  series: {
    selectable: true,
  },
  tooltip: {
    formatter: (value) => `${value}kWh`,
  },
});

showSeriesDataLabel()

Show series data label.

EXAMPLES
chart.showSeriesDataLabel();

showTooltip(seriesInfo)

Show tooltip.

PARAMETERS
NameTypeDescription

seriesInfo

Object

Information of the series for the tooltip to be displayed.

PROPERTIES
NameTypeDescription

seriesIndex

number

Index of series.

EXAMPLES
chart.showTooltip({seriesIndex: 1});

updateOptions(options)

Update chart options.

PARAMETERS
NameTypeDescription

options

Object

Chart options

EXAMPLES
chart.updateOptions({
  chart: {
    height: 'auto',
    title: 'Energy Usage',
  },
  tooltip: {
    formatter: (value) => `${value}kWh`,
  },
});
Resizable