Use FocusFormat Property
The FocusFormat property in the Property Explorer is used to determine what information is shown for focus items in a chart.
Define the data and format to be used for view focus information, the "pop up" box giving additional information about an object in a view. Views may display their focus information in a custom way, in which case this format is ignored. For views supporting this property, you can override the format and data displayed for the focus item by the view.
Assign an empty string ("") to FocusFormat causes no focus to be displayed for that view.
The value of this property is a string encoded like this:
- "'format string' fieldspec1 fieldspec2 ..."
The first field is a format string; the following fields are data that is substituted into the format string. Enclose string containing spaces (such as the format string!) with single quotes (').
The format string contains static text and point to substitute values. Substitution points are given by "%{number}%", for example, "%1%". The numbers start at 1 and go for the number of substitution values. These may appear in any order; the value substituted is the "field{number}" from the list of field specifications. Newlines are coded by "\n".
Data that can be displayed includes:
- Axis field names. Up to 3 axis are supported.
- Current axis value.
- Value of any Data Pool field. (For aggregated views, this will be the value from the first row mapped to the aggregation.)
- Various aggregated amounts calculated for aggregated views.
Field names ("fieldspec1", "fieldspec2", ...) specify the data to be substituted into the format string. A "fieldspec" can be any of these:
- The name of a field in the table displayed by the view.
- A "metafield" that names data relevant to a field; see the following table for the names supported.
- A combination of a special name and a field name, .e.g., "name fieldname". This is valid only for aggregated views. The metaname gives the data that will be extracted from the aggregation for the named field. The named field must be aggregated over by the view.
For example: "’X: %1%\\nY: %2%’ *Axis0Value* *Axis1Value*". This substitutes the current value on Axis 0 and the current value for Axis 1 into the string; if the current values were "100" and "25", this would result in:
X: 100 Y: 25
The field names supported are:
FocusFormat Fields
| Field | View Type | Description |
|---|---|---|
| *Axis0Name* | Unaggregated | Axis 0 (X axis) field name. |
| *Axis0Value* | Unaggregated | Current axis 0 (X axis) value. |
| *Axis1Name* | Unaggregated | Axis 1 (Y axis) field name. |
| *Axis1Value* | Unaggregated | Current axis 1 (Y axis) value. |
| *Axis2Name* | Unaggregated | Axis 2 (Z axis) field name. |
| *Axis2Value* | Unaggregated | Current axis 2 (Z axis) value. |
| {any field name in view table} | Unaggregated | Value for field in focus row of view table. |
| *Category* | Aggregated | Aggregation category name. |
| *Count* | Aggregated | Count of items in aggregation category. |
| *SelectedCount* | Aggregated | Count of selected items in aggregation category. |
| *Total* | Aggregated | Total weight for aggregation across all statistics. |
| *WeightName* | Aggregated | Name of aggregation weight, possibly including type of aggregation (e.g., "Avg") and weighting field name. |
| *Weight* | Aggregated | Weight for category, based on type of aggregation (e.g., count, sum, average). |
| *SelectedWeight* | Aggregated | Selected weight for category. |
| *StdDev* | Aggregated | Standard deviation for current aggregation. Only available if aggregation type is "average". |
| *SelectedStdDev* | Aggregated | Standard deviation for current aggregation for selected subset. Only available if aggregation type is "average". |
| *%Weight* | Aggregated | Percent that weight of current aggregation category is of total for field. |
| *%Selected* | Aggregated | Percent that selected weight of aggregation is versus total for category. |
| *String* | Aggregated | Unique string value in aggregation. |
| *SelectedString* | Aggregated | Unique string value in aggregation for selected subset. |
| *ChiSquare* | Aggregated | The Chi-squared statistical deviation of the selected subset from the expected value for each category in the aggregation. |
| *StatSignificance* | Aggregated | A description of the statistical significance of the entire selected subset either "Statistically representative subset" or "Statistically deviant subset". The determining threshold is a Chi-Square probability of 5%. |
| {any field name in view table} | Aggregated | Value for first row in table mapped to aggregation. |
The default format strings for aggregated views are:
Default Aggregated View Formats
| Aggregation | Format |
|---|---|
| Sum/Count | '%1%\\n%2%=%3% (%4%%%)\\nSelected=%5 (%6%%%)' *Category* *WeightName* *Weight* *%Weight* *SelectedWeight* *%Selected* |
| Average | '%1%\\n%2%=%3% Items=%4% StdDev=%5%\\nSelected=%6% Items=%7% StdDev=%8%' *Category* *WeightName* *Weight* *Count* *StdDev* *SelectedWeight* *SelectedCount* *SelectedStdDev* |