WjPivotChart Class

File
wijmo.angular2.js
Module
wijmo/wijmo.angular2.olap
Base Class
PivotChart
Show
   

Angular 2 component for the PivotChart control.

Use the wj-pivot-chart component to add PivotChart controls to your Angular 2 applications. For details about Angular 2 markup syntax, see Angular 2 Markup.

The WjPivotChart component is derived from the PivotChart control and inherits all its properties, events and methods.

Constructor

Properties

Methods

Events

Constructor

constructor

constructor(element: any, options?): PivotChart

Initializes a new instance of the PivotChart class.

Parameters
Inherited From
PivotChart
Returns
PivotChart

Properties

chartType

Gets or sets the type of chart to create.

The default value for this property is PivotChartType.Column.

Inherited From
PivotChart
Type
PivotChartType

engine

Gets a reference to the PivotEngine that owns this PivotChart.

Inherited From
PivotChart
Type
PivotEngine

flexChart

Gets a reference to the inner FlexChart control.

Inherited From
PivotChart
Type
FlexChart

flexPie

Gets a reference to the inner FlexPie control.

Inherited From
PivotChart
Type
FlexPie

footerStyle

Gets or sets the style of the chart footer.

Inherited From
PivotChart
Type
any

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.

Type
EventEmitter

headerStyle

Gets or sets the style of the chart header.

Inherited From
PivotChart
Type
any

hostElement

Gets the DOM element that is hosting the control.

Inherited From
Control
Type
HTMLElement

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.

Type
EventEmitter

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

isInitialized

Indicates whether the component has been initialized by Angular. Changes its value from false to true right before triggering the initialized event.

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

itemsSource

Gets or sets the PivotEngine or PivotPanel that provides data for this PivotChart.

Inherited From
PivotChart
Type
any

legendPosition

Gets or sets a value that determines whether and where the legend appears in relation to the plot area.

The default value for this property is Position.Right.

Inherited From
PivotChart
Type
Position

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.

Type
EventEmitter

maxPoints

Gets or sets the maximum number of points to be shown in each series.

The default value for this property is 100 points.

Inherited From
PivotChart
Type
number

maxSeries

Gets or sets the maximum number of data series to be shown in the chart.

The default value for this property is 100 series.

Inherited From
PivotChart
Type
number

rightToLeft

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

Inherited From
Control
Type
boolean

showHierarchicalAxes

Gets or sets a value that determines whether the chart should group axis annotations for grouped data.

The default value for this property is true.

Inherited From
PivotChart
Type
boolean

showLegend

Gets or sets a value that determines whether the chart should include a legend.

The default value for this property is LegendVisibility.Always.

Inherited From
PivotChart
Type
LegendVisibility

showTitle

Gets or sets a value that determines whether the chart should include a title.

The default value for this property is true.

Inherited From
PivotChart
Type
boolean

showTotals

Gets or sets a value that determines whether the chart should include only totals.

If showTotals is true and the view has Column Fields, then the chart will show column totals instead of individual values.

The default value for this property is false.

Inherited From
PivotChart
Type
boolean

stacking

Gets or sets a value that determines whether and how the series objects are stacked.

The default value for this property is Stacking.None.

Inherited From
PivotChart
Type
Stacking

wjModelProperty

Defines a name of a property represented by [(ngModel)] directive (if specified). Default value is ''.

Type
string

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
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
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
Control
Returns
boolean

created

created(): void

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

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

Inherited From
Control
Returns
string

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
Inherited From
Control
Returns
void

invalidate

invalidate(fullUpdate?: boolean): void

Invalidates the control causing an asynchronous refresh.

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

onRefreshed

onRefreshed(e?: EventArgs): void

Raises the refreshed event.

Parameters
Inherited From
Control
Returns
void

onRefreshing

onRefreshing(e?: EventArgs): void

Raises the refreshing event.

Parameters
Inherited From
Control
Returns
void

refresh

refresh(fullUpdate?: boolean): void

Refreshes the control.

Parameters
Inherited From
PivotChart
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
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
Inherited From
Control
Returns
number

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 wijmo.chart.render module to the page.

Parameters
Inherited From
PivotChart
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
Inherited From
PivotChart
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

refreshed

Occurs after the control has refreshed its contents.

Inherited From
Control
Arguments
EventArgs

refreshing

Occurs when the control is about to refresh its contents.

Inherited From
Control
Arguments
EventArgs