DataPA Enterprise Dashboard Controls API Reference
The ColumnPreferences type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
|
|
ColumnPreferences()()()() |
Creates and returns a new ColumnPreferences object
|
|
|
ColumnPreferences(SummaryColumn) |
Creates and returns a new ColumnPreferences object
|
|
|
ColumnPreferences(YAxis) |
Creates and returns a new ColumnPreferences object
|
Methods
| Name | Description | |
|---|---|---|
|
|
apply(SummaryColumn) |
Applies this object to a Summary Column
|
|
|
apply(YAxis) |
Applies this object to a y axis object
|
|
|
applyPercentageFormatting(SummaryColumn) |
Applies the default percentage formatting to a Summary Column
|
|
|
applyPercentageFormatting(YAxis) |
Applies the default percentage formatting to a Y Axis
|
|
|
GetObjectData | |
|
|
IsEqual(SummaryColumn) |
Returns a value that indicates if the SummaryColumn numeric format is equal to this column preferences
|
|
|
IsEqual(YAxis) |
Returns a value that indicates if the yAxis numeric format is equal to this column preferences
|
|
|
isFormattedForPercentage(SummaryColumn) |
Returns a value that indicates if the SummaryColumn is formatted for percentages
|
|
|
isFormattedForPercentage(YAxis) |
Returns a value that indicates if the yAxis is formatted for percentages
|
|
|
SetObjectData |
Fields
| Name | Description | |
|---|---|---|
|
|
ClassId | |
|
|
EventsId | |
|
|
InterfaceId |
Properties
| Name | Description | |
|---|---|---|
|
|
forceTrailingZeros |
Gets and sets a value that indicates whether all labels should have the number of decimal digits specified by numberDecimals, even if it requires trailing zeros.
|
|
|
formatNumericValues |
Gets and sets a value that indicates if numeric values on the Y Axis should be formatted.
|
|
|
numberDecimals |
Gets and sets a value that indicates the number of decimal places that should be used for values represented on the Y Axis.
|
|
|
numberDecimalsYAxis |
Gets and sets a value that indicates the number of decimal places that should be used for labels on the Y Axis.
|
|
|
numericPrefix |
Gets and sets the numeric prefix (text before the data value) that will be used in labels on the Y Axis.
|
|
|
numericSuffix |
Gets and sets the numeric suffix (text after the data value) that will be used in labels on the Y Axis.
|
|
|
scalingUnits |
Gets and sets a string value that represents the scaling units used to represent the Y Axis label values.
|
|
|
scalingValues |
Gets and sets a string value that represents the scaling values used to represent the Y Axis label values.
|
|
|
SuppressThousandSeparator |
Gets and sets a property that indicates if numeric values should suppress the thousand separator.
|