[]
DEMOS DOCS API
DOWNLOAD NEED HELP? BOOK DEMO
(Showing Draft Content)

FlexPie Class

FlexPie Class

The FlexPie control provides pie and doughnut charts with selectable slices.

To use the FlexPie control, set the FlexPie.itemsSource property to an array containing the data and use the FlexPie.binding and FlexPie.bindingName properties to set the properties that contain the item values and names.

Type parameters

  • T

Heirarchy

Constructors

Properties

Methods

Events

Constructors

constructor

  • new FlexPie(element: any, options?: any): FlexPie

  • Initializes a new instance of the FlexPie class.

    Parameters

    • element: any

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

    • Optional options: any

      A Javascript object containing initialization data for the control.

    Returns FlexPie

Properties

binding

binding: string

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

bindingName

bindingName: string

Gets or sets the name of the property that contains the name of the data items.

chartsPerLine

chartsPerLine: number

Gets or sets the maximal number of charts per line.

The property is used when there are multiple pies. By default, it's undefined and the control perform layout automatically.

collectionView

collectionView: ICollectionView<T>

Gets the ICollectionView object that contains the chart data.

dataLabel

dataLabel: PieDataLabel

Gets or sets the point data label.

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.

innerRadius

innerRadius: number

Gets or sets the size of the pie's inner radius.

The inner radius is measured as a fraction of the pie radius.

The default value for this property is zero, which creates a pie. Setting this property to values greater than zero creates pies with a hole in the middle, also known as doughnut charts. The valid range for inner radius is from 0 to 1.

The default value for this property is 0.

innerText

innerText: any

Gets or sets the text inside the pie (at the pie center).

innerTextStyle

innerTextStyle: any

Gets or sets the style of text inside the pie.

isAnimated

isAnimated: boolean

Gets or sets a value indicating whether to use animation when items are selected.

See also the selectedItemPosition and selectionMode properties.

The default value for this property is false.

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.

offset

offset: number

Gets or sets the offset of the slices from the pie center.

The offset is measured as a fraction of the pie radius.

The default value for this property is 0.

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

reversed

reversed: boolean

Gets or sets a value that determines whether angles are reversed (counter-clockwise).

The default value is false, which causes angles to be measured in the clockwise direction.

The default value for this property is false.

rightToLeft

rightToLeft: boolean

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

selectedIndex

selectedIndex: number

Gets or sets the index of the selected slice.

selectedItemOffset

selectedItemOffset: number

Gets or sets the offset of the selected slice from the pie center.

Offsets are measured as a fraction of the pie radius.

The default value for this property is 0.

selectedItemPosition

selectedItemPosition: Position

Gets or sets the position of the selected slice.

Setting this property to a value other than 'None' causes the pie to rotate when an item is selected.

Note that in order to select slices by clicking the chart, you must set the selectionMode property to 'Point'.

The default value for this property is Position.None.

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.

startAngle

startAngle: number

Gets or sets the starting angle for the pie slices, in degrees.

Angles are measured clockwise, starting at the 9 o'clock position.

The default value for this property is 0.

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.

titles

titles: string[]

Gets or sets the pie titles.

The titles are shown above each pie chart when multiple properties are specified in binding. If the property is not set (undefined) the property names are used as pie titles.

tooltip

tooltip: ChartTooltip

Gets the chart's Tooltip.

Methods

addEventListener

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

    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

  • 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

containsFocus

  • containsFocus(): boolean

  • Checks whether this control contains the focused element.

    Returns boolean

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

    • fn: Function

      Function to be executed.

    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.

    Returns void

endUpdate

  • endUpdate(shouldInvalidate?: boolean): void

  • 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

  • Sets the focus to this control.

    Returns void

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, 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

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

    Parameters

    • v: PropertyKey

      A property name.

    Returns boolean

hitTest

  • hitTest(pt: any, y?: number, isTooltip?: boolean): HitTestInfo

  • Gets a HitTestInfo object with information about the specified point.

    Parameters

    • pt: any

      The point to investigate, in window coordinates.

    • Optional y: number

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

    • Optional isTooltip: boolean

      Enables hit testing for tooltip.

    Returns HitTestInfo

    A HitTestInfo object containing information about the point.

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.

    Returns void

invalidate

  • invalidate(fullUpdate?: boolean): void

  • 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

  • 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

onInvalidInput

onItemsSourceChanged

onItemsSourceChanging

onRefreshed

onRefreshing

onRendered

onRendering

onSelectionChanged

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

  • Determines whether a specified property is enumerable.

    Parameters

    • v: PropertyKey

      A property name.

    Returns boolean

refresh

  • refresh(fullUpdate?: boolean): void

  • 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

  • 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

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

    Returns string

toString

  • toString(): string

  • Returns a string representation of an object.

    Returns string

valueOf

  • valueOf(): Object

  • Returns the primitive value of the specified object.

    Returns Object

Static disposeAll

  • disposeAll(e?: HTMLElement): void

  • Disposes of all Wijmo controls contained in an HTML element.

    Parameters

    • Optional e: HTMLElement

      Container element.

    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 hosts the control, or a CSS selector for the host element (e.g. '#theCtrl').

    Returns Control

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

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