Type Alias FieldInTableProfilingData

type FieldInTableProfilingData = {
    Average?: number;
    AvgStringLen?: number;
    DataEvenness?: number;
    DistinctNumericValues?: number;
    DistinctTextValues?: number;
    DistinctValues?: number;
    EmptyStrings?: number;
    FieldTags?: string[];
    FirstSorted?: string;
    Fractiles?: number[];
    FrequencyDistribution?: FrequencyDistributionData;
    Kurtosis?: number;
    LastSorted?: string;
    Max?: number;
    MaxStringLen?: number;
    Median?: number;
    Min?: number;
    MinStringLen?: number;
    MostFrequent?: SymbolFrequency[];
    Name?: string;
    NegValues?: number;
    NullValues?: number;
    NumberFormat?: FieldAttributes;
    NumericValues?: number;
    PosValues?: number;
    Skewness?: number;
    Std?: number;
    Sum?: number;
    Sum2?: number;
    SumStringLen?: number;
    TextValues?: number;
    ZeroValues?: number;
}
Index

Properties

Average? AvgStringLen? DataEvenness? DistinctNumericValues? DistinctTextValues? DistinctValues? EmptyStrings? FieldTags? FirstSorted? Fractiles? FrequencyDistribution? Kurtosis? LastSorted? Max? MaxStringLen? Median? Min? MinStringLen? MostFrequent? Name? NegValues? NullValues? NumberFormat? NumericValues? PosValues? Skewness? Std? Sum? Sum2? SumStringLen? TextValues? ZeroValues?

Properties

Average?: number

Average of all numerical values. NaN otherwise.

AvgStringLen?: number

Average string length of textual values. 0 otherwise.

DataEvenness?: number

Data evenness aka Shannon's entropy normalized to [0,1]

DistinctNumericValues?: number

Number of distinct numeric values

DistinctTextValues?: number

Number of distinct text values

DistinctValues?: number

Number of distinct values

EmptyStrings?: number

Number of empty strings

FieldTags?: string[]

List of tags related to the field.

FirstSorted?: string

For textual values the first sorted string.

Fractiles?: number[]

The .01, .05, .1, .25, .5, .75, .9, .95, .99 fractiles. Array of NaN otherwise.

FrequencyDistribution?: FrequencyDistributionData
Kurtosis?: number

Kurtosis of the numerical values. NaN otherwise.

LastSorted?: string

For textual values the last sorted string.

Max?: number

Maximum value of numerical values. NaN otherwise.

MaxStringLen?: number

Maximum string length of textual values. 0 otherwise.

Median?: number

Median of all numerical values. NaN otherwise.

Min?: number

Minimum value of numerical values. NaN otherwise.

MinStringLen?: number

Minimum string length of textual values. 0 otherwise.

MostFrequent?: SymbolFrequency[]

Three most frequent values and their frequencies

Name?: string

Name of the field.

NegValues?: number

Number of negative values

NullValues?: number

Number of null values

NumberFormat?: FieldAttributes

Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

The formatting mechanism depends on the type set in qType, as shown below:

In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

The following applies:

  • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
  • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
  • The properties qDec , qThou , qnDec , qUseThou are not used.

The following applies:

  • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
  • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

The following applies:

  • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
  • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
  • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
  • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

The following applies:

  • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
  • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

The following applies:

  • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
  • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

No formatting, qFmt is ignored.

NumericValues?: number

Number of numeric values

PosValues?: number

Number of positive values

Skewness?: number

Skewness of the numerical values. NaN otherwise.

Std?: number

Standard deviation of numerical values. NaN otherwise.

Sum?: number

Sum of all numerical values. NaN otherwise.

Sum2?: number

Squared sum of all numerical values. NaN otherwise.

SumStringLen?: number

Sum of all characters in strings in the field

TextValues?: number

Number of textual values

ZeroValues?: number

Number of zero values for numerical values

Settings

Member Visibility

On This Page

Properties