Class VectorSummary

Implements to collect all entries of a column in a sorted vector.

Inheritance
System.Object
SummaryBase
VectorSummary
DistinctCountSummary
FilterBarChoicesSummary
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: Syncfusion.Grouping
Assembly: Syncfusion.Grouping.Base.dll
Syntax
public class VectorSummary : SummaryBase, ITreeTableSummary, ICountAggregate

Constructors

VectorSummary(Object[], Int32)

Initializes a new instance of VectorSummary class with the specified values.

Declaration
public VectorSummary(object[] values, int length)
Parameters
Type Name Description
System.Object[] values

Summary values.
System.Int32 length

Number of values.

Fields

Empty

The initial summary object for empty records or tables.

Declaration
public static readonly VectorSummary Empty
Field Value
Type
VectorSummary

Properties

Count

Gets the number of elements in the vector.

Declaration
public int Count { get; }
Property Value
Type
System.Int32

Values

Gets the array with values in the vector.

Declaration
public object[] Values { get; }
Property Value
Type
System.Object[]

Methods

Combine(SummaryBase)

Combines the values of this summary with another summary and returns a new summary object.

Declaration
public override SummaryBase Combine(SummaryBase other)
Parameters
Type Name Description
SummaryBase other

Another summary object.
Returns
Type Description
SummaryBase

A new summary object with combined values of both summaries.
Overrides

Combine(VectorSummary)

Combines the values of this summary with another summary and returns a new summary object.

Declaration
public VectorSummary Combine(VectorSummary other)
Parameters
Type Name Description
VectorSummary other

Another summary object (of the same type).
Returns
Type Description
VectorSummary

A new summary object with combined values of both summaries.

CombineHelper(VectorSummary, Boolean, out Int32)

Combines the values of this summary with another summary and returns a new summary object.

Declaration
protected object[] CombineHelper(VectorSummary other, bool distinct, out int length)
Parameters
Type Name Description
VectorSummary other

Another summary object (of the same type).
System.Boolean distinct

True if vector should only contain unique values; False if duplicates are allowed.
System.Int32 length

The resulting length of the vector.
Returns
Type Description
System.Object[]

A new summary object with combined values of both summaries.

CreatePageSummaryMethod(SummaryDescriptor, Record)

Used to interface the definition for a summary object.

Declaration
public static ITreeTableSummary CreatePageSummaryMethod(SummaryDescriptor sd, Record record)
Parameters
Type Name Description
SummaryDescriptor sd

SummaryDescriptor.
Record record

Record values.
Returns
Type Description
ITreeTableSummary

An instance of the VectorSummary class.

CreateSummaryMethod(SummaryDescriptor, Record)

Creates a summary object for the specified SummaryDescriptor and Record.

Declaration
public static ITreeTableSummary CreateSummaryMethod(SummaryDescriptor sd, Record record)
Parameters
Type Name Description
SummaryDescriptor sd

The summary descriptor.
Record record

The record with data.
Returns
Type Description
ITreeTableSummary

A new summary object.

ToString()

Returns string representation of the summary object.

Declaration
public override string ToString()
Returns
Type Description
System.String

String representation of the summary object.
Overrides
System.Object.ToString()

Implements