ASP.NET MVC Controls
FlexChartCore Class
File
wijmo.chart.js
Module
wijmo.chart
Base Class
FlexChartBase
Derived Classes
FlexChart, FlexRadar, FinancialChart

The core charting control for FlexChart.

Constructor

Properties

Methods

Events

Constructor

constructor

constructor(element: any, options?): FlexChartCore

Initializes a new instance of the FlexChart class.

Parameters
Returns
FlexChartCore

Properties

axes

Gets the collection of Axis objects.

Type
ObservableArray

axisX

Gets or sets the main X axis.

Type
Axis

axisY

Gets or sets the main Y axis.

Type
Axis

binding

Gets or sets the name of the property that contains the Y values.

Type
string

bindingX

Gets or sets the name of the property that contains the X data values.

Type
string

collectionView

Gets the ICollectionView object that contains the chart data.

Inherited From
FlexChartBase
Type
ICollectionView

dataLabel

Gets or sets the point data label.

Type
DataLabel

footerStyle

Gets or sets the style of the chart footer.

Inherited From
FlexChartBase
Type
any

headerStyle

Gets or sets the style of the chart header.

Inherited From
FlexChartBase
Type
any

hostElement

Gets the DOM element that is hosting the control.

Inherited From
Control
Type
HTMLElement

interpolateNulls

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.

Type
boolean

isDisabled

Gets or sets a value that determines whether the control is disabled.

Disabled controls cannot get mouse or keyboard events.

Inherited From
Control
Type
boolean

isTouching

Gets a value that indicates whether the control is currently handling a touch event.

Inherited From
Control
Type
boolean

isUpdating

Gets a value that indicates whether the control is currently being updated.

Inherited From
Control
Type
boolean

itemFormatter

Gets or sets the item formatter function that allows you to customize the appearance of data points. See the Explorer sample's Item Formatter for a demonstration.

Inherited From
FlexChartBase
Type
Function

itemsSource

Gets or sets the array or ICollectionView object that contains the data used to create the chart.

Inherited From
FlexChartBase
Type
any

legend

Gets or sets the chart legend.

Inherited From
FlexChartBase
Type
Legend

legendToggle

Gets or sets a value indicating whether clicking legend items toggles the series visibility in the chart.

Type
boolean

palette

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 = wijmo.chart.Palettes.coral;
Inherited From
FlexChartBase
Type
string[]

plotAreas

Gets the collection of PlotArea objects.

Type
PlotAreaCollection

plotMargin

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';
Inherited From
FlexChartBase
Type
any

rightToLeft

Gets a value indicating whether the control is hosted in an element with right-to-left layout.

Inherited From
Control
Type
boolean

selection

Gets or sets the selected chart series.

Type
SeriesBase

selectionMode

Gets or sets an enumerated value indicating whether or what is selected when the user clicks the chart.

Inherited From
FlexChartBase
Type
SelectionMode

series

Gets the collection of Series objects.

Type
ObservableArray

symbolSize

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.

Type
number

tooltip

Gets the chart Tooltip object.

The tooltip content is generated using a template that may contain any of the following parameters:

  • propertyName: Any property of the data object represented by the point.
  • seriesName: Name of the series that contains the data point (FlexChart only).
  • pointIndex: Index of the data point.
  • value: Value of the data point (y-value for FlexChart, item value for FlexPie).
  • x: x-value of the data point (FlexChart only).
  • y: y-value of the data point (FlexChart only).
  • name: Name of the data point (x-value for FlexChart or legend entry for FlexPie).

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.

Type
ChartTooltip

Methods

addEventListener

addEventListener(target: EventTarget, type: string, fn: any, capture?: 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 method).

Failing to remove event listeners may cause memory leaks.

Parameters
  • target: EventTarget

    Target element for the event.

  • type: string

    String that specifies the event.

  • fn: any

    Function to execute when the event occurs.

  • capture: boolean Optional

    Whether the listener is capturing.

Inherited From
Control
Returns
void

applyTemplate

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. 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', template, {
  _tbx: 'input',
  _btnUp: 'btn-inc',
  _btnDn: 'btn-dec'
}, 'input');
Parameters
  • classNames: string

    Names of classes to add to the control's host element.

  • template: string

    An HTML string that defines the control template.

  • parts: Object

    A dictionary of part variables and their names.

  • namePart: string Optional

    Name of the part to be named after the host element. This determines how the control submits data when used in forms.

Inherited From
Control
Returns
HTMLElement

beginUpdate

beginUpdate(): void

Suspends notifications until the next call to endUpdate.

Inherited From
Control
Returns
void

containsFocus

containsFocus(): boolean

Checks whether this control contains the focused element.

Inherited From
FlexChartBase
Returns
boolean

dataToPoint

dataToPoint(pt: any, y?: number): Point

Converts a Point from data coordinates to control coordinates.

Parameters
  • pt: any

    Point in data coordinates, or X coordinate of a point in data coordinates.

  • y: number Optional

    Y coordinate of the point (if the first parameter is a number).

Returns
Point

deferUpdate

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.

Parameters
Inherited From
Control
Returns
void

dispose

dispose(): void

Disposes of the control by removing its association with the host element.

The dispose method automatically removes any event listeners added with the addEventListener method.

Calling the dispose method is important in applications that create and remove controls dynamically. Failing to dispose of the controls may cause memory leaks.

Inherited From
Control
Returns
void

Static disposeAll

disposeAll(e?: HTMLElement): void

Disposes of all Wijmo controls contained in an HTML element.

Parameters
Inherited From
Control
Returns
void

endUpdate

endUpdate(): void

Resumes notifications suspended by calls to beginUpdate.

Inherited From
Control
Returns
void

focus

focus(): void

Sets the focus to this control.

Inherited From
Control
Returns
void

Static getControl

getControl(element: any): Control

Gets the control that is hosted in a given DOM element.

Parameters
  • element: any

    The DOM element that is hosting the control, or a selector for the host element (e.g. '#theCtrl').

Inherited From
Control
Returns
Control

getTemplate

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, it will override the template defined by the DropDown base class.

Inherited From
Control
Returns
string

hitTest

hitTest(pt: any, y?: number): HitTestInfo

Gets a HitTestInfo object with information about the specified point.

Parameters
  • pt: any

    The point to investigate, in window coordinates.

  • y: number Optional

    The Y coordinate of the point (if the first parameter is a number).

Returns
HitTestInfo

initialize

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.

Parameters
  • options: any

    Object that contains the initialization data.

Inherited From
Control
Returns
void

invalidate

invalidate(fullUpdate?: boolean): void

Invalidates the control causing an asynchronous refresh.

Parameters
  • fullUpdate: boolean Optional

    Whether to update the control layout as well as the content.

Inherited From
Control
Returns
void

Static invalidateAll

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.

Parameters
  • e: HTMLElement Optional

    Container element. If set to null, all Wijmo controls on the page will be invalidated.

Inherited From
Control
Returns
void

onGotFocus

onGotFocus(e?: EventArgs): void

Raises the gotFocus event.

Parameters
Inherited From
Control
Returns
void

onLostFocus

onLostFocus(e?: EventArgs): void

Raises the lostFocus event.

Parameters
Inherited From
Control
Returns
void

onRendered

onRendered(e: RenderEventArgs): void

Raises the rendered event.

Parameters
Inherited From
FlexChartBase
Returns
void

onRendering

onRendering(e: RenderEventArgs): void

Raises the rendering event.

Parameters
Inherited From
FlexChartBase
Returns
void

onSelectionChanged

onSelectionChanged(e?: EventArgs): void

Raises the selectionChanged event.

Parameters
Inherited From
FlexChartBase
Returns
void

onSeriesVisibilityChanged

onSeriesVisibilityChanged(e: SeriesEventArgs): void

Raises the seriesVisibilityChanged event.

Parameters
Returns
void

pointToData

pointToData(pt: any, y?: number): Point

Converts a Point from control coordinates to chart data coordinates.

Parameters
  • pt: any

    The point to convert, in control coordinates.

  • y: number Optional

    The Y coordinate of the point (if the first parameter is a number).

Returns
Point

refresh

refresh(fullUpdate?: boolean): void

Refreshes the chart.

Parameters
  • fullUpdate: boolean Optional

    A value indicating whether to update the control layout as well as the content.

Inherited From
FlexChartBase
Returns
void

Static refreshAll

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.

Parameters
  • e: HTMLElement Optional

    Container element. If set to null, all Wijmo controls on the page will be invalidated.

Inherited From
Control
Returns
void

removeEventListener

removeEventListener(target?: EventTarget, type?: string, fn?: any, capture?: boolean): number

Removes one or more event listeners attached to elements owned by this Control.

Parameters
  • target: EventTarget Optional

    Target element for the event. If null, removes listeners attached to all targets.

  • type: string Optional

    String that specifies the event. If null, removes listeners attached to all events.

  • fn: any Optional

    Handler to remove. If null, removes all handlers.

  • capture: boolean Optional

    Whether the listener is capturing. If null, removes capturing and non-capturing listeners.

Inherited From
Control
Returns
number

saveImageToDataUrl

saveImageToDataUrl(format: ImageFormat, done: Function): void

Save chart to image data url.

Parameters
  • format: ImageFormat

    The ImageFormat for the exported image.

  • done: Function

    A function to be called after data url is generated. The function gets passed the data url as its argument.

Inherited From
FlexChartBase
Returns
void

saveImageToFile

saveImageToFile(filename: string): void

Save chart to an image file.

Parameters
  • filename: string

    The filename for the exported image file including extension. Supported types are PNG, JPEG, SVG.

Inherited From
FlexChartBase
Returns
void

Events

gotFocus

Occurs when the control gets the focus.

Inherited From
Control
Arguments
EventArgs

lostFocus

Occurs when the control loses the focus.

Inherited From
Control
Arguments
EventArgs

rendered

Occurs after the chart finishes rendering.

Inherited From
FlexChartBase
Arguments
RenderEventArgs

rendering

Occurs before the chart starts rendering data.

Inherited From
FlexChartBase
Arguments
RenderEventArgs

selectionChanged

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.

Inherited From
FlexChartBase
Arguments
EventArgs

seriesVisibilityChanged

Occurs when the series visibility changes, for example when the legendToggle property is set to true and the user clicks the legend.

Arguments
SeriesEventArgs

 

 


Copyright © GrapeCity, inc. All rights reserved.

Product Support Forum |  Documentation Feedback