AdapTable Types Reference

RowSummary

Defines a Row Summary used in a Layout

TypeScript
export interface RowSummary extends
Extends

SuspendableObject

Properties

PropertyDescriptionDefault
ColumnsMapMap of Columns with Summary Expressions
IncludeOnlyFilteredRowsEvaluates only currently filtered rows in the summarytrue
PositionWhere Row Summary appears - 'Top' or 'Bottom'
IsReadOnlySets Entity to ReadOnly (overwriting a Strategy Entitlement of 'Full')
IsSuspendedSuspends (i.e. turns off) an Adaptable Object

Property Details

ColumnsMap

Map of Columns with Summary Expressions

TypeScript
ColumnsMap: Record<string, SummarySupportedExpression>;
Property Value

Record<string, SummarySupportedExpression>

IncludeOnlyFilteredRows

Evaluates only currently filtered rows in the summary

TypeScript
IncludeOnlyFilteredRows?: boolean;
Default Value

true

Property Value

boolean

Position

Where Row Summary appears - 'Top' or 'Bottom'

TypeScript
Position?: RowSummaryPosition;
Property Value

RowSummaryPosition

IsSuspended

Inherited from SuspendableObject

Suspends (i.e. turns off) an Adaptable Object

TypeScript
IsSuspended?: boolean;
Property Value

boolean

IsReadOnly

Inherited from AdaptableObject

Sets Entity to ReadOnly (overwriting a Strategy Entitlement of 'Full')

TypeScript
IsReadOnly?: boolean;
Property Value

boolean

PreviousRowsHighlightInfoNextRowSummaryPosition