chart.builder
Hierarchy
corechart.builderRequires
jqueryFiles
Implements chart builder
Config options
Determines a axis to be added to a chart.
Defaults to: []
Sets a component objects to be bind.
Defaults to: null
Determines a brush to be added to a chart.
Defaults to: []
Defines a DOM event to be used in a UI
Defaults to: {}
Sets a format callback function to be used in a grid/brush/widget.
Defaults to: null
Icon-related settings available in the chart.
Defaults to: {type: "jennifer", path: null}
- type : String (optional)
Defaults to:
"jennifer"
- path : String (optional)
Defaults to:
null
chart padding
Defaults to: {top: 50, bottom: 50, left: 50, right: 50}
- top : Number (optional)
chart padding
Defaults to:
50
- bottom : Number (optional)
chart padding
Defaults to:
50
- left : Number (optional)
chart padding
Defaults to:
50
- right : Number (optional)
chart padding
Defaults to:
50
Does not render a chart when a rendering-related method is called with false (although the render method is not included).
Defaults to: true
Defines a template markup to be used in a UI
Defaults to: {}
Determines a widget to be added to a chart.
Defaults to: []
Properties
Methods
Returns the values of rendering options and, if the rendering option is false, does not render the chart again when a method is called.
Returns
- Boolean
Adds a brush and performs rendering again.
Parameters
- brush : Object
Check the parameter type of a UI method and generates an alarm when a wrong value is entered
Parameters
- name : String
Method name
- params : Array
Parameters
Adds a widget and performs rendering again.
Parameters
- widget : Object
Add the child element in defs tag.
Parameters
- elem : chart.svg.element
Binds data used in a uix.table or the uix.xtable.
Parameters
- axisIndex : Number
- uiObj : Object
Sets a callback function that is called after a UI method is run
Parameters
- name : String
Method name
- callback : Function
Returns
- Mixed
Sets a callback function that is called before a UI method is run
Parameters
- name : String
Method name
- callback : Function
Returns
- Mixed
Sets a callback function and the delay time before/after a UI method is run
Parameters
- name : String
Method name
- callback : Function
Removes all events set in a UI obejct and the DOM element
Generates a custom event. The first parameter is the type of a custom event. A function defined as an option or on method is called
Parameters
- type : String
Event type
- args : Function
Event Arguments
Returns
- Mixed
Gets a named axis, brush, widget (type: axis, brush, widget, padding, area)
Parameters
- type : "axis"/"brush"/"widget"/"padding"/"area"
- key : String
Property name
Returns
- Mixed/Object
Removes a custom event of an applicable type or callback handler
Parameters
- type : String
Event type
A callback function defined as an on method is run when an emit method is called.
Parameters
- type : String
Event's name
- callback : Function
- resetType : "render"/"renderAll"/undefined
Overrides: core.on
Deletes the brush of a specified index and performs rendering again.
Parameters
- index : Number
Deletes the widget of a specified index and performs rendering again.
Parameters
- index : Number
Dynamically defines the options of a UI
Parameters
- key : String
- value : Mixed
Dynamically defines the template method of a UI
Parameters
- name : String
Template name
- html : String
Template markup
Gets a value for the theme element applied to the current chart.
// get all theme property
var theme = chart.theme();
// get a part of theme
var fontColor = chart.theme("fontColor");
// get selected value of theme
chart.theme(isSelected, "selectedFontColor", "fontColor"); // if isSelected is true, return 'selectedFontColor' else return 'fontColor'
Updates the brush of a specified index and performs rendering again.
Parameters
- index : Number
- brush : Object
- isReset : Boolean
Updates the widget of a specified index and performs rendering again
Parameters
- index : Number
- widget : Object
- isReset : Boolean
Events
Event that occurs when clicking on the chart margin. (real name bg.click
)
Parameters
- e : jQueryEvent
The event object.
Event that occurs when double clicking on the chart margin. (real name bg.dblclick
)
Parameters
- e : jQueryEvent
The event object.
Event that occurs when left clicking on the chart margin. (real name bg.mousedown
)
Parameters
- e : jQueryEvent
The event object.
Event that occurs when moving the mouse over the chart margin. (real name bg.mousemove
)
Parameters
- e : jQueryEvent
The event object.
Event that occurs when moving the mouse out of the chart margin. (real name bg.mouseout
)
Parameters
- e : jQueryEvent
The event object.
Event that occurs when placing the mouse over the chart margin. (real name bg.mouseover
)
Parameters
- e : jQueryEvent
The event object.
Event that occurs after left clicking on the chart margin. (real name bg.mouseup
)
Parameters
- e : jQueryEvent
The event object.
Event that occurs when right clicking on the chart margin. (real name bg.rclick
)
Parameters
- e : jQueryEvent
The event object.
Event that occurs when clicking on the chart area. (real name chart.click
)
Parameters
- e : jQueryEvent
The event object.
Event that occurs when double clicking on the chart area. (real name chart.dblclick
)
Parameters
- e : jQueryEvent
The event object.
Event that occurs when left clicking on the chart area. (real name chart.mousedown
)
Parameters
- e : jQueryEvent
The event object.
Event that occurs when moving the mouse over the chart area. (real name chart.mousemove
)
Parameters
- e : jQueryEvent
The event object.
Event that occurs when moving the mouse out of the chart area. (real name chart.mouseout
)
Parameters
- e : jQueryEvent
The event object.
Event that occurs when placing the mouse over the chart area. (real name chart.mouseover
)
Parameters
- e : jQueryEvent
The event object.
Event that occurs after left clicking on the chart area. (real name chart.mouseup
)
Parameters
- e : jQueryEvent
The event object.
Event that occurs when right clicking on the chart area. (real name chart.rclick
)
Parameters
- e : jQueryEvent
The event object.