WjFlexPie Class
WjFlexPie Class
Type parameters
-
T
Heirarchy
-
FlexPie
- WjFlexPie
Properties
- binding
- binding
Name - charts
Per Line - collection
View - data
Label - footer
- footer
Style - got
Focus Ng - header
- header
Style - host
Element - initialized
- inner
Radius - inner
Text - inner
Text Style - invalid
Input Ng - is
Animated - is
Disabled - is
Initialized - is
Touching - is
Updating - item
Formatter - items
Source - items
Source Changed Ng - items
Source Changing Ng - legend
- lost
Focus Ng - offset
- options
- palette
- plot
Margin - refreshed
Ng - refreshing
Ng - rendered
Ng - rendering
Ng - reversed
- right
ToLeft - selected
Index - selected
Item Offset - selected
Item Position - selection
Changed Ng - selection
Mode - start
Angle - tab
Order - titles
- tooltip
- wj
Model Property
Methods
- apply
Template - begin
Update - contains
Focus - created
- defer
Update - dispose
- end
Update - focus
- get
Template - has
Own Property - hit
Test - initialize
- invalidate
- is
Prototype Of - on
Got Focus - on
Invalid Input - on
Items Source Changed - on
Items Source Changing - on
Refreshed - on
Refreshing - on
Rendered - on
Rendering - on
Selection Changed - page
ToControl - property
IsEnumerable - refresh
- remove
Event Listener - save
Image ToData Url - save
Image ToFile - save
Svg ToData Url - save
Svg ToFile - to
Locale String - to
String - value
Of - dispose
All - get
Control - invalidate
All - refresh
All
Events
Properties
binding
Gets or sets the name of the property that contains the chart values.
bindingName
Gets or sets the name of the property that contains the name of the data items.
chartsPerLine
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
Gets the ICollectionView object that contains the chart data.
dataLabel
Gets or sets the point data label.
footer
Gets or sets the text displayed in the chart footer.
footerStyle
Gets or sets the style of the chart footer.
gotFocusNg
Angular (EventEmitter) version of the Wijmo gotFocus event for programmatic access. Use this event name if you want to subscribe to the Angular version of the event in code. In template bindings use the conventional gotFocus Wijmo event name.
header
Gets or sets the text displayed in the chart header.
headerStyle
Gets or sets the style of the chart header.
hostElement
Gets the DOM element that is hosting the control.
initialized
This event is triggered after the component has been initialized by Angular, that is all bound properties have been assigned and child components (if any) have been initialized.
innerRadius
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
Gets or sets the text inside the pie (at the pie center).
innerTextStyle
Gets or sets the style of text inside the pie.
invalidInputNg
Angular (EventEmitter) version of the Wijmo invalidInput event for programmatic access. Use this event name if you want to subscribe to the Angular version of the event in code. In template bindings use the conventional invalidInput Wijmo event name.
isAnimated
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
Gets or sets a value that determines whether the control is disabled.
Disabled controls cannot get mouse or keyboard events.
isInitialized
Indicates whether the component has been initialized by Angular. Changes its value from false to true right before triggering the initialized event.
isTouching
Gets a value that indicates whether the control is currently handling a touch event.
isUpdating
Gets a value that indicates whether the control is currently being updated.
itemFormatter
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
Gets or sets the array or ICollectionView object that contains the data used to create the chart.
itemsSourceChangedNg
Angular (EventEmitter) version of the Wijmo itemsSourceChanged event for programmatic access. Use this event name if you want to subscribe to the Angular version of the event in code. In template bindings use the conventional itemsSourceChanged Wijmo event name.
itemsSourceChangingNg
Angular (EventEmitter) version of the Wijmo itemsSourceChanging event for programmatic access. Use this event name if you want to subscribe to the Angular version of the event in code. In template bindings use the conventional itemsSourceChanging Wijmo event name.
legend
Gets or sets the chart legend.
lostFocusNg
Angular (EventEmitter) version of the Wijmo lostFocus event for programmatic access. Use this event name if you want to subscribe to the Angular version of the event in code. In template bindings use the conventional lostFocus Wijmo event name.
offset
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
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
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
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';
refreshedNg
Angular (EventEmitter) version of the Wijmo refreshed event for programmatic access. Use this event name if you want to subscribe to the Angular version of the event in code. In template bindings use the conventional refreshed Wijmo event name.
refreshingNg
Angular (EventEmitter) version of the Wijmo refreshing event for programmatic access. Use this event name if you want to subscribe to the Angular version of the event in code. In template bindings use the conventional refreshing Wijmo event name.
renderedNg
Angular (EventEmitter) version of the Wijmo rendered event for programmatic access. Use this event name if you want to subscribe to the Angular version of the event in code. In template bindings use the conventional rendered Wijmo event name.
renderingNg
Angular (EventEmitter) version of the Wijmo rendering event for programmatic access. Use this event name if you want to subscribe to the Angular version of the event in code. In template bindings use the conventional rendering Wijmo event name.
reversed
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
Gets a value indicating whether the control is hosted in an element with right-to-left layout.
selectedIndex
Gets or sets the index of the selected slice.
selectedItemOffset
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
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.
selectionChangedNg
Angular (EventEmitter) version of the Wijmo selectionChanged event for programmatic access. Use this event name if you want to subscribe to the Angular version of the event in code. In template bindings use the conventional selectionChanged Wijmo event name.
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
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
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
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
Gets the chart's Tooltip.
wjModelProperty
Defines a name of a property represented by [(ngModel)] directive (if specified). Default value is ''.
Methods
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
-
Suspends notifications until the next call to endUpdate.
Returns void
containsFocus
-
Checks whether this control contains the focused element.
Returns boolean
created
-
If you create a custom component inherited from a Wijmo component, you can override this method and perform necessary initializations that you usually do in a class constructor. This method is called in the last line of a Wijmo component constructor and allows you to not declare your custom component's constructor at all, thus preventing you from a necessity to maintain constructor parameters and keep them in synch with Wijmo component's constructor parameters.
Returns void
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
-
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
-
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
-
Sets the focus to this control.
Returns void
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
-
Determines whether an object has a property with the specified name.
Parameters
-
v: PropertyKey
A property name.
Returns boolean
-
hitTest
-
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
-
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
-
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
-
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
-
Raises the invalidInput event.
If the event handler cancels the event, the control will keep the invalid input and the focus.
Parameters
Returns boolean
onItemsSourceChanged
-
Raises the itemsSourceChanged event.
Parameters
-
e: EventArgs
Returns void
-
onItemsSourceChanging
-
Raises the itemsSourceChanging event.
Parameters
-
e: CancelEventArgs
CancelEventArgs that contains the event data.
Returns boolean
True if the event was not canceled.
-
onRefreshed
onRefreshing
-
Raises the refreshing event.
Parameters
-
Optional e: EventArgs
Returns void
-
onRendered
-
Raises the rendered event.
Parameters
-
e: RenderEventArgs
The RenderEventArgs object used to render the chart.
Returns void
-
onRendering
-
Raises the rendering event.
Parameters
-
e: RenderEventArgs
The RenderEventArgs object used to render the chart.
Returns void
-
onSelectionChanged
-
Raises the selectionChanged event.
Parameters
-
Optional e: EventArgs
Returns void
-
pageToControl
-
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
-
Determines whether a specified property is enumerable.
Parameters
-
v: PropertyKey
A property name.
Returns boolean
-
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
-
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
-
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.rendermodule 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
-
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
-
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
-
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
-
Returns a date converted to a string using the current locale.
Returns string
toString
-
Returns a string representation of an object.
Returns string
valueOf
-
Returns the primitive value of the specified object.
Returns Object
Static disposeAll
-
Disposes of all Wijmo controls contained in an HTML element.
Parameters
-
Optional e: HTMLElement
Container element.
Returns void
-
Static 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
-
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
-
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
Occurs when the control gets the focus.
invalidInput
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
Occurs after the chart has been bound to a new items source.
itemsSourceChanging
Occurs before the chart is bound to a new items source.
lostFocus
Occurs when the control loses the focus.
refreshed
Occurs after the control has refreshed its contents.
refreshing
Occurs when the control is about to refresh its contents.
rendered
Occurs after the chart finishes rendering.
rendering
Occurs before the chart starts rendering data.
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.
Angular 2 component for the wijmo.chart.FlexPie control.
Use the wj-flex-pie component to add FlexPie controls to your Angular 2 applications. For details about Angular 2 markup syntax, see Angular 2 Markup.
The WjFlexPie component is derived from the FlexPie control and inherits all its properties, events and methods.
The wj-flex-pie component may contain the following child components: wijmo.angular2.chart.animation.WjFlexChartAnimation , wijmo.angular2.chart.WjFlexChartLegend and wijmo.angular2.chart.WjFlexPieDataLabel.