WjFlexRadarAxis Class

File
wijmo.angular2.js
Module
wijmo/wijmo.angular2.chart.radar
Base Class
FlexRadarAxis
Show
   

Angular 2 component for the FlexRadarAxis control.

The wj-flex-radar-axis component must be contained in one of the following components: WjFlexRadar or WjFlexRadarSeries.

Use the wj-flex-radar-axis component to add FlexRadarAxis controls to your Angular 2 applications. For details about Angular 2 markup syntax, see Angular 2 Markup.

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

Constructor

Properties

Methods

Events

Constructor

constructor

constructor(position?: Position): Axis

Initializes a new instance of the Axis class.

Parameters
Inherited From
Axis
Returns
Axis

Properties

actualMax

Gets the actual axis maximum.

It returns a number or a Date object (for time-based data).

Inherited From
Axis
Type
any

actualMin

Gets the actual axis minimum.

It returns a number or a Date object (for time-based data).

Inherited From
Axis
Type
any

axisLine

Gets or sets a value indicating whether the axis line is visible.

Inherited From
Axis
Type
boolean

axisType

Gets the axis type.

Inherited From
Axis
Type
AxisType

binding

Gets or sets the comma-separated property names for the itemsSource property to use in axis labels.

The first name specifies the value on the axis, the second represents the corresponding axis label. The default value is 'value,text'.

Inherited From
Axis
Type
string

format

Gets or sets the format string used for the axis labels (see Globalize).

Inherited From
Axis
Type
string

hostElement

Gets the axis host element.

Inherited From
Axis
Type
SVGGElement

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

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

itemFormatter

Gets or sets the itemFormatter function for the axis labels.

If specified, the function takes two parameters:

  • render engine: The IRenderEngine object to be used in formatting the labels.
  • current label: A string value with the following properties:
    • value: The value of the axis label to format.
    • text: The text to use in the label.
    • pos: The position in control coordinates at which the label is to be rendered.
    • cls: The CSS class to be applied to the label.

The function returns the label parameters of labels for which properties are modified.

For example:

chart.axisY.itemFormatter = function(engine, label) {
    if (label.val > 5){
        engine.textFill = 'red'; // red text
        label.cls = null; // no default CSS
     }
    return label;
}
Inherited From
Axis
Type
Function

itemsSource

Gets or sets the items source for the axis labels.

Names of the properties are specified by the binding.

For example:

// default value for Axis.binding is 'value,text'
 chart.axisX.itemsSource = [ { value:1, text:'one' }, { value:2, text:'two' } ];
Inherited From
Axis
Type
any

labelAlign

Gets or sets the label alignment.

By default the labels are centered. The supported values are 'left' and 'right for x-axis and 'top' and 'bottom' for y-axis.

Inherited From
Axis
Type
string

labelAngle

Gets or sets the rotation angle of the axis labels.

The angle is measured in degrees with valid values ranging from -90 to 90.

Inherited From
Axis
Type
number

labelPadding

Gets or sets the label padding.

Inherited From
Axis
Type
number

labels

Gets or sets a value indicating whether the axis labels are visible.

Inherited From
Axis
Type
boolean

logBase

Gets or sets the logarithmic base of the axis.

If the base is not specified the axis uses a linear scale.

Use the logBase property to spread data that is clustered around the origin. This is common in several financial and economic data sets.

Inherited From
Axis
Type
number

majorGrid

Gets or sets a value indicating whether the axis includes grid lines.

Inherited From
Axis
Type
boolean

majorTickMarks

Gets or sets the location of the axis tick marks.

Inherited From
Axis
Type
TickMark

majorUnit

Gets or sets the number of units between axis labels.

If the axis contains date values, then the units are expressed in days.

Inherited From
Axis
Type
number

max

Gets or sets the maximum value shown on the axis.

If not set, the maximum is calculated automatically. The value can be a number or a Date object (for time-based data).

Inherited From
Axis
Type
any

min

Gets or sets the minimum value shown on the axis.

If not set, the minimum is calculated automatically. The value can be a number or a Date object (for time-based data).

Inherited From
Axis
Type
any

minorGrid

Gets or sets a value indicating whether the axis includes minor grid lines.

Inherited From
Axis
Type
boolean

minorTickMarks

Gets or sets the location of the minor axis tick marks.

Inherited From
Axis
Type
TickMark

minorUnit

Gets or sets the number of units between minor axis ticks.

If the axis contains date values, then the units are expressed in days.

Inherited From
Axis
Type
number

name

Gets or sets the axis name.

Inherited From
Axis
Type
string

origin

Gets or sets the value at which an axis crosses the perpendicular axis.

Inherited From
Axis
Type
number

overlappingLabels

Gets or sets a value indicating how to handle the overlapping axis labels.

Inherited From
Axis
Type
OverlappingLabels

plotArea

Gets or sets the plot area for the axis.

Inherited From
Axis
Type
PlotArea

position

Gets or sets the enumerated axis position.

Inherited From
Axis
Type
Position

rangeChangedNg

Angular (EventEmitter) version of the Wijmo rangeChanged 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 rangeChanged Wijmo event name.

Type
EventEmitter

reversed

Gets or sets a value indicating whether the axis is reversed (top to bottom or right to left).

Inherited From
Axis
Type
boolean

title

Gets or sets the title text shown next to the axis.

Inherited From
Axis
Type
string

wjProperty

Gets or sets a name of a property that this component is assigned to. Default value is 'axes'.

Type
string

Methods

convert

convert(val: number, maxValue?: number, minValue?: number): number

Converts the specified value from data to pixel coordinates.

Parameters
Inherited From
Axis
Returns
number

convertBack

convertBack(val: number): number

Converts the specified value from pixel to data coordinates.

Parameters
Inherited From
Axis
Returns
number

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

onRangeChanged

onRangeChanged(e?: EventArgs): void

Raises the rangeChanged event.

Parameters
Inherited From
Axis
Returns
void

Events

rangeChanged

Occurs when the axis range changes.

Inherited From
Axis
Arguments
EventArgs