File

projects/components/widgets/chart/src/chart.component.doc.ts

Description

The wmChart component defines the chart widget.

Index

Methods
Inputs

Methods

onSelect
onSelect($event: MouseEvent, widget: any, selectedItem: any, selectedChartItem: any)

Callback function which will be triggered when the chart is selected.

Parameters :
Name Type Optional Description
$event MouseEvent No

DOM event on which call back is triggered

widget any No

Instance of the chart widget

selectedItem any No

The data of selected item from data source

selectedChartItem any No

The data of selected item on chart

Returns : void
onTransform
onTransform($event: MouseEvent, widget: any)

Callback function which will be triggered for transform event.

Parameters :
Name Type Optional Description
$event MouseEvent No

DOM event on which call back is triggered

widget any No

Instance of the chart widget

Returns : void

Inputs

aggregation
Type : string

This property shows the different options available to aggregate the data in the chart.

aggregationcolumn
Type : string

This property shows the columns using which you can aggregate the data in the chart.

areaviewtype
Type : string
Default value : 'stack'

This property controls how to show area in an Area chart.

Allowed Values: Standard Patterns like 'stack', 'stream', 'expand'

barspacing
Type : string
Default value : 'medium'

This property controls the spacing between the bars for bar and column charts.

Allowed Values: Standard Patterns like 'small', 'medium', 'large'

bubblesize
Type : string

This property controls the size of the bubble for a Bubble chart.

centerlabel
Type : string

This property determines the text to include in the centre of a donut chart

customcolors
Type : string

This property enables to define custom colors to chart.

datavalue
Type : string

This property defines the value of the chart widget.

Bindable: true

donutratio
Type : string
Default value : 'medium'

This property controls the radius of a Donut chart.

Allowed Values: Standard Patterns like 'small', 'medium', 'large'

formattype
Type : string

This property shows the options to format the number type.

groupby
Type : string

This property shows the options to group the data.

highlightpoints
Type : boolean
Default value : false

This property decides whether to highlight points or not.

iconclass
Type : string

CSS class of the icon.

interpolation
Type : string
Default value : 'linear'

This property determines how datapoints are joined and rendered in chart

Allowed Values: Standard Patterns like 'linear', 'cardinal', 'step'

labeltype
Type : string
Default value : 'percent'

This property controls the type of the label to be shown in the chart.

Allowed Values: Standard Patterns like 'key', 'value', 'percent', 'key, value'

linethickness
Type : string

This property controls thickness of line in line and cumulative line chart.

loadingdatamsg
Type : string
Default value : 'Loading...'

This property shows the message which will be displayed in grid, when the data is loading.

Bindable: true

name
Type : string

Name of the chart widget.

nodatamessage
Type : string
Default value : 'No Data Available.'

This property shows the message which will be displayed in grid, when there is no data to display.

Bindable: true

offset
Type : number

This property controls the offset(left, right, top, bottom) of the chart.

orderby
Type : string

This property shows the options to order the data.

reducexticks
Type : boolean
Default value : true

This property controls whether to reduce the xticks or not.

show
Type : boolean
Default value : true

This property will be used to show/hide the chart widget on the web page.

Bindable: true

showlabels
Type : string
Default value : 'outside'

This property controls the visibility of labels.

Allowed Values: Standard Patterns like 'hide', 'outside', 'inside'

showlegend
Type : string
Default value : 'top'

This property controls where to show the legends.

Allowed Values: Standard Patterns like 'hide', 'top', 'bottom', right

showvalues
Type : boolean
Default value : false

This property controls showing of values on the bars.

showxaxis
Type : boolean
Default value : true

This property decides whether to show x axis or not.

showxdistance
Type : boolean
Default value : false

This property enables showing the distance from the x axis.

showyaxis
Type : boolean
Default value : true

This property decides whether to show y axis or not.

showydistance
Type : boolean
Default value : false

This property enables showing the distance from the y axis.

staggerlabels
Type : boolean
Default value : false

This property controls whether to stagger the labels which distributes labels into multiple lines.

subheading
Type : string

Subheading for the chart widget.

Bindable: true

theme
Type : string

This property controls theme of chart.

Allowed Values: Standard Patterns like 'Terrestrial', 'Annabelle', 'Azure', 'Retro', 'Mellow', 'Orient', 'GrayScale', 'Flyer', 'Luminosity'

title
Type : string

Title for the chart widget.

Bindable: true

tooltips
Type : boolean
Default value : true

This property controls whether to show the tooltip on hover.

type
Type : string

The type of the chart.

xaxisdatakey
Type : string

This property defines the key of the object, i.e y-axis variable, on the chart.

xaxislabel
Type : string

This property defines the caption of x axis on the chart.

Bindable: true

xaxislabeldistance
Type : number

This property controls the distance between the x axis and its label.

xdateformat
Type : string

This property shows the options to format the date type in x axis.

xdigits
Type : number

This property defines the number of digits to be displayed after decimal in x axis.

xnumberformat
Type : string

This property shows the options to format the number type in x axis.

xunits
Type : number

This property defines the number of digits to be displayed after decimal in x axis.

yaxisdatakey
Type : string

This property specifies the units for the y axis.

yaxislabel
Type : string

This property defines the caption of y axis on the chart.

yaxislabeldistance
Type : number

This property controls the distance between the y axis and its label.

ydigits
Type : number

This property shows the number of digits to be displayed after decimal in y axis.

ynumberformat
Type : string

This property shows the options to format the number type in y axis.

Bindable: true

yunits
Type : number

This property specifies the units for the y axis.

result-matching ""

    No results matching ""