FlexChartBase Class

The FlexChartBase control from which the FlexChart and FlexPie derive.

Type parameters

Heirarchy

Control
- FlexChartBase
  - FlexChartCore
  - FlexPie
  - TreeMap
  - FlexMap

Constructors

constructor

Properties

Methods

Events

Constructors

constructor

new FlexChartBase(element: any, options?: any, invalidateOnResize?: boolean): FlexChartBase

Inherited from Control.constructor

Overrides ControlBase.__constructor

Initializes a new instance of the Control class and attaches it to a DOM element.

Parameters
- element: any
  
  The DOM element that hosts the control, or a CSS selector for the host element (e.g. '#theCtrl').
- Optional options: any
  
  JavaScript object containing initialization data for the control.
- Optional invalidateOnResize: boolean
  
  Whether the control should be invalidated when it is resized.
Returns FlexChartBase

Properties

collectionView

collectionView: ICollectionView<T>

Gets the ICollectionView object that contains the chart data.

footer: string

Gets or sets the text displayed in the chart footer.

footerStyle

footerStyle: any

Gets or sets the style of the chart footer.

header: string

Gets or sets the text displayed in the chart header.

headerStyle

headerStyle: any

Gets or sets the style of the chart header.

hostElement

hostElement: HTMLElement

Gets the DOM element that is hosting the control.

isDisabled

isDisabled: boolean

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

Disabled controls cannot get mouse or keyboard events.

isTouching

isTouching: boolean

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

isUpdating

isUpdating: boolean

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

itemFormatter

itemFormatter: Function

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}

itemsSource

itemsSource: any

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

legend

legend: Legend

Gets or sets the chart legend.

options

options: any

Gets or sets various chart options.

The following options are supported:

htmlText: If true, it allows to use HTML tags in chart text elements like header, footer legend, axis and data labels. The default value is false.

chart.header: 'Country GDP';
chart.options = {
  htmlText: true
}

palette

palette: string[]

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;

plotMargin

plotMargin: any

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';

rightToLeft

rightToLeft: boolean

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

selectionMode

selectionMode: SelectionMode

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.

tabOrder

tabOrder: number

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.

Methods

addEventListener

addEventListener(target: EventTarget, type: string, fn: any, capture?: boolean, passive?: boolean): void

Inherited from Control.addEventListener

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.

Parameters
- target: EventTarget
  
  Target element for the event.
- type: string
  
  String that specifies the event.
- fn: any
  
  Function to execute when the event occurs.
- Optional capture: boolean
  
  Whether the listener should be handled by the control before it is handled by the target element.
- Optional passive: boolean
  
  Indicates that the handler will never call preventDefault().
Returns void

applyTemplate

applyTemplate(classNames: string, template: string, parts: Object, namePart?: string): HTMLElement

Inherited from Control.applyTemplate
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');
```
@param classNames Names of classes to add to the control's host element. @param template An HTML string that defines the control template. @param parts A dictionary of part variables and their names. @param namePart Name of the part to be named after the host element. This determines how the control submits data when used in forms.
Parameters
- classNames: string
- template: string
- parts: Object
- Optional namePart: string
Returns HTMLElement

beginUpdate

beginUpdate(): void

Inherited from Control.beginUpdate

Suspends notifications until the next call to endUpdate.

Returns void

containsFocus

containsFocus(): boolean

Inherited from Control.containsFocus

Checks whether this control contains the focused element.

Returns boolean

deferUpdate

deferUpdate(fn: Function): void

Inherited from Control.deferUpdate

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
- fn: Function
  
  Function to be executed.
Returns void

dispose

dispose(): void

Inherited from Control.dispose

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.

Returns void

endUpdate

endUpdate(shouldInvalidate?: boolean): void

Inherited from Control.endUpdate

Resumes notifications suspended by calls to beginUpdate.

Parameters
- Optional shouldInvalidate: boolean
  
  should invalidate the control. Default value for this parameter is true.
Returns void

focus

focus(): void

Inherited from Control.focus

Sets the focus to this control.

Returns void

getTemplate

getTemplate(): string

Inherited from Control.getTemplate

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).

Returns string

hasOwnProperty

hasOwnProperty(v: PropertyKey): boolean

Inherited from Object.hasOwnProperty

Determines whether an object has a property with the specified name.

Parameters
- v: PropertyKey
  
  A property name.
Returns boolean

initialize

initialize(options: any): void

Inherited from Control.initialize
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.
Returns void

invalidate

invalidate(fullUpdate?: boolean): void

Inherited from Control.invalidate

Invalidates the control causing an asynchronous refresh.

Parameters
- Optional fullUpdate: boolean
  
  Whether to update the control layout as well as the content.
Returns void

isPrototypeOf

isPrototypeOf(v: Object): boolean

Inherited from Object.isPrototypeOf

Determines whether an object exists in another object's prototype chain.

Parameters
- v: Object
  
  Another object whose prototype chain is to be checked.
Returns boolean

onGotFocus

onGotFocus(e?: EventArgs): void

Inherited from Control.onGotFocus

Raises the gotFocus event.

Parameters
- Optional e: EventArgs
Returns void

onInvalidInput

onInvalidInput(e: CancelEventArgs): boolean

Inherited from Control.onInvalidInput

Raises the invalidInput event.

If the event handler cancels the event, the control will keep the invalid input and the focus.

Parameters
- e: CancelEventArgs
Returns boolean

onItemsSourceChanged

onItemsSourceChanged(e: EventArgs): void

Raises the itemsSourceChanged event.

Parameters
- e: EventArgs
Returns void

onItemsSourceChanging

onItemsSourceChanging(e: CancelEventArgs): boolean

Raises the itemsSourceChanging event.

Parameters
- e: CancelEventArgs
  
  CancelEventArgs that contains the event data.
Returns boolean

True if the event was not canceled.

onRefreshed

onRefreshed(e?: EventArgs): void

Inherited from Control.onRefreshed

Raises the refreshed event.

Parameters
- Optional e: EventArgs
Returns void

onRefreshing

onRefreshing(e?: EventArgs): void

Inherited from Control.onRefreshing

Raises the refreshing event.

Parameters
- Optional e: EventArgs
Returns void

onRendered

onRendered(e: RenderEventArgs): void

Raises the rendered event.

Parameters
- e: RenderEventArgs
  
  The RenderEventArgs object used to render the chart.
Returns void

onRendering

onRendering(e: RenderEventArgs): void

Raises the rendering event.

Parameters
- e: RenderEventArgs
  
  The RenderEventArgs object used to render the chart.
Returns void

onSelectionChanged

onSelectionChanged(e?: EventArgs): void

Raises the selectionChanged event.

Parameters
- Optional e: EventArgs
Returns void

pageToControl

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

Converts page coordinates to control coordinates.

Parameters
- pt: any
  
  The point of page coordinates or x value of page coordinates.
- Optional y: number
  
  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.
Returns Point

propertyIsEnumerable

propertyIsEnumerable(v: PropertyKey): boolean

Inherited from Object.propertyIsEnumerable

Determines whether a specified property is enumerable.

Parameters
- v: PropertyKey
  
  A property name.
Returns boolean

refresh

refresh(fullUpdate?: boolean): void

Overrides Control.refresh

Refreshes the chart.

Parameters
- Optional fullUpdate: boolean
  
  A value indicating whether to update the control layout as well as the content.
Returns void

removeEventListener

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

Inherited from Control.removeEventListener

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

Parameters
- Optional target: EventTarget
  
  Target element for the event. If null, removes listeners attached to all targets.
- Optional type: string
  
  String that specifies the event. If null, removes listeners attached to all events.
- Optional fn: any
  
  Handler to remove. If null, removes all handlers.
- Optional capture: boolean
  
  Whether the listener is capturing. If null, removes capturing and non-capturing listeners.
Returns number

The number of listeners removed.

saveImageToDataUrl

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.

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.
Returns void

saveImageToFile

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.

Parameters
- filename: string
  
  The filename for the exported image file including extension. Supported types are PNG, JPEG and SVG.
Returns void

saveSvgToDataUrl

saveSvgToDataUrl(done: Function, embedCss?: boolean): void

Saves the chart to a data url as SVG image.

Parameters
- done: Function
  
  A function to be called after data url is generated. The function gets passed the data url as its argument.
- Optional embedCss: boolean
  
  Whether to include CSS styles to SVG image.
Returns void

saveSvgToFile

saveSvgToFile(filename: string, embedCss?: boolean): void

Saves the chart to an SVG image file.

Parameters
- filename: string
  
  The filename for the exported image file including extension.
- Optional embedCss: boolean
  
  Whether to include CSS styles to SVG image.
Returns void

toLocaleString

toLocaleString(): string

Inherited from Object.toLocaleString

Returns a date converted to a string using the current locale.

Returns string

toString

toString(): string

Inherited from Object.toString

Returns a string representation of an object.

Returns string

valueOf

valueOf(): Object

Inherited from Object.valueOf

Returns the primitive value of the specified object.

Returns Object

Static disposeAll

disposeAll(e?: HTMLElement): void

Inherited from Control.disposeAll

Disposes of all Wijmo controls contained in an HTML element.

Parameters
- Optional e: HTMLElement
  
  Container element.
Returns void

Static getControl

getControl(element: any): Control

Inherited from Control.getControl

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

Parameters
- element: any
  
  The DOM element that hosts the control, or a CSS selector for the host element (e.g. '#theCtrl').
Returns Control

Static invalidateAll

invalidateAll(e?: HTMLElement): void

Inherited from Control.invalidateAll

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 Control.invalidateAll method so the contained Wijmo controls will update their layout information properly.

Parameters
- Optional e: HTMLElement
  
  Container element. If set to null, all Wijmo controls on the page will be invalidated.
Returns void

Static refreshAll

refreshAll(e?: HTMLElement): void

Inherited from Control.refreshAll

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
- Optional e: HTMLElement
  
  Container element. If set to null, all Wijmo controls on the page will be invalidated.
Returns void

Events

gotFocus

gotFocus: Event<Control, EventArgs>

Occurs when the control gets the focus.

invalidInput

invalidInput: Event<Control, CancelEventArgs>

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.

itemsSourceChanged

itemsSourceChanged: Event<FlexChartBase<any>, EventArgs>

Occurs after the chart has been bound to a new items source.

itemsSourceChanging

itemsSourceChanging: Event<FlexChartBase<any>, CancelEventArgs>

Occurs before the chart is bound to a new items source.

lostFocus

lostFocus: Event<Control, EventArgs>

Occurs when the control loses the focus.

refreshed

refreshed: Event<Control, EventArgs>

Occurs after the control has refreshed its contents.

refreshing

refreshing: Event<Control, EventArgs>

Occurs when the control is about to refresh its contents.

rendered

rendered: Event<FlexChartBase<any>, RenderEventArgs>

Occurs after the chart finishes rendering.

rendering

rendering: Event<FlexChartBase<any>, RenderEventArgs>

Occurs before the chart starts rendering data.

selectionChanged

selectionChanged: Event<FlexChartBase<any>, EventArgs>

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.

FlexChartBase Class

FlexChartBase Class

Type parameters

T

Heirarchy

Constructors

Properties

Methods

Events

Constructors

constructor

Parameters

element: any

Optional options: any

Optional invalidateOnResize: boolean

Returns FlexChartBase

Properties

collectionView

footer

footerStyle

header

headerStyle

hostElement

isDisabled

isTouching

isUpdating

itemFormatter

itemsSource

legend

options

palette

plotMargin

rightToLeft

selectionMode

tabOrder

Methods

addEventListener

Parameters

target: EventTarget

type: string

fn: any

Optional capture: boolean

Optional passive: boolean

Returns void

applyTemplate

Parameters

classNames: string

template: string

parts: Object

Optional namePart: string

Returns HTMLElement

beginUpdate

Returns void

containsFocus

Returns boolean

deferUpdate

Parameters

fn: Function

Returns void

dispose

Returns void

endUpdate

Parameters

Optional shouldInvalidate: boolean

Returns void

focus

Returns void

getTemplate

Returns string

hasOwnProperty

Parameters

v: PropertyKey

Returns boolean

initialize

Parameters

options: any

Returns void

invalidate

Parameters

Optional fullUpdate: boolean