Codeunit "Business Chart"
Provides functionality for working with the business chart control add-in.
Properties
| Name | Value |
|---|---|
| Access | Public |
| InherentEntitlements | X |
| InherentPermissions | X |
Methods
Initialize
Initializes all the underlying objects needed for working with business charts.
procedure Initialize()SetXDimension
Sets the x dimension on the business chart.
procedure SetXDimension(Caption: Text, BusinessChartDataType: Enum "Business Chart Data Type")Parameters
| Name | Type | Description |
|---|---|---|
| Caption | Text |
x dimension caption. |
| BusinessChartDataType | Enum System.Visualization."Business Chart Data Type" |
The data type of the column. |
GetXDimension
Gets the x dimension caption.
procedure GetXDimension(): TextReturns
| Type | Description |
|---|---|
| Text |
The x dimension caption. |
GetXDimensionDataType
Gets the x dimension data type.
procedure GetXDimensionDataType(): Enum "Business Chart Data Type"Returns
| Type | Description |
|---|---|
| Enum System.Visualization."Business Chart Data Type" |
The x dimension data type. |
AddMeasure
Adds a new measure to the business chart.
procedure AddMeasure(Caption: Text, MeasureValueVariant: Variant, DataColumnType: Enum "Business Chart Data Type", BusinessChartType: Enum "Business Chart Type")Parameters
| Name | Type | Description |
|---|---|---|
| Caption | Text |
Measure caption. |
| MeasureValueVariant | Variant |
The value of the measure. |
| DataColumnType | Enum System.Visualization."Business Chart Data Type" |
The data type of the measure. |
| BusinessChartType | Enum System.Visualization."Business Chart Type" |
The type of the business chart. |
AddDataRowWithXDimension
Adds a new data row and sets the value of the x dimension column in this row to the specified value.
procedure AddDataRowWithXDimension(XDimensionColumnValue: Text)Parameters
| Name | Type | Description |
|---|---|---|
| XDimensionColumnValue | Text |
The value to assign to the x dimension column in the new row. |
AddDataColumn
Adds the data column to the data table that the business chart is based on.
procedure AddDataColumn(Caption: Text, ValueType: Enum "Business Chart Data Type")Parameters
| Name | Type | Description |
|---|---|---|
| Caption | Text |
Column caption. |
| ValueType | Enum System.Visualization."Business Chart Data Type" |
The data type of the column. |
SetValue
Sets the value of the scpecified measure at the specified index.
procedure SetValue(MeasureName: Text, XAxisIndex: Integer, MeasureValueVariant: Variant)Parameters
| Name | Type | Description |
|---|---|---|
| MeasureName | Text |
The name of the measure |
| XAxisIndex | Integer |
The X axis index. |
| MeasureValueVariant | Variant |
The value of the measure to set. |
SetValue
Sets the value of the scpecified measure index at the specified x axis index.
procedure SetValue(MeasureIndex: Integer, XAxisIndex: Integer, MeasureValueVariant: Variant)Parameters
| Name | Type | Description |
|---|---|---|
| MeasureIndex | Integer |
The index of the measure |
| XAxisIndex | Integer |
The X axis index. |
| MeasureValueVariant | Variant |
The value of the measure to set. |
GetValue
Gets the value of the scpecified measure at the specified index.
procedure GetValue(MeasureName: Text, XAxisIndex: Integer, var MeasureValueVariant: Variant)Parameters
| Name | Type | Description |
|---|---|---|
| MeasureName | Text |
The name of the measure |
| XAxisIndex | Integer |
The X axis index. |
| MeasureValueVariant | Variant |
The returned value of the measure. |
GetMaxNumberOfMeasures
Gets the maximum number of measures that the business chart can display.
procedure GetMaxNumberOfMeasures(): IntegerReturns
| Type | Description |
|---|---|
| Integer |
The maximum number of measures that the business chart can display. |
Update
Updates the provided business chart control add-in.
procedure Update(BusinessChartAddIn: ControlAddIn BusinessChart)Parameters
| Name | Type | Description |
|---|---|---|
| BusinessChartAddIn | ControlAddIn System.Integration.BusinessChart |
The business chart add-in to update. |
GetMeasureNameToValueMap
Gets the dictionary of measure names and values.
procedure GetMeasureNameToValueMap(): Dictionary of [Text, Text]Returns
| Type | Description |
|---|---|
| Dictionary of [Text, Text] |
The dictionary of measure names and values. |
SetShowChartCondensed
Sets a value indicating whether the XAxis Margin is visible or not.
procedure SetShowChartCondensed(ShowChartCondensed: Boolean)Parameters
| Name | Type | Description |
|---|---|---|
| ShowChartCondensed | Boolean |
Indicates whether the XAxis Margin is visible or not. |