Provides access to members to generate statistics on a field.
Members
Name | Description | |
---|---|---|
Cancelled | Indicates if the operation has been cancelled. | |
Continue | Indicates if the cursor contains more records than the current sample. | |
Cursor | The cursor which will generate the statistics. | |
Field | The field for which to gather statistics. | |
SampleRate | The maximum number of records to sample at a time (-1 means pull all records). | |
SimpleStats | Indicates whether only simple statistics are generated. | |
Statistics | The statistics for the current field over the current cursor. | |
UniqueValueCount | The number of unique values for the current sample. | |
UniqueValues | The unique values for the current field over the current cursor. |
IDataStatistics.Cancelled Property
Indicates if the operation has been cancelled.
Public ReadOnly Property Cancelled As Boolean
public bool Cancelled {get;}
IDataStatistics.Continue Property
Indicates if the cursor contains more records than the current sample.
Public ReadOnly Property Continue As Boolean
public bool Continue {get;}
IDataStatistics.Cursor Property
The cursor which will generate the statistics.
Public WriteOnly Property Cursor
public void Cursor {set;}
IDataStatistics.Field Property
The field for which to gather statistics.
Public Property Field As String
public string Field {get; set;}
IDataStatistics.SampleRate Property
The maximum number of records to sample at a time (-1 means pull all records).
Public Property SampleRate As Integer
public int SampleRate {get; set;}
IDataStatistics.SimpleStats Property
Indicates whether only simple statistics are generated.
Public Property SimpleStats As Boolean
public bool SimpleStats {get; set;}
IDataStatistics.Statistics Property
The statistics for the current field over the current cursor.
Public ReadOnly Property Statistics As IStatisticsResults
public IStatisticsResults Statistics {get;}
IDataStatistics.UniqueValueCount Property
The number of unique values for the current sample.
Public ReadOnly Property UniqueValueCount As Integer
public int UniqueValueCount {get;}
Remarks
The UniqueValues property must be accessed prior to getting this property (in order to calculate the count) for a correct value to be returned.
IDataStatistics.UniqueValues Property
The unique values for the current field over the current cursor.
Public ReadOnly Property UniqueValues As System.Collections.IEnumerator
public System.Collections.IEnumerator UniqueValues {get;}
Classes that implement IDataStatistics
Classes | Description |
---|---|
DataStatistics | Esri Data Statistics object. |
Remarks
The IDataStatistics object is the lone interface on the DataStatistics object and provides access to statistical information and unique values for the specified field. The data to perform the analysis on is provided via an ICursor object attached to the DataStatistics object through the IDataStatistics::Cursor property.
Cursors can only be traversed once, which needs to be kept in mind when accessing statistical information and unique values. For instance, it is necessary to re-execute the original query and set the Cursor property to the new cursor between accessing the Statistics and UniqueValues properties.
The UniqueValueCount property will return zero until you have retrieved the set of unique values from the UniqueValues property.
When accessing the Statistics property, the Field property should be set to the name of a numeric field. Attempting to retrieve Statistics for a non-numeric field will raise an error.