| Client-Side API Reference > FlexChart > wijmo.hierarchical > Sunburst Class |
constructor(element: any, options?): FlexPie
Initializes a new instance of the FlexPie 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 chart values.
Gets or sets the name of the property containing name of the data item; it should be an array or a string.
Gets or sets the name of the property (or properties) used to generate child items in hierarchical data.
Set this property to a string to specify the name of the property that contains an item's child items (e.g. 'items').
Set this property to an array containing the names of the properties that contain child items at each level, when the items are child items at different levels with different names (e.g. [ 'accounts', 'checks', 'earnings' ]).
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 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.
Gets or sets a value indicating whether to use animation when items are selected.
See also the selectedItemPosition and selectionMode properties.
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 data points. See the Explorer sample's Item Formatter for a demonstration.
Gets or sets the array or ICollectionView object that contains the data used to create the chart.
Gets or sets the offset of the slices from the pie center.
The offset is measured as a fraction of the pie radius.
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;
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 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.
Gets a value indicating whether the control is hosted in an element with right-to-left layout.
Gets or sets the offset of the selected slice from the pie center.
Offsets are measured as a fraction of the pie radius.
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".
Gets or sets an enumerated value indicating whether or what is selected when the user clicks the chart.
Gets or sets the starting angle for the pie slices, in degrees.
Angles are measured clockwise, starting at the 9 o'clock position.
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.
Target element for the event.
String that specifies the event.
Function to execute when the event occurs.
Whether the listener is capturing.
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');
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.
containsFocus(): boolean
Checks whether this control contains the focused element.
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.
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.
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 is hosting the control, or a 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, it will override the template defined by the DropDown base class.
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.
onLostFocus(e?: EventArgs): void
Raises the lostFocus 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.
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
Save chart to image data url.
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
Save chart to an image file.
The filename for the exported image file including extension. Supported types are PNG, JPEG, SVG.
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.
Sunburst chart control.