DataPA Enterprise Dashboard Controls API Reference

The ColumnPreferences type exposes the following members.

Constructors

  Name Description
Public method ColumnPreferences()()()()
Creates and returns a new ColumnPreferences object
Public method ColumnPreferences(SummaryColumn)
Creates and returns a new ColumnPreferences object
Public method ColumnPreferences(YAxis)
Creates and returns a new ColumnPreferences object

Methods

  Name Description
Public method apply(SummaryColumn)
Applies this object to a Summary Column
Public method apply(YAxis)
Applies this object to a y axis object
Public method Static member applyPercentageFormatting(SummaryColumn)
Applies the default percentage formatting to a Summary Column
Public method Static member applyPercentageFormatting(YAxis)
Applies the default percentage formatting to a Y Axis
Public method GetObjectData
Public method IsEqual(SummaryColumn)
Returns a value that indicates if the SummaryColumn numeric format is equal to this column preferences
Public method IsEqual(YAxis)
Returns a value that indicates if the yAxis numeric format is equal to this column preferences
Public method Static member isFormattedForPercentage(SummaryColumn)
Returns a value that indicates if the SummaryColumn is formatted for percentages
Public method Static member isFormattedForPercentage(YAxis)
Returns a value that indicates if the yAxis is formatted for percentages
Protected method SetObjectData

Fields

  Name Description
Public field Static member ClassId
Public field Static member EventsId
Public field Static member InterfaceId

Properties

  Name Description
Public property 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.
Public property formatNumericValues
Gets and sets a value that indicates if numeric values on the Y Axis should be formatted.
Public property numberDecimals
Gets and sets a value that indicates the number of decimal places that should be used for values represented on the Y Axis.
Public property numberDecimalsYAxis
Gets and sets a value that indicates the number of decimal places that should be used for labels on the Y Axis.
Public property numericPrefix
Gets and sets the numeric prefix (text before the data value) that will be used in labels on the Y Axis.
Public property numericSuffix
Gets and sets the numeric suffix (text after the data value) that will be used in labels on the Y Axis.
Public property scalingUnits
Gets and sets a string value that represents the scaling units used to represent the Y Axis label values.
Public property scalingValues
Gets and sets a string value that represents the scaling values used to represent the Y Axis label values.
Public property SuppressThousandSeparator
Gets and sets a property that indicates if numeric values should suppress the thousand separator.

See Also