Difference between revisions of "GraphFillerInfo"

Revision as of 00:11, 5 March 2019

This index is used by the roles variable in OnGraphDraw, and indexes the information about a graphing role filler dimension.

Index GraphFillerInfo

The roles variable in OnGraphDraw contains information about the graphing dimensions depicted on a graph. Roles is indexed by GraphingRole and by GraphFillerInfo. Each graphing role may by filled by a graphing dimension (either an index or a value), and information about that graphing dimension is indexed by GraphFillerInfo.

The filler information that is provided (the elements of GraphFillerInfo) are as follows:

"Type": The type of this graphing dimension, either "Index", "Value" or Null.
"Source": Usually a Handle to the variable that corresponds to this dimension. This will be true for an index dimension, the main result, and a comparison variable. Less commonly, a filler may be the result of a computed expression, in which case this contains a parsed expression.
"Slice index": The comparison index, if there is one.
"Slice position": The 1-based position along the comparison index of this graphing dimension.
"Categorical": Boolean, true when this graphing dimension is categorical (i.e., not continuous).
"Min", "Max": The smallest and largest values in an axis scale.
"Log scale": True when the axis uses a log-scale.
"Log abs min": When the axis uses a log scale, the smallest absolute value of non-zero data.
"Rounding unit": (for internal use)
"Reversed": Boolean. True when the order of the axis values or key values are reversed.
"Labels": The individual labels in a categorical dimension. For a categorical value dimension, this will be the set of unique values, in the order determined by the domain and other factors.
"Value": A reference to the computed value for this dimension (i.e., the data being depicted). In general, this is an array that may have multiple indexes.

@@ Line 6: / Line 6: @@
 The filler information that is provided (the elements of [[GraphFillerInfo]]) are as follows:
-* <code>"Type"</code>:
+* <code>"Type"</code>: The type of this graphing dimension, either <code>"Index"</code>, <code>"Value"</code> or [[Null]].
-* <code>"Source"</code>:
+* <code>"Source"</code>: Usually a [[Handle]] to the variable that corresponds to this dimension. This will be true for an index dimension, the main result, and a comparison variable. Less commonly, a filler may be the result of a computed expression, in which case this contains a parsed expression.
-* <code>"Slice index"</code>:
+* <code>"Slice index"</code>: The comparison index, if there is one.
-* <code>"Slice position"</code>:
+* <code>"Slice position"</code>: The 1-based position along the comparison index of this graphing dimension.
-* <code>"Categorical"</code>:
+* <code>"Categorical"</code>: Boolean, true when this graphing dimension is categorical (i.e., not continuous).
-* <code>"Min"</code>:
+* <code>"Min"</code>, <code>"Max"</code>: The smallest and largest values in an axis scale.
-* <code>"Max"</code>:
+* <code>"Log scale"</code>: True when the axis uses a log-scale.
-* <code>"Log scale"</code>:
+* <code>"Log abs min"</code>: When the axis uses a log scale, the smallest absolute value of non-zero data.
-* <code>"Log abs min"</code>:
+* <code>"Rounding unit"</code>: (for internal use)
-* <code>"Rounding unit"</code>:
+* <code>"Reversed"</code>: Boolean. True when the order of the axis values or key values are reversed.
-* <code>"Reversed"</code>:
+* <code>"Labels"</code>: The individual labels in a categorical dimension. For a categorical value dimension, this will be the set of unique values, in the order determined by the domain and other factors.
-* <code>"Labels"</code>:
+* <code>"Value"</code>: A [[reference]] to the computed value for this dimension (i.e., the data being depicted). In general, this is an array that may have multiple indexes.
-* <code>"Value"</code>:
 == See Also ==
 * [[OnGraphDraw]]
 * [[GraphingRole]]