Click or drag to resize
SummaryColumn Properties DataPA OpenAnalytics
DataPA OpenAnalytics API Reference

The SummaryColumn type exposes the following members.

Properties
  Name Description
Public property ColumnName
Gets and sets the name of this summary column.
Public property DataGridFont
Gets and sets the bespoke font that will be used to render this column in a datagrid if DataGridUseBespokeFont is true.
Public property DataGridFormatColumn
Gets and sets a column from the query data source that will be used to provide the format value for this column.
Public property DataGridFormatType
Gets and sets a value that indicates how to derive the format string for this column when displayed in a data grid.
Public property DataGridTextColor
Gets and sets the colour of the text used for this column in a data grid if DataGridUseBespokeFont is true.
Public property DataGridUseBespokeFont
Gets and sets a value that indicates if this column should use a bespoke font when rendered in a data grid.
Public property DisplayType
Gets and sets a value representing the type of object that will be used to display this summary column.
Public property DistinctColumn
Gets and sets the name of the distinct column that will be used to calculate a distinct sum value
Public property Editable
Gets and sets a property that indicates if this column is editable in a datagrid.
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 Format
Gets and sets a display format string for this summary column.
Public property formatNumericValues
Gets and sets a value that indicates if numeric values for this column should be formatted.
Public property GUID
Gets a GUID that uniquely identifies this object.
Public property Hidden
Gets and sets a value that indicates if this column should be hidden in a datagrid.
Public property HyperLink
Gets and sets a hyperlink value that will be applied to this column.
Public property ID
Gets a value that indicates the Unique ID of this object.
Public property Label
Gets and sets a label for this summary column.
Public property numberDecimals
Gets and sets a value that indicates the number of decimal places that should be used for this column in a data grid.
Public property NumericColumn
Gets a value that indicates if this SummaryColumn is derived from a numeric value.
Public property NumericFormatSelectionName
Gets the label used to identify this numeric format provider in the interface
Public property NumericGuiFormat
Gets a GUI format string for this Column
Public property numericPrefix
Gets and sets the numeric prefix (text before the data value) that will be used in a data grid.
Public property NumericSourceColumn
Gets a value that indicates if this SummaryColumn is derived from a numeric value.
Public property numericSuffix
Gets and sets the numeric suffix (text after the data value) that will be used in a data grid.
Public property ObjectSizes
Gets a dictionary of serialized objects contained in this object, along with their sizes (in bytes)
Public property Parent
Gets the SummaryColumns object that is the parent of this SummaryColumn.
Public property PivotTotalSource
Gets and sets a value representing how averages in a pivot table are calculated
Public property scalingUnits
Gets and sets a string value that represents the scaling units used to represent values.
Public property scalingValues
Gets and sets a string value that represents the scaling values used to represent values.
Public property ShowAsPercentageOfTotal
Gets a value that indicates if this column should be displayed as a percentage of the total.
Public property SummariseBeforeCalculation
Gets and sets a value that indicates when the calculation on a calculated column should be executed.
Public property SummaryType
Gets and sets a value that indicates the summary operation this column will use.
Public property SuppressThousandSeparator
Gets and sets a property that indicates if numeric values should suppress the thousand separator.
Public property TotalSummaryType
Gets and sets a value that indicates the summary operation this column will use for totals in a pivot table.
Public property UniqueColumnName
Gets a unique column name based on the column and it's summary type
Public property UseSecondaryYAxis
Gets and sets a value that indicates if this summary column will be associated with the secondary Y axis.
Top
See Also