Parameters used by Axis Charts, which are all except Pie Charts. Axis Charts provide the following animators:

  • point-height with initial value in pointHeightStart.
  • deviation with initial value in deviationStart.
  • sweep with initial value in sweepStart.
interface AxisChartTaskParams {
    animeSelector?: string;
    barWidth?: any;
    chartType?: string | ChartTypes;
    chartTypes?: (string | ChartTypes)[];
    data: SeriesData[];
    deviationStart?: any;
    fillColors?: string | string[] | string[][];
    labelsX?: any;
    labelsY?: any;
    legend?: ChartLegend;
    markers?: ChartMarkers;
    maxValue?: any;
    minValue?: any;
    negativeFillColors?: string | string[] | string[][];
    pointDistance?: any;
    pointHeightStart?: any;
    pointMaxHeight?: any;
    seriesSpacing?: any;
    strokeColors?: string | string[] | string[][];
    strokeWidth?: any;
    sweepStart?: any;
    title?: any;
    xAxis?: ChartLine;
    y0Line?: ChartLine;
    yAxis?: ChartLine;
}

Hierarchy (view full)

Properties

animeSelector?: string

Set with a unique virtual selector, to be used another addAnimations to animate the chart.

   scene.addAnimations([{
selector: 'canvas',
tasks: [{
handler: 'chart',
params: {
data: [[100, 200, 50, 140, 300]],
pointHeightStart: 0.1, // defined the initial value for the animation point-height property
animeSelector: 'chart-anime-02', // unique animation selector to be used by the animator
} as BeamToIX.AxisChartTaskParams,
}],
}])
.addAnimations([{
selector: `%chart-anime-02`, // animation selector defined previously, prefixed with '%'
duration: `1s`,
props: [{
prop: 'point-height', // property which initial value is 0.1
value: 1, // value at the end of animation
}],
}]);
barWidth?: any

x bar length for bar charts. If it's zero, it's calculated automatically in order to fill the complete x-space.

chartType?: string | ChartTypes

Defines the type of chart. If it's mixed it uses

chartTypes?: (string | ChartTypes)[]

Chart Type per series. Use only if is mixed. @example: [BeamToIX.ChartTypes.bar, BeamToIX.ChartTypes.bar, BeamToIX.ChartTypes.line]

data: SeriesData[]

List of series of data points. Each series much have the same number of data points.

deviationStart?: any
fillColors?: string | string[] | string[][]

Interior Color used by area, bar and pie charts.

labelsX?: any

Defines the X labels with complete information or just as an . If it's a ExprString, it will create one label for each point. The iterator variable is v. If it's an array, it must match the number of points in a series.

=2012 + v
{ captions: ['A', 'B', 'C', 'D'] }
labelsY?: any

Defines the Y labels with complete information or just as an . If it's a ExprString, it will create one label for each point. The iterator variable is v. If it's an array, it must match the tickCount.

=v/1000 + 'k'
{ captions: ['10', '20', '30', '40'] }
legend?: ChartLegend

Defines the chart legend. At the moment is only supported stacked left or right top legend.

markers?: ChartMarkers
maxValue?: any
minValue?: any
negativeFillColors?: string | string[] | string[][]

Colors to be used in case of the data point is negative. At the moment, it only supports bar charts.

pointDistance?: any

x distance between two data points. If it's zero, it's calculated automatically in order to fill the complete x-space. If the chart includes bars charts it must be big enough to include all the bars.

pointHeightStart?: any
pointMaxHeight?: any
seriesSpacing?: any

x space between two bars. Used only in bar charts.

strokeColors?: string | string[] | string[][]

Outline Color used by area, bar and pie charts, and line color for line chart.

strokeWidth?: any
sweepStart?: any
title?: any

Defines the chart title. At the moment is only supported horizontal top or bottom titles.

xAxis?: ChartLine
y0Line?: ChartLine
yAxis?: ChartLine