Difference between revisions of "Graph Setting Associations"

(Documented the Att_GraphSetupSlices and its use in Att_GraphValueRange)
Line 90: Line 90:
 
| Dimension range settings<br>(for non-index values) || Attribute || <code>Att_graphValueRange</code>
 
| Dimension range settings<br>(for non-index values) || Attribute || <code>Att_graphValueRange</code>
 
| Dimension
 
| Dimension
| For case when <code>va1</code> has self-index,<br>used for the value.<br>Same format as <code>Att_graphIndexRange</code>
+
| Axis settings for value dimensions. When a variable has a self-index, both its index and its value may be separately used in graphing roles, so this attribute has the settings for the value, whereas <code>Att_graphIndexRange</code> has the axis settings for the self-index.<br/><br/>
 +
The field here are the same as for <code>Att_graphIndexRange</code>. In addition, multiple value settings may appear, separated by a bar (<code>|</code>) character. After the first, each successive settings is first preceeded by a number and a colon, followed by the same fields as in <code>Att_graphIndexRange</code>. The number corresponds to a position in the <code>Att_GraphSetupSlices</code> attribute. These multiple settings are used to store the axis ranges for comparison slices in an XY-plot, so that if you are plotting <code>Va1[J='x']</code> vs <code>Va1[J='z']</code>, the axis ranges for x can tracked separately from the axis ranges for z. The very first field (before the first bar) is not preceded by a number and colon, and is used for the main result when not a comparison slice (including the case where it is sliced to do index slicers other than the comparison index).
 +
|-
 +
|Result slices || Attribute || <code>Att_graphSetupSlices</code> || View
 +
| A list of slices that have, or may have, axis settings in <code>Att_graphValueRange</code>.  It is a bracketed list, here the first entry is the number of slots per item as is usually 3. (Although this could vary by Analytica release due to enhancements). When this is a 3, the next 3 entries are the first item, with components «idv», «ind» and «posv».  «idv» is the id that appears before the colon in <code>Att_GraphSetupSlices</code>. «ind» is the comparison index that this applies to, which can be either a global index indentifier or <code>Sys_LocalIndex('name')</code> for a local index.  «posv» is the 1-based slice number along the comparison index.
 
|-
 
|-
 
| Use Categorical || Attribute || <code>Att_forceCategorical</code> || View
 
| Use Categorical || Attribute || <code>Att_forceCategorical</code> || View

Revision as of 16:25, 21 May 2021


If you change the style, font, or background settings of a graph, that change will apply to any uncertainty view of that variable. But, if you select the line style for a PDF view of a variable, it will usually not apply to the CDF view of that variable. If you change the axis range of a scale, it will still apply to that dimension if you pivot the graph or swap horizontal and vertical scales.

More generally, each graph setting has an association that control what different graph views it applies to. Usually, you don't have to think about these associations. Analytica just does what you expect. But, occasionally you may need to understand them so you can predict their effects, especially when saving defaults for a model or defining a template.

There are four types of association, controlling what types of graph a change to a graph setting applies to:

Global Associations: Appearance settings, such as colors, style, font, and background are global -- meaning that a change to one graph for a variable will apply to all graph views of that variable; clicking "Set default" button, will apply these settings to all graphs in the model that use defaults for those settings.

Result Associations: These settings apply only to the specific graph, and no other graphs, even if you click "Set Default".

Dimension Associations: Settings in the Axis Ranges tab, including range, reverse order, categorical, or log scale, apply to the specified dimension or index. When you pivot the graph, or swap horizontal and vertical, they still apply to that dimension. If you click "Set default" after changing settings for a scale that is an index variable, those settings will become the default for that index in all graphs that use that index.

Uncertainty view Associations: The application of Line style and related settings on the Chart Type tab is different for categorical and continuous graphs, and may differ by uncertainty view (PDF, CDF, Confidence Bands, etc.).

Whether the X-axis dimension is categorical or continuous determines whether a graph is considered categorical or continuous. (If SwapXY is on, then it is the Y-axis that determines this). Separate line-styles are maintained for the categorical case and the continuous case. Therefore, if you pivot a graph, causing the X-axis to change from a continuous dimension to a categorical one, the graph settings can swap from a line-graph to a bar graph, for example. (only the line-style depends on the categorical / continuous distinction).

Settings in this category are associated with a view mode. Mid, Mean and Bands all share the same association, so a setting for Mid will transfer to a graph of Mean. Separate settings exist for stats view, continuous PDF, continuous CDF, discrete prob mass, discrete cum prob, and sample. There is a separate line style for the continuous and categorical case for each of these views. But all other settings in this category, such as Area fill, change only with the view mode. (so you can't have a filled line for continuous mean and unfilled line for categorical mean, but you could have an unfilled line for mean and a filled line for PDF).

Finally, when a line style is set to Bar, the graph is required to be categorical. A flag indicates whether the continuous style setting has been set to bar, and if so, a continuous X-axis is forced to categorical when the graph is rendered.

Graph Settings and their Association Type

Descripton Stored as Sys or Att Name Association Type Notes
Graph Template
Graph Template Identifier Attribute Att_graphTemplate Global
Line Style Settings:
Line Style Attribute Att_ContLineStyle & Att_CatLineStyle

0 = dot
1 = line only
4 = symbol only
5 = line & symbol
6 = step
9 = bar

View Attribute used depends on whether x-axis is cat or continuous
Stacked Bar flag Attribute Att_StackedBar View
Stacked lines flag Attribute Att_stacked_lines View
Area fill flag Attribute Att_AreaFill View
Relative Proportion Flag
(not yet implemented)
Attribute Att_relProportion View
Bar Overlap Percent Attribute Att_barOverlap View In Analytica 3.1, was sysVar overlapWidth.
It is an attribute now.
Symmetric Colors flag
(not implemented)
Attribute Att_symmetric_colors Key
Transparency for fills Sys var Graph_fillTransparency Global Scale of 0 to 255
Bar Shape Sys Var Graph_barShape View
3D Effects flag Sys Var Graph_3DEffects Global
Line Thickness Sys Var Graph_LineThickness Global
Use Separate Color / Symbol Keys SysVar Graph_SymbolKey Global
Enable Symbol Size Role Sys Var Graph_SymbolSizeKey Global
Symbol Size Sys Var symbolSize Global For fixed symbol size
Min Symbol Size Sys Var Graph_minSymbolSize Global For variable symbol size
Max Symbol Size Sys Var Graph_maxSymbolSize Global For variable symbol size
Axis Ranges:
Dimension range settings
(for Index values)
Attribute Att_graphIndexRange Dimension For case when Va1 has self-index,
used for the self-index.

ver, cat,auto, includezero, log, reverse, incs, min, max
where:
 ver : Must be 1 (version)
 cat : Categorical flag (1=force categorical interp), opt.
 auto : Full autoscale flag
 includezero : force 0 to be in range flag
 log : log scaling flag
 reverse : reverse order flag
 incs : Number of increments
 min : minimum value for manually scaled axis
 max : maximum value for manually scaled axis
 catPos: 1=The preceeding «min», «max» are the position of categorical values. 0=They are the actual value (usually a real number).

Dimension range settings
(for non-index values)
Attribute Att_graphValueRange Dimension Axis settings for value dimensions. When a variable has a self-index, both its index and its value may be separately used in graphing roles, so this attribute has the settings for the value, whereas Att_graphIndexRange has the axis settings for the self-index.

The field here are the same as for Att_graphIndexRange. In addition, multiple value settings may appear, separated by a bar (|) character. After the first, each successive settings is first preceeded by a number and a colon, followed by the same fields as in Att_graphIndexRange. The number corresponds to a position in the Att_GraphSetupSlices attribute. These multiple settings are used to store the axis ranges for comparison slices in an XY-plot, so that if you are plotting Va1[J='x'] vs Va1[J='z'], the axis ranges for x can tracked separately from the axis ranges for z. The very first field (before the first bar) is not preceded by a number and colon, and is used for the main result when not a comparison slice (including the case where it is sliced to do index slicers other than the comparison index).

Result slices Attribute Att_graphSetupSlices View A list of slices that have, or may have, axis settings in Att_graphValueRange. It is a bracketed list, here the first entry is the number of slots per item as is usually 3. (Although this could vary by Analytica release due to enhancements). When this is a 3, the next 3 entries are the first item, with components «idv», «ind» and «posv». «idv» is the id that appears before the colon in Att_GraphSetupSlices. «ind» is the comparison index that this applies to, which can be either a global index indentifier or Sys_LocalIndex('name') for a local index. «posv» is the 1-based slice number along the comparison index.
Use Categorical Attribute Att_forceCategorical View Forces categorical X-axis.
Style Settings:
Frame Style Sys Var Frame

0 = None
1 = Bottom Left
2 = All solid
3 = All dashed

Global
Frame Color Sys var Graph_frameColor Global
Grid Style Sys Var Grid

0 = None
1 = Dots
2 = Pluses
3 = Lines
4 = Dots

Global
Grid Color Sys Var Graph_gridColor Global
Tick locations Sys Var Ticks Global
Tick direction Sys Var Graph_tickDir Global 0 = outward, 1 = inward, 2 = both.
Key Position Sys Var ShowKey

0 = None
1 = Bottom
2 = Right
3 = Left

Global
Outline key flag Sys Var Graph_OutlineKey Global
Font:
Axis title font Sys Var Graph_axisTitleFont Global
Axis title color Sys Var Graph_axisTitleColor Global
Axis label font Sys Var Graph_axisLabelFont Global
Axis label color Sys Var Graph_axisLabelColor Global
Key title font Sys Var Graph_keyTitleFont Global
Key title color Sys Var Graph_keyTextColor Global
Key label font Sys Var Graph_keyFont Global
Key label color Sys Var Graph_keyLabelColor Global
Vertical Label Rotation Sys Var Graph_VLabelRotation Global
Horizontal Label Rotation Sys Var Graph_HLabelRotation Global
Patterns:
Page fill Sys Var Graph_PageBrush Global
Plot Area Fill Sys Var Graph_plotAreaBrush Global
Key Area Fill Sys Var Graph_keyAreaBrush Global
Key Sequences:
Symbol sequence Sys Var Graph_SymbolSeq Global Order of symbols used in keys
Color sequence Sys Var Graph_ColorSeq Global List of colors used for curves
Line-dash sequence
(not implemented)
Sys Var Graph_LineDashSeq Global
Fill-effects sequence
(not implemented)
Sys Var Graph_FillEffectsSeq Global
Excel Graph:
External graphing engine (Excel Chart) Sys var GraphTool Global Disabled for now.
Role/Pivot state:
X-Axis role Attribute Att_xRole Global
Y-Axis role Attribute Att_yRole Global
Color role Attribute Att_colorRole Global
Symbol shape role Attribute Att_symbolRole Global
Symbol size role Attribute Att_symbolSizeRole Global
Origin role Attribute Att_originRole Global
Other free indexes
(not implemented)
Attribute Att_freeIndexes View For scatter only plots.
Coordinate Index Attribute Att_coordinateIndex Result Contains identifier of index
Exogenous Values Attribute Att_exogenousValues Result List of expressions

The following system variables are used to hold graph settings for special cases:

  • Graph_Primary_Valdim
  • Graph_Stats_Valdim
  • Graph_PDF_Valdim
  • Graph_Prob_Valdim
  • Graph_CDF_Valdim
  • Graph_Cumprob_Valdim

See Also

Comments


You are not allowed to post comments.