PromptPlus API:IControlChartBar
IControlChartBar
Namespace: PPlus.Controls
Represents the interface with all Methods of the ChartBar control
public interface IControlChartBar : IPromptControls<Boolean>
Implements IPromptControls<Boolean>
Methods
AddItem(String, Double, Nullable<Color>)
Add item to ChartBar
IControlChartBar AddItem(string label, double value, Nullable<Color> colorbar)
Parameters
label String
Label Item to add
value Double
Value to Item
colorbar Nullable<Color>
The Color bar.
If not informed, the color bar will be chosen in descending sequence from 15 to 0 and then back to 15.
Returns
BarType(ChartBarType)
Define type Bar to ChartBar.
IControlChartBar BarType(ChartBarType value)
Parameters
value ChartBarType
The ChartBarType. Default value ‘ChartBarType.Fill’
Returns
Config(Action<IPromptConfig>)
Custom config the control.
IControlChartBar Config(Action<IPromptConfig> context)
Parameters
context Action<IPromptConfig>
Action to apply changes. IPromptConfig
Returns
Culture(CultureInfo)
CultureInfo to on show value format.
IControlChartBar Culture(CultureInfo value)
Parameters
value CultureInfo
CultureInfo to use
Returns
Culture(String)
CultureInfo to show value format.
Default value is global Promptplus Cultureinfo
IControlChartBar Culture(string value)
Parameters
value String
Name of CultureInfo to use
Returns
EnabledInteractionUser(Boolean, Boolean, Boolean)
Enabled Interaction to switch Layout , Legend and order when browse the charts / Legends.
IControlChartBar EnabledInteractionUser(bool switchType, bool switchLegend, bool switchorder)
Parameters
switchType Boolean
Enabled switch Layout
switchLegend Boolean
Enabled switch legend
switchorder Boolean
Enabled switch Ordination
Returns
FracionalDig(Int32)
Define the Fracional Digits of value to show. Default is 0.
IControlChartBar FracionalDig(int value)
Parameters
value Int32
Fracional Digits
Returns
HideOrdination(Boolean)
Hide info of ordination labels
IControlChartBar HideOrdination(bool value)
Parameters
value Boolean
Hide info of ordination labels.
Returns
HidePercent(Boolean)
Hide Percent in bar.Default false
IControlChartBar HidePercent(bool value)
Parameters
value Boolean
Hide Percent
Returns
HideValue(Boolean)
Hide value in bar.Default false
IControlChartBar HideValue(bool value)
Parameters
value Boolean
Hide value
Returns
HotKeySwitchLegend(HotKey)
Overwrite a HotKey to Switch Legend Chart when EnabledInteractionUser is active. Default value is ‘F3’
IControlChartBar HotKeySwitchLegend(HotKey value)
Parameters
value HotKey
The HotKey to Switch Legend Chart
Returns
HotKeySwitchOrder(HotKey)
Overwrite a HotKey to Switch ordination bar and label when EnabledInteractionUser is active. Default value is ‘F4’
IControlChartBar HotKeySwitchOrder(HotKey value)
Parameters
value HotKey
The HotKey to Switch ordination bar and label
Returns
HotKeySwitchType(HotKey)
Overwrite a HotKey to Switch Layout Chart when EnabledInteractionUser is active. Default value is ‘F2’
IControlChartBar HotKeySwitchType(HotKey value)
Parameters
value HotKey
The HotKey to Switch Layout Chart
Returns
Interaction<T1>(IEnumerable<T1>, Action<IControlChartBar, T1>)
Execute a action foreach item of colletion passed as a parameter
IControlChartBar Interaction<T1>(IEnumerable<T1> values, Action<IControlChartBar, T1> action)
Type Parameters
T1
Layout external colletion
Parameters
values IEnumerable<T1>
Colletion for interaction
action Action<IControlChartBar, T1>
Action to execute
Returns
Layout(LayoutChart)
Define layout to ChartBar.
IControlChartBar Layout(LayoutChart value)
Parameters
value LayoutChart
The LayoutChart. Default value ‘LayoutChart.Standard’
Returns
OrderBy(ChartOrder)
Sort bars and labels
IControlChartBar OrderBy(ChartOrder chartOrder)
Parameters
chartOrder ChartOrder
The sort type
Returns
PageSize(Int32)
Set max.item view per page when EnabledInteractionUser is active
Default value : 10.The value must be greater than or equal to 1
IControlChartBar PageSize(int value)
Parameters
value Int32
Number of Max.items
Returns
ShowLegends(Boolean, Boolean)
Show Legends after ChartBar
IControlChartBar ShowLegends(bool withvalue, bool withPercent)
Parameters
withvalue Boolean
Show value in legend
withPercent Boolean
Show Percent in legend
Returns
Styles(ChartStyles, Style)
Overwrite Styles
IControlChartBar Styles(ChartStyles styletype, Style value)
Parameters
styletype ChartStyles
ChartStyles of content
Returns
TitleAlignment(Alignment)
Define Tille Alignment.
IControlChartBar TitleAlignment(Alignment value)
Parameters
value Alignment
The Alignment title
Returns
Width(Int32)
Define Width to ChartBar. Default value is 80.The value must be greater than or equal to 10.
IControlChartBar Width(int value)
Parameters
value Int32
Width