bb

Members

(static) instance

Description:

• An array containing instance created

Source:

• core.ts, line 138

Properties:

Example

// generate charts
 var chart1 = bb.generate(...);
 var chart2 = bb.generate(...);

 bb.instance;  // [ chart1, chart2, ... ]

(static) plugin

Description:

• Namespace for plugins

Source:

• core.ts, line 147

Properties:

Example

// Stanford diagram plugin
 bb.plugin.stanford;

(static) version

Description:

• Version information

Source:

• core.ts, line 21

Properties:

Example

bb.version;  // "1.0.0"

Methods

(static) defaults(options) → {Options}

Description:

• Set or get global default options.

  • NOTE:
    • The options values settings are valid within page context only.
    • If is called multiple times, will override the last value.

Source:

• core.ts, line 121

See:

• Options

Example

// Set same option value as for `.generate()`
bb.defaults({
  data: {
    type: "bar"
  }
});

bb.defaults();  // {data:{type: "bar"}}

// data.type defaults to 'bar'
var chart = bb.generate({ ... });

Parameters:

Returns:

Type

Options

(static) generate(config) → {Chart}

Description:

• Generate chart

  • NOTE: Bear in mind for the possiblity of throwing an error, during the generation when:
    • Unused option value is given.
      • ex) For data.type="pie" option, setting 'axis' option can cause unexpected generation error.
    • Insufficient value is given for certain option used.
      • ex) data: { x: "x", columns: [["x"], ["data1", 30, 200, 100]] }

Source:

• core.ts, line 92

See:

• Options for different generation options
• Chart for different methods API

Examples

<!-- chart holder -->
<div id="LineChart"></div>

// Generate chart with options
 var chart = bb.generate({
     "bindto": "#LineChart"
     "data": {
         "columns": [
             ["data1", 30, 200, 100, 400, 150, 250],
             ["data2", 50, 20, 10, 40, 15, 25]
          ],
         "type": "line"
     }
 });

 // call some API
 // ex) get the data of 'data1'
 chart.data("data1");

// Generate chart by importing ESM
// Import types to be used only, where this will make smaller bundle size.
import bb, {
  area,
  areaLineRange,
  areaSpline,
  areaSplineRange,
  areaStep,
  bar,
  bubble,
  donut,
  gauge,
  line,
  pie,
  polar,
  radar,
  scatter,
  spline,
  step
}

bb.generate({
     "bindto": "#LineChart"
     "data": {
         "columns": [
             ["data1", 30, 200, 100, 400, 150, 250],
             ["data2", 50, 20, 10, 40, 15, 25]
          ]
     },
     type: line(),

     // or
     types: {
       data1: bar(),
       data2: step()
     }
});

Parameters:

Returns:

Type

Chart