Financial charting control.
constructor(element: any, options?: any): FinancialChart
Initializes a new instance of the FlexChart class.
The DOM element that hosts the control, or a selector for the host element (e.g. '#theCtrl').
A JavaScript object containing initialization data for the control.
Gets or sets the name of the property that contains the Y values.
Gets or sets the name of the property that contains the X data values.
Gets the ICollectionView object that contains the chart data.
Gets or sets the text displayed in the chart header.
Gets the DOM element that is hosting the control.
Gets or sets a value that determines whether to interpolate null values in the data.
If true, the chart interpolates the value of any missing data based on neighboring points. If false, it leaves a break in lines and areas at the points with null values.
The default value for this property is false.
Gets or sets a value that determines whether the control is disabled.
Disabled controls cannot get mouse or keyboard events.
Gets a value that indicates whether the control is currently handling a touch event.
Gets a value that indicates whether the control is currently being updated.
Gets or sets the item formatter function that allows you to customize the appearance of the chart elements.
If specified, the function should take three parameters: the chart's IRenderEngine responsible for rendering elements on the chart, a HitTestInfo parameter that describes the element being rendered, and a function that provides the default rendering for the item.
For example:
itemFormatter: function (engine, hitTestInfo, defaultRenderer) {
var ht = hitTestInfo,
binding = 'downloads';
// check that this is the right series/element
if (ht.series.binding == binding && ht.pointIndex > 0 &&
ht.chartElement == ChartElement.SeriesSymbol) {
// get current and previous values
var chart = ht.series.chart,
items = chart.collectionView.items,
valNow = items[ht.pointIndex][binding],
valPrev = items[ht.pointIndex - 1][binding];
// add line if value is increasing
if (valNow > valPrev) {
var pt1 = chart.dataToPoint(ht.pointIndex, valNow),
pt2 = chart.dataToPoint(ht.pointIndex - 1, valPrev);
engine.drawLine(pt1.x, pt1.y, pt2.x, pt2.y, null, {
stroke: 'gold',
strokeWidth: 6
});
}
}
// render element as usual
defaultRenderer();
}
{@sample: Chart/LineArea/CustomLineSegments/purejs Example}
Gets or sets the array or ICollectionView object that contains the data used to create the chart.
Gets or sets a value indicating whether clicking legend items toggles the series visibility in the chart.
The default value for this property is false.
Gets or sets various chart options.
The following options are supported:
kagi.fields: Specifies the DataFields used for the Kagi chart. The default value is DataFields.Close.
kagi.rangeMode: Specifies the RangeMode for the Kagi chart. The default value is RangeMode.Fixed.
kagi.reversalAmount: Specifies the reversal amount for the Kagi chart. The default value is 14.
chart.options = {
kagi: {
fields: DataFields.Close,
rangeMode: RangeMode.Fixed,
reversalAmount: 14
}
}
lineBreak.newLineBreaks: Gets or sets the number of previous boxes that must be compared before a new box is drawn in Line Break charts. The default value is 3.
chart.options = {
lineBreak: { newLineBreaks: 3 }
}
renko.fields: Specifies the DataFields used for the Renko chart. The default value is DataFields.Close.
renko.rangeMode: Specifies the RangeMode for the Renko chart. The default value is RangeMode.Fixed.
renko.boxSize: Specifies the box size for the Renko chart. The default value is 14.
chart.options = {
renko: {
fields: DataFields.Close,
rangeMode: RangeMode.Fixed,
boxSize: 14
}
}
Gets or sets an array of default colors to use for displaying each series.
The array contains strings that represents CSS colors. For example:
// use colors specified by name chart.palette = ['red', 'green', 'blue']; // or use colors specified as rgba-values chart.palette = [ 'rgba(255,0,0,1)', 'rgba(255,0,0,0.8)', 'rgba(255,0,0,0.6)', 'rgba(255,0,0,0.4)'];
There is a set of predefined palettes in the Palettes class that you can use, for example:
chart.palette = Palettes.coral;
Gets the collection of PlotArea objects.
Gets or sets the plot margin in pixels.
The plot margin represents the area between the edges of the control and the plot area.
By default, this value is calculated automatically based on the space required by the axis labels, but you can override it if you want to control the precise position of the plot area within the control (for example, when aligning multiple chart controls on a page).
You may set this property to a numeric value or to a CSS-style margin specification. For example:
// set the plot margin to 20 pixels on all sides chart.plotMargin = 20; // set the plot margin for top, right, bottom, left sides chart.plotMargin = '10 15 20 25'; // set the plot margin for top/bottom (10px) and left/right (20px) chart.plotMargin = '10 20';
Gets a value indicating whether the control is hosted in an element with right-to-left layout.
Gets or sets an enumerated value indicating whether or what is selected when the user clicks the chart.
The default value for this property is SelectionMode.None.
Gets or sets the size of the symbols used for all Series objects in this FlexChart.
This property may be overridden by the symbolSize property on each Series object.
The default value for this property is 10 pixels.
Gets or sets a value of the **tabindex** attribute associated with the control.
**tabindex** attribute value can be defined statically for a Wijmo control by specifying it on the control's host HTML element. But this value can't be changed later during application lifecycle, because Wijmo controls have complex structure, and the control may need to propagate this attribute value to its internal element to work properly.
Because of this, to read or change control's **tabindex** dynamically, you should do it using this property.
Gets the chart Tooltip object.
The tooltip content is generated using a template that may contain any of the following parameters:
To modify the template, assign a new value to the tooltip's content property. For example:
chart.tooltip.content = '<b>{seriesName}</b> ' +
'<img src="resources/{x}.png"/><br/>{y}';
You can disable chart tooltips by setting the template to an empty string.
You can also use the tooltip property to customize tooltip parameters such as showDelay and hideDelay:
chart.tooltip.showDelay = 1000;
See ChartTooltip properties for more details and options.
addEventListener(target: EventTarget, type: string, fn: any, capture?: boolean, passive?: boolean): void
Adds an event listener to an element owned by this Control.
The control keeps a list of attached listeners and their handlers, making it easier to remove them when the control is disposed (see the dispose and removeEventListener methods).
Failing to remove event listeners may cause memory leaks.
The passive parameter is set to false by default, which means the event handler may call event.preventDefault(). If you are adding passive handlers to touch or wheel events, setting this parameter to true will improve application performance.
For details on passive event listeners, please see Improving scrolling performance with passive listeners.
Target element for the event.
String that specifies the event.
Function to execute when the event occurs.
Whether the listener should be handled by the control before it is handled by the target element.
Indicates that the handler will never call preventDefault().
applyTemplate(classNames: string, template: string, parts: Object, namePart?: string): HTMLElement
Applies the template to a new instance of a control, and returns the root element.
This method should be called by constructors of templated controls. Therefore, this method is not available. It is responsible for binding the template parts to the corresponding control members.
For example, the code below applies a template to an instance of an InputNumber control. The template must contain elements with the 'wj-part' attribute set to 'input', 'btn-inc', and 'btn-dec'. The control members '_tbx', '_btnUp', and '_btnDn' will be assigned references to these elements.
this.applyTemplate('wj-control wj-inputnumber', templateString, {
_tbx: 'input',
_btnUp: 'btn-inc',
_btnDn: 'btn-dec'
}, 'input');
```
Names of classes to add to the control's host element.
An HTML string that defines the control template.
A dictionary of part variables and their names.
Name of the part to be named after the host element. This determines how the control submits data when used in forms.
beginUpdate(): void
Suspends notifications until the next call to endUpdate.
dataToPoint(pt: any, y?: number): Point
Converts a Point from data coordinates to control coordinates.
Point in data coordinates, or X coordinate of a point in data coordinates.
Y coordinate of the point (if the first parameter is a number).
deferUpdate(fn: Function): void
Executes a function within a beginUpdate/endUpdate block.
The control will not be updated until the function has been executed. This method ensures endUpdate is called even if the function throws an exception.
Function to be executed.
dispose(): void
Disposes of the control by removing its association with the host element.
disposeAll(e?: HTMLElement): void
Disposes of all Wijmo controls contained in an HTML element.
Container element.
endUpdate(): void
Resumes notifications suspended by calls to beginUpdate.
getControl(element: any): Control
Gets the control that is hosted in a given DOM element.
The DOM element that hosts the control, or a CSS selector for the host element (e.g. '#theCtrl').
getTemplate(): string
Gets the HTML template used to create instances of the control.
This method traverses up the class hierarchy to find the nearest ancestor that specifies a control template. For example, if you specify a prototype for the ComboBox control, which does not specify a template, it will override the template defined by the DropDown base class (the nearest ancestor that does specify a template).
hitTest(pt: any, y?: number): HitTestInfo
Gets a HitTestInfo object with information about the specified point.
The point to investigate, in window coordinates.
The Y coordinate of the point (if the first parameter is a number).
initialize(options: any): void
Initializes the control by copying the properties from a given object.
This method allows you to initialize controls using plain data objects instead of setting the value of each property in code.
For example:
grid.initialize({
itemsSource: myList,
autoGenerateColumns: false,
columns: [
{ binding: 'id', header: 'Code', width: 130 },
{ binding: 'name', header: 'Name', width: 60 }
]
});
// is equivalent to
grid.itemsSource = myList;
grid.autoGenerateColumns = false;
// etc.
The initialization data is type-checked as it is applied. If the initialization object contains unknown property names or invalid data types, this method will throw.
Object that contains the initialization data.
invalidate(fullUpdate?: boolean): void
Invalidates the control causing an asynchronous refresh.
Whether to update the control layout as well as the content.
invalidateAll(e?: HTMLElement): void
Invalidates all Wijmo controls contained in an HTML element.
Use this method when your application has dynamic panels that change the control's visibility or dimensions. For example, splitters, accordions, and tab controls usually change the visibility of its content elements. In this case, failing to notify the controls contained in the element may cause them to stop working properly.
If this happens, you must handle the appropriate event in the dynamic container and call the invalidateAll method so the contained Wijmo controls will update their layout information properly.
Container element. If set to null, all Wijmo controls on the page will be invalidated.
onGotFocus(e?: EventArgs): void
Raises the gotFocus event.
onInvalidInput(e: CancelEventArgs): void
Raises the invalidInput event.
If the event handler cancels the event, the control will keep the invalid input and the focus.
onItemsSourceChanged(e: EventArgs): void
Raises the itemsSourceChanged event.
onItemsSourceChanging(e: CancelEventArgs): boolean
Raises the itemsSourceChanging event.
CancelEventArgs that contains the event data.
onLostFocus(e?: EventArgs): void
Raises the lostFocus event.
onRefreshed(e?: EventArgs): void
Raises the refreshed event.
onRefreshing(e?: EventArgs): void
Raises the refreshing event.
onRendered(e: RenderEventArgs): void
Raises the rendered event.
The RenderEventArgs object used to render the chart.
onRendering(e: RenderEventArgs): void
Raises the rendering event.
The RenderEventArgs object used to render the chart.
onSelectionChanged(e?: EventArgs): void
Raises the selectionChanged event.
onSeriesVisibilityChanged(e: SeriesEventArgs): void
Raises the seriesVisibilityChanged event.
The SeriesEventArgs object that contains the event data.
pageToControl(pt: any, y?: number): Point
Converts page coordinates to control coordinates.
The point of page coordinates or x value of page coordinates.
The y value of page coordinates. Its value should be a number, if pt is a number type. However, the y parameter is optional when pt is Point type.
pointToData(pt: any, y?: number): Point
Converts a Point from control coordinates to chart data coordinates.
The point to convert, in control coordinates.
The Y coordinate of the point (if the first parameter is a number).
refresh(fullUpdate?: boolean): void
Refreshes the chart.
A value indicating whether to update the control layout as well as the content.
refreshAll(e?: HTMLElement): void
Refreshes all Wijmo controls contained in an HTML element.
This method is similar to invalidateAll, except the controls are updated immediately rather than after an interval.
Container element. If set to null, all Wijmo controls on the page will be invalidated.
removeEventListener(target?: EventTarget, type?: string, fn?: any, capture?: boolean): number
Removes one or more event listeners attached to elements owned by this Control.
Target element for the event. If null, removes listeners attached to all targets.
String that specifies the event. If null, removes listeners attached to all events.
Handler to remove. If null, removes all handlers.
Whether the listener is capturing. If null, removes capturing and non-capturing listeners.
saveImageToDataUrl(format: ImageFormat, done: Function): void
Saves the chart to an image data url.
NOTE: This method does not work in IE browsers. If you require IE support, add the flex-chart.render module to the page.
The ImageFormat for the exported image.
A function to be called after data url is generated. The function gets passed the data url as its argument.
saveImageToFile(filename: string): void
Saves the chart to an image file.
NOTE: This method does not work in IE browsers. If you require IE support, add the *wijmo.chart.render* module to the page.
The filename for the exported image file including extension. Supported types are PNG, JPEG and SVG.
saveSvgToDataUrl(done: Function, embedCss?: boolean): void
Saves the chart to a data url as SVG image.
A function to be called after data url is generated. The function gets passed the data url as its argument.
Whether to include CSS styles to SVG image.
saveSvgToFile(filename: string, embedCss?: boolean): void
Saves the chart to an SVG image file.
The filename for the exported image file including extension.
Whether to include CSS styles to SVG image.
Occurs when invalid input is detected.
Invalid input may occur when the user types or pastes a value that cannot be converted to the proper type, or a value that is outside the valid range.
If the event handler cancels the event, the control will retain the invalid content and the focus, so users can correct the error.
If the event is not canceled, the control will ignore the invalid input and will retain the original content.
Occurs after the chart has been bound to a new items source.
Occurs before the chart is bound to a new items source.
Occurs after the control has refreshed its contents.
Occurs when the control is about to refresh its contents.
Occurs after the chart finishes rendering.
Occurs before the chart starts rendering data.
Occurs after the selection changes, whether programmatically or when the user clicks the chart. This is useful, for example, when you want to update details in a textbox showing the current selection.
Occurs when the series visibility changes, for example when the legendToggle property is set to true and the user clicks the legend.