logo

/github|v4.6.1

Class

new ColumnChart(props)

EXTENDS
  • Chart
PARAMETERS
NameTypeDescription

props

Object

PROPERTIES
NameTypeDescription

el

HTMLElement

The target element to create chart.

options

[ Object ]

Options for making Column 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.

rangeSelectable

boolean = false

Whether to use range selection feature or not.

barWidth

[ number ]

Bar width.

diverging

[ boolean ]

Whether to use diverging chart or not.

stack

[ Object ]

Option to use the stack chart or, if so, what type of stack to use.

eventDetectType

[ string ]

Event detect type. 'grouped', 'point' is available.

dataLabels

[ Object ]

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

shift

boolean = false

Whether to use shift when addData or not.

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

[ ObjectArray.<Object> ]

If this option is an array type, use the secondary y axis.

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 Bar 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

[ ObjectArray.<Object> ]

Y Axis theme. In the case of an arrangement, the first is the main axis and the second is the theme for the secondary axis.

legend

[ Object ]

Legend theme.

tooltip

[ Object ]

Tooltip theme.

plot

[ Object ]

Plot theme.

exportMenu

[ Object ]

ExportMenu theme.

data

Object

Data for making Column Chart.

PROPERTIES
NameTypeDescription

categories

Array.<string>

Categories.

series

Array.<Object>

Series data.

PROPERTIES
NameTypeDescription

name

string

Series name.

colorByCategories

string

Paint Rect with color based on categories.

data

Array.<number|Array.<number>>

Series data.

Instance Methods

addData(data, category)

Add data.

PARAMETERS
NameTypeDescription

data

Array.<number|Array.<number>>

Array of data to be added

category

string

Category to be added

EXAMPLES
chart.addData([10, 20], '6');

addSeries(data)

Add series.

PARAMETERS
NameTypeDescription

data

Object

Data to be added

PROPERTIES
NameTypeDescription

name

string

Series name

data

Array.<number|Array.<number>>

Array of data to be added

EXAMPLES
chart.addSeries({
  name: 'newSeries',
  data: [10, 100, 50, 40, 70, 55, 33, 70, 90, 110],
});

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({
  categories: ['1', '2', '3'],
  series: [
    {
      name: 'new series',
      data: [1, 2, 3],
    },
    {
      name: 'new series2',
      data: [4, 5, 6],
    }
  ]
});

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',
    date: { format: 'yy/MM' },
  },
  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

index

number

Index of data within series. If 'series.eventDetectType' is "grouped", only seriesIndex is needed.

seriesIndex

[ number ]

Index of series.

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

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