Analytica Docs - User contributions [en]

Attributes

2026-04-14T18:23:22Z

Mhenrion:

[[Category:Attributes]]
(Up to [[Analytica Reference]])

Each Analytica Object consists of a set of Attributes -- "properties" or "fields" in other computer languages. Every Object has a [[Classes of variables and other objects|Class]], Identifier, and Title. Variables and Functions also have a Definition and Domain.

You can easily view and edit some attributes in an [[Object window]] or the [[Attribute panel]] below a Diagram. Other attributes you can see, but not edit directly -- such as, the Value, Inputs and Outputs of a Variable, which Analytica computes from the Definition.

Some attributes apply only to a particular object [[Class]] -- for example, Author and Creation date apply only to a Model or Module; Parameters and Recursive apply only to a Function. There are also many internal attributes that you don't usually see but may affect how the node looks -- such as, Nodeinfo, NodeSize, and Nodefont.

In an Analytica expression you can access attributes using [[Attrib of Obj|«Attrib» OF «Obj»]] syntax. Inside [[OnClick]] and [[Onchange]] attributes, you can also modify some Attributes from Analytica code by assigning to them.

This page first describes common editable Attributes, then common non-modifiable Attributes, and finally the many obscure internal Attributes that users rarely need to know about.

== Common attributes ==

These attributes apply to all classes of user-defined objects. You can edit them directly in [[Edit mode]] in the [[Object window]] and [[Attribute panel]]:

===Editable Attributes of all Objects===

====Class====
The [[Classes of variables and other objects|class]] of the object, such as Variable, Index, Function, or Module. You may change the Class of an object only to a compatible class: You can change the class of a Variable among these subclasses Chance, Constant, Determ, Decision, Index, Objective, Variable. You may change a [[Modules and Libraries|Module]] among these subclasses Library, FiledLibrary, Model, Module, FiledModule, or Form. You can change a [[Text nodes|Text]] node to a [[Frame node|Frame]] node or back. You can't change the class of a Function, Button, or system object. In the [[Object window]] or [[Attribute panel]], in Edit mode, the Class appears as a pulldown menu that lets you change it to another compatible Class.

====Identifier====
The unique name of the object. An identifier must start with a letter, and contain only letters, digits, or underscore, up to 40 characters. Identifiers are insensitive to case -- but Analytica retains and shows the case originally provided (or adapted from the Object's title). So you can use CamelCase to clarify words in the identifier.

====Title====
A word or brief phrase identifying the the object. It usually appears in the diagram node, and in many other places in the user interface. It's best to limit a Title to about 50 characters. By default, it creates an identifier from the first 20 characters of the title, substituting "_" for blank or any character that isn't a letter or digit.

====Description====
Text that describes or documents the object. For a variable, it should describe what the quantity represents. For a function, it should describe what value it returns and what parameters it expects. If the definition is not obvious, it should also explain briefly what definition is doing. It should also mention any exceptions, such as what it does if an input or parameter is outside the expected domain.

===Editable attributes of Variables and Functions===

====Units====
The units of measurement of a variable, or value returned by a function -- such as "$/year" or "km/hr". It's best to use abbreviations to keep units within about 10 characters.

====Definition====
The expression used to compute the value of a variable or function.

====[[Check Attribute|Check]]====
An expression used to test that the computed result value is valid. If it returns false, it gives a warning. This is helpful to detect errors in user input or complex calculations. See [[Check Attribute]].

===Non-editable attributes of variables and functions===

These attributes are of variables and functions are visible, but not editable, in the Object window and Attribute panel:

====Inputs====
A list of variables and functions used in the definition, after definition has been parsed. Before parsing, it may contain variables and functions from which arrows were drawn.

====Outputs====
A list of variables and functions that use this object in their definitions.

====Value====
The computed (mid-)value of the variable (not available for functions). You may displayed the Value in an Object window, but it is not displayed by default.

Accessing the attribute's value from an expression (using e.g., <code>Value of X</code> doesn't trigger a calculation, and will return a special value of <code>Undefined</code> if it isn't yet computed. However, we recommend using <code>[[Mid]]([[IsResultComputed]](X))</code> to detect whether the mid-value is computed yet or not (or <code>[[Sample]]([[IsResultComputed]](X))</code>.

====EvaluationTime====
The number of CPU seconds that have been spent evaluating or obtaining the value of the variable, or computing the result of the [[User Defined Functions|function]], since the object was created or loaded, or since the [[ResetEvalTimes]] command was last executed. This timing does not include the time spent evaluating parent values.

====EvaluationTimeAll====
The number of CPU seconds spent in evaluation of the object, including time spent evaluating or obtaining the values of other variables that it depends on. This is the cumulative time since the object was first created or loaded, or since the [[ResetEvalTimes]] command was last executed.

===Editable attributes of Functions===

====Parameters====
A list of the function [[parameters]], enclosed in parentheses. It may include [[parameter qualifiers|qualifiers]] that specify what data type or dimension are expected for each parameter, or whether a parameter is optional or may be repeated. It is good practice to also list the main (non-optional) parameters (without qualifiers) in the title, so users can easily see what parameters it expects from seeing the function node in a diagram.

====Recursive====
A boolean, with value 0 (default) or 1, specifies whether the function is recursive -- i.e., it may call itself in its definition, or call another function that calls it (mutually recursive). By default, it is not displayed. You need to set it to be displayed in the [[Attributes dialog]].

===Editable Attributes of Modules===

====Author====
The name(s) of the person or people who created this module. When you start a new model, it may automatically fill this in with the name of the owner of the computer, if registered with Windows.

====[[TemplateInput]]====
Identifies a single variable within the module that functions at the module's primary input. Drawing an arrow into this module node inserts the origin of the arrow as the definition of this variable.

====[[TemplateOutput]]====
Identifies a single variable within the module that serves as the module's primary output. Drawing an arrow from this module node treats this variable as the origin of the arrow -- for example, for use as an input to another object.

===Non-editable attributes of modules===

The Module [[class]] includes subclasses Model, Module, Filed Module, Library, Filed Library, and Form. These are attributes of modules that you can see but not edit in the [[Object window]] and [[Attribute panel]]:

====Date (Created)====
The time and date on which the module was first created.

====Savedate (Last Saved)====
The time and date on which this model or separately filed module or library was last saved.

====FileInfo (File info)====
The directory path and name of the file from which this model was read from or to which it was last saved.

==Hidden attributes==

There are quite a few hidden attributes that you can't usually see in the standard user interface, and almost never need to think about. If needed you can see them in the [[Typescript]] Window. Type "Profile <identifier>" into the Typescript to see all the attributes of an object.

=== Hidden attributes of Variables and Functions===

====[[NumberFormat]]====
The number format parameters specified in the [[Number Format Dialog]] for numbers generated in a variable or function. If absent, it uses the default Number Format.
:<code>v, format, proxy, zeroes, separators, currency, digits, trailingZeros, currencysymbol, currencyPlacement, datetemplate, fullPrecision, fullDateTemplate, relReqForFullDateTemplate, datesAsNumbers, numbersAsDates, digitsForGeneralFmt</code>

====[[ProbabilityNumberFmt]]====
In a Probability Bands result view, a Cumulative Probability result view, or a Probability mass view for a discrete-valued quantity, probabilities display in addition to values for the underlying variable. For the columns or axes containing probabilities, this attribute holds the number format, which is often different from the underlying variable's number format.
:<code>v, format, proxy, zeroes, separators, currency, digits, trailingZeros, currencysymbol, currencyPlacement, datetemplate, fullPrecision, fullDateTemplate, relReqForFullDateTemplate, datesAsNumbers, numbersAsDates, digitsForGeneralFmt</code>

====[[DensityNumberFormat]]====
In a Probability Density Result view for a continuous variable, probability density values appear in addition to values for the underlying variable's quantity. This attribute stores the number format used for columns or axes that display probability densities.
:<code>v, format, proxy, zeroes, separators, currency, digits, trailingZeros, currencysymbol, currencyPlacement, datetemplate, fullPrecision, fullDateTemplate, relReqForFullDateTemplate, datesAsNumbers, numbersAsDates, digitsForGeneralFmt</code>

====FixedDef====
The parse-tree (DCODE) from the Definition. It displays as the code, usually with extra parens.

====DisplayInputs====
A list of objects among inputs from which arrows are to be displayed. It does not display arrows from Inputs that are not in Displayinputs.

====IsIn====
A handle to the module that contains this object. (Null for the top model.)

====[[Aliases]]====
A list of handles to any user inputs or user outputs ([FormNode]]) or [[Alias nodes]] for this object. Any object type can have aliases, including Variables, Functions, Modules, and Buttons.

====[[Original]]====
The original node of a user input or user output ([[FormNode]]) or [[Alias nodes|Alias node]]. [[Aliases]] attribute contains all the nodes listing it as its Original.

===Hidden attributes of Modules===

====Contains====
The list of objects contained in this module.

====DefaultSize====
The default node size for new nodes in this module. It uses the same format as Nodesize. If empty, it inherits the default size from its parent module. For a Model, it uses the default size from the Analytica initialization.

==Node attributes==

These attributes apply to the visual node that represents an object in its parent influence diagram. They control the location, size, and appearance of each node. You can modify some in the [[Diagram window|Diagram view]] (NodeLocation, NodeSize), some in the [[Node Style dialog]] (NodeFont, NodeInfo), or using the [[Color palette|Color palette dialog]], (NodeColor and NodeFontColor). :

====Nodelocation====
The location of the node center in its parent diagram, as x,y,z, where x and y are number of pixels rightwards and downwards from the top-left corner of the diagram. You can, of course, modify node location by dragging nodes in their diagram. Nodes are displayed in order of z value, which therefore controls which nodes are displayed in front of other nodes. You can send a node back or to the front by selecting the node and using the [[Right mouse button menus|Right mouse button menus.]]

====Nodesize====
The size of the node, as x,y, where x and y are the half width and half height in pixels, i.e. the distance from the node center to each edge. You can change the size of each node in its Diagram dragging the corner boxes around a selected node. You can define the default node sizes in the [[Diagram Style dialog]].

====Nodecolor====
The color for this node, as r,g,b, where each color is in the range 0 to 65535. If empty, it uses the default color for this object class. You can modify colors by directly by selecting the node in the diagram, and using the [[Color palette]]. For arrow objects, the arrow color is determined by this attribute; if empty, it uses the Arrow class default. Dynamic dependency arrows use a separate color (the dynamic arrow color attribute) instead.

====NodeFontColor====
Controls the font color of a node in a diagram. You can modify it from the [[Color palette#Change the text color of nodes|Color palette]]. The attribute is in RGB format, r,g,b, where each color is in the range 0 to 65535. If empty, it inherits the font color from the diagram's default font color (DiagFontColor). If the diagram has no default, it uses the class default.

====NodeBorderColor====
The border color of a node. The attribute is in RGB format, r,g,b, where each color is in the range 0 to 65535. If empty, it uses the default border color for this object class. For modules, the border color walks up the ancestor module hierarchy until an explicit border color is found.

You can see the effects of Nodefont and Nodeinfo in the parent diagram. You can modify them for each node with the [[Node Style dialog]] or set defaults for a model or module with the [[Diagram Style dialog]].

====NodeInfo ====
{{Assista||Subattributes of NodeInfo -- you can also read or set the subattributes such as <code>NodeInfo::fill of obj</code>, etc.}}

This affects how the node appears. It has quite a number of fields, all Boolean -- 0 or 1 -- except ''widthOfCtrl''. [[NodeInfo|More on NodeInfo...]]

Individual sub-fields of NodeInfo (such as show inputs, show outputs, show label, show border, fill node, show icon) inherit from the class default when not explicitly set on the node. Label justification (a sub-field not shown above) defaults to center for most classes, and left-aligned for [[Text]] nodes.

:<code>1,inputArrows, outputArrows, label, border, fill, useCustomFont, widthOfCtrl, bevel, showFormIcon, embedded, hidden</code>

:: ''inputArrows'': set to 1 to show all input influence arrows or 0 to suppress them
:: ''outputArrows'': set to 1 to show all output influence arrows or 0 to suppress them
:: ''label'': set to 1 to show the title (or identifier) in the node, or 0 not to.
:: ''border'': set to 1 to show the thin border around the node, or 0 not to.
:: ''fill'': set to 1 to fill the node with selected color, or 0 not to.
:: ''label'': set to 1 to show the title (or identifier) in the node, or 0 not to.
:: ''useCustomFont'': set to 1 to use the custom font set in NodeFont, or 0 not to.
:: ''widthOfCtrl'': For a user input or output node, this specifies the width of the field (for a text or choice menu) or the button for other types.
:: ''bevel'': set to 1 to show a bevel to make the node appear outdented -- default for button nodes -- or 0 not to.
:: ''ShowFormIcon'': controls whether the little result mode icon (e.g., "Mid") displays to the right of the result button or not.
:: ''Embedded'': is reserved for a future release, where it will specify that the edit table, result view, or module is shown directly on the diagram within the node's rectangular area.
::''visibility'': The visible / hidden / disabled state of the node, usually set using the [[ChangeNodeVisibility]] function. Possible values:
::: 0 = visible (default when unset)
::: 1 = hidden
::: 2 = very hidden
::: 3 = Extremely hidden
::: 4 = Hidden in browse mode
::: 5 = Disabled
::: 6 = Disabled in browse mode

====Nodefont====
The node font family and size in points, e.g. Bodoni, 16. If empty, it inherits the font from the parent diagram module, walking up the module hierarchy until a module with an explicit font is found. If no ancestor sets a font, it uses the default project font (typically Arial).

====Att_hyperlinkPref====
When an index or result table contains a [[handle]] to an object, it shows title of the object as a blue clickable link. When you click a handle link, it shows the object. The number assigned to this attribute controls how it shows the object when you click :
# Open its Object window
# Open its parent diagram with the node selected
# If it's a Module, open its Diagram with nothing selected. Otherwise, Open parent Diagram with the node selected.
The attribute is inherited: If you set this attribute for a Model, it sets the default for all results. If you set it on a module, it sets the default for results inside that module. If you set it for a particular variable, it applies only to that variable.

====DiagramColor====
The background color of a diagram, as r,g,b, where each color is in the range 0 to 65535. This attribute is set on a Module. Unlike most node appearance attributes, the diagram background color does '''not''' inherit from parent modules; if not set, it defaults to white.

====Pict====
An image shown in the node. You can paste an image into a node, or assign an image in standard formats (.png, jpeg, tiff) to the Pict attribute of a node.

==Window status attributes==

These attributes store the location and size of windows, including the Diagram, Object, and Result window, as applicable to each class of object.

====DiagState====
The location and size of the diagram window, where ''x'', ''y'' are location of top left corner, ''w'' and ''h'' are width and height in pixels. ''b'' is a bit field that stores the diagram style options. ''t'' is the style for tabs when a tabbed diagram style is selected.

:<code>v, x, y, w, h, b, tabs, buttonStyle, customIcon, titleOnly, crumbs</code>

:''v'' is a version number. Should be 2.

:''x'', ''y'' in the coordinate of the top-left corner of the window frame when the window is not maximized, relative to the top-left corner of the ''desk area'' (the gray background area that starts under the toolbar).

:''w, h'' are the width and height of the client area of the window when the window is not maximized. This client are is the area of the window not including the edges around the window, the window title bar, or the attribute panel, but it does include the diagram scroll bars (which have a width and height of 16). In [[Analytica 4.6]] and earlier, the height is from the bottom edge of the title bar to the bottom of the diagram's horizontal scroll bar, and hence, includes the height of the module hierarchy stripe within the total height. In [[Analytica 5.0]], the height starts at the lower edge of the hierarchy stripe -- so it does not include the hierarchy stripe.

:''b'' is a bit field, which is the sum of the following values:
:* 1 = Show arrows to/from modules
:* 2 = Show arrows to/from indexes
:* 4 = Show arrows to/from functions
:* 8 = Turn off background (i.e., the diagram background will appear white)
:* 16 = Show dynamic dependency arrows
:* 32 = Show arrows for dependencies in the Check attribute

:''tabs'' is reserved for a future enhancement (not currently exposed) It encodes whether the diagram is a tabbed diagram, which side the tabs display on, and which style of tabs are used. Possible values are:
:* 0 = (default) Not tabbed
:* 1 = Tabs on top
:* 2 = Tabs on bottom
:* 3 = Tabs on left (vertical text)
:* 4 = Tabs on right (vertical text)
:* 5 = Wide tabs on left (horizontal text)
:* 6 = Wide tabs on right (horizontal text)
:* 7 = Tabs hidden (e.g. overlays, controlled via button scripts)

:''buttonStyle'' controls how the buttons in input and output nodes display (such as ''Calc'', ''Edit Table'', etc).
:* 0 = Normal text (default in [[Analytica 5.0]])
:* 1 = Bolded text (pre-5.0 standard)
:* 2 = Blank (no label or icon in button)
:* 3 = Icon
:* 4 = Bare Icon
::''buttonStyle'' was introduced in [[Analytica 5.0]]
::The ''buttonStyle'' inherits from the parent module's diagram. If no ancestor module sets it, it defaults to normal text style (0).

:''customIcon'' If set to 1, uses the pict of the module or model as the icon for the titlebar.

:''titleOnly'' If set to 1, uses the diagram object's title as the titlebar's title without the prefix "Diagram - ".

:''crumbs'' If 0, hides the hierarchy bar from this diagram window only (child diagrams unaffected),

::''customIcon'', ''titleOnly'', and ''crumbs'' were introduced in [[Analytica 6.4]].

{{Assista||You can read or set the SubAttributes of DiagState using e.g., <code>DiagState::w of obj</code>.}}

====WindState====
The location and size of the object window, where X, Y are location of top left corner, W and H are width and height in pixels. v is version number, usually 1. (Applies to all user-defined objects.)
:<code>v, X, Y, W, H</code>

{{Assista||In an expression, you can use a subattribute such as <code>WindState::W of obj</code>

====ValueState====
{{Assista|key|SubAttributes of ValueState}}
<code>v, X, Y, W, H, Graph, U</code>
The type, location and size of the result window for a variable, where X, Y are location of top left corner of the window, W and H are width and height in pixels of the area exclusing the title bar and edges (the actual window size is X+15, Y+38), Graph is 1 if a graph view, 0 if a table view, and U is text defining the uncertainty view. v is version number, usually 1. (Applies only to variables.)

====DefnState====
The location and size of an edit table window.
{{Assista|key|SubAttributes of DefnState}}
:<code>v, x, y, w, h</code>

====OutlinerState====
The location and size of the outliner window. This is stored as an attribute of the keyword object named <code>All</code> and is not saved with the model.
{{Assista|key|SubAttributes of OutlinerState}}
:<code>v, x, y, w, h</code>

====Reformval====
Lists the indexes for a multidimensional variable, in sequence defining which index is for rows (x axis), which for columns (key), and the remaining as slicers, from bottom to top.

====Att_usebyprevindex====
???

== Internal Engine Attributes==

=== Att_versionRange ===
=== Att_canBeIn ===

=== Att_dirties ===
Used on a system variable to flag whether a change to the sys var causes the model to "dirty" (i.e., require a save).

Starting with [[Analytica 6.6]], you can also set this to 0 on your own Variables to signal that a change to the Definition does not dirty the module or library containing the variable. This can be useful when your library (which might be linked) updates a user input or internal state, but that is specific to the model, not the library, so you don't want this to trigger a save of the library.

=== Att_showable ===
=== Att_saveAlways ===
=== Att_recordSysFunDependencies ===
=== Att_Saveable ===
=== Att_attributeType ===
=== Att_readOnly ===
=== Att_domainKids, Att_domainParents ===

== User Interface State Attributes ==

'''Att_resultSliceState''':

'''Att_editSliceState'''

== Graphing Attributes ==

=== xyExpr ===

Contains one external/exogenous value expression. Recognized by Analytica 3.1 and earlier, where the expression for the X value in an XY graph was stored.

=== Att_exogenousValue ===

Holds a list of external values for a result window, which can then be used as graphing dimensions. Analytica 4.0 allows more than one external value to be brought in for plotting against the primary result of a variable. This attribute holds a list of expressions -- most commonly, each expression consists of a single variable identifier.

The xyExpr may also contain one addition external expression. (The reason it is split across two attributes is for greater 3.1 interoperability).

=== Att_GraphIndexRange ===
Stores the axis settings for an index. When you have set it globally (via the '''Set Default''' button in the [[Graph setup dialog]]), the attribute setting is set on the index node itself. More commonly, it is set from within a [[GraphSetup]] attribute so that it applies to that index only in the context of the graph.

{{Assista|key|SubAttributes of Att_GraphIndexRange}}

:ver, cat,auto, includezero, log, reverse, incs, min, max, includeSubset, excludeSubset, hideLabels
where:
:version : Must be 1 (version)
:categorical : 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
:includeSubset : [2,7,8,12] -- include these items (by position) when using manual scaling. Brackets included
:excludeSubset : [3,6,13,17] -- exclude these items when using manual scaling.
:hideLabels: 1=hide labels for this axis

=== Att_GraphValueRange ===

This attribute is usually contained within the [[GraphSetup]] attribute (except when '''Set Default''' was pressed after configuring the range).

The range for each value is encoded as

{{Assista|key|SubAttributes of Att_GraphValueRange}}
:ver, cat,auto, includezero, log, reverse, incs, min, max, includeSubset, excludeSubset, hideLabels
where:
:version : Must be 1 (version)
:categorical : 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
:includeSubset : [2,7,8,12] -- include these items (by position) when using manual scaling. Brackets included
:excludeSubset : [3,6,13,17] -- exclude these items when using manual scaling.
:hideLabels: 1=hide labels for this axis

For a given variable identifier, there can be a different range for each slice along a comparison index. These are encoded by joining the different range settings using a pipe separator (<code>|</code>) and prefixing each slice range with the slice number and colon. For example:

:<code>1,,1,,0,,20|1:1,,0,,1,,,0.01,0.56,0</code>

The first range (<code>1,,1,,0,,20</code> is for the variable's main value, the second one is prefixed by "1:" and applies to the first comparison slice. In a continuous CDF, PDF or Exceedance plot, this would be the 'X' value (e.g., the probability or density axis), but the 'Y' value is encoded instead on the <code>Graph_*_Valdim</code> system variable.

For common statistical axis, the attribute is set on special system variables with names having the form <code>Graph_*_Valdim</code>, such as <code>Graph_Pdf_Valdim</code>. This encodes the range setting for the PDF's density axis.

=== Att_continuousLineStyle ===
=== Att_categoricaLineStyle ===
=== Att_stackedBar ===
=== Att_stackedLine ===
=== Att_barOverlap ===

=== Graphing Role Attributes ===

These attributes are: '''Att_xRole''', '''Att_yRole''', '''Att_colorRole''', '''Att_symbolRole''', '''Att_symbolSizeRole''', '''Att_originRole'''.

They define the graphing pivot in coordination with the '''reformVal''' attribute. The settings in these attributes are combined with the current chart type, dimensions present in the current value (or values), etc., and Analytica may adjust the pivot actually shown to create a consistent set of roles. Since the dimensionality of results can change in Analytica (as upstream dimensions or added or removed, the view type can be changed, or the number of elements in a dimension may change), the exact pivot used the previous time the graph was displayed may no longer be sensible. However, when possible, the roles defined in these attributes do become the roles used in the graph.

Each of these role attributes can hold values in several possible forms:
* '''Self''': The keyword Self indicates that the main result fills the role.
* '''barOrigin''': The attribute name barOrigin indicates that the expression found in the legacy barOrigin attribute fills the role.
* '''xyExpr''': The attribute name indicates that the expression found in the xyExpr attribute fills the role.
* ''identifier'' : The identifier indicates that the index having this identifier fills the role.
* '''Sys_LocalIndex("''name''")''': Syntax indicating that the local index having the indicated name is used.
* '''Sys_CoordIndex(''value'')''' : The slice of the main result corresponding to ''[CoordIndex=value]'' is used, where ''value'' is an element of the coordinate index.
* 0 : The numeric value zero indicates that the main result is used (same as Self).
* n > 0: A positive integer value indicates that an external value is used. Several exogenous values may be attached to the result view (see '''Att_exogenousValues''' and '''xyExpr''' attributes). These are numbered, with the xyExpr always being n=1 if present, and then the remaining continuing in order through those listed in Att_exogenousValues, and finally the legacy barOrigin attribute expression coming last.
* n < 0: A negative integer value identifies a coordinate index slice by position. The role uses the slice of the main result corresponding to ''[@CoordIndex=abs(n)]''.

Also '''barOrigin'''.

== Table attributes ==

* [[TableCellDefault]]: The default value (or Checkbox or Choice expression) used in a new cell of an Edit table when you add or extend an index of that table.

* [[CorrespondenceMethod]]

==Other attributes==
; Att_BrowseOnly
; Att__cloakDefn
; Att_Dirty
; Att_Obfuscated
; Att_recordSet : See [[DbQuery]] for examples of use
; Att_ResultSliceState
; Att_rlm_license
; Att_rlm_licenseobj
; Att_Showable
; Att_whenDisallowed
; [[Att_PreLoadScript]]

==See Also==
<div style="column-count:2;-moz-column-count:2;-webkit-column-count:2">
* [[Manage attributes]]
* [[Attrib of Obj]]
* [[Objects and Values]]
* [[Objects_and_Their_Attributes_-_Part_1_of_3|Objects and Their Attributes]]
* [[Objects_and_Their_Attributes_-_Part_2_of_3#User-Specified_Attributes|User-Defined Attributes]]
* [[To edit an attribute]]
* [[Attribute panel]]
* [[:Category: Attributes]]
* [[Domain attribute]]
* [[Class]]
* [[Identifier]]
* [[Optimizer Attributes]]
* [[Attributes of a function]]
* [[Check attribute]]
* [[Classes of variables and other objects]]
* [[Definitions]]
</div>

Attributes

2026-04-14T18:22:27Z

Mhenrion:

[[Category:Attributes]]
(Up to [[Analytica Reference]])

Each Analytica Object consists of a set of Attributes -- "properties" or "fields" in other computer languages. Every Object has a [[Classes of variables and other objects|Class]], Identifier, and Title. Variables and Functions also have a Definition and Domain.

You can easily view and edit some attributes in an [[Object window]] or the [[Attribute panel]] below a Diagram. Other attributes you can see, but not edit directly -- such as, the Value, Inputs and Outputs of a Variable, which Analytica computes from the Definition.

Some attributes apply only to a particular object [[Class]] -- for example, Author and Creation date apply only to a Model or Module; Parameters and Recursive apply only to a Function. There are also many internal attributes that you don't usually see but may affect how the node looks -- such as, Nodeinfo, NodeSize, and Nodefont.

In an Analytica expression you can access attributes using [[Attrib of Obj|«Attrib» OF «Obj»]] syntax. Inside [[OnClick]] and [[Onchange]] attributes, you can also modify Attributes from Analytica code.

This page first describes common editable Attributes, then common non-modifiable Attributes, and finally the many obscure internal Attributes that users rarely need to know about.

== Common attributes ==

These attributes apply to all classes of user-defined objects. You can edit them directly in [[Edit mode]] in the [[Object window]] and [[Attribute panel]]:

===Editable Attributes of all Objects===

====Class====
The [[Classes of variables and other objects|class]] of the object, such as Variable, Index, Function, or Module. You may change the Class of an object only to a compatible class: You can change the class of a Variable among these subclasses Chance, Constant, Determ, Decision, Index, Objective, Variable. You may change a [[Modules and Libraries|Module]] among these subclasses Library, FiledLibrary, Model, Module, FiledModule, or Form. You can change a [[Text nodes|Text]] node to a [[Frame node|Frame]] node or back. You can't change the class of a Function, Button, or system object. In the [[Object window]] or [[Attribute panel]], in Edit mode, the Class appears as a pulldown menu that lets you change it to another compatible Class.

====Identifier====
The unique name of the object. An identifier must start with a letter, and contain only letters, digits, or underscore, up to 40 characters. Identifiers are insensitive to case -- but Analytica retains and shows the case originally provided (or adapted from the Object's title). So you can use CamelCase to clarify words in the identifier.

====Title====
A word or brief phrase identifying the the object. It usually appears in the diagram node, and in many other places in the user interface. It's best to limit a Title to about 50 characters. By default, it creates an identifier from the first 20 characters of the title, substituting "_" for blank or any character that isn't a letter or digit.

====Description====
Text that describes or documents the object. For a variable, it should describe what the quantity represents. For a function, it should describe what value it returns and what parameters it expects. If the definition is not obvious, it should also explain briefly what definition is doing. It should also mention any exceptions, such as what it does if an input or parameter is outside the expected domain.

===Editable attributes of Variables and Functions===

====Units====
The units of measurement of a variable, or value returned by a function -- such as "$/year" or "km/hr". It's best to use abbreviations to keep units within about 10 characters.

====Definition====
The expression used to compute the value of a variable or function.

====[[Check Attribute|Check]]====
An expression used to test that the computed result value is valid. If it returns false, it gives a warning. This is helpful to detect errors in user input or complex calculations. See [[Check Attribute]].

===Non-editable attributes of variables and functions===

These attributes are of variables and functions are visible, but not editable, in the Object window and Attribute panel:

====Inputs====
A list of variables and functions used in the definition, after definition has been parsed. Before parsing, it may contain variables and functions from which arrows were drawn.

====Outputs====
A list of variables and functions that use this object in their definitions.

====Value====
The computed (mid-)value of the variable (not available for functions). You may displayed the Value in an Object window, but it is not displayed by default.

Accessing the attribute's value from an expression (using e.g., <code>Value of X</code> doesn't trigger a calculation, and will return a special value of <code>Undefined</code> if it isn't yet computed. However, we recommend using <code>[[Mid]]([[IsResultComputed]](X))</code> to detect whether the mid-value is computed yet or not (or <code>[[Sample]]([[IsResultComputed]](X))</code>.

====EvaluationTime====
The number of CPU seconds that have been spent evaluating or obtaining the value of the variable, or computing the result of the [[User Defined Functions|function]], since the object was created or loaded, or since the [[ResetEvalTimes]] command was last executed. This timing does not include the time spent evaluating parent values.

====EvaluationTimeAll====
The number of CPU seconds spent in evaluation of the object, including time spent evaluating or obtaining the values of other variables that it depends on. This is the cumulative time since the object was first created or loaded, or since the [[ResetEvalTimes]] command was last executed.

===Editable attributes of Functions===

====Parameters====
A list of the function [[parameters]], enclosed in parentheses. It may include [[parameter qualifiers|qualifiers]] that specify what data type or dimension are expected for each parameter, or whether a parameter is optional or may be repeated. It is good practice to also list the main (non-optional) parameters (without qualifiers) in the title, so users can easily see what parameters it expects from seeing the function node in a diagram.

====Recursive====
A boolean, with value 0 (default) or 1, specifies whether the function is recursive -- i.e., it may call itself in its definition, or call another function that calls it (mutually recursive). By default, it is not displayed. You need to set it to be displayed in the [[Attributes dialog]].

===Editable Attributes of Modules===

====Author====
The name(s) of the person or people who created this module. When you start a new model, it may automatically fill this in with the name of the owner of the computer, if registered with Windows.

====[[TemplateInput]]====
Identifies a single variable within the module that functions at the module's primary input. Drawing an arrow into this module node inserts the origin of the arrow as the definition of this variable.

====[[TemplateOutput]]====
Identifies a single variable within the module that serves as the module's primary output. Drawing an arrow from this module node treats this variable as the origin of the arrow -- for example, for use as an input to another object.

===Non-editable attributes of modules===

The Module [[class]] includes subclasses Model, Module, Filed Module, Library, Filed Library, and Form. These are attributes of modules that you can see but not edit in the [[Object window]] and [[Attribute panel]]:

====Date (Created)====
The time and date on which the module was first created.

====Savedate (Last Saved)====
The time and date on which this model or separately filed module or library was last saved.

====FileInfo (File info)====
The directory path and name of the file from which this model was read from or to which it was last saved.

==Hidden attributes==

There are quite a few hidden attributes that you can't usually see in the standard user interface, and almost never need to think about. If needed you can see them in the [[Typescript]] Window. Type "Profile <identifier>" into the Typescript to see all the attributes of an object.

=== Hidden attributes of Variables and Functions===

====[[NumberFormat]]====
The number format parameters specified in the [[Number Format Dialog]] for numbers generated in a variable or function. If absent, it uses the default Number Format.
:<code>v, format, proxy, zeroes, separators, currency, digits, trailingZeros, currencysymbol, currencyPlacement, datetemplate, fullPrecision, fullDateTemplate, relReqForFullDateTemplate, datesAsNumbers, numbersAsDates, digitsForGeneralFmt</code>

====[[ProbabilityNumberFmt]]====
In a Probability Bands result view, a Cumulative Probability result view, or a Probability mass view for a discrete-valued quantity, probabilities display in addition to values for the underlying variable. For the columns or axes containing probabilities, this attribute holds the number format, which is often different from the underlying variable's number format.
:<code>v, format, proxy, zeroes, separators, currency, digits, trailingZeros, currencysymbol, currencyPlacement, datetemplate, fullPrecision, fullDateTemplate, relReqForFullDateTemplate, datesAsNumbers, numbersAsDates, digitsForGeneralFmt</code>

====[[DensityNumberFormat]]====
In a Probability Density Result view for a continuous variable, probability density values appear in addition to values for the underlying variable's quantity. This attribute stores the number format used for columns or axes that display probability densities.
:<code>v, format, proxy, zeroes, separators, currency, digits, trailingZeros, currencysymbol, currencyPlacement, datetemplate, fullPrecision, fullDateTemplate, relReqForFullDateTemplate, datesAsNumbers, numbersAsDates, digitsForGeneralFmt</code>

====FixedDef====
The parse-tree (DCODE) from the Definition. It displays as the code, usually with extra parens.

====DisplayInputs====
A list of objects among inputs from which arrows are to be displayed. It does not display arrows from Inputs that are not in Displayinputs.

====IsIn====
A handle to the module that contains this object. (Null for the top model.)

====[[Aliases]]====
A list of handles to any user inputs or user outputs ([FormNode]]) or [[Alias nodes]] for this object. Any object type can have aliases, including Variables, Functions, Modules, and Buttons.

====[[Original]]====
The original node of a user input or user output ([[FormNode]]) or [[Alias nodes|Alias node]]. [[Aliases]] attribute contains all the nodes listing it as its Original.

===Hidden attributes of Modules===

====Contains====
The list of objects contained in this module.

====DefaultSize====
The default node size for new nodes in this module. It uses the same format as Nodesize. If empty, it inherits the default size from its parent module. For a Model, it uses the default size from the Analytica initialization.

==Node attributes==

These attributes apply to the visual node that represents an object in its parent influence diagram. They control the location, size, and appearance of each node. You can modify some in the [[Diagram window|Diagram view]] (NodeLocation, NodeSize), some in the [[Node Style dialog]] (NodeFont, NodeInfo), or using the [[Color palette|Color palette dialog]], (NodeColor and NodeFontColor). :

====Nodelocation====
The location of the node center in its parent diagram, as x,y,z, where x and y are number of pixels rightwards and downwards from the top-left corner of the diagram. You can, of course, modify node location by dragging nodes in their diagram. Nodes are displayed in order of z value, which therefore controls which nodes are displayed in front of other nodes. You can send a node back or to the front by selecting the node and using the [[Right mouse button menus|Right mouse button menus.]]

====Nodesize====
The size of the node, as x,y, where x and y are the half width and half height in pixels, i.e. the distance from the node center to each edge. You can change the size of each node in its Diagram dragging the corner boxes around a selected node. You can define the default node sizes in the [[Diagram Style dialog]].

====Nodecolor====
The color for this node, as r,g,b, where each color is in the range 0 to 65535. If empty, it uses the default color for this object class. You can modify colors by directly by selecting the node in the diagram, and using the [[Color palette]]. For arrow objects, the arrow color is determined by this attribute; if empty, it uses the Arrow class default. Dynamic dependency arrows use a separate color (the dynamic arrow color attribute) instead.

====NodeFontColor====
Controls the font color of a node in a diagram. You can modify it from the [[Color palette#Change the text color of nodes|Color palette]]. The attribute is in RGB format, r,g,b, where each color is in the range 0 to 65535. If empty, it inherits the font color from the diagram's default font color (DiagFontColor). If the diagram has no default, it uses the class default.

====NodeBorderColor====
The border color of a node. The attribute is in RGB format, r,g,b, where each color is in the range 0 to 65535. If empty, it uses the default border color for this object class. For modules, the border color walks up the ancestor module hierarchy until an explicit border color is found.

You can see the effects of Nodefont and Nodeinfo in the parent diagram. You can modify them for each node with the [[Node Style dialog]] or set defaults for a model or module with the [[Diagram Style dialog]].

====NodeInfo ====
{{Assista||Subattributes of NodeInfo -- you can also read or set the subattributes such as <code>NodeInfo::fill of obj</code>, etc.}}

This affects how the node appears. It has quite a number of fields, all Boolean -- 0 or 1 -- except ''widthOfCtrl''. [[NodeInfo|More on NodeInfo...]]

Individual sub-fields of NodeInfo (such as show inputs, show outputs, show label, show border, fill node, show icon) inherit from the class default when not explicitly set on the node. Label justification (a sub-field not shown above) defaults to center for most classes, and left-aligned for [[Text]] nodes.

:<code>1,inputArrows, outputArrows, label, border, fill, useCustomFont, widthOfCtrl, bevel, showFormIcon, embedded, hidden</code>

:: ''inputArrows'': set to 1 to show all input influence arrows or 0 to suppress them
:: ''outputArrows'': set to 1 to show all output influence arrows or 0 to suppress them
:: ''label'': set to 1 to show the title (or identifier) in the node, or 0 not to.
:: ''border'': set to 1 to show the thin border around the node, or 0 not to.
:: ''fill'': set to 1 to fill the node with selected color, or 0 not to.
:: ''label'': set to 1 to show the title (or identifier) in the node, or 0 not to.
:: ''useCustomFont'': set to 1 to use the custom font set in NodeFont, or 0 not to.
:: ''widthOfCtrl'': For a user input or output node, this specifies the width of the field (for a text or choice menu) or the button for other types.
:: ''bevel'': set to 1 to show a bevel to make the node appear outdented -- default for button nodes -- or 0 not to.
:: ''ShowFormIcon'': controls whether the little result mode icon (e.g., "Mid") displays to the right of the result button or not.
:: ''Embedded'': is reserved for a future release, where it will specify that the edit table, result view, or module is shown directly on the diagram within the node's rectangular area.
::''visibility'': The visible / hidden / disabled state of the node, usually set using the [[ChangeNodeVisibility]] function. Possible values:
::: 0 = visible (default when unset)
::: 1 = hidden
::: 2 = very hidden
::: 3 = Extremely hidden
::: 4 = Hidden in browse mode
::: 5 = Disabled
::: 6 = Disabled in browse mode

====Nodefont====
The node font family and size in points, e.g. Bodoni, 16. If empty, it inherits the font from the parent diagram module, walking up the module hierarchy until a module with an explicit font is found. If no ancestor sets a font, it uses the default project font (typically Arial).

====Att_hyperlinkPref====
When an index or result table contains a [[handle]] to an object, it shows title of the object as a blue clickable link. When you click a handle link, it shows the object. The number assigned to this attribute controls how it shows the object when you click :
# Open its Object window
# Open its parent diagram with the node selected
# If it's a Module, open its Diagram with nothing selected. Otherwise, Open parent Diagram with the node selected.
The attribute is inherited: If you set this attribute for a Model, it sets the default for all results. If you set it on a module, it sets the default for results inside that module. If you set it for a particular variable, it applies only to that variable.

====DiagramColor====
The background color of a diagram, as r,g,b, where each color is in the range 0 to 65535. This attribute is set on a Module. Unlike most node appearance attributes, the diagram background color does '''not''' inherit from parent modules; if not set, it defaults to white.

====Pict====
An image shown in the node. You can paste an image into a node, or assign an image in standard formats (.png, jpeg, tiff) to the Pict attribute of a node.

==Window status attributes==

These attributes store the location and size of windows, including the Diagram, Object, and Result window, as applicable to each class of object.

====DiagState====
The location and size of the diagram window, where ''x'', ''y'' are location of top left corner, ''w'' and ''h'' are width and height in pixels. ''b'' is a bit field that stores the diagram style options. ''t'' is the style for tabs when a tabbed diagram style is selected.

:<code>v, x, y, w, h, b, tabs, buttonStyle, customIcon, titleOnly, crumbs</code>

:''v'' is a version number. Should be 2.

:''x'', ''y'' in the coordinate of the top-left corner of the window frame when the window is not maximized, relative to the top-left corner of the ''desk area'' (the gray background area that starts under the toolbar).

:''w, h'' are the width and height of the client area of the window when the window is not maximized. This client are is the area of the window not including the edges around the window, the window title bar, or the attribute panel, but it does include the diagram scroll bars (which have a width and height of 16). In [[Analytica 4.6]] and earlier, the height is from the bottom edge of the title bar to the bottom of the diagram's horizontal scroll bar, and hence, includes the height of the module hierarchy stripe within the total height. In [[Analytica 5.0]], the height starts at the lower edge of the hierarchy stripe -- so it does not include the hierarchy stripe.

:''b'' is a bit field, which is the sum of the following values:
:* 1 = Show arrows to/from modules
:* 2 = Show arrows to/from indexes
:* 4 = Show arrows to/from functions
:* 8 = Turn off background (i.e., the diagram background will appear white)
:* 16 = Show dynamic dependency arrows
:* 32 = Show arrows for dependencies in the Check attribute

:''tabs'' is reserved for a future enhancement (not currently exposed) It encodes whether the diagram is a tabbed diagram, which side the tabs display on, and which style of tabs are used. Possible values are:
:* 0 = (default) Not tabbed
:* 1 = Tabs on top
:* 2 = Tabs on bottom
:* 3 = Tabs on left (vertical text)
:* 4 = Tabs on right (vertical text)
:* 5 = Wide tabs on left (horizontal text)
:* 6 = Wide tabs on right (horizontal text)
:* 7 = Tabs hidden (e.g. overlays, controlled via button scripts)

:''buttonStyle'' controls how the buttons in input and output nodes display (such as ''Calc'', ''Edit Table'', etc).
:* 0 = Normal text (default in [[Analytica 5.0]])
:* 1 = Bolded text (pre-5.0 standard)
:* 2 = Blank (no label or icon in button)
:* 3 = Icon
:* 4 = Bare Icon
::''buttonStyle'' was introduced in [[Analytica 5.0]]
::The ''buttonStyle'' inherits from the parent module's diagram. If no ancestor module sets it, it defaults to normal text style (0).

:''customIcon'' If set to 1, uses the pict of the module or model as the icon for the titlebar.

:''titleOnly'' If set to 1, uses the diagram object's title as the titlebar's title without the prefix "Diagram - ".

:''crumbs'' If 0, hides the hierarchy bar from this diagram window only (child diagrams unaffected),

::''customIcon'', ''titleOnly'', and ''crumbs'' were introduced in [[Analytica 6.4]].

{{Assista||You can read or set the SubAttributes of DiagState using e.g., <code>DiagState::w of obj</code>.}}

====WindState====
The location and size of the object window, where X, Y are location of top left corner, W and H are width and height in pixels. v is version number, usually 1. (Applies to all user-defined objects.)
:<code>v, X, Y, W, H</code>

{{Assista||In an expression, you can use a subattribute such as <code>WindState::W of obj</code>

====ValueState====
{{Assista|key|SubAttributes of ValueState}}
<code>v, X, Y, W, H, Graph, U</code>
The type, location and size of the result window for a variable, where X, Y are location of top left corner of the window, W and H are width and height in pixels of the area exclusing the title bar and edges (the actual window size is X+15, Y+38), Graph is 1 if a graph view, 0 if a table view, and U is text defining the uncertainty view. v is version number, usually 1. (Applies only to variables.)

====DefnState====
The location and size of an edit table window.
{{Assista|key|SubAttributes of DefnState}}
:<code>v, x, y, w, h</code>

====OutlinerState====
The location and size of the outliner window. This is stored as an attribute of the keyword object named <code>All</code> and is not saved with the model.
{{Assista|key|SubAttributes of OutlinerState}}
:<code>v, x, y, w, h</code>

====Reformval====
Lists the indexes for a multidimensional variable, in sequence defining which index is for rows (x axis), which for columns (key), and the remaining as slicers, from bottom to top.

====Att_usebyprevindex====
???

== Internal Engine Attributes==

=== Att_versionRange ===
=== Att_canBeIn ===

=== Att_dirties ===
Used on a system variable to flag whether a change to the sys var causes the model to "dirty" (i.e., require a save).

Starting with [[Analytica 6.6]], you can also set this to 0 on your own Variables to signal that a change to the Definition does not dirty the module or library containing the variable. This can be useful when your library (which might be linked) updates a user input or internal state, but that is specific to the model, not the library, so you don't want this to trigger a save of the library.

=== Att_showable ===
=== Att_saveAlways ===
=== Att_recordSysFunDependencies ===
=== Att_Saveable ===
=== Att_attributeType ===
=== Att_readOnly ===
=== Att_domainKids, Att_domainParents ===

== User Interface State Attributes ==

'''Att_resultSliceState''':

'''Att_editSliceState'''

== Graphing Attributes ==

=== xyExpr ===

Contains one external/exogenous value expression. Recognized by Analytica 3.1 and earlier, where the expression for the X value in an XY graph was stored.

=== Att_exogenousValue ===

Holds a list of external values for a result window, which can then be used as graphing dimensions. Analytica 4.0 allows more than one external value to be brought in for plotting against the primary result of a variable. This attribute holds a list of expressions -- most commonly, each expression consists of a single variable identifier.

The xyExpr may also contain one addition external expression. (The reason it is split across two attributes is for greater 3.1 interoperability).

=== Att_GraphIndexRange ===
Stores the axis settings for an index. When you have set it globally (via the '''Set Default''' button in the [[Graph setup dialog]]), the attribute setting is set on the index node itself. More commonly, it is set from within a [[GraphSetup]] attribute so that it applies to that index only in the context of the graph.

{{Assista|key|SubAttributes of Att_GraphIndexRange}}

:ver, cat,auto, includezero, log, reverse, incs, min, max, includeSubset, excludeSubset, hideLabels
where:
:version : Must be 1 (version)
:categorical : 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
:includeSubset : [2,7,8,12] -- include these items (by position) when using manual scaling. Brackets included
:excludeSubset : [3,6,13,17] -- exclude these items when using manual scaling.
:hideLabels: 1=hide labels for this axis

=== Att_GraphValueRange ===

This attribute is usually contained within the [[GraphSetup]] attribute (except when '''Set Default''' was pressed after configuring the range).

The range for each value is encoded as

{{Assista|key|SubAttributes of Att_GraphValueRange}}
:ver, cat,auto, includezero, log, reverse, incs, min, max, includeSubset, excludeSubset, hideLabels
where:
:version : Must be 1 (version)
:categorical : 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
:includeSubset : [2,7,8,12] -- include these items (by position) when using manual scaling. Brackets included
:excludeSubset : [3,6,13,17] -- exclude these items when using manual scaling.
:hideLabels: 1=hide labels for this axis

For a given variable identifier, there can be a different range for each slice along a comparison index. These are encoded by joining the different range settings using a pipe separator (<code>|</code>) and prefixing each slice range with the slice number and colon. For example:

:<code>1,,1,,0,,20|1:1,,0,,1,,,0.01,0.56,0</code>

The first range (<code>1,,1,,0,,20</code> is for the variable's main value, the second one is prefixed by "1:" and applies to the first comparison slice. In a continuous CDF, PDF or Exceedance plot, this would be the 'X' value (e.g., the probability or density axis), but the 'Y' value is encoded instead on the <code>Graph_*_Valdim</code> system variable.

For common statistical axis, the attribute is set on special system variables with names having the form <code>Graph_*_Valdim</code>, such as <code>Graph_Pdf_Valdim</code>. This encodes the range setting for the PDF's density axis.

=== Att_continuousLineStyle ===
=== Att_categoricaLineStyle ===
=== Att_stackedBar ===
=== Att_stackedLine ===
=== Att_barOverlap ===

=== Graphing Role Attributes ===

These attributes are: '''Att_xRole''', '''Att_yRole''', '''Att_colorRole''', '''Att_symbolRole''', '''Att_symbolSizeRole''', '''Att_originRole'''.

They define the graphing pivot in coordination with the '''reformVal''' attribute. The settings in these attributes are combined with the current chart type, dimensions present in the current value (or values), etc., and Analytica may adjust the pivot actually shown to create a consistent set of roles. Since the dimensionality of results can change in Analytica (as upstream dimensions or added or removed, the view type can be changed, or the number of elements in a dimension may change), the exact pivot used the previous time the graph was displayed may no longer be sensible. However, when possible, the roles defined in these attributes do become the roles used in the graph.

Each of these role attributes can hold values in several possible forms:
* '''Self''': The keyword Self indicates that the main result fills the role.
* '''barOrigin''': The attribute name barOrigin indicates that the expression found in the legacy barOrigin attribute fills the role.
* '''xyExpr''': The attribute name indicates that the expression found in the xyExpr attribute fills the role.
* ''identifier'' : The identifier indicates that the index having this identifier fills the role.
* '''Sys_LocalIndex("''name''")''': Syntax indicating that the local index having the indicated name is used.
* '''Sys_CoordIndex(''value'')''' : The slice of the main result corresponding to ''[CoordIndex=value]'' is used, where ''value'' is an element of the coordinate index.
* 0 : The numeric value zero indicates that the main result is used (same as Self).
* n > 0: A positive integer value indicates that an external value is used. Several exogenous values may be attached to the result view (see '''Att_exogenousValues''' and '''xyExpr''' attributes). These are numbered, with the xyExpr always being n=1 if present, and then the remaining continuing in order through those listed in Att_exogenousValues, and finally the legacy barOrigin attribute expression coming last.
* n < 0: A negative integer value identifies a coordinate index slice by position. The role uses the slice of the main result corresponding to ''[@CoordIndex=abs(n)]''.

Also '''barOrigin'''.

== Table attributes ==

* [[TableCellDefault]]: The default value (or Checkbox or Choice expression) used in a new cell of an Edit table when you add or extend an index of that table.

* [[CorrespondenceMethod]]

==Other attributes==
; Att_BrowseOnly
; Att__cloakDefn
; Att_Dirty
; Att_Obfuscated
; Att_recordSet : See [[DbQuery]] for examples of use
; Att_ResultSliceState
; Att_rlm_license
; Att_rlm_licenseobj
; Att_Showable
; Att_whenDisallowed
; [[Att_PreLoadScript]]

==See Also==
<div style="column-count:2;-moz-column-count:2;-webkit-column-count:2">
* [[Manage attributes]]
* [[Attrib of Obj]]
* [[Objects and Values]]
* [[Objects_and_Their_Attributes_-_Part_1_of_3|Objects and Their Attributes]]
* [[Objects_and_Their_Attributes_-_Part_2_of_3#User-Specified_Attributes|User-Defined Attributes]]
* [[To edit an attribute]]
* [[Attribute panel]]
* [[:Category: Attributes]]
* [[Domain attribute]]
* [[Class]]
* [[Identifier]]
* [[Optimizer Attributes]]
* [[Attributes of a function]]
* [[Check attribute]]
* [[Classes of variables and other objects]]
* [[Definitions]]
</div>

ArrowClass

2026-04-14T00:58:51Z

Mhenrion:

ArrowClass is the [[Classes of variables and other objects|Class]] of Objects that represent influence arrows. Only arrows that have nondefault properties such as [[Arrow bends, curves, and styles]] have explit Objects, needed to contain those properties as Attributes. Users don't normally need to know about Arrow objects unless you want to write special functions to use or change Arrow properties.

See also
* [[Objects]]
* [[Classes of variables and other objects]]
* [[Arrow bends, curves, and styles]]

ArrowClass

2026-04-14T00:58:37Z

Mhenrion:

ArrowClass

2026-04-14T00:55:47Z

Mhenrion: Created page with "ArrowClass is the Class of Objects that represent influence arrows. Only arrows that have nondefault properties like Thickness or Waypoints have Objects. Users never nee..."

ArrowClass is the [[Class]] of Objects that represent influence arrows. Only arrows that have nondefault properties like Thickness or Waypoints have Objects. Users never need to bother about Arrow objects except if they want to write special functions that use or change Arrow properties.

See also
* [[Objects]]
* [[Classes]
*

Mutables library

2026-04-07T17:03:02Z

Mhenrion: /* Using mutables for debugging */

[[category:Function libraries]]

A ''mutable'' is a memory location that you can write to as a side-effect of a calculation and can later read from. It can hold any Analytica data structure. There is no dependency maintenance, unlike normal Analytica flow architecture, so values you read from it don't invalidate if the mutable later changes. Mutables can be especially useful for debugging, especially with complex data structures.

'''Download:''' [[media:Mutables library.ana|Mutables library.ana]].

==Using mutables for debugging==

Mutables can be especially useful for debugging when the data structures are too complex to use [[ConsolePrint]] effectively, or contain [[In-memory binary data terms|binary data]], etc.. The code you are debugging can save intermediate values in mutables, and then you can examine these later after the entire calc finishes to figure out what was going on.

Use in this way, you will usually create a Variable node to hold the mutable:
::<code>Variable debug_val ::= [[MutableNew]]( )</code>

The code you are debugging calls
::<code>[[MutableSet]]( debug_val, some_intermediate_val );</code>
to save the value for examination later. Then later you view it using, say
::<code>Variable ViewDebugVal ::= [[MutableGet]](debug_val)</code>
It is best to set the [[CachingMethod]] of <code>ViewDebugVal</code> to '''Never Cache''', since there is no dependency maintenance. I.e., if you rerun your algorithm and then view this result, you'll see the first value if <code>ViewDebugVal</code> caches.
You can also use <code>[[InvalidateResult]](ViewDebugVal)</code> from a button OnClick.

You can pass mutables to a function parameter, which is sometimes useful when you have subroutines that modify a data structure.

Mutables can also be used from imperative code, but this use is strongly discouraged. There is seldom a good reason for using them in this way -- you just inherit all the disadvantages of imperative code. Analytica explicitly prohibits side-effects of expression evaluation, which promotes referential transparency. This library provides a mechanism to get around this, but its more legitimate uses are for debugging or in-memory logging use cases.

If you have a calculation that has multiple results, instead of placing the secondary results in variables that have mutables, it's better to get the secondary result variables with the [[ComputedBy]] function or with [[MultiResult]].

== Function Reference ==
=== <span id="MutableNew">MutableNew( )</span> ===

Creates a new mutable -- a storage location that can be set using
:<code>[[MutableSet]]( mutable, x )</code>
and read using
:<code>[[MutableGet]]( mutable )</code>

;Use case 1 (common for debugging)
:Create a new global variable to be your mutable. The name of the variable is the name of your mutable. Its definition is:
::<code>MutableNew()</code>
;Use case 2 (Common when passing a mutable parameter to a UDF):
::<code>Local myMutableName := [[MutableNew]]();</code>
::<code>F( myMutableName )</code>
:where <code>F</code> is the called UDF. Inside F it uses [[MutableGet]] and [[MutableSet]].

You can also have mutables within a data structure, and data structures with multiple separate mutables. The data structure itself doesn't change, just the values inside the mutable elements.

=== <span id="MutableSet">MutableSet( mutable, x )</span> ===
Stores the value «x» in the «mutable».

=== <span id="MutableGet">MutableGet( mutable )</span> ===
Returns the current value stored in «mutable».

==History==
The mutables library is included with [[Analytica 6.4]] and later. It requires [[Analytica 6.0]] or later.

== See Also ==
* [[ComputedBy]]
* [[Local Values]]
* [[Side effects]]
* [[Debugging Hints]]

IndexesOf

2026-04-07T16:18:37Z

Mhenrion: /* See Also */

[[Category:Functions that create lists]]
[[Category:Functions returning information about arrays]]
[[Category:Meta-Inference Functions]]

== IndexesOf(a'', except...'') ==
Returns a list of [[handle]]s to the indexes of array «a». It is different from [[IndexNames]](a), which returns the identifiers of the indexes as text values instead of handles.

If «X» has an [[implicit index]] (an index without a name), the first element of the output list is [[null]], rather than a handle.

If the array has more than one [[Local Indexes|local index]] with the same identifier, you can use [[IndexesOf]](a) to identify each index safely because each handle unambiguously refers to the corresponding index, where [[IndexNames]](a) would return the identifiers as identical and therefore ambiguous text values.

The optional «except» parameter excludes any of the indexes that are listed.

[[Syntax]]:
:[[IndexesOf]](a: Array)

== Example ==
:<code>IndexesOf(Car_prices) → [Car_types, Year]</code>

:<code>IndexesOf(Car_prices, except: Car_types) → [Year]</code>

Find the maximum in <code>A</code> over all indexes:
:<code>[[Max]]( A, ...[[IndexesOf]](A) )</code>

Sum over all indexes of <code>x</code> except <code>J</code> and <code>K</code>:
:<code>[[Sum]]( x, ...[[IndexesOf]](x, except: J,K) )</code>

== History ==
* The «except» parameter was introduced in [[Analytica 5.2]].

== See Also ==
* [[Handle]]
* [[Handle Functions]]
* [[IndexNames]]: The names of the indexes of a variable
* [[HasIndex]] Tests if a variable has a specified Index.
* [[Repeated parameter forwarding]]

IndexesOf

2026-04-07T16:18:00Z

Mhenrion: /* See Also */

[[Category:Functions that create lists]]
[[Category:Functions returning information about arrays]]
[[Category:Meta-Inference Functions]]

== IndexesOf(a'', except...'') ==
Returns a list of [[handle]]s to the indexes of array «a». It is different from [[IndexNames]](a), which returns the identifiers of the indexes as text values instead of handles.

If «X» has an [[implicit index]] (an index without a name), the first element of the output list is [[null]], rather than a handle.

If the array has more than one [[Local Indexes|local index]] with the same identifier, you can use [[IndexesOf]](a) to identify each index safely because each handle unambiguously refers to the corresponding index, where [[IndexNames]](a) would return the identifiers as identical and therefore ambiguous text values.

The optional «except» parameter excludes any of the indexes that are listed.

[[Syntax]]:
:[[IndexesOf]](a: Array)

== Example ==
:<code>IndexesOf(Car_prices) → [Car_types, Year]</code>

:<code>IndexesOf(Car_prices, except: Car_types) → [Year]</code>

Find the maximum in <code>A</code> over all indexes:
:<code>[[Max]]( A, ...[[IndexesOf]](A) )</code>

Sum over all indexes of <code>x</code> except <code>J</code> and <code>K</code>:
:<code>[[Sum]]( x, ...[[IndexesOf]](x, except: J,K) )</code>

== History ==
* The «except» parameter was introduced in [[Analytica 5.2]].

== See Also ==
* [[Handle]]
* [[Handle Functions]]
* [[IndexNames]]: The names of the indexes of a variable
* [[Hasindex]] Tests if a variable has a specified Index.
* [[Repeated parameter forwarding]]

If you don’t read manuals

2026-03-18T00:36:36Z

Mhenrion:

[[Category:Analytica User Guide]]
<breadcrumbs>Analytica User Guide > Introduction: About Analytica > {{PAGENAME}}</breadcrumbs>

Experienced modelers find most Analytica features intuitive. But, it’s helpful to get a good grasp of
some key concepts so you can get up to speed rapidly. Here are a few chapters that you might
find especially helpful to review.

:{| class="wikitable"
!Chapter
!Contents
|-
| [[Building Effective Models]]
|Guidelines distilled from the experience of master modelers. It offers practical suggestions for building models that are clear, reliable, and focus on what really matters — the decisions, objectives, and key uncertainties. These tips are not specific to Analytica, but we designed Analytica to make them especially easy to follow.
|-
| [[Creating Lucid Influence Diagrams|Creating Lucid Diagrams]]
|Tips on how to avoid producing incomprehensible spaghetti -- and create influence diagrams that are truly lucid and even elegant.
|-
|[[Arrays and Indexes]]
|We especially recommend this section for people who don't read manuals, including -- perhaps especially -- experienced modelers! Once you grasp the essentials of Analytica’s Intelligent Arrays™, you'll find that you can build complex multidimensional models with surprising ease. But you might find they take a little getting used to, particularly if you have spent a lot of time with spreadsheets or programming with arrays.
|-
|[[Expressing Uncertainty]]
|How to select appropriate probability distributions to express uncertainties. It also provides an overview of how Analytica computes probability distributions using Monte Carlo and other random sampling methods, and your options for displaying probabilistic values.
|-
|[[Procedural Programming]]
|Analytica is a "declarative" language, enabling you to create large and sophisticated models without conventional procedural programming. But, sometimes you really want to write complex procedural functions. If so, read this chapter to understand Analytica as a programming language.
|}

==See Also==
* [[Analytica Tutorial]]
* [[Creating Lucid Influence Diagrams]]
* [[Building Effective Models]]
* [[Arrays and Indexes]]
* [[Expressing Uncertainty]]
* [[Procedural Programming]]

<footer>Welcome! / {{PAGENAME}} /Hardware and software requirements</footer>

MediaWiki:Hierarchy

2026-03-18T00:34:31Z

Mhenrion:

* Getting started
** [[Analytica_Tutorial|Tutorial]]
*** [[About Analytica]]
*** [[Tutorial: Open a model to browse|Opening A Model]]
*** [[Tutorial: Reviewing a model|Reviewing a model]]
*** [[Tutorial: Create a model|Create a Model]]
*** [[Tutorial: Arrays|Arrays]]
***[[Tutorial: Analyzing a model|Uncertainty]]
***[[Tutorial: Sharing a model with ACP| Sharing a model with ACP]]
***[[Tutorial: Decision trees|Decision tree]]
***[[Tutorial: Dynamic system model| Dynamic system model]]
***[[Example Models and Libraries]]
***[[Tutorial videos]]
**[[If you don’t read manuals]]
** [[Excel and Analytica]]
** [[Edit and improve these docs]]
** [[Open these docs from Analytica]]
* Quick links
** [[Example Models]]
** [[Tutorial videos|Videos]]
** [[Keyboard Shortcuts]]
** [[Functions by category]]
** [[Alphabetical Function List]]
** [[Modelling Guide]]
** [[Standard libraries]]
** [[Additional libraries]]
** [[:Category:Concepts|Key concepts]]
** [[Techniques and technologies]]

* [[Analytica_User_Guide|User Guide]]
** [[Contents of User Guide|Contents in detail]]
** Basics
*** [[Introduction: About Analytica|Introduction]]
**** [[If you don’t read manuals]]
**** [[Hardware and software requirements]]
**** [[Installation and licenses]]
**** [[Editions of Analytica]]
*** [[Help menu and documentation]]
**** [[Normally, usually, and defaults]]
**** [[Typographic conventions in this guide]]
**** [[User guide Examples folder]]
**** [[New Releases|What’s new?]]
*** [[Menus]]
**** [[File menu]]
**** [[Edit menu]]
**** [[Object menu]]
**** [[Definition menu (more)|Definition menu]]
**** [[Result menu]]
**** [[Diagram menu]]
**** [[Window menu]]
**** [[Help menu]]
**** [[Right mouse button menus]]
*** [[Windows and dialogs]]
**** [[Object window]]
**** [[Result window]]
**** [[Diagram window]]
**** [[Outline window]]
**** [[Object Finder dialog]]
**** [[Diagram Style dialog]]
**** [[Node Style dialog]]
**** [[Number Format Dialog]]
**** [[Graph setup dialog]]
**** [[Uncertainty Setup dialog]]
**** [[Preferences dialog]]
**** [[Attributes dialog]]
*** [[Examining a Model]]
**** [[To open or exit a model]]
**** [[Diagram window]]
**** [[Classes of variables and other objects]]
**** [[Selecting nodes]]
**** [[Toolbar]]
**** [[User input nodes and user output nodes]]
**** [[Object window]]
**** [[Attribute panel]]
**** [[Values in Object Window]]
**** [[Printing]]
*** [[Result Tables and Graphs]]
**** [[Result window]]
**** [[Table view of a result]]
**** [[Graph view of a result]]
**** [[Uncertainty view of a result]]
**** [[Comparing results]]
*** [[Parametric analysis]]
*** [[Create and edit a model]]
**** [[Create and save a model]]
**** [[Create and edit nodes]]
**** [[Draw arrows]]
**** [[Draw arrows between modules]]
**** [[Alias nodes]]
**** [[To edit an attribute]]
**** [[Change class of an object]]
**** [[Preferences dialog]]
*** [[Building Effective Models]]
**** [[Create a model]]
**** [[Test and debug your model]]
**** [[Expand your model]]
*** [[Creating Lucid Influence Diagrams|Lucid influence diagrams]]
**** [[About influence diagrams]]
**** [[Guidelines for creating lucid models]]
**** [[Arranging nodes to make clear diagrams]]
**** [[Organizing a module hierarchy]]
**** [[Color in influence diagrams]]
**** [[Diagram Style dialog]]
**** [[Node Style dialog]]
**** [[Taking screenshots of diagrams|Screenshots of a diagram]]
*** [[Number and table formats]]
**** [[Number formats]]
**** [[Date formats]]
**** [[Display of constraint results|Display constraint results]]
**** [[Multiple formats in one table]]
***[[Graphs]]
**** [[Graphing roles]]
**** [[Graph setup dialog]]
**** [[Changing Series Colors]]
**** [[Graph templates]]
**** [[XY Comparison]]
** Definitions and expressions
*** [[Definitions]]
**** [[Creating or editing a definition]]
**** [[The Expression popup menu]]
**** [[Expression Assist]]
**** [[Object Finder dialog]]
**** [[Definition menu]]
**** [[The domain of possible values]]
**** [[Check attribute]]
*** [[Expressions]]
**** [[Numbers]]
**** [[Date and Time Values]]
**** [[Boolean or truth values]]
**** [[Text values]]
**** [[Operators]]
**** [[IF a THEN b ELSE c]]
**** [[Function calls and parameters]]
**** [[Math functions]]
**** [[Numbers and text]]
**** [[INF, NAN, and NULL - Exception values]]
**** [[Warnings]]
**** [[Datatype functions]]
*** [[Text, Date, Math, and Financial Functions]]
**** [[Text functions]]
**** [[Date functions]]
**** [[Advanced math functions]]
**** [[Complex number functions]]
**** [[Financial functions]]
**** [[Financial library functions]]
*** [[Dynamic Simulation]]
**** [[Time index]]
**** [[Dynamic function]]
**** [[Time index details]]
**** [[Dynamic initial values]]
**** [[Dynamic using arrays]]
**** [[Dynamic dependencies]]
**** [[Dynamic and uncertainty]]
**** [[Dynamic on non-Time Indexes]]
**** [[Reverse Dynamic]]
** Arrays and Indexes
*** [[Intelligent Arrays]]
*** [[Indexes and arrays: An introduction]]
*** [[Arrays and Indexes]]
**** [[IF a THEN b ELSE c with arrays]]
**** [[Creating an index]]
**** [[Functions that create indexes]]
**** [[To make an edit table]]
**** [[To edit a table]]
**** [[Splice a table when computed indexes change]]
**** [[Subscript and slice of a subarray]]
**** [[Choice menus and Checkboxes in an edit table]]
**** [[Shortcuts to navigate and edit a table]]
*** [[Array functions]]
**** [[Array Function Example Variables]]
**** [[Functions that create arrays]]
**** [[Array-reducing functions]]
**** [[Transforming functions]]
**** [[Relational tables and multiD arrays]]
**** [[Interpolation functions]]
**** [[Fourier Transform]]
**** [[Sets - collections of unique elements]]
**** [[Other array functions]]
**** [[DetermTable: Deterministic tables]]
**** [[Subtable: Editable part of an array]]
**** [[MultiTable: Combining editable and computed arrays]]
**** [[Matrix functions]]
** Uncertainty and statistics
*** [[Expressing Uncertainty]]
**** [[Uncertainty Setup dialog]]
**** [[Uncertainty views]]
**** [[Selecting the Sample Size]]
**** [[Choosing an appropriate distribution ]]
**** [[Defining a variable as a distribution]]
**** [[Including a distribution in a definition]]
**** [[Probabilistic calculation]]
**** [[Monte Carlo and probabilistic simulation]]
*** [[Probability distributions]]
**** [[Parametric discrete distributions]]
**** [[Probability density and mass graphs]]
**** [[The domain attribute and discrete variables]]
**** [[Custom discrete probabilities]]
**** [[Parametric continuous distributions]]
**** [[Custom continuous distributions]]
**** [[Special probabilistic functions]]
**** [[Advanced probability functions]]
**** [[Multivariate distributions]]
**** [[Importance weights]]
*** [[Statistics, Sensitivity, and Uncertainty Analysis]]
**** [[Statistical functions]]
**** [[Weighted statistics and w parameter]]
**** [[Importance analysis]]
**** [[Sensitivity analysis functions]]
**** [[Tornado charts]]
**** [[X-Y plots]]
**** [[Scatter plots]]
**** [[Regression analysis]]
**** [[Uncertainty in regression results]]
**** [[Logistic regression functions]]
**** [[Stochastic Information Packets (SIPs)]]
** [[User interfaces]]
*** [[Creating Interfaces for End Users|User interfaces]]
**** [[User Input nodes]]
**** [[Choice menu user input]]
**** [[Checkbox user input]]
**** [[User output nodes]]
**** [[User inputs and outputs as aliases]]
**** [[Onchange attribute]]
**** [[Button creation]]
**** [[Form modules]]
**** [[Icon images in a node]]
**** [[Graphics, frames, and text in a diagram]]
**** [[Links or URL in model attributes]]
**** [[Analytica Free Edition]]
*** [[Analytica Cloud Player (ACP)]]
** Advanced features
*** [[Integration with data and applications]]
**** [[Read and write text files]]
**** [[Read data from URL on internet]]
**** [[Copy and Paste between applications]]
**** [[Import and Export data]]
**** [[Model file formats]]
**** [[OLE linking]]
**** [[Database access]]
**** [[Database functions]]
**** [[Excel spreadsheets read and write]]
**** [[RunConsoleProcess - call other applications]]
**** [[COM Automation Objects]]
*** [[Working with Large Models]]
**** [[Module hierarchy]]
**** [[Outline window]]
**** [[Find variables and other objects]]
**** [[Manage attributes]]
**** [[Invalid variables]]
**** [[Filed modules and libraries]]
**** [[Import a module or library]]
**** [[Combining models into an integrated model]]
**** [[Making a browse-only model and hiding definitions]]
**** [[Managing windows]]
**** [[Memory usage and management]]
**** [[Performance Profiler library]]
**** [[Analytica Enterprise]]
*** [[User-defined Functions and Libraries]]
**** [[Example function]]
**** [[Call a function]]
**** [[Define a function]]
**** [[Attributes of a function]]
**** [[Parameter qualifiers]]
**** [[User Libraries]]
*** [[Procedural Programming]]
**** [[Procedural Programming Example]]
**** [[Summary of Programming Constructs]]
**** [[Begin-End for Grouping Expressions]]
**** [[Local Values]]
**** [[For and While Loops]]
**** [[Recursion]]
**** [[Local Indexes]]
**** [[Ensuring Array Abstraction]]
**** [[References and Data Structures]]
**** [[Handles to Objects]]
**** [[Dialog Functions]]
**** [[Other Procedural Functions]]
** [[Reference sections]]
*** [[Analytica Specifications]]
*** [[Identifiers Already Used]]
*** [[Error Message Types]]
*** [[Forward and Backward Compatibility]]
*** [[Bibliography]]
* [[Analytica Optimizer Guide|Analytica Optimizer]]
** [[Introduction to Optimizer]]
** [[Optimizer Quick Start]]
** [[Optimization Characteristics]]
** [[Optimizing with Arrays]]
** [[Optimizer key concepts: Airline Example]]
** [[Optimizer Attributes]]
** [[Primary Optimization Functions]]
** [[Optimization Status Functions]]
** [[Optimizer control settings]]
* [[ADE User Guide|Analytica Decision Engine]]
** [[Introduction to ADE]]
** [[Installation of ADE]]
** [[The ADE Tutorial]]
** [[Using the ADE Server]]
** [[Working with Models, Modules, and Files in ADE]]
** [[ADE Server Class Reference]]
* [[Analytica Cloud Platform|ACP]]
** [[What's new in ACP?]]
* User Community
** [https://lumina.com/community/ Analytica User Forum]
** [http://blog.lumina.com/blog Lumina Blog]
** [https://analytica.com/publications-using-analytica/ Publications using Analytica]

MediaWiki:Hierarchy

2026-03-18T00:32:19Z

Mhenrion: Moved the Tutorial (and its chapters) into the first thing under Getting started.

* Getting started
** [[Analytica_Tutorial|Tutorial]]
*** [[About Analytica]]
*** [[Tutorial: Open a model to browse|Opening A Model]]
*** [[Tutorial: Reviewing a model|Reviewing a model]]
*** [[Tutorial: Create a model|Create a Model]]
*** [[Tutorial: Arrays|Arrays]]
***[[Tutorial: Analyzing a model|Uncertainty]]
***[[Tutorial: Sharing a model with ACP| Sharing a model with ACP]]
***[[Tutorial: Decision trees|Decision tree]]
***[[Tutorial: Dynamic system model| Dynamic system model]]
***[[Example Models and Libraries]]
***[[Tutorial videos]]
** [[Excel and Analytica]]
** [[Edit and improve these docs]]
** [[Open these docs from Analytica]]
* Quick links
** [[Example Models]]
** [[Tutorial videos|Videos]]
** [[Keyboard Shortcuts]]
** [[Functions by category]]
** [[Alphabetical Function List]]
** [[Modelling Guide]]
** [[Standard libraries]]
** [[Additional libraries]]
** [[:Category:Concepts|Key concepts]]
** [[Techniques and technologies]]

* [[Analytica_User_Guide|User Guide]]
** [[Contents of User Guide|Contents in detail]]
** Basics
*** [[Introduction: About Analytica|Introduction]]
**** [[If you don’t read manuals]]
**** [[Hardware and software requirements]]
**** [[Installation and licenses]]
**** [[Editions of Analytica]]
*** [[Help menu and documentation]]
**** [[Normally, usually, and defaults]]
**** [[Typographic conventions in this guide]]
**** [[User guide Examples folder]]
**** [[New Releases|What’s new?]]
*** [[Menus]]
**** [[File menu]]
**** [[Edit menu]]
**** [[Object menu]]
**** [[Definition menu (more)|Definition menu]]
**** [[Result menu]]
**** [[Diagram menu]]
**** [[Window menu]]
**** [[Help menu]]
**** [[Right mouse button menus]]
*** [[Windows and dialogs]]
**** [[Object window]]
**** [[Result window]]
**** [[Diagram window]]
**** [[Outline window]]
**** [[Object Finder dialog]]
**** [[Diagram Style dialog]]
**** [[Node Style dialog]]
**** [[Number Format Dialog]]
**** [[Graph setup dialog]]
**** [[Uncertainty Setup dialog]]
**** [[Preferences dialog]]
**** [[Attributes dialog]]
*** [[Examining a Model]]
**** [[To open or exit a model]]
**** [[Diagram window]]
**** [[Classes of variables and other objects]]
**** [[Selecting nodes]]
**** [[Toolbar]]
**** [[User input nodes and user output nodes]]
**** [[Object window]]
**** [[Attribute panel]]
**** [[Values in Object Window]]
**** [[Printing]]
*** [[Result Tables and Graphs]]
**** [[Result window]]
**** [[Table view of a result]]
**** [[Graph view of a result]]
**** [[Uncertainty view of a result]]
**** [[Comparing results]]
*** [[Parametric analysis]]
*** [[Create and edit a model]]
**** [[Create and save a model]]
**** [[Create and edit nodes]]
**** [[Draw arrows]]
**** [[Draw arrows between modules]]
**** [[Alias nodes]]
**** [[To edit an attribute]]
**** [[Change class of an object]]
**** [[Preferences dialog]]
*** [[Building Effective Models]]
**** [[Create a model]]
**** [[Test and debug your model]]
**** [[Expand your model]]
*** [[Creating Lucid Influence Diagrams|Lucid influence diagrams]]
**** [[About influence diagrams]]
**** [[Guidelines for creating lucid models]]
**** [[Arranging nodes to make clear diagrams]]
**** [[Organizing a module hierarchy]]
**** [[Color in influence diagrams]]
**** [[Diagram Style dialog]]
**** [[Node Style dialog]]
**** [[Taking screenshots of diagrams|Screenshots of a diagram]]
*** [[Number and table formats]]
**** [[Number formats]]
**** [[Date formats]]
**** [[Display of constraint results|Display constraint results]]
**** [[Multiple formats in one table]]
***[[Graphs]]
**** [[Graphing roles]]
**** [[Graph setup dialog]]
**** [[Changing Series Colors]]
**** [[Graph templates]]
**** [[XY Comparison]]
** Definitions and expressions
*** [[Definitions]]
**** [[Creating or editing a definition]]
**** [[The Expression popup menu]]
**** [[Expression Assist]]
**** [[Object Finder dialog]]
**** [[Definition menu]]
**** [[The domain of possible values]]
**** [[Check attribute]]
*** [[Expressions]]
**** [[Numbers]]
**** [[Date and Time Values]]
**** [[Boolean or truth values]]
**** [[Text values]]
**** [[Operators]]
**** [[IF a THEN b ELSE c]]
**** [[Function calls and parameters]]
**** [[Math functions]]
**** [[Numbers and text]]
**** [[INF, NAN, and NULL - Exception values]]
**** [[Warnings]]
**** [[Datatype functions]]
*** [[Text, Date, Math, and Financial Functions]]
**** [[Text functions]]
**** [[Date functions]]
**** [[Advanced math functions]]
**** [[Complex number functions]]
**** [[Financial functions]]
**** [[Financial library functions]]
*** [[Dynamic Simulation]]
**** [[Time index]]
**** [[Dynamic function]]
**** [[Time index details]]
**** [[Dynamic initial values]]
**** [[Dynamic using arrays]]
**** [[Dynamic dependencies]]
**** [[Dynamic and uncertainty]]
**** [[Dynamic on non-Time Indexes]]
**** [[Reverse Dynamic]]
** Arrays and Indexes
*** [[Intelligent Arrays]]
*** [[Indexes and arrays: An introduction]]
*** [[Arrays and Indexes]]
**** [[IF a THEN b ELSE c with arrays]]
**** [[Creating an index]]
**** [[Functions that create indexes]]
**** [[To make an edit table]]
**** [[To edit a table]]
**** [[Splice a table when computed indexes change]]
**** [[Subscript and slice of a subarray]]
**** [[Choice menus and Checkboxes in an edit table]]
**** [[Shortcuts to navigate and edit a table]]
*** [[Array functions]]
**** [[Array Function Example Variables]]
**** [[Functions that create arrays]]
**** [[Array-reducing functions]]
**** [[Transforming functions]]
**** [[Relational tables and multiD arrays]]
**** [[Interpolation functions]]
**** [[Fourier Transform]]
**** [[Sets - collections of unique elements]]
**** [[Other array functions]]
**** [[DetermTable: Deterministic tables]]
**** [[Subtable: Editable part of an array]]
**** [[MultiTable: Combining editable and computed arrays]]
**** [[Matrix functions]]
** Uncertainty and statistics
*** [[Expressing Uncertainty]]
**** [[Uncertainty Setup dialog]]
**** [[Uncertainty views]]
**** [[Selecting the Sample Size]]
**** [[Choosing an appropriate distribution ]]
**** [[Defining a variable as a distribution]]
**** [[Including a distribution in a definition]]
**** [[Probabilistic calculation]]
**** [[Monte Carlo and probabilistic simulation]]
*** [[Probability distributions]]
**** [[Parametric discrete distributions]]
**** [[Probability density and mass graphs]]
**** [[The domain attribute and discrete variables]]
**** [[Custom discrete probabilities]]
**** [[Parametric continuous distributions]]
**** [[Custom continuous distributions]]
**** [[Special probabilistic functions]]
**** [[Advanced probability functions]]
**** [[Multivariate distributions]]
**** [[Importance weights]]
*** [[Statistics, Sensitivity, and Uncertainty Analysis]]
**** [[Statistical functions]]
**** [[Weighted statistics and w parameter]]
**** [[Importance analysis]]
**** [[Sensitivity analysis functions]]
**** [[Tornado charts]]
**** [[X-Y plots]]
**** [[Scatter plots]]
**** [[Regression analysis]]
**** [[Uncertainty in regression results]]
**** [[Logistic regression functions]]
**** [[Stochastic Information Packets (SIPs)]]
** [[User interfaces]]
*** [[Creating Interfaces for End Users|User interfaces]]
**** [[User Input nodes]]
**** [[Choice menu user input]]
**** [[Checkbox user input]]
**** [[User output nodes]]
**** [[User inputs and outputs as aliases]]
**** [[Onchange attribute]]
**** [[Button creation]]
**** [[Form modules]]
**** [[Icon images in a node]]
**** [[Graphics, frames, and text in a diagram]]
**** [[Links or URL in model attributes]]
**** [[Analytica Free Edition]]
*** [[Analytica Cloud Player (ACP)]]
** Advanced features
*** [[Integration with data and applications]]
**** [[Read and write text files]]
**** [[Read data from URL on internet]]
**** [[Copy and Paste between applications]]
**** [[Import and Export data]]
**** [[Model file formats]]
**** [[OLE linking]]
**** [[Database access]]
**** [[Database functions]]
**** [[Excel spreadsheets read and write]]
**** [[RunConsoleProcess - call other applications]]
**** [[COM Automation Objects]]
*** [[Working with Large Models]]
**** [[Module hierarchy]]
**** [[Outline window]]
**** [[Find variables and other objects]]
**** [[Manage attributes]]
**** [[Invalid variables]]
**** [[Filed modules and libraries]]
**** [[Import a module or library]]
**** [[Combining models into an integrated model]]
**** [[Making a browse-only model and hiding definitions]]
**** [[Managing windows]]
**** [[Memory usage and management]]
**** [[Performance Profiler library]]
**** [[Analytica Enterprise]]
*** [[User-defined Functions and Libraries]]
**** [[Example function]]
**** [[Call a function]]
**** [[Define a function]]
**** [[Attributes of a function]]
**** [[Parameter qualifiers]]
**** [[User Libraries]]
*** [[Procedural Programming]]
**** [[Procedural Programming Example]]
**** [[Summary of Programming Constructs]]
**** [[Begin-End for Grouping Expressions]]
**** [[Local Values]]
**** [[For and While Loops]]
**** [[Recursion]]
**** [[Local Indexes]]
**** [[Ensuring Array Abstraction]]
**** [[References and Data Structures]]
**** [[Handles to Objects]]
**** [[Dialog Functions]]
**** [[Other Procedural Functions]]
** [[Reference sections]]
*** [[Analytica Specifications]]
*** [[Identifiers Already Used]]
*** [[Error Message Types]]
*** [[Forward and Backward Compatibility]]
*** [[Bibliography]]
* [[Analytica Optimizer Guide|Analytica Optimizer]]
** [[Introduction to Optimizer]]
** [[Optimizer Quick Start]]
** [[Optimization Characteristics]]
** [[Optimizing with Arrays]]
** [[Optimizer key concepts: Airline Example]]
** [[Optimizer Attributes]]
** [[Primary Optimization Functions]]
** [[Optimization Status Functions]]
** [[Optimizer control settings]]
* [[ADE User Guide|Analytica Decision Engine]]
** [[Introduction to ADE]]
** [[Installation of ADE]]
** [[The ADE Tutorial]]
** [[Using the ADE Server]]
** [[Working with Models, Modules, and Files in ADE]]
** [[ADE Server Class Reference]]
* [[Analytica Cloud Platform|ACP]]
** [[What's new in ACP?]]
* User Community
** [https://lumina.com/community/ Analytica User Forum]
** [http://blog.lumina.com/blog Lumina Blog]
** [https://analytica.com/publications-using-analytica/ Publications using Analytica]

Document style guide

2026-03-17T17:21:29Z

Mhenrion: /* Table of Contents */

[[Category: Documentation guidelines]]

This style guide is designed to help us write language that is clear and easy to read. It applies to all Analytica and Lumina written material, including Analytica docs, including [[Analytica Tutorial]], [[User Guide]]s, emails, proposals, reports, and even error messages.

Many of these guidelines are fairly standard for technical writers and editors. We've borrowed and adapted liberally from standard style manuals. The main goal is to make the language easy to read by avoiding unecessary words and convoluted grammar. Some guidelines, especially for terminology, is specific to Analytica docs.

Feel free to edit any wiki pages to make them follow this guide more closely.

For style guidelines for Analytica models see [[Analytica model style guide]].

== Language ==

=== Use imperative, active voice, and present tense ===

Use the '''imperative''' -- directly telling the reader what to do -- when suggesting or explaining what to do (as we do here), because it concise and direct -- for example:
* Select '''Graph setup''' from the '''Result''' menu
* '''''Not:''''' The user should select select '''Graph setup''' from the '''Result''' menu.
* '''''And Definitely not:''''' The '''Graph setup''' should be selected from the '''Result''' menu.

Imperative is especially useful for a series of steps for you (the "user") to perform. Number the steps only when you must perform them in that sequence:
#Select '''Graph setup...''' from the '''Result''' menu
#Check '''Stacked''' option
#Click '''OK'''

The imperative is technically a form of "active voice", where "you" (the reader or software user) is the implied subject. Sometimes it is helpful to make the subject -- i.e."you" explicit -- for example:
* You should avoid the passive voice.
* '''Not:''' The passive voice should always be avoided
* When you press ''ctrl+F'', it opens the '''Find''' dialog.
* '''Not:''' When the user presses ''ctrl+F'', the '''Find''' dialog is displayed.

Use '''present not future''' tense for what Analytica does:
* Press ''ctrl+F'' and it opens the '''Find''' dialog.
* '''Not''': When you press ''ctrl+F'', it ''will'' display the '''Find''' dialog.
* '''Better''': Press ''ctrl+F'' to open the '''Find''' dialog.

=== You, we, it, and Analytica ===

As you saw above, we use "you" to refer to the reader or software user, and "we" or "us" to refer to the writer or Lumina:
* You can use Function F to ...,
* '''''Not:''''' Function F can be utilized to ...
* We invite you to email us your comments
* '''''Not:''''' The reader is invited to email Lumina their comments.

If the recipient would otherwise be ambiguous, write for example:
* Email Lumina your comments.

When the subject isn't "you", it's often "Analytica". Since this documentation is about Analytica, it's fine to refer to Analytica as "it" (she doesn't mind):
* When you click the button, it shows the dialog box.
* '''''Not:''''' When the user clicks the button, Analytica will display the dialog box.
* '''''Definitely not:''''' When the button is clicked, the dialog box is displayed.

It's occasionally useful to mention "Analytica" explicitly to emphasize a special Analytica way of doing things to contrast it to other languages and software:
* Analytica uses name-based subscripting, instead of position-based subscripting, which is standard in most computer languages.

=== It's, don't and common contractions ===

It's fine to use common contractions like "it's", "don't", "isn't" and so on. They're a bit faster to read, and convey informality, which is good. We want to avoid academic, government, or corporate-speak.

=== Click, Press, Select ===

* You '''''click''''' a button or link (not ''click on'').
*You '''''press''''' a menu to see the menu options (the action is to click and hold)
*You '''''select''''' a menu option.
*You also '''''select''''' a node or text from a text field.
*You '''''press''''' (not ''hit ''or ''depress'') a key or key combination on the keyboard.

* Label web links so that users get a reasonable idea of what they will find on the linked page.

* You never need to write "click this link" or "click here". People know about clicking links! The browser normally shows hyperlinked text in blue and/or underlined to show that it's clickable.

===Common words and concepts===

Use short words instead of longer synonyms:
* "use" is better than "utilize"
* "let" is better than "allow ... to".
* Use long dash (m-dash) or double-dash around examples or interjections (rather than parentheses) -- for example "Use a reducing function -- e.g. Sum or Min -- rather than a transforming function."

===Also additionally, moreover,and more===

Inexperienced writers often use words like "Also", "Additionally", or "Moreover" to start sentences to indicate some link to the preceding sentences. These words are almost always unnecessary and should be deleted. The fact that two sentences come one after the another already implies "Additionally".

== Analytica terminology ==

* Capitalize terms used with a special meaning in Analytica -- such as, Variable, Object, Attribute, or Diagram -- to distinguish them from their common meaning, which is often subtly different.
* There's no need to capitalize standard computer terms -- like, window, menu, button, mouse, keyboard -- or standard mathematical terms -- like, variable, function, parameter, array -- except when they're being used with a special Analytica take on the meaning, as for example, ''Variable''.

* Don't use '''''node''''' to mean a ''Variable'' or ''Object''. A '''''node''''' is the visual representation in a Diagram of a ''Variable ''or other Class of ''Object''. An ''Object" can have multiple nodes -- e.g., the original node and aliases, including input and output nodes. A Variable is just one Class of Object. For views or operations that apply to all classes of Object, use ''Object'' rather than ''Variable''. But, do use '''''node''''' when you are actually referring to a node in a Diagram that you select, create, find, drag, or deletee (including a input or output node).

* Use '''''Edition''''' of Analytica to mean Player, Professional, {{Developer}}, ADE, ACP, and so on.
* Use '''''Release''''' as in Release 5.3.
* Avoid '''''version''''' because it can mean either ''Edition'' or ''Release''.

*'''ADE''' and '''ACP''' are '''''Editions''''' of Analytica, just like Professional and {{Developer}}. So we don't need to say "Analytica and ADE" or "Analytica and ACP" as we have done often in the past. '''''Optimizer''''' is also an Edition, not an extension or option.

* Use "parameter" ''not '' "argument" for the things listed in parentheses in a call to a function (the ''actual'' parameters), or in the '''Parameters''' attribute of a function (the ''formal'' parameters).

== Lists ==

*Use a '''''bulleted list''''', like this, wherever appropriate.

*Use a '''''numbered or lettered list''''' only where the items are intrinsically ordered -- e.g. a series of steps that won't work in a different order:

#Do this
#Next, do this
#Finish up by doing this

There's no need to introduce a list by saying "the following". A simple colon followed by a list makes it clear without the extra words:
* These are options for parameter X: (note the colon)
* '''''Not:''''' The following are options for parameter X.

* If each item is a single phrase, there's no need for a period or comma at the end. But, do use a period if there are multiple sentences, as in this list.

* Order items in a list (or sections in a chapter, or parameters of a function when designing a function) from the easiest or most commonly used to the more complicated and esoteric. That way, readers scanning down the list will:
** find what they want sooner on average,
** read the easy stuff first, preparing them to understand the harder stuff that comes later, only if they need to.
* Alphabetic ordering is usually pointless online: If you already know the name of the function (or whatever), which you would need for alphabetic search, you can use '''Find''' ctrl+F.

* Avoid making lists with more than about 5 items at the same level. If you have a lot more items, group related items into sublists as a hierarchy. That makes it easier to scan down a list to find what you want.

==Media wiki conventions==
===Page titles and wiki links===

In Analytica Docs), use Sentence case for page titles. The first word starts with a capital letter. Don't capitalize the other words unless they are proper nouns (such as Analytica):
* '''Document style guide'''
* Not:''' Document Style Guide'''
This is important because Mediawiki (the platform for these Analytica docs) is case-sensitive for internal links.

Use singular nouns, not plural:
* User-defined attribute
* '''Not:''' User-defined Attributes

You can add plurals for internal links by added "s" or other letters after an internal link:
:<code><nowiki>[[User-defined attribute]]s</nowiki> are suitable for creating attributes that do not exist. To create a new [[user-defined attribute]], proceed as follows.</code>
There's no need to rename all existing pages, but please use the suggested style for new pages or when merging multiple pages of similar content.

To make wiki markup easier to read and edit, use the standard wiki links to other wiki pages, like:
<code><nowiki>[[User-defined attribute]]</nowiki></code>
'''Never use''' full urls in internal links, like:
<code><nowiki>[http://docs.analytica.com/index.php?title=User-defined attribute|User-defined attribute]</nowiki></code>

=== Titles of Analytica components, such as names of windows, functions etc ===

Use the same name and capitalization used in the software so that the users will not be confused by different terms.

=== Table of Contents ===

Analytica docs automatically generates a Table of Contents for each page in a panel on the right.
You can ignore the standard Mediawiki Table of contents code <code><nowiki>__TOC__</nowiki></code> .

===Tables===
Use wikitable format to create a table:
Precede it by a colon (<code>:</code>)) to indent the table:

<pre style="background:white; border:white">
:{| class=wikitable
!
! Column 1
! Column 2
|-
! Row 1
| Cell 11
| Cell 12
|-
! Row 2
| Cell 21
| Cell 22
|}
</pre>

The code above yields this table:

:{| class=wikitable
!
! Column 1
! Column 2
|-
! Row 1
| Cell 11
| Cell 12
|-
! Row 2
| Cell 21
| Cell 22
|}

See [[Guide to Converting Documents to MediaWiki]] for more.

==Images==
Use the wiki Upload file functionality to upload image files.

Indent images by one tab (precede by one colon (<code>:</code>)), as in:

<pre style="background:white; border:white">
:[[image:ImageFile.png]]
</pre>

The wiki syntax for images with centered captions on white background is as follows.

One image:
<pre style="background:white; border:white">
:{|border=0
|bgcolor=white|[[image:ImageFile.png|frame|<center>Image caption.</center>]]
|}
</pre>

Two images side-by-side:

<pre style="background:white; border:white">
:{| border="0"
|bgcolor=white|[[image:ImageFileOne.png|frame|<center>Image caption one</center>]]
|bgcolor=white|[[image:ImageFileTwo.png|frame|<center>Image caption two</center>]]
|}
</pre>

or
<pre style="background:white; border:white">
:{|
|bgcolor=white|[[File:ImageFileOne.png|thumb|500px|<center>Image caption one</center>]]
|bgcolor=white|[[File:ImageFileTwo.png|thumb|500px|<center>Image caption two</center>]]
|}
</pre>

For sample images created this way, see [[Kernel Density Smoothing]] and [[Node Alignment, Sizing, and Spacing]].

==Formulas==
Indent mathematical formulas by one tab (precede by one colon (<code>:</code>)) and surround by <code><nowiki><math></nowiki></code> tags, e.g.

<pre style="background:white; border:white;">
:<math>
E=mc^2
</math>
</pre>

which results in
:<math>
E=mc^2
</math>

For help with mathematical formulas, see the [http://en.wikipedia.org/wiki/Help:Displaying_a_formula Wikipedia help page].

== Other typographic conventions ==

:{| cellpadding="2" class="wikitable"
|-
! width="200pt" | Type of Text
! width="300pt" | Typography
! width="100pt" | Example
! width="300pt" | Wiki Code
|-
| Special Analytica term
| Capitalize and link when used with special Analytica meaning, but not when used in its normal sense.
| [[Intelligent Arrays]], [[Attributes]]
| <nowiki>[[Intelligent Arrays]]</nowiki>
|-
| Window title, menus, menu item, dialog box title, panel title, and button label
| '''Bold'''
| '''File''', '''Attribute Panel'''
| <nowiki>'''File'''</nowiki>
|-
| Analytica global object identifier or title, including variable or module
| '''Bold'''
| for example variable '''X''', '''X'''
| <nowiki>'''X'''</nowiki>
|-
| Label of a user input such as a checkbox
| ''Italics''
| ''Edit Attributes'' setting for the '''Preferences''' dialog
| <nowiki>''Edit Attributes''</nowiki>
|-
| Key on a keyboard
| ''Italics''
| "Press ''Enter''"; ''control+e''
| <nowiki>Press ''Enter''</nowiki>
|-
| Function name
| Linked (which bolds functions when on their own page) with trailing parens, "()". No links needed when embedded in code.
| [[Sequence]]()
| <nowiki>[[Sequence]]()</nowiki>
|-
| Formal parameter name -- i.e. the declared name of a function parameter distinct from the actual parameter, which is the value or expression passed in a call to a function
| Use lowercase or "camelCase"; surround by by double angled brackets «a», except when inside formal parameter declaration (within parens after function name). Italicize optional parameters when inside parentheses. Code (courier) font so <code>I</code> appears distinct from the number 1.
| <code>[[Sort]](a, I, ''keyIndex'' ); «a», «I», «keyIndex»</code>
| <nowiki>«a»</nowiki>''How does one find these characters?''

- Install English (United States) International keyboard

- for « use AltGr (Right-Alt) + [

- for » use AltGr (Right-Alt) + ]
|-
| parameter qualifier
| Capitalize to distinguish from formal parameter names
| Bool, Text, Number
| <nowiki>Bool</nowiki>
|-
| Code and script examples, expressions and variable definitions
| <code>Fixed width font, indented rows</code>
| <tt>MDTable(T,Rows,Cols,[Car_type,Mpg],'average','n/a')</tt>
| This can be done by

1) using colons (for indentation) and code tags:

<nowiki>:<code>MDTable(T, Rows, Cols, [Car_type, Mpg], 'average', 'n/a')</code></nowiki>

2) using colons and <nowiki><tt></nowiki> tags:

<nowiki>:</nowiki><nowiki><tt>MDTable(T, Rows, Cols, [Car_type, Mpg], 'average', 'n/a')</tt></nowiki>

3) putting a space at the beginning of the line (the code will be displayed in a gray box):

<nowiki> </nowiki>MDTable(T, Rows, Cols, [Car_type, Mpg], 'average', 'n/a')

4) surrounding the code by <nowiki><pre> tags (preferred method with multi-line code):</nowiki>

<nowiki><pre style="background:white; border:white; margin-left: 1em;"></nowiki>

MDTable(T, Rows, Cols, [Car_type, Mpg], 'average', 'n/a')

</pre>
|-
|Error message examples
|''<code>Fixed width font in italics, indented rows </code>''
|''<code>You cannot evaluate a call to RunConsoleProcess directly from an input variable.</code>''
|This can be done by

1) using colons (:) in front of every row for indentation and <nowiki><code> tags around every row:</nowiki><nowiki>:<code>''</nowiki>You cannot evaluate a call to RunConsoleProcess directly from an input variable.<nowiki>''</nowiki><nowiki></code></nowiki>

2) using <nowiki><pre>tags around text (preferred method with multi-line error messages):</nowiki>

<nowiki><pre style="background:white; border:white; margin-left: 1em; font-style:italic"></nowiki>

You cannot evaluate a call to RunConsoleProcess directly from an input variable.

</pre>
|-
| Document name
| ''Italics and Capitalized''
| ''User Guide''
| <nowiki>''User Guide''</nowiki>
|}

== Conventions for explaining functions and their parameters ==

The heading for the section of documentation on a function should contain the name of function and the most common parameters, without qualifiers. Don't include optional parameters unless they are usually used.

* Function definition sections should use a Heading2 paragraph tag for the function title for the section.

In some cases, we include several related functions in one section. We should then include them all in the same heading, e.g.

=== PDF(x) and CDF(x) ===

Conventions: Use the recommended name for each qualifier rather than its deprecated synonyms. Omit "Atom" which is of more interest to the implementer than the user of a function.

Use these conventions for naming parameters that don't have otherwise meaningful names, to indicate what type is expected:

*x, y, z: Numbers that may be scalar or array-valued.
*I, J, K: Identifiers of Index variables
*t, t1, t2: Text values (numbers will be coerced to text)
*a, b, c: An expression that may evaluate to anything: Scalar or array, number or text, NAN, or reference.
*p, q: A probability, a number between 0 and 1.
*r: A reference
*v: Identifier of variable.
*expr: An expression, which is not evaluated before calling function
*obj or o: A handle to an an Object (of any Class)
*attrib: The identifier of an Attribute

Most named parameters in the User Guide that are not meaningful (unlike mean, min, mode) already follow these conventions. If any do not, we should consider changing them so they do.

*Provide a page explaining these conventions, linked to from every function description.

Each function description should have these sections (where appropriate):

*Title of section (usually 3= level) includes name of function and most common parameters.
*Brief description of at least one simple case use.
*Example(s)
*Requirements: Expectations or constraints on parameters.
*If there are many parameters, list them as a bulleted list, explaining each one
*More complex examples
*Syntax: Near bottom using (slightly cleaned) declaration syntax.

In this wiki, each section describing a function should contain a complete spec of its parameters, usually near the end of the section, with a format like this:<br> [[Parameter types]]: MakeDate(year: Coerce Atomic Positive; month, day: Optional Coerce Atomic Positive)<br>Note that the subhead [[Parameter types]] is a link to a page that explains the meaning of the parameter types and qualifiers.

=== Guidelines for Analytica Docs ===
==== Organizing documents with multiple pages ====

* Organize the pages into a set of "documents", such as [[Analytica Tutorial|Tutorial]], [[Analytica User Guide|User Guide]], [[Analytica Optimizer Guide|Optimizer Guide]], [[ADE User Guide]], Analytica Reference Guide, Analytica FAQs, Analytica libraries.

* Organize each document or section as a tree hierarchy -- i.e., where each page has a single parent -- although there may, of course, be many cross-references. A tree makes it easier for you to understand the organization, and go through all pages at a given level. It also makes it easier to generate a sequential PDF or printed document if we need to.

* Show ancestor list (a.k.a. "bread crumbs") at the top of each page -- i.e. a list of links to parent, grandparent etc. For example, page [[SolverInfo]] should show
[[Analytica Reference Guide]] > [[Enhancements to Optimizer in Analytica 4.0]]
This helps you see where you are and lets you quickly move up one or more levels.

==== Organizing a page ====

* Keep page names as short as reasonable.

* Show ancestor list (see above)

* Common subheads:
** Examples
** Syntax
** Tips
** See also
** History: Summarizes when a new feature was introduced or modified. Move all old links like "New in Release 5.1" when we're up to Release 5.3 to the History section (or just delete them).

** Enhancement requests
** Documentation requests

====Categories====

The category indexes are a big benefit of MediaWiki. You can specify one or more Categories for each page. The page then automatically appears in the corresponding Category page. For example, for a page on [[MdArrayToTable]] contains the code
[[:Category:Array Flattening Functions]]
No matter where you locate this code, it shows this at the bottom of the page:
[[:Category: Array Flattening Functions]]
And it inserts [[MdArrayToTable]] in the page [[:Category:Array Flattening Functions]]
This makes it easy for readers to find all the array-flattening functions.

You can list multiple categories:
[[:Category: Array Flattening Functions]], [[:Category: Array Functions]], [[:Category: Table functions]]

If you want to categorize two or more items with different categories, on the same page, create a redirect page for each item with the item's name. Include a category markup in the redirect page. This might look like this:
<pre>
[[Category:Database Functions]]
#REDIRECT [[Functions To Read Excel Worksheets#SpreadsheetCell]]
</pre>

Put the category tag(s) before the redirect or it won't work right. When linking to an item that lives on a page with other items, link to the redirect page, i.e., use <pre>[[SpreadsheetCell]]</pre>, not <pre>[[Functions To Read Excel Worksheets#SpreadsheetCell]]</pre>.

If the heading within the page you redirect to has extra stuff in the heading, for example:
<pre>===SpreadsheetCell(wb, sheet, col, row)===</pre>
Make a simple anchor tag using a div tag such as
<pre>===<div id="SpreadsheetCell">SpreadsheetCell(wb, sheet, col, row)</div>===</pre>
This way you can use just "#SpreadsheetCell" in the redirect URL.

==History==

* Many features have links from and to a "What's new" page for the release in which they were first introduced or modified, e.g. [[What's new in Analytica 5.0?]].
* Ideally, links to a "What's new" page should only exist for the most recent release -- e.g. [[What's new in Analytica 5.4?]]. Ancient history is of little interest to 99% of readers.
* So, when working on a page, please move information about when a feature was introduced or modified for older releases to the '''History''' section at the end of each page.

==See Also==
Every page should have a '''See Also''' section, with links to pages on related topics that someone reading this page may find useful. In this case:

* [[Analytica model style guide]] for Analytica code and model documentation
* [[Guide to Converting Documents to MediaWiki]]
* [[Ana:Pages needing work]]

AcpStyles

2026-02-24T20:59:18Z

Mhenrion: /* ACP styles inheritance */

[[Category: Analytica Cloud Platform]]
[[Category: Attributes]]
[[Analytica_Cloud_Player|<<Analytica Cloud Platform ]]

::{{ReleaseBar}}

ACP offers a wide variety of styles and options to control the look and functioning of the user interface. Many of these go beyond what is (currently) available in Desktop Analytica (DTA).

The easiest way to set these styles and options is to use the [[ACP Style Library]], which you can load into your model within ACP from the hamburger menu. As you change styles in ACP, you can see their effects immediately.

If you use [[ACP Style Library]] you don't need to learn about the ACP Styles described below. The only reason to read the rest of this page is if you want to do something esoteric with AcpStyles, or use one of the few AcpStyles not accessible in the [[ACP_Style_Library]].

You can also load the [[ACP Style Library]] in Analytica on the desktop from the '''Add Library...' option from the '''File''' menu. But, you won't be able to see the effects until you upload the model into ACP.

The styles and options are specified as keywords and tags in the AcpStyles attribute. Most styles and options apply to the whole Model and are specified in the AcpStyles attribute of the Model. When you want to specify special styles for individual modules or variables, you apply them to the ACPStyles attribute of the relevant object.

The easiest way to view and edit the AcpStyles attribute in Desktop Analytica is to use the [[Attribute panel]]. Select AcpStyles from the list of Attributes at the top of that panel. By default, AcpStyles is not shown in the [[Object window]], so you first need to set it to be shown either with the [[Object_Window|right click menu]] in the Object window, or in the [[Manage attributes|Attributes dialog]].

The AcpStyles and their flags are not case sensitive.

When you put multiple flags in a AcpStyles attribute, put each flag on a separate line.

== Model level styles ==

These styles apply to the entire model. You set them in the AcpStyles attribute for the Main Model. (They have no effect when set for a submodule.)

=== Navigation style ===

These Navigation_style options control how a user can view and access the module hierarchy:
* '''<code>Navigation_style: Outline</code>''' -- Show an expandable tree of modules on the left of the ACP window, similar to the outline view in desktop Analytica (showing only modules not other objects). This is the default style when you upload a model with no ACP styles set or no Acp styles library embedded, or if you have not yet set the Navigation style in the Acp styles library. A navigation flag is not needed for this style, but if you want to explicitly set this style you can add '''<code>Navigation_style: Outline</code>''' to the top diagram's AcpStyles attribute.

*'''<code>Navigation_style: Top diagram only</code>''' -- Show only the top diagram, with no Outline and no tabs. This lets you make a simple web application with a single UI page.
<br />

For the next two 'Tabbed application' styles, each module in the main model becomes a tab. The order of the tabs follows the sequence of the module nodes in the main diagram, from left to right then top to bottom.

* '''<code>Navigation_style: Top_tabs</code>''' -- The main modules in the top model appear as a row of tabs across the top of the window. Click a tab to show the diagram for that module.

*'''<code>Navigation_style: Side_tabs</code>''' -- The main modules in the top model appear as a column of tabs on the left of the window. Click a tab to show the diagram for that module.


We describe each in more detail below.

===Outline Tree===

By default, when using the Outline Navigation style, ACP shows an expandable outline tree of modules on the left hand side of the window, similar to the Outline view in Analytica on the desktop. This makes it easy to navigate a model with an extensive hierarchy of modules.

*'''<code>Show_outline: yes</code>''' -- The default, and unecessary for Outline Navigation style. It is generally redundant with other Navigation styles since the tabs or hierarchy show the same information, and the Outline takes up screen space. But you can add it to the top diagram's AcpStyles attribute if you want to show the Outline tree with other Navigation styles.

{{CalloutAnnotationBlock|[[File:Outline tree 6.0 01.png]]|{{CalloutAnnotation|Market model with<br>Outline Tree|v=80|pt=10,106}}}}
*'''<code>show_outline: no</code>''' -- When using the Acp Style library this is set by default for Navigation styles other than Outline. For small models, and most web apps, you may want to suppress the Outline view even when using the Outline Navigation style. Do this by inserting this text into the top diagram's AcpStyles attribute (See image below). (If a model has only one diagram, i.e. with no modules, it never shows the outline tree.)<br/>
{{CalloutAnnotationBlock|[[File:Outline tree 6.0 02.png]]|{{CalloutAnnotation|Market model with <br/>'''<code>show_outline: no</code>'''|v=80}}}}

===Top Diagram Only===

Set by adding '''<code>navigation_style: top_diagram_only</code>''' to the AcpStyles attribute of the top diagram.  The Styles library will set the flag  '''<code>show_outline:no</code>''' .

===Tabbed Module Navigation===

As an alternative to the Outline view, you can set the '''<code>Navigation_style</code>''' to use use a tabbed interface which is often more convenient and familiar for web applications. By default, the main model appears as the first tab. You can change this with the style [[AcpStyles_Attribute_Values#Exclude_the_top_level_diagram_from_tabs|show_as_tab:no]] described below.


There are two tabbed styles, Top_tabs, with a row of tabs across the top; and Side_tabs with a column of tabs down the side. Top_tabs works well if you have up to 5 to 8 modules in the main diagram (tabs), depending on the length of their titles and the width of the ACP window. If you have a lot of modules, or they have long titles, it may be better to use Side_tabs.

'Top tabs or side tabs.' The first tab displays the top level diagram, and the remaining tabs display the modules present on the top level diagram of the model. (The modules will not display on the diagram, so you need to tweak your diagram for playing in ACP so that it looks right without these present).

* '''<code>navigation_style: top_tabs</code>''' -- This setting instructs ACP to use the 'Tabs across top' navigation style.

[[File:Top tabs 6.0 01.png]]

* '''<code>navigation_style: side_tabs</code>''' -- This setting instructs ACP to use the 'Side tabs' navigation style. Side tabs work better than top tabs when there are more module nodes present.

[[File:Side tabs 6.0 01.png]]

=== Toolbar Tabs ===
*'''<code>show_tabs: no</code>''' -- By default, with the Outline Navigation style. ACP shows navigation tabs for "Diagram", "Object", "Table", "Graph" along the top. Use this flag to hide those tabs. If you display the model inputs and outputs on the diagram -- using embedded tables and graphs on the diagram -- your users may not need those tabs. (You can also use '''<code>show_tabs: yes</code>''' to explicitly show the tabs in Outline and Top diagram only Navigation styles.)
{{CalloutAnnotationBlock|[[File:Show tabs no 6.0 0.1.png]]|{{CalloutAnnotation|Market model with <br/>'''<code>show_tabs: no</code>'''|v=80|pt=232,37|path=t!-}}}}
<br/>

===Module hierarchy bar ===
Using tabbed navigation, ACP shows the model hierarchy in a bar at the top of the diagram by default. The model hierarchy header shows you where you are in a large model by listing the titles of the ancestor modules in which the current diagram is nested. You can click any ancestor to click up levels in the hierarchy. The Hierarchy Bar takes up much less screen real estate than the Outline Tree. ACP doesn't show the hierarchy bar when you are viewing a top level module, or if the module title is already in the selected tab. 

Note that this setting is not based on a AcpStyles attribute, but rather on the ''Show module hierarchy'' check box in the model [[Preferences]] in Analytica. If you want to set this preference manually, with the model opened in Analytica, on the [[Edit menu]], select '''Preference...''', and check (or uncheck) the ''Show module hierarchy'' checkbox.

If you are using the ACP styles library, the Styles library will set this to the default setting automatically once you select a Navigation style. But you have the option of changing it if, for instance you want to show the Outline and the Hierarchy bar.


===Auto zoom ===
*'''<code>auto_zoom_diagrams: yes</code>''' -- ACP automatically zooms the UI to fit the browser window -- the most constraining of width or height so it retains the aspect ratio of the diagram. Works with zoom in and zoom out. Auto Zoom will allow a model to go down to 50% of its size or up to 200% of its size. If the model does not fit at 50% size, the window will show scroll bars. This Acp style has no effect if '''<code>Use_top_diagram_size:Yes </code>''' is present, you can use only one or the other. You can also set '''<code>auto_zoom_diagrams: no</code>''' which is the default. (This is a model level setting and is added to the top diagram of a model).

===Customize zoom levels===
AcpStyles for controlling the max/min zoom when '''<code>auto_zoom_diagram: yes</code>''' is set. The default if these styles are not set is as above - 50% and 200%. The easiest way to set these is with the [[ACP_Style_Library]] - where the controls are in the Esoteric ACP styles module. This is available from the Hamburger menu in ACP. Note that in order to see this effect, the '''<code>Browser window size</code>''' needs to have the screen size pulldown menu set to '''<code>Auto zoom</code>''' as well.
*'''<code>zoom_min_percent: 75</code>''' (means that the minimum zoom level will be 75% or .75)
*'''<code>zoom_max_percent: 125</code>''' (means the that max zoom level will be 125% or 1.25)

===Use top diagram size for all ACP windows===
*'''<code>Use_top_diagram_size:Yes </code>''' -- Sets the size of all diagrams based on the size of the diagram window of the top level when the model was last viewed in Desktop Analytica (in non-maximized mode). '''<code>Use_top_diagram_size:No </code>''' is the same as if the flag is not set, and is the default - the ACP diagram will use the entire browser window.


===Show or hide the Dashboard Title and Model title===
*'''<code>show_model_title: no</code>''' -- Hide the title of the model, which appears by default in the top Teal bar.

*'''<code>show_diagram_title: yes</code>''' -- Use to show the dashboard title at the top of the diagram. Or <code>show_diagram_title: no</code> to suppress the diagram title, but not really necessary because ACP does not show the diagram title by default.


===Exclude diagram(s) from tabs===

When using tabbed navigation, you can select those modules (from the top model diagram) that you want to appear as a tab in ACP. The default is for all to appear as tabs. You should use the ''Show modules as tabs'' choice menu in the '''<code>ACP Navigation styles</code>''' section of the [[ACP Style Library]] if you want to set this flag,, and if you also want to hide the modules corresponding to these tabs [[ChangeNodeVisibility|hidden]], so that the model viewer cannot see them.

*Optionally, Enter the text '''<code>Show_as_tab: no</code>''' in the AcpStyles attribute of the modules you don't wish to show as a tab. The modules themselves will not be hidden with this setting, only the tabs.

===Tab color===

When using Tabbed Navigation, you can use these flags to control how the color of the tabs display on your model in ACP. To use, add one of them to the AcpStyles attribute of the top level diagram of your model. They have no effect if added to a module other than the top diagram.

*'''<code>Tab_color: Default </code>''' The default. Non-selected tabs are bluish white. The selected tab uses the background color for that diagram.
*'''<code>Tab_color: Background </code>''' All tabs use their diagram background color, whether selected or not
*'''<code>Tab_color: Node </code>''' The selected Tab uses its diagram background color; The other tabs use the color of their Module node (not their diagram background color). You can use this to change the color of the tabs by modifying their node color in an Analytica functions.

== Model level styles for diagram nodes. ==

These model-level styles affect how all nodes are displayed in diagrams.

=== Node shadows and bevels ===

By default ACP displays nodes without shadows or bevels (for now) , so they look like this:
:[[Image:Nodes no shadow or bevel.png]]

Set this flag to show a drop shadow behind each node, giving a kind of 3D effect:

*'''<code>node_drop_shadow: yes</code>'''

:[[Image:Nodes drop shadow.png]]

Set this flag to display a bevel border for each node, giving another kind of 3-D effect:
*'''<code>bevel_node_border: yes</code>'''

:[[Image:Nodes beveled border.png]]

===Node hover highlighting===

By default, ACP displays a highlight -- a contrasting light rectangle behind a node -- when you move the cursor over the node:

[[File:acp hover hl.png]]

You can switch it off by setting:
*'''<code>show_hover_highlight: No</code>'''

=== Balloon Help ===

When you move the cursor over a node, ACP usually shows a "balloon" popup next to the node with the description of the node (if it has one) to help end users understand what its for, or what to enter for a user input. If the node has no description, the [[help balloons|balloon help]] will not appear.

*'''<code>show_id_in_balloon: yes</code>''' Use this flag to show each node's identifier below its title in the balloon -- unless the identifier and title are identical (except for spaces which are replaced by underscores). This flag goes in the AcpStyles of the model and apply to all nodes in the model.



*'''<code>show_hover_balloon: no</code>'''
::Insert this flag in the AcpStyles for a node, to suppress display of its balloon.


==ACP styles inheritance==
This is the order of inheritance for Acpstyles below that apply to tables and graphs. Styles at a higher level take precedence over the lower precedence styles. (Inheritance doesn't apply to the ACPstyles described above tbecause they work only at the Model level.)
# '''Variable''' (includes Tall nodes): Acpstyles applied to an individual variable will take precedence over all other styles. A variable with a style of <code>show_title:no</code> will not show the title, even if the model level style is <code>show_title:yes</code>, and if that node shows it's result in a frame node the variable style will override the frame node style.
# '''Frame''' : An Acpstyle set for a frame node will affect any variable shown in that frame that doesn't have its own settings. These will also override any styles at the model level.
# '''Model ACP style defaults''': Acpstyles that you can enter into the Acptyles attribute of the top diagram of your model. These will override the ACP defaults, and will be inherited by frame nodes and variables in the model that don't have their own Acpstyle.
# '''ACP style defaults for ACP''': The default style ACP uses if you have no specific setting for that style. Eg for show_index_menus the default is fly-in and that is what will show if you don't enter a different show_index_menus: Acpstyle flag in the Acpstyle for the top diagram (model level) or for frame nodes or variables.

==ACP Styles for tables and graphs==

These styles affect how result graphs and tables are displayed in ACP, including in [[Embed_table_or_graph_with_ACP#Frame_nodes|Tall nodes]] and [[Embed_table_or_graph_with_ACP#Tall_nodes|˞Frame nodes]]. They provide options not (yet) available in Desktop Analytica. ACP has default settings for these. You can override these settings for the entire model. You can also set them for [[Embed_table_or_graph_with_ACP#Frame_nodes|˞Frame nodes]], which will apply to all results shown in the Frame and override the ACP and model level settings. And you can set these styles for individual variables, which will override any settings in the Model or Frame. As always, it's easiest to set the using the [[ACP_Style_library]].

None of these styles apply to tab result views using the default Navigation_style: Outline.

===Show or hide the Description===

*'''<code>Show_description: n</code>''' If <code>n > 0 </code> it shows the Description of the variable above the table or graph using up to n% of the vertical space available. If that's not big enough to show the entire description, it shows a vertical scroll bar. Iif you don't want to show the description at all, set <code>n = 0</code>. Default if not mentioned, is one third, i.e. <code>Show_description: 33</code>. You can set this style at the model level for all Frame or Tall nodes, and you can override this default for any individual node.

===Show or hide the Object view icon===
*'''<code>Object_in_Frame:yes/no</code>''': With this style set, it shows an object view hover icon at the top right of a frame node or tall node when showing a graph or table view. Click this icon to show the object window view. The object view shows the Table and Graph hover icon to go back to the table or graph view. You can set '''<code>Object_in_frame</code>''' style at either the top level of the model or in an individual frame node, which overrides the top level setting. When working with tall nodes, you can set '''<code>Object_in_frame</code>''' style at the top level or in the original variable's ACP style setting, which overrides the top level setting.

===Show or hide the title===

*'''<code>Show_title</code>''': Set <code>Show_title: yes</code> to show or <code>Show_title: no</code> to stop showing the Title and units of a selected variable. This style can be used at the model level, for frame nodes or for individual nodes, but controls whether or not the Title and units show in Frame nodes or tall nodes.

===Show or hide the Graph-Table icon===

*'''<code>Show_graph_table_icon:no</code>''' Hides the icon in the top right of a Result that lets you toggle between Graph and Table view. This applies to [[Embed_table_or_graph_with_ACP|Frame nodes and tall nodes]]. This style can be used for the entire model, for frame nodes or for individual nodes . You set them in the AcpStyles attribute. Conversely, you can set '''<code>Show_graph_table_icon:yes</code>'''. This is the default so not usually necessary at the model level, but can be used in a frame node or variable to override the model default or override a frame node setting.

===Show or hide the Uncertainty view menu===
By default, in ACP, as in desktop Analytica, the [[Uncertainty views]] menu appears above each result graph or table to let you select [[Mid]] to display its deterministic value, or Mean, Probability distribution, and other ways to display a probabilistic value.

You can override this default behavior with this ACP style for the entire model, [[Embed_table_or_graph_with_ACP#Frame_nodes|Frame nodes]], or for individual variables. The Uncertainty view menu is always present in tab result views.
*'''<code>Show_uncertainty_view: No</code>''' Never show the uncertainty menu in frame nodes or tall result nodes. Suitable for models with no probabilistic values, or if you want to fix a particular probabilistic view for each frame node or variable so that ACP users can't change it.
*'''<code>Show_uncertainty_view: Yes</code>''' Always show the uncertainty menu even for variables that are not probabilistic, as in Desktop Analytica. This is the default and not normally necessary at the model level, but can be used to customize which frame nodes or variables to show the uncertainty view menu when the model level style is set to '''<code>Show_uncertainty_view: No</code>'''

===Show or hide the Index menus and Pivoters/slicers===
*'''<code>Show_index_menus: Fly-in</code>''' By default (the same as if there is no show_index_menu: setting) the index menus are not shown in [[https://wiki.analytica.com/index.php?title=Embed_table_or_graph_with_ACP|frame nodes or tall nodes]] (but slicers are), since often the modeler has already chosen the pivot they want to use. And because these menus take up valuable screen space. But if you hover over the frame node (or tall node) there is a fly-in pivoter control. If you click this it toggles - on or off - the visibility of the pivoters; allowing you to pivot the result table or graph and then close the pivoters to give you more space.
*'''<code>Show_index_menus: Yes</code>''' If you do want to allow users to be able to pivot or change the slice of the table or graph, without using the fly-in, then use use show_index_menus:yes. Always present in tab result views.
*'''<code>Show_index_menus: No</code>''' If show_index_menus:no is set then the indexes and pivoters will not show and there is no fly-in, but the slicers will still be present.
*'''<code>Show_index_menus: Not_even_slicers</code>''' If you don't want to show any pivoters or slicers, you can set show_index_menus:Not_even_slicers.

===Table filtering===
'''<code>Show_Table_Filtering: no</code>''' Turns off the ability to filter tables by column, and reverts to the previous sort functionality. [[Tables_in_ACP#Sort_columns]]<br />
'''<code>Show_Table_Filtering: yes</code>''' The default - shows the table filtering icons

===Autocalc===

In the [[ACP Style Library]], Autocalc looks like a style you can set for a model, module or variable. It controls whether ACP evaluates each variable and shows its results automatically when you view a Diagram or tab showing the -- instead of the default Analytica behavior where the end user has to click on a Calc button to compute a result. With Autocalc on, a result in view also recomputes automatically when you change an input that influences it.

Autocalc is not actually an ACPStyle in ACP3. (It was in ACP1.) Autocalc is implemented using the Desktop Analytica functionality for [[Proactive_Evaluation]].

== Node Level Settings ==

These style flags and options apply to individual nodes (variables), rather than the model as a whole. So, you set these flags on the AcpStyles for selected objects (nodes).

=== Other node level flags ===
=== Prevent nodes from showing on the diagram ===

*'''<code>Show_Object: no</code>'''
You can prevent nodes or modules from showing on the diagram of your model, by adding this flag to the AcpStyles attribute of the object you wish to hide. Once the model is shown in ACP the objects aren't visible.

== Modifying ACP menus==

Normally, ACP offers menus that appear when you press one of the three icons on the right of the top teal bar. These ACP styles let you modify these menus.

===Hide the Save options===

*'''<code>Hide_save_button: yes </code>''' Set this model ACP style option to exclude the 'Save this model' and 'Save model as...' from the ACP Close menu. It prevents users from saving over your models or saving other versions.
*''This style cannot currently be set from the ACP style library, since it would allow users to show the save and save as menu options and then save changes even if the modeler does not want to allow it.''

===Remove Help menu items===

These styles add menu items to or remove items from the help (?) menu if added to the AcpStyles of the top diagram of your model. For [[ACP_Server_License|ACP installations]] on an intranet, these standard links may not be accessible. On the other hand you may want to offer a special help page for a particular model.

*'''<code>Remove_help_menu_options: Text</code>
This style allows you to list one or more of the standard options to remove from the help (?) menu. Replace <code>Text</code> with one or more of the following: <code>ACP_Online_docs, Analytica_Q_A_forum, Tech_support</code>.

(Note: The help menu item <code>Connection status</code> cannot currently be removed).

===Add Help menu item===
*'''<code>Add_help_menu_option: Text|URL</code>'''
Adds another menu item, for example: <code>Add_help_menu_option: How to use this model...|https://www.lumina.com</code> adds a menu item to the help (?) menu with the text "How to use this model..." and opens the link when clicked.

===Add download this model to the Close menu===
*'''<code>save_menu_download: yes</code>'''
This AcpStyle is controlled by a setting in the [[Customizing_an_ACP_server#The_acpConfig.json_file|AcpConfig.json]] file. On Lumina's acp.analytica.com server it is turned on.
With this AcpStyle in the model, ''<code>"download this model"</code>'' is added to the close menu at the top right of the ACP GUI.
When set, this will allow anyone to download the model - even a reviewer, and even from an email invite.
*'''<code>save_menu_download: no</code>''' (default if not set)
*'''<code>save_menu_download:Prompt_to_download_free</code>'''. This adds a popup dialog with a download link and prompt to download the Analytica free installer.
''This style cannot be set from the ACP Style library, since it would allow reviewers to change the style and download the model, even if the modeler does not want to allow that.''

==See Also==
* [[ACP Style Library]]
* [[media:ACP style library.ana]]
* [[Analytica Cloud Platform]]
* [[ACP Rendering tables and graphs on the diagram]]
* [[Putting ACP in a Web Page]]
* [[Help balloons]]
* [[Attributes]]
* [[Manage attributes]]

AcpStyles

2026-02-24T20:58:01Z

Mhenrion: /* Show or hide the Description */

[[Category: Analytica Cloud Platform]]
[[Category: Attributes]]
[[Analytica_Cloud_Player|<<Analytica Cloud Platform ]]

::{{ReleaseBar}}

ACP offers a wide variety of styles and options to control the look and functioning of the user interface. Many of these go beyond what is (currently) available in Desktop Analytica (DTA).

The easiest way to set these styles and options is to use the [[ACP Style Library]], which you can load into your model within ACP from the hamburger menu. As you change styles in ACP, you can see their effects immediately.

If you use [[ACP Style Library]] you don't need to learn about the ACP Styles described below. The only reason to read the rest of this page is if you want to do something esoteric with AcpStyles, or use one of the few AcpStyles not accessible in the [[ACP_Style_Library]].

You can also load the [[ACP Style Library]] in Analytica on the desktop from the '''Add Library...' option from the '''File''' menu. But, you won't be able to see the effects until you upload the model into ACP.

The styles and options are specified as keywords and tags in the AcpStyles attribute. Most styles and options apply to the whole Model and are specified in the AcpStyles attribute of the Model. When you want to specify special styles for individual modules or variables, you apply them to the ACPStyles attribute of the relevant object.

The easiest way to view and edit the AcpStyles attribute in Desktop Analytica is to use the [[Attribute panel]]. Select AcpStyles from the list of Attributes at the top of that panel. By default, AcpStyles is not shown in the [[Object window]], so you first need to set it to be shown either with the [[Object_Window|right click menu]] in the Object window, or in the [[Manage attributes|Attributes dialog]].

The AcpStyles and their flags are not case sensitive.

When you put multiple flags in a AcpStyles attribute, put each flag on a separate line.

== Model level styles ==

These styles apply to the entire model. You set them in the AcpStyles attribute for the Main Model. (They have no effect when set for a submodule.)

=== Navigation style ===

These Navigation_style options control how a user can view and access the module hierarchy:
* '''<code>Navigation_style: Outline</code>''' -- Show an expandable tree of modules on the left of the ACP window, similar to the outline view in desktop Analytica (showing only modules not other objects). This is the default style when you upload a model with no ACP styles set or no Acp styles library embedded, or if you have not yet set the Navigation style in the Acp styles library. A navigation flag is not needed for this style, but if you want to explicitly set this style you can add '''<code>Navigation_style: Outline</code>''' to the top diagram's AcpStyles attribute.

*'''<code>Navigation_style: Top diagram only</code>''' -- Show only the top diagram, with no Outline and no tabs. This lets you make a simple web application with a single UI page.
<br />

For the next two 'Tabbed application' styles, each module in the main model becomes a tab. The order of the tabs follows the sequence of the module nodes in the main diagram, from left to right then top to bottom.

* '''<code>Navigation_style: Top_tabs</code>''' -- The main modules in the top model appear as a row of tabs across the top of the window. Click a tab to show the diagram for that module.

*'''<code>Navigation_style: Side_tabs</code>''' -- The main modules in the top model appear as a column of tabs on the left of the window. Click a tab to show the diagram for that module.


We describe each in more detail below.

===Outline Tree===

By default, when using the Outline Navigation style, ACP shows an expandable outline tree of modules on the left hand side of the window, similar to the Outline view in Analytica on the desktop. This makes it easy to navigate a model with an extensive hierarchy of modules.

*'''<code>Show_outline: yes</code>''' -- The default, and unecessary for Outline Navigation style. It is generally redundant with other Navigation styles since the tabs or hierarchy show the same information, and the Outline takes up screen space. But you can add it to the top diagram's AcpStyles attribute if you want to show the Outline tree with other Navigation styles.

{{CalloutAnnotationBlock|[[File:Outline tree 6.0 01.png]]|{{CalloutAnnotation|Market model with<br>Outline Tree|v=80|pt=10,106}}}}
*'''<code>show_outline: no</code>''' -- When using the Acp Style library this is set by default for Navigation styles other than Outline. For small models, and most web apps, you may want to suppress the Outline view even when using the Outline Navigation style. Do this by inserting this text into the top diagram's AcpStyles attribute (See image below). (If a model has only one diagram, i.e. with no modules, it never shows the outline tree.)<br/>
{{CalloutAnnotationBlock|[[File:Outline tree 6.0 02.png]]|{{CalloutAnnotation|Market model with <br/>'''<code>show_outline: no</code>'''|v=80}}}}

===Top Diagram Only===

Set by adding '''<code>navigation_style: top_diagram_only</code>''' to the AcpStyles attribute of the top diagram.  The Styles library will set the flag  '''<code>show_outline:no</code>''' .

===Tabbed Module Navigation===

As an alternative to the Outline view, you can set the '''<code>Navigation_style</code>''' to use use a tabbed interface which is often more convenient and familiar for web applications. By default, the main model appears as the first tab. You can change this with the style [[AcpStyles_Attribute_Values#Exclude_the_top_level_diagram_from_tabs|show_as_tab:no]] described below.


There are two tabbed styles, Top_tabs, with a row of tabs across the top; and Side_tabs with a column of tabs down the side. Top_tabs works well if you have up to 5 to 8 modules in the main diagram (tabs), depending on the length of their titles and the width of the ACP window. If you have a lot of modules, or they have long titles, it may be better to use Side_tabs.

'Top tabs or side tabs.' The first tab displays the top level diagram, and the remaining tabs display the modules present on the top level diagram of the model. (The modules will not display on the diagram, so you need to tweak your diagram for playing in ACP so that it looks right without these present).

* '''<code>navigation_style: top_tabs</code>''' -- This setting instructs ACP to use the 'Tabs across top' navigation style.

[[File:Top tabs 6.0 01.png]]

* '''<code>navigation_style: side_tabs</code>''' -- This setting instructs ACP to use the 'Side tabs' navigation style. Side tabs work better than top tabs when there are more module nodes present.

[[File:Side tabs 6.0 01.png]]

=== Toolbar Tabs ===
*'''<code>show_tabs: no</code>''' -- By default, with the Outline Navigation style. ACP shows navigation tabs for "Diagram", "Object", "Table", "Graph" along the top. Use this flag to hide those tabs. If you display the model inputs and outputs on the diagram -- using embedded tables and graphs on the diagram -- your users may not need those tabs. (You can also use '''<code>show_tabs: yes</code>''' to explicitly show the tabs in Outline and Top diagram only Navigation styles.)
{{CalloutAnnotationBlock|[[File:Show tabs no 6.0 0.1.png]]|{{CalloutAnnotation|Market model with <br/>'''<code>show_tabs: no</code>'''|v=80|pt=232,37|path=t!-}}}}
<br/>

===Module hierarchy bar ===
Using tabbed navigation, ACP shows the model hierarchy in a bar at the top of the diagram by default. The model hierarchy header shows you where you are in a large model by listing the titles of the ancestor modules in which the current diagram is nested. You can click any ancestor to click up levels in the hierarchy. The Hierarchy Bar takes up much less screen real estate than the Outline Tree. ACP doesn't show the hierarchy bar when you are viewing a top level module, or if the module title is already in the selected tab. 

Note that this setting is not based on a AcpStyles attribute, but rather on the ''Show module hierarchy'' check box in the model [[Preferences]] in Analytica. If you want to set this preference manually, with the model opened in Analytica, on the [[Edit menu]], select '''Preference...''', and check (or uncheck) the ''Show module hierarchy'' checkbox.

If you are using the ACP styles library, the Styles library will set this to the default setting automatically once you select a Navigation style. But you have the option of changing it if, for instance you want to show the Outline and the Hierarchy bar.


===Auto zoom ===
*'''<code>auto_zoom_diagrams: yes</code>''' -- ACP automatically zooms the UI to fit the browser window -- the most constraining of width or height so it retains the aspect ratio of the diagram. Works with zoom in and zoom out. Auto Zoom will allow a model to go down to 50% of its size or up to 200% of its size. If the model does not fit at 50% size, the window will show scroll bars. This Acp style has no effect if '''<code>Use_top_diagram_size:Yes </code>''' is present, you can use only one or the other. You can also set '''<code>auto_zoom_diagrams: no</code>''' which is the default. (This is a model level setting and is added to the top diagram of a model).

===Customize zoom levels===
AcpStyles for controlling the max/min zoom when '''<code>auto_zoom_diagram: yes</code>''' is set. The default if these styles are not set is as above - 50% and 200%. The easiest way to set these is with the [[ACP_Style_Library]] - where the controls are in the Esoteric ACP styles module. This is available from the Hamburger menu in ACP. Note that in order to see this effect, the '''<code>Browser window size</code>''' needs to have the screen size pulldown menu set to '''<code>Auto zoom</code>''' as well.
*'''<code>zoom_min_percent: 75</code>''' (means that the minimum zoom level will be 75% or .75)
*'''<code>zoom_max_percent: 125</code>''' (means the that max zoom level will be 125% or 1.25)

===Use top diagram size for all ACP windows===
*'''<code>Use_top_diagram_size:Yes </code>''' -- Sets the size of all diagrams based on the size of the diagram window of the top level when the model was last viewed in Desktop Analytica (in non-maximized mode). '''<code>Use_top_diagram_size:No </code>''' is the same as if the flag is not set, and is the default - the ACP diagram will use the entire browser window.


===Show or hide the Dashboard Title and Model title===
*'''<code>show_model_title: no</code>''' -- Hide the title of the model, which appears by default in the top Teal bar.

*'''<code>show_diagram_title: yes</code>''' -- Use to show the dashboard title at the top of the diagram. Or <code>show_diagram_title: no</code> to suppress the diagram title, but not really necessary because ACP does not show the diagram title by default.


===Exclude diagram(s) from tabs===

When using tabbed navigation, you can select those modules (from the top model diagram) that you want to appear as a tab in ACP. The default is for all to appear as tabs. You should use the ''Show modules as tabs'' choice menu in the '''<code>ACP Navigation styles</code>''' section of the [[ACP Style Library]] if you want to set this flag,, and if you also want to hide the modules corresponding to these tabs [[ChangeNodeVisibility|hidden]], so that the model viewer cannot see them.

*Optionally, Enter the text '''<code>Show_as_tab: no</code>''' in the AcpStyles attribute of the modules you don't wish to show as a tab. The modules themselves will not be hidden with this setting, only the tabs.

===Tab color===

When using Tabbed Navigation, you can use these flags to control how the color of the tabs display on your model in ACP. To use, add one of them to the AcpStyles attribute of the top level diagram of your model. They have no effect if added to a module other than the top diagram.

*'''<code>Tab_color: Default </code>''' The default. Non-selected tabs are bluish white. The selected tab uses the background color for that diagram.
*'''<code>Tab_color: Background </code>''' All tabs use their diagram background color, whether selected or not
*'''<code>Tab_color: Node </code>''' The selected Tab uses its diagram background color; The other tabs use the color of their Module node (not their diagram background color). You can use this to change the color of the tabs by modifying their node color in an Analytica functions.

== Model level styles for diagram nodes. ==

These model-level styles affect how all nodes are displayed in diagrams.

=== Node shadows and bevels ===

By default ACP displays nodes without shadows or bevels (for now) , so they look like this:
:[[Image:Nodes no shadow or bevel.png]]

Set this flag to show a drop shadow behind each node, giving a kind of 3D effect:

*'''<code>node_drop_shadow: yes</code>'''

:[[Image:Nodes drop shadow.png]]

Set this flag to display a bevel border for each node, giving another kind of 3-D effect:
*'''<code>bevel_node_border: yes</code>'''

:[[Image:Nodes beveled border.png]]

===Node hover highlighting===

By default, ACP displays a highlight -- a contrasting light rectangle behind a node -- when you move the cursor over the node:

[[File:acp hover hl.png]]

You can switch it off by setting:
*'''<code>show_hover_highlight: No</code>'''

=== Balloon Help ===

When you move the cursor over a node, ACP usually shows a "balloon" popup next to the node with the description of the node (if it has one) to help end users understand what its for, or what to enter for a user input. If the node has no description, the [[help balloons|balloon help]] will not appear.

*'''<code>show_id_in_balloon: yes</code>''' Use this flag to show each node's identifier below its title in the balloon -- unless the identifier and title are identical (except for spaces which are replaced by underscores). This flag goes in the AcpStyles of the model and apply to all nodes in the model.



*'''<code>show_hover_balloon: no</code>'''
::Insert this flag in the AcpStyles for a node, to suppress display of its balloon.


==ACP styles inheritance==
This is the order of inheritance for Acpstyles below that apply to tables and graphs. Styles at a higher level take precedence over the lower precedence styles. (Inheritance doesn't apply to the ACPstyles described above that apply only at the Model level.)
# '''Variable''' (includes Tall nodes): Acpstyles applied to an individual variable will take precedence over all other styles. A variable with a style of <code>show_title:no</code> will not show the title, even if the model level style is <code>show_title:yes</code>, and if that node shows it's result in a frame node the variable style will override the frame node style.
# '''Frame''' : An Acpstyle set for a frame node will affect any variable shown in that frame that doesn't have its own settings. These will also override any styles at the model level.
# '''Model ACP style defaults''': Acpstyles that you can enter into the Acptyles attribute of the top diagram of your model. These will override the ACP defaults, and will be inherited by frame nodes and variables in the model that don't have their own Acpstyle.
# '''ACP style defaults for ACP''': The default style ACP uses if you have no specific setting for that style. Eg for show_index_menus the default is fly-in and that is what will show if you don't enter a different show_index_menus: Acpstyle flag in the Acpstyle for the top diagram (model level) or for frame nodes or variables.

==ACP Styles for tables and graphs==

These styles affect how result graphs and tables are displayed in ACP, including in [[Embed_table_or_graph_with_ACP#Frame_nodes|Tall nodes]] and [[Embed_table_or_graph_with_ACP#Tall_nodes|˞Frame nodes]]. They provide options not (yet) available in Desktop Analytica. ACP has default settings for these. You can override these settings for the entire model. You can also set them for [[Embed_table_or_graph_with_ACP#Frame_nodes|˞Frame nodes]], which will apply to all results shown in the Frame and override the ACP and model level settings. And you can set these styles for individual variables, which will override any settings in the Model or Frame. As always, it's easiest to set the using the [[ACP_Style_library]].

None of these styles apply to tab result views using the default Navigation_style: Outline.

===Show or hide the Description===

*'''<code>Show_description: n</code>''' If <code>n > 0 </code> it shows the Description of the variable above the table or graph using up to n% of the vertical space available. If that's not big enough to show the entire description, it shows a vertical scroll bar. Iif you don't want to show the description at all, set <code>n = 0</code>. Default if not mentioned, is one third, i.e. <code>Show_description: 33</code>. You can set this style at the model level for all Frame or Tall nodes, and you can override this default for any individual node.

===Show or hide the Object view icon===
*'''<code>Object_in_Frame:yes/no</code>''': With this style set, it shows an object view hover icon at the top right of a frame node or tall node when showing a graph or table view. Click this icon to show the object window view. The object view shows the Table and Graph hover icon to go back to the table or graph view. You can set '''<code>Object_in_frame</code>''' style at either the top level of the model or in an individual frame node, which overrides the top level setting. When working with tall nodes, you can set '''<code>Object_in_frame</code>''' style at the top level or in the original variable's ACP style setting, which overrides the top level setting.

===Show or hide the title===

*'''<code>Show_title</code>''': Set <code>Show_title: yes</code> to show or <code>Show_title: no</code> to stop showing the Title and units of a selected variable. This style can be used at the model level, for frame nodes or for individual nodes, but controls whether or not the Title and units show in Frame nodes or tall nodes.

===Show or hide the Graph-Table icon===

*'''<code>Show_graph_table_icon:no</code>''' Hides the icon in the top right of a Result that lets you toggle between Graph and Table view. This applies to [[Embed_table_or_graph_with_ACP|Frame nodes and tall nodes]]. This style can be used for the entire model, for frame nodes or for individual nodes . You set them in the AcpStyles attribute. Conversely, you can set '''<code>Show_graph_table_icon:yes</code>'''. This is the default so not usually necessary at the model level, but can be used in a frame node or variable to override the model default or override a frame node setting.

===Show or hide the Uncertainty view menu===
By default, in ACP, as in desktop Analytica, the [[Uncertainty views]] menu appears above each result graph or table to let you select [[Mid]] to display its deterministic value, or Mean, Probability distribution, and other ways to display a probabilistic value.

You can override this default behavior with this ACP style for the entire model, [[Embed_table_or_graph_with_ACP#Frame_nodes|Frame nodes]], or for individual variables. The Uncertainty view menu is always present in tab result views.
*'''<code>Show_uncertainty_view: No</code>''' Never show the uncertainty menu in frame nodes or tall result nodes. Suitable for models with no probabilistic values, or if you want to fix a particular probabilistic view for each frame node or variable so that ACP users can't change it.
*'''<code>Show_uncertainty_view: Yes</code>''' Always show the uncertainty menu even for variables that are not probabilistic, as in Desktop Analytica. This is the default and not normally necessary at the model level, but can be used to customize which frame nodes or variables to show the uncertainty view menu when the model level style is set to '''<code>Show_uncertainty_view: No</code>'''

===Show or hide the Index menus and Pivoters/slicers===
*'''<code>Show_index_menus: Fly-in</code>''' By default (the same as if there is no show_index_menu: setting) the index menus are not shown in [[https://wiki.analytica.com/index.php?title=Embed_table_or_graph_with_ACP|frame nodes or tall nodes]] (but slicers are), since often the modeler has already chosen the pivot they want to use. And because these menus take up valuable screen space. But if you hover over the frame node (or tall node) there is a fly-in pivoter control. If you click this it toggles - on or off - the visibility of the pivoters; allowing you to pivot the result table or graph and then close the pivoters to give you more space.
*'''<code>Show_index_menus: Yes</code>''' If you do want to allow users to be able to pivot or change the slice of the table or graph, without using the fly-in, then use use show_index_menus:yes. Always present in tab result views.
*'''<code>Show_index_menus: No</code>''' If show_index_menus:no is set then the indexes and pivoters will not show and there is no fly-in, but the slicers will still be present.
*'''<code>Show_index_menus: Not_even_slicers</code>''' If you don't want to show any pivoters or slicers, you can set show_index_menus:Not_even_slicers.

===Table filtering===
'''<code>Show_Table_Filtering: no</code>''' Turns off the ability to filter tables by column, and reverts to the previous sort functionality. [[Tables_in_ACP#Sort_columns]]<br />
'''<code>Show_Table_Filtering: yes</code>''' The default - shows the table filtering icons

===Autocalc===

In the [[ACP Style Library]], Autocalc looks like a style you can set for a model, module or variable. It controls whether ACP evaluates each variable and shows its results automatically when you view a Diagram or tab showing the -- instead of the default Analytica behavior where the end user has to click on a Calc button to compute a result. With Autocalc on, a result in view also recomputes automatically when you change an input that influences it.

Autocalc is not actually an ACPStyle in ACP3. (It was in ACP1.) Autocalc is implemented using the Desktop Analytica functionality for [[Proactive_Evaluation]].

== Node Level Settings ==

These style flags and options apply to individual nodes (variables), rather than the model as a whole. So, you set these flags on the AcpStyles for selected objects (nodes).

=== Other node level flags ===
=== Prevent nodes from showing on the diagram ===

*'''<code>Show_Object: no</code>'''
You can prevent nodes or modules from showing on the diagram of your model, by adding this flag to the AcpStyles attribute of the object you wish to hide. Once the model is shown in ACP the objects aren't visible.

== Modifying ACP menus==

Normally, ACP offers menus that appear when you press one of the three icons on the right of the top teal bar. These ACP styles let you modify these menus.

===Hide the Save options===

*'''<code>Hide_save_button: yes </code>''' Set this model ACP style option to exclude the 'Save this model' and 'Save model as...' from the ACP Close menu. It prevents users from saving over your models or saving other versions.
*''This style cannot currently be set from the ACP style library, since it would allow users to show the save and save as menu options and then save changes even if the modeler does not want to allow it.''

===Remove Help menu items===

These styles add menu items to or remove items from the help (?) menu if added to the AcpStyles of the top diagram of your model. For [[ACP_Server_License|ACP installations]] on an intranet, these standard links may not be accessible. On the other hand you may want to offer a special help page for a particular model.

*'''<code>Remove_help_menu_options: Text</code>
This style allows you to list one or more of the standard options to remove from the help (?) menu. Replace <code>Text</code> with one or more of the following: <code>ACP_Online_docs, Analytica_Q_A_forum, Tech_support</code>.

(Note: The help menu item <code>Connection status</code> cannot currently be removed).

===Add Help menu item===
*'''<code>Add_help_menu_option: Text|URL</code>'''
Adds another menu item, for example: <code>Add_help_menu_option: How to use this model...|https://www.lumina.com</code> adds a menu item to the help (?) menu with the text "How to use this model..." and opens the link when clicked.

===Add download this model to the Close menu===
*'''<code>save_menu_download: yes</code>'''
This AcpStyle is controlled by a setting in the [[Customizing_an_ACP_server#The_acpConfig.json_file|AcpConfig.json]] file. On Lumina's acp.analytica.com server it is turned on.
With this AcpStyle in the model, ''<code>"download this model"</code>'' is added to the close menu at the top right of the ACP GUI.
When set, this will allow anyone to download the model - even a reviewer, and even from an email invite.
*'''<code>save_menu_download: no</code>''' (default if not set)
*'''<code>save_menu_download:Prompt_to_download_free</code>'''. This adds a popup dialog with a download link and prompt to download the Analytica free installer.
''This style cannot be set from the ACP Style library, since it would allow reviewers to change the style and download the model, even if the modeler does not want to allow that.''

==See Also==
* [[ACP Style Library]]
* [[media:ACP style library.ana]]
* [[Analytica Cloud Platform]]
* [[ACP Rendering tables and graphs on the diagram]]
* [[Putting ACP in a Web Page]]
* [[Help balloons]]
* [[Attributes]]
* [[Manage attributes]]

What's new in Analytica 7.0?

2026-02-18T17:01:04Z

Mhenrion: /* Index label auto updates */

[[category:What's new pages]]
[[category:Analytica releases]]

[[Analytica 7.0]] will be the next major Analytica release and is currently in [[Beta Tester Page|beta testing]]. Go to [[Beta Tester Page]] to try it. The current official release is [[Analytica 6.6]].

==Highlights of Analytica 7.0==

* '''[[#Python integration|Python integration]]:''' The major enhancement is integration with Python and hence the entire Python ecosystem of libraries. You can easily call functions from Python libraries, access Python variables, and even write Python code right inside Analytica variables and functions. So now you can mix and match Analytica and Python according to which language you think best for your modeling or coding needs.
* '''[[#Index label auto updates|Index label auto updates]]:''' A common source of errors has been when you change a text label in an Index without remembering to change expressions that refer to that same text label. Changes to labels now update automatically in expressions in most cases.
* The '''Analytica Enterprise'''' edition has been renamed the [[#Developer Edition (formerly known as Enterprise) |Developer edition]], which better reflects what it is.
* It introduces two new object Classes:
** [[Struct]] lets you bundle disparate values, like text, numbeers, atoms and arrays, together in one object that does not array abstract -- similar to Records and Classes in other languages).
** [[Callable]] is like a user-defined Function but it's Definition can be a [[handle]] to a Python class or a Python function.
* [[ParseJSON]] and [[MakeJSON]] now use Structs, which are much more convenient for representing the hierarchical structure of JSON.
* [[#SpreadsheetOpen|Read and write spreadsheets without Excel]]: This is faster and more robust, and you don't need Excel installed.

== [[Using Python from Analytica|Python integration]] ==

You can now write Python code inside Analytica definitions! It's easy to call Python functions, with Analytica-style Intelligent Arrays!. So you can access the vast ecosystem of Python libraries (''modules'' in Python lingo). Among the gazillion possibilities are specialized libraries for data visualization, statistics, machine learning, and much more.
It means that you can mix and match Analytica and Python -- write Analytica code for what's easiest in Analytica and Python code for what's easiest in Python.

See: [[Using Python from Analytica]]
(In [[Analytica Developer]] edition or better).

For the Analytica modeler, this puts a ton of resources at your fingertips.

It's also pretty cool for the Python developer. Analytica is like a new interactive development environment with a lot of unique advantages, especially during interactive code development:
* Analytica's dependency maintenance can be really convenient during interactive development, creating automatic dependency maintenance between your Python functions, classes and variables that don't exist in Python.
* The visual influence diagram layout can be a super useful to way organize and visualize your code.
* It naturally encourages declarative code practices, which leads to better and more maintainable coding style.
* You get the benefits of Analytica's edit tables, plus for results, Analytica's multi-D result tables and one-click, no-code, graphing.
* It is easy to wrap existing Python models to get Monte Carlo, parametric analysis and sensitivity analysis with Analytica ease.
* Sometimes one or the other language is more convenient for a particular task. You can freely switch between whichever language feels better suited to the immediate task, and intermix languages easily.

== Developer Edition (formerly known as Enterprise) ==

Analytica's middle-tier edition formerly known as the ''Enterprise Edition'', it is now called the [[Analytica Developer|Analytica Developer edition]]. That name better reflects what it is--software for developers of decision applications. If you're now a user of Analytica Enterprise you don't have to update your license or do anything special. The name will just change when you install Analytica 7.0. In Analytica docs, when you select "7.0" on the release bar (at the top of pages that have release-contingent content), all the docs automatically use the new Analytica Developer edition name.

== Analytica language extensions ==

=== Index label auto updates ===

When you change the identifier of a variable, Analytica automatically updates all Definitions to use the new name. But, when you change a text label in an Index, it previously caused an error in any Definition using that label. For example, if you have
<code>
Index Animal := ['Cat', 'Dog']
Variable Sound := IF Animal = 'Cat' THEN 'Miaow' ELSE 'Woof'
</code>
If you change <code> 'Cat'</code> to <code>'Feline' </code> in Index <code>Animal</code>, the Definition of <code>Sound</code> will now automatically update to
<code>
IF Animal = 'Feline' THEN 'Miaow' ELSE 'Woof'
</code>
It does this wherever it sees <code>Animal= 'Cat'<label></code>. If you use an index label in a context where the index doesn't normally appear, you should the new [[Index-label dot syntax]] (<code>Animal . 'Cat'</code>). By associating the label with its index it will automatically update when needed. These [[Keeping text literals consistent with index labels| features]] help you avoiding a common error when updating text labels in Indexes.

=== Callable ===

The new object [[Class]] [[Callable]] is a variable-like object, meaning it has a [[Definition]] and a computed value, but can be used for convenience and documentation when the computed value itself is something that can be called, such as a [[Local function]] (aka ''lambda function''), a [[handle]] to an global function, a Python class or a Python function.

If you "compute" the identity of a callable data item inside a normal [[Variable]] instance, <code>X</code>, you could call it using the syntax <code>X->(a,b,c)</code>. On your influence diagram the object would have a rounded rectangle and thus would not communicate that the result is something that can be called. When you change its class to be a [[Callable]], you can then invoke the call using the syntax <code>X(a,b,c)</code> and the shape of the node changes to something that resembles a function shape, thus communicating that this holds something that is callable.

To create a callable, first create a [[Variable]] node, then use the [[Class]] dropdown from the [[Object window]] or [[Attribute pane]] to change the class to ''Callable''.

=== Struct ===
A [[Struct]] defines a new atomic, immutable data type. For use when you need to bundle multiple heterogeneous items and don't want their dimensionalities to interact. Array abstract treats an instance of a Struct as a single cell (an atom).

=== Expression and Lazy qualifiers ===
An expression passed to a function parameter declared with the qualifier as <code>[[Function_parameter_qualifiers#Expression|Expression]]</code> can now include local variable identifiers. The local variables are captured (similar to how they would be captured by a [[Local function]]).

A new function parameter qualifier, [[Function_parameter_qualifiers#Lazy]], has been added, which does lazy evaluation of the expression passed to it. In the function Definition, you can use it as if it were a normal value parameter, but evaluation occurs when the value is used rather than when the function is called, and in the evaluation context (which includes the [[Evaluation modes|evaluation mode]]) where the value is used instead as in the context of the call.

=== Excess parameter qualifier ===
A new function declaration allows a function to tolerate or capture excess named parameters in the call that are not declared as parameter names in the function's Parameters declaration. It can also be used in a [[Struct]] declaration.

== Functions ==
=== ParseJSON ===
Changed to parse to [[Struct]]s, thus greatly simplifying and improving the convenience of using JSON in Analytica expressions.

For parsing with a schema, a Struct's declaration serves as the schema, which is far easier and more familiar for an Analytica user than the former scheme for specifying a schema.

[[MakeJSON]] is able to generate JSON from a Struct (or nested structs) as well, which is the most convenient representation for JSON representations.

=== SpreadsheetOpen ===
Added a new «backend» parameter to [[SpreadsheetOpen]] with a new option of <code>'LibXl'</code>, allowing you to read and manipulate a spreadsheet without having Excel installed. But unlike the Excel backend, the <b>LibXl</b> option does not have a calculation engine (so can't recompute cell formulas after you change cells). This option is be better when you simply want to read (or write) data in a *.xlsx file format.

== Example models and libraries ==

* There is a new "Auto insurance claim risk analysis.ana" in the Example Models / Risk Analysis folder.
* The [[Mutables library]] has been updated. It provides a new [[Mutable]] [[Struct]] which is superior to the older representation, which displays the actual value in result table cells and is atomic. The legacy functions ([[MutableNew]], [[MutableSet]] and [[MutableGet]]) are still there for backward compatibility, but have been changed to just wrap the new Mutable.

== Result tables and graphs ==
* A blank (none) entry was added to the [[XY_comparison#Use_comparison_index|comparison index pulldown]]. Use this to quickly unset the comparison index without having to re-enter the [[XY_comparison]] dialog. Also, the pulldown is now visible and enabled in browse mode.
* Comparison variables are no longer summed over slicer indexes that are set to '''Totals''' when the value for that variable does not include the slicer index. Note that this results in some changes to what is displayed in table body cells and in axis scaling on graphs.

== Assista ==

You can now copy-paste from Expression blocks in Assista's response using the little copy icon in the top-right corner of the expression block.

== Experimental ==
* A way for an Analytica model running in desktop Analytica to [[MCP server in Analytica|act as a Model Context Protocol (MCP) server]] for use by Large Language Models (LLMs).

== ADE ==
* Added a new example: <code>Mcp_server</code>. This is an MCP server that wraps ADE. Among other things, it can give AI agents like Claude Code the ability to build, explore and use Analytica models.

What's new in Analytica 7.0?

2026-02-18T01:36:14Z

Mhenrion: /* Index label auto updates */

[[category:What's new pages]]
[[category:Analytica releases]]

[[Analytica 7.0]] will be the next major Analytica release and is currently in [[Beta Tester Page|beta testing]]. Go to [[Beta Tester Page]] to try it. The current official release is [[Analytica 6.6]].

==Highlights of Analytica 7.0==

* '''[[#Python integration|Python integration]]:''' The major enhancement is integration with Python and hence the entire Python ecosystem of libraries. You can easily call functions from Python libraries, access Python variables, and even write Python code right inside Analytica variables and functions. So now you can mix and match Analytica and Python according to which language you think best for your modeling or coding needs.
* '''[[#Index label auto updates|Index label auto updates]]:''' A common source of errors has been when you change a text label in an Index without remembering to change expressions that refer to that same text label. Changes to labels now update automatically in expressions in most cases.
* The '''Analytica Enterprise'''' edition has been renamed the [[#Developer Edition (formerly known as Enterprise) |Developer edition]], which better reflects what it is.
* It introduces two new object Classes:
** [[Struct]] lets you bundle disparate values, like text, numbeers, atoms and arrays, together in one object that does not array abstract -- similar to Records and Classes in other languages).
** [[Callable]] is like a user-defined Function but it's Definition can be a [[handle]] to a Python class or a Python function.
* [[ParseJSON]] and [[MakeJSON]] now use Structs, which are much more convenient for representing the hierarchical structure of JSON.
* [[#SpreadsheetOpen|Read and write spreadsheets without Excel]]: This is faster and more robust, and you don't need Excel installed.

== [[Using Python from Analytica|Python integration]] ==

You can now write Python code inside Analytica definitions! It's easy to call Python functions, with Analytica-style Intelligent Arrays!. So you can access the vast ecosystem of Python libraries (''modules'' in Python lingo). Among the gazillion possibilities are specialized libraries for data visualization, statistics, machine learning, and much more.
It means that you can mix and match Analytica and Python -- write Analytica code for what's easiest in Analytica and Python code for what's easiest in Python.

See: [[Using Python from Analytica]]
(In [[Analytica Developer]] edition or better).

For the Analytica modeler, this puts a ton of resources at your fingertips.

It's also pretty cool for the Python developer. Analytica is like a new interactive development environment with a lot of unique advantages, especially during interactive code development:
* Analytica's dependency maintenance can be really convenient during interactive development, creating automatic dependency maintenance between your Python functions, classes and variables that don't exist in Python.
* The visual influence diagram layout can be a super useful to way organize and visualize your code.
* It naturally encourages declarative code practices, which leads to better and more maintainable coding style.
* You get the benefits of Analytica's edit tables, plus for results, Analytica's multi-D result tables and one-click, no-code, graphing.
* It is easy to wrap existing Python models to get Monte Carlo, parametric analysis and sensitivity analysis with Analytica ease.
* Sometimes one or the other language is more convenient for a particular task. You can freely switch between whichever language feels better suited to the immediate task, and intermix languages easily.

== Developer Edition (formerly known as Enterprise) ==

Analytica's middle-tier edition formerly known as the ''Enterprise Edition'', it is now called the [[Analytica Developer|Analytica Developer edition]]. That name better reflects what it is--software for developers of decision applications. If you're now a user of Analytica Enterprise you don't have to update your license or do anything special. The name will just change when you install Analytica 7.0. In Analytica docs, when you select "7.0" on the release bar (at the top of pages that have release-contingent content), all the docs automatically use the new Analytica Developer edition name.

== Analytica language extensions ==

=== Index label auto updates ===

When you change the identifier of a variable, Analytica automatically updates all Definitions to use the new name. But, when you change a text label in an Index, it previously cause cause errors in Definitions using that label. For example, if you have
<code>
Index Animal := ['Cat', 'Dog']
Variable Sound := IF Animal = 'Cat' THEN 'Miaow' ELSE 'Woof'
</code>
If you change <code> 'Cat'</code> to <code>'Feline' </code> in Index <code>Animal</code>, the Definition of <code>Sound</code> will now automatically update to
<code>
IF Animal = 'Feline' THEN 'Miaow' ELSE 'Woof'
</code>
It does this wherever it sees <code>Animal=<label></code>. If you use an index label in a context where the index doesn't normally appear, you should the new [[Index-label dot syntax]] (<code>Animal . 'Cat'</code>). By associating the label with its index it will automatically update when needed. These [[Keeping text literals consistent with index labels| features]] help avoid common errors when updating text labels in Indexes.

=== Callable ===

The new object [[Class]] [[Callable]] is a variable-like object, meaning it has a [[Definition]] and a computed value, but can be used for convenience and documentation when the computed value itself is something that can be called, such as a [[Local function]] (aka ''lambda function''), a [[handle]] to an global function, a Python class or a Python function.

If you "compute" the identity of a callable data item inside a normal [[Variable]] instance, <code>X</code>, you could call it using the syntax <code>X->(a,b,c)</code>. On your influence diagram the object would have a rounded rectangle and thus would not communicate that the result is something that can be called. When you change its class to be a [[Callable]], you can then invoke the call using the syntax <code>X(a,b,c)</code> and the shape of the node changes to something that resembles a function shape, thus communicating that this holds something that is callable.

To create a callable, first create a [[Variable]] node, then use the [[Class]] dropdown from the [[Object window]] or [[Attribute pane]] to change the class to ''Callable''.

=== Struct ===
A [[Struct]] defines a new atomic, immutable data type. For use when you need to bundle multiple heterogeneous items and don't want their dimensionalities to interact. Array abstract treats an instance of a Struct as a single cell (an atom).

=== Expression and Lazy qualifiers ===
An expression passed to a function parameter declared with the qualifier as <code>[[Function_parameter_qualifiers#Expression|Expression]]</code> can now include local variable identifiers. The local variables are captured (similar to how they would be captured by a [[Local function]]).

A new function parameter qualifier, [[Function_parameter_qualifiers#Lazy]], has been added, which does lazy evaluation of the expression passed to it. In the function Definition, you can use it as if it were a normal value parameter, but evaluation occurs when the value is used rather than when the function is called, and in the evaluation context (which includes the [[Evaluation modes|evaluation mode]]) where the value is used instead as in the context of the call.

=== Excess parameter qualifier ===
A new function declaration allows a function to tolerate or capture excess named parameters in the call that are not declared as parameter names in the function's Parameters declaration. It can also be used in a [[Struct]] declaration.

== Functions ==
=== ParseJSON ===
Changed to parse to [[Struct]]s, thus greatly simplifying and improving the convenience of using JSON in Analytica expressions.

For parsing with a schema, a Struct's declaration serves as the schema, which is far easier and more familiar for an Analytica user than the former scheme for specifying a schema.

[[MakeJSON]] is able to generate JSON from a Struct (or nested structs) as well, which is the most convenient representation for JSON representations.

=== SpreadsheetOpen ===
Added a new «backend» parameter to [[SpreadsheetOpen]] with a new option of <code>'LibXl'</code>, allowing you to read and manipulate a spreadsheet without having Excel installed. But unlike the Excel backend, the <b>LibXl</b> option does not have a calculation engine (so can't recompute cell formulas after you change cells). This option is be better when you simply want to read (or write) data in a *.xlsx file format.

== Example models and libraries ==

* There is a new "Auto insurance claim risk analysis.ana" in the Example Models / Risk Analysis folder.
* The [[Mutables library]] has been updated. It provides a new [[Mutable]] [[Struct]] which is superior to the older representation, which displays the actual value in result table cells and is atomic. The legacy functions ([[MutableNew]], [[MutableSet]] and [[MutableGet]]) are still there for backward compatibility, but have been changed to just wrap the new Mutable.

== Result tables and graphs ==
* A blank (none) entry was added to the [[XY_comparison#Use_comparison_index|comparison index pulldown]]. Use this to quickly unset the comparison index without having to re-enter the [[XY_comparison]] dialog. Also, the pulldown is now visible and enabled in browse mode.
* Comparison variables are no longer summed over slicer indexes that are set to '''Totals''' when the value for that variable does not include the slicer index. Note that this results in some changes to what is displayed in table body cells and in axis scaling on graphs.

== Assista ==

You can now copy-paste from Expression blocks in Assista's response using the little copy icon in the top-right corner of the expression block.

== Experimental ==
* A way for an Analytica model running in desktop Analytica to [[MCP server in Analytica|act as a Model Context Protocol (MCP) server]] for use by Large Language Models (LLMs).

== ADE ==
* Added a new example: <code>Mcp_server</code>. This is an MCP server that wraps ADE. Among other things, it can give AI agents like Claude Code the ability to build, explore and use Analytica models.

User:ACP3 Enhancements and fixes

2026-02-18T01:28:21Z

Mhenrion: /* Pre release */

[[Category: Analytica_Cloud_Platform]]
[[Analytica_Cloud_Platform#See_also|<<Back to Analytica Cloud Platform]]

The most
These are changes by build for releases on the staging server, which may not yet be released on the release server. When they are, the issues likely to be of interest to most users are copied over to [[What's new in ACP?]].

The next planned release is build 180. It should be released in mid February 2026.

'''ER''' - Enhancement request number
'''EW''' - Bug number
'''W''' - Monday item number

=='''Pre release'''==

Issues that have been implemented or fixed since the Current release (build 174) .

===Fixed or implemented in ACP build 181===
*M-06433 Error message box sometimes shows errors from a previous model when opening a new model.
*M-06430 UseEval warnings and evalOnCells warnings are showing on the diagram instead of only in the console.
*M-06392 Icons on the BCH server sometimes appear broken

===ACP build 180===
====Bug fixes and minor enhancements====
*M-01229 Make ACP resize images in tables as in DTA
*M-06421 Com error in send email/send email invites in suan account model
*M-06417 Compute button not appearing in frame node
*M-06416 For [[ACP_Server_License|AcpServer]] Added a Watchdog (aka zombie killer) script for the suan server processes - restarts them if the websocket becomes unresponsive. (In addition to the built in redundancy).
*M-06415 CSV Download format for Long and Wide tables are not correct while downloading for the first time after page refresh
*M-06402 UI fails to update after calculations complete.
*M-06400 Can't scroll all the way to the right in a table
*M-06383 Show all icons in maximized frame node view
*M-06382 change to the expand view tooltip
*M-06381 position tooltips below the icon in frame nodes, and add tail
*M-06353 Vertical scroll bar should not cover column headers
*M-00006 Diagram and module hierarchy don't update when new object is clicked on
*M-00049 Click on inputs in tall node goes to result not object window
*M-06369 Table filtering: menu gets cut off if window is too small
*M-00174 Can't resize a table column with a slider in the cell
*M-00652 Slider shows as an empty cell when copying or downloading csv from an edit table.
*M-01254 Tall atomic subtable input not showing label in middle
*M-06380 Remove the green outline around check boxes

===Fixed or implemented in ACP build 179===
*M-06389 Remove teal box around checkbox inputs on click
*M-06391 Cancel button in a progress bar doesn't work if a calculation is not ongoing
*M-06397 new AcpStyle Frame_default_view:
*M-06395 No download and Diagram hang after pressing download csv icon in frame node. For large files - it was timing out. Added a download size estimate and animation to show that the file is being downloaded.
*M-06390 Suan process crashes when launched with /config:server or singleinstance
*M-06387 Reduce the size of a progress bar without any textual parameters - to the same size as progress bars with textual parameters.
*M-06386 ACP did not reliably show progress bars and message boxes that showed in DTA during a computation.
*M-06359 ACP1 invite link does not open model
*M-06346 Lines don't align in Table UI

===Fixed or implemented in ACP build 178===
*M-06372 Object view does not switch nodes
*M-06339 Frame node does not show object view initially
*M-00002 A way to make the Object view the first default view (instead of result) in a Frame node
*M-00516 A way to keep cells selected while scrolling in a table.
*M-00004 Max: Text in lists should be similar to the diagram font size

===Fixed or implemented in ACP build 177===
*M-06368 with object view set as default in frame nodes, clicking on result does not show result
*M-06385 ACP hangs on BCH model when switching between tabs
*M-06363 Edit table too many messages with wrong cell format entry
*M-06361 show_table_filtering does not effect tables in the ACP1 tab
*M-06357 For column and row pivoters, need a blank cell for no index view
*M-06355 Cell format 'text and number' accepts only number
*M-06354 No scroll bar for long list indexes
*M-06350 Close popup after reordering items in a list
*M-06349 In Framenodes remember object view for edit tables and input nodes c.f. m-00011
*M-06344 Edit table extends past white background after pivoting
*M-00003 Max: When adding to a list using the list UI, the new entry should be highlighted cf 2314
*M-00005 Add scrollbar to Text node
*M-01864 When selecting Time from inputs popup, show object window for time.
*M-01997 Stop showing hand pointer for diagram background.
*M-00009 Max: Improvements to the List input UI
*M-00079 Max: Improve the graphic design for Object view.
*M-00186 Text in tall node object view does not wrap correctly.
*M-00393 Cell selection rect doesn't expand as cell contents make the cell larger

===Fixed or implemented in ACP build 176===
*M-06356 Crash after entering wrong cell format value into multitable
*M-06338 stray 0 inside of a framenode and text node
*M-00012 In Bare icon style, make the buttons in user input and output nodes just show the icon.
*M-00013 Missing probabilistic result icons
*M-02001 User outputs with long textual results not truncating correctly.

===Fixed or implemented in ACP build 175===
* ER 2303 MultiChoice input node UI improvements.
* EW 2306 ACP crashes after download button click - downloading a particular blank template types from a database instance.
* M-00018 Multiple errors followed by unusable model after entering invalid cell value into edit table
* M-00021 - Text in form nodes is slightly below center
* M-00031 In outline view, the style library asks which modules to show as tabs. (Desktop Analytica bug 21800)
* M-00033 Update ACP's UI Icons
* M-00058 Add date picker functionality to date inputs

=='''Current release'''==
=== Fixed or implemented in ACP build 174 11- Nov 2025===
* EW 2301 Deleted text value in a table cell becomes '0' instead of ''
* EW 2300 Table filtering acp style precedence is wrong for frame nodes and variables

=== Fixed or implemented in ACP build 173 9 - Nov 2025===
* ER 2243 AcpStyle to turn on / turn off table filtering

=== Fixed or implemented in ACP build 172 3 - Nov 2025 ===
* EW 2295 Sql error thrown in model_run_counting due to date format.
* EW 2293 MsgBox window is cut off when messages are long.
* EW 2292 Sum - totals icon is tricky to use. Needs to have the clickable area enlarged.
* EW 2291 No option to download csv in an edit table (framenode).

=== Fixed or implemented in ACP build 171 29 Oct 2025 ===
* EW 2283 Numbers do not fit User inputs
* ER 2281 Expand/reduce icon should be the right most icon
* ER 2274 Update the List and Sequence modals
* EW 2273 Artifact in the list and sequence modals
* EW 2271 Graph does not display after reducing while graph is zoomed
* EW 2269 Loading bar has extra symbol
* EW 2266 Tooltip text for the maximize icon is wrong

=== Fixed or implemented in ACP build 170 22 Oct 2025 ===
* EW 2288 Error when changing from mid to probabilistic in a frame node
* EW 2285 Diagram crash when selecting uncertainty result in atomic result node.

=== Fixed or implemented in ACP build 169 15 - Oct 2025===
* EW 2270 Pressing the Reduce button in tall nodes returns to an acp tab instead of the embedded graph.
* EW 2232 Wrong number format in slider labels
* EW 2231 Scaling of slider labels looks bad
* EW 2228 Adding style library gives an unnecessary message "OK will set the styles library..."

=== Fixed or implemented in ACP build 168 ===
* EW 2268 Crash when clicking filtering icon in column with dates
* EW 2263 Can't switch to table view - Suan server half
* EW 2261 With flex on, problem changing to table view in some models.
* ER 2260 Warning when pivoting a table with filters applied needs the positioning adjusted.
* ER 2256 Distribution input window should match updated ACP UI styling
* EW 2257 Input nodes UI inconsistent across input types
* ER 2196 Add an expand button (and reduce ) to graphs
* ER 1812 Implement clickable inputs/outputs in the object window in frame nodes/ tall nodes

=== Fixed or implemented in ACP build 167 26 - Sept 2025 ===
* ER 2259 When a table has filter applied, If the pivot is changed, (e.g., columns are now rows) any previously selected filters should be cleared.
* ER 2252 - improve the Table filtering UI
* ER 2181 Add invite sent popup notification after sharing a model.
* EW 2167 Could not scroll the model description when it is present after mouseover of the title. The description closes when the mouse was moved.

=== Fixed or implemented in ACP build 166 23 - Sep 2025 ===
* EW 2238 Crash when attempting to filter a table column that contains a handle.
* ER 2229 Enable the table filter menu on the row index column

=== Fixed or implemented in ACP build 165 12 - Sep 2025 ===
* ER 2245 Update the icons for filtering tables
* EW 2242 In the user management the checkmark sticks on the wrong item after assigning a role.
* ER 2241 For Table filtering "Contains" Matches Handling on the javascript side
* EW 2225 Input node has scrollbars when it shouldn't with auto zoom set

=== Fixed or implemented in ACP build 164 3 - Sep-2025 ===
(Test build only)
=== Fixed or implemented in ACP build 163 1 - Sep-2025 ===
* ER 2222 Update choice menu UI dropdown
* EW 2100 Text nodes default to flex_box_item: yes
* ER 2076 Redesign hierarchical choice menu popup when at the right edge of the diagram.

=== Fixed or implemented in ACP build 162 27 - Aug-2025 ===
* ER 2224 Update UI for input nodes with input field
* ER 2223 Add checkmark to Choice/Multichoice menus
* EW 2216 Fixed a crashing bug when pressing download wide csv
* EW 2212 For ACP server configuration - fixed a bug where All users are effected by the configuration flag "reviewersCanUploadDataFiles"
* EW 2199 Fixed a bug, when mousing over the copy button the hover balloon shows description instead.
* EW 2090 No tool tips for hover icons that appear when the object view is displayed in a tall/frame node

=== Fixed or implemented in ACP build 161 31 - July-2025 ===
* EW 2218 Rendering Issue in Some Models
* EW 2213 Cannot change from table to graph in framenode
* ER 2198 Add tooltip for the copy graph button
* ER 2183 Change hamburger menu to gear icon
* ER 2182 Updated connection status window style
* ER 2177 Make the actual menu show on mouseover instead of a tooltip (on the top bar)
* EW 2172 Upload button is enabled when reviewers cannot upload
* ER 2027 Implement label parameter for choice and multichoice
* EW 2218 Rendering Issue in Some Models
* EW 2213 Cannot change from table to graph in framenode
* 2198 Add tooltip for the copy graph button
* ER 2183 Change hamburger menu to gear icon
* ER 2182 Updated connection status window style to new tooltip styling
* ER 2177 Make the actual menu show on mouseover instead of the tooltip. (For the top bar)
* EW 2172 Upload button is enabled when reviewers cannot upload files.
* ER 2027 Implement label parameter for choice and multichoice

=== Fixed or implemented in ACP build 160 31 - July-2025 ===
Build 160 was not implemented- test build only

=== Fixed or implemented in ACP build 159 27 - June-2025 ===
* EW 2175 No filtering for input nodes
* EW 2174 No text filtering in choice modes in edit tables
* ER 2162 Change title of the message sent to new users.
* ER 2093 Allowing HTML in text nodes in ACP (partial implementation)
* EW 1938 ACP style library is not setting auto zoom correctly when added to a model with option to retain the styles
* ER 1180 Get Download CSV working better with tables with 3 or more dimension

=== Fixed or implemented in ACP build 158 22 - June-2025 ===
(A test build without any full implementation)

=== Fixed or implemented in ACP build 157 18 - June-2025 ===
* ER 2137 Ability to select MariaDB in the assets\DB driver info.ana library (For ACP server).
* ER 2108 UI changes - UI redesign part 1.
* ER 2108 UI changes - UI redesign part 2.
* ER 2108 UI changes - UI redesign - icon updates.
* ER 2108 UI changes - UI redesign - usertable updates.
* ER 2093 Allowing HTML in text nodes in ACP. (Continued)

=== Fixed or implemented in ACP build 156 3 - June-2025 ===

=== Fixed or implemented in ACP build 155 20 - May-2025 ===

=== Fixed or implemented in ACP build 154 9 - May-2025 ===
* ER 2093 Allowing HTML in text nodes in ACP. (Partial implementation for titles in text nodes)

=== Fixed or implemented in ACP build 153 17 - January-2025 ===
* EW 2135 Error when closing object window in a frame node to go back to the table view

=== Fixed or implemented in ACP build 152 30 - January-2025 ===
* 2133 Can not hide the Microsoft button for sign in
* EW 2129 Download indicator animation doesn't go away after download.

=== Fixed or implemented in ACP build 151: 16 - December-2024 ===
* ER 2127 Convert the Sql to mariadb compatible in the publish to cloud service model.
* EW 2126 Can't generate a valid email invite code with mariadb
* ER 2120 Update fonts in Change password form.
* ER 2119 Update fonts in Add Project page.
* EW 2115 ACP will not open model listing with Suan 6.5 in Apache.
* ER 2113 Change tooltips shown for the help and close toolbar buttons when viewed in the ACP portal.
* ER 2112 Add AcpStyles for controlling the max/min zoom for auto_zoom_diagram: yes.
* ER 2111 Update toolbar buttons for question mark, hamburger, and power button icons.
* 2109 In Portal's model listing, move Upload, download, delete, share buttons at the top rather than bottom.
* EW 2107 Variable, object, chance node titles are not vertically centered when they reside in a text node that is a Flex box.
* ER 2099 Add Min % and Max % for auto zoom in the Acp style library.
* ER 2096 Get arrows between nodes to show when using FlexBox display.
* ER 2065 Remove the Analytica logo in the add project dialog.
* ER 1852 Add Object_in_frame to the style library.

=== Fixed or implemented in ACP build 150: 5 - November-2024 ===
* ER 2095 Allow Microsoft login (when enabled) when no Google login is set.
* EW 2091 Hover icons in frame nodes can overlap the vertical scrollbar when viewing Object view.
* EW 2089 Hover icons in tall nodes can overlap the vertical scrollbar when viewing Object view.
* EW 2085 In object view, Table graph and other icons are too far to the right.
* EW 553 Col width not draggable and forgotten.

=== Fixed or implemented in ACP build 149: 15 - October-2024 ===
* EW 2083 Stop bounce back when resizing the height of a row header in an edit or result table.
* EW 2080 Problem with discrete slider in table when zoomed in a lot.
* ER 2078 Internal code change: clean up code in slider.js and remove the newZoom variable.
* ER 2067 Add a way to display messages to users based on what Chrome version they are using.
* EW 2061 Graph zoom in feature is too sensitive, graphs zoom when I just want to click a data point.
* EW 2060 Hover balloons in zoomed frame/tall nodes not appearing in right location, or appearing off screen.
* EW 2047 Stop bounce back when resizing a column in an edit or result table.

=== Fixed or implemented in ACP build 148: 8 - October-2024 ===
* EW 2081 The table of models in the portal is too narrow, it should have same margin on left and right hand sides
* EW 2064 ACP online docs in Help menu points to 'wiki...'

=== Fixed or implemented in ACP build 147: 30 - September-2024 ===
* ER 2077 Get input node that is a discrete slider working when auto zoom diagrams is on.
* ER 2075 Get input node with continuous slider control working with auto zoom.
* ER 2074 Choice input pulldown menu is in wrong location when diagram is zoomed.
* ER 2073 White screen crash when opening tab in heat pump model with auto zoom set.
* EW 2072 Some of the user interface panes don't fit the diagram.
* EW 2071 Items in askmsgchoice pulldown menu not selectable.
* EW 2069 Sliders are hard to adjust with Auto zoom
* EW 2068 Help balloons position is off when hovering over nodes when auto zoom diagrams is yes

=== Fixed or implemented in ACP build 146: 20 - September-2024 ===
* EW 2070 Add acpConfig flag to turning off "auto zoom diagrams" feature on a particular server.
* EW 2062 Wrong selection when you drag to select a portion of the graph for zooming.
* EW 2058 Data Balloon displayed when clicking on a graph that is zoomed is not working anymore
* ER 2043 Add a sign in with Microsoft option

=== Fixed or implemented in ACP build 145: 10 - September-2024 ===
* ER 2055 Edit the login screen so it looks better with Microsoft. And add a flag to turn this feature off.
* ER 2054 Add a tool tip for the 'Show Object' button that appears in frame and tall nodes
* EW 2053 When viewing object view in an embedded node, sometimes the outputs shows object_view_btn_acp.
* EW 2052 Button icon missing in object view for button inputs / outputs.
* ER 2051 Add support for pasting into body cells of selected row or column of table
* EW 2050 Error occurs when typing when a row or column is selected in a table
* ER 2049 Support copying selected row or column so it can be pasted e.g. into Excel
* EW 2048 Selected column showing dashed lines when selection line should be solid
* EW 2046 Resizing a row or column header should not result in the row or column becoming selected
* ER 2043 Add a sign in with Microsoft option
* ER 2042 Add a flag for turning off EW 2041, selecting rows and columns by clicking on header cells
* ER 2041 Clicking on a table row header or column header should select that row or column
* ER 2040 Show hand cursor when hovering mouse of analytica cube
* EW 2038 Tooltip from top toolbar remains after opening model
* EW 1816 In Object in frame/tall nodes, the inputs and outputs text is clipped at the bottom.
* ER 1761 Press and drag to select a cell range in an edit table

=== Fixed or implemented in ACP build 144: 10 - August-2024 ===
* EW 2057 Graph doesn't fit Frame node with auto zoom set.
* EW 2037 Node being highlighted when it should not be. Problem relates to nodes results being showing in a frame node on another diagram
* EW 2036 Flickering and sometime disappearing icons on right hand side of top toolbar - caused by turning off the caching of images.
* EW 2035 <code>'Press to add a new project'</code> tooltip remains after entering a module.
* EW 2034 Input node is highlighted when its original is being displayed in another module.
* ER 2033 Highlight nodes (that are not input/outputs) displayed in frame nodes, part 2, e.g. variable, decision etc.
* EW 2032 Edit table that is also a SubTable does not show in frame node when the form node is clicked (but does if the button is clicked).
* ER 2030 Add html meta tags to disable caching of index.html
* ER 2029 Turn off server side caching in Apache
* EW 2028 Crash on model open - ACP sessions log model
* EW 2014 Multiline table headers are displaying as a single line in edit and result tables

=== Fixed or implemented in ACP build 143: 1 - August-2024 ===
* The [[Choice#nestUnder_for_hierarchical_menus|nestunder for Hierarchical choice menus]] are enabled in this build.
* ER 2026 Added a tooltip for the [+] Add project button in the top toolbar (ACP Group accounts) [[ACP_Group_plans_for_Managers_and_Admins#The_Models_tab|more information...]]
* EW 2025 Not all items are listed in a multichoice menu after having filtering items previously.
* EW 2024 Add Project button in toolbar is not aligned with the Account and Project choice inputs
* EW 2023 In Hierarchical multichoice, ACP allows no items selected in submenu when allownone is not set.
* EW 2021 Choice menu selection doesn't stick. (this was a side effect of the nestunder implementation).
* EW 2018 Hierarchical choice menu does not display all items after making a choice with the textual filter. (This was a side effect of the nestunder implementation).

=== Fixed or implemented in ACP build 142: 19 - July-2024 ===
* EW 2019 Swap XY axis icon in frame node has no effect.
* EW 2018 Hierarchical choice menu does not display all items after making a choice. Also choice is not sticking.
* EW 2016 In Hierarchical multichoice, ACP allows no items selected when [[Multichoice#Parameters|allownone:]] is not set, shows 'All'.
* ER 2015 Highlight each node shown in Frame node(s) - input / output nodes.
* ER 2013 Enhancements and additions to the Close menu download option. Add popup with download link and change the text.

=== Fixed or implemented in ACP build 141: 12 - July-2024 ===
* ER 2012 Add 8 pixel left margin between table shown in ACP tabs and left edge of browser.
* EW 2011 Crash when hovering on choice input popup menu with hierarchical menus (Related to the new Hierarchical inputs implementation).
* EW 2009 Menu item in First level of Hierarchical choice menu not showing check mark when clicked.
* ER 2005 Hierarchical choice menu filtering, show items that match first level menu name or if sub menu item matches.
* ER 1997 Align description with title in frame/tall nodes.
* ER 1988 Auto zoom not correct in some models due to hidden ACP Styles library node.

=== Fixed or implemented in ACP build 140: 26 - June-2024 ===
* EW 2008 Choice Input nodes don't show the pulldown menu when clicked. (Related to the new Hierarchical inputs implementation).
* EW 2007 Diagram crash when clicking on multichoice input. (Related to the new Hierarchical inputs implementation).
* ER 2006 Get hierarchical choice inputs working for MultiChoice input nodes
* ER 2004 Hierarchical choice menus with multiple sub menus
* ER 2003 When filtering long menus, matches should include any substring present.
* EW 2002 Diagram crash using choice with sub-list.
* EW 1993 Swap x-y hover icon does not show for graphs displayed in Frame nodes.

=== Fixed or implemented in ACP build 139: 21 - June-2024 ===
* EW 1998 Some arrows are black when they should be white (certain arrows with no associated error class.)
* ER 1995 Hierarchical choice input menus - step 1 (The simplest case
* ER 1994 acpConfig.json flag for enabling or disabling choice drop down sub menus.

=== Fixed or implemented in ACP build 138: 1 - June-2024 ===

* ER 1990 Need a scroll bar for Object view in tall nodes when the attributes don't fit the available space.
* EW 1989 Clicking the object icon in a tall node table has no effect. (MultiChoice inputs in the table cells) .
* EW 1981 Choice menus in table cells don't show with the correct font size.
* EW 1978 flex items don't wrap for flex_direction: column.
* ER 1964 Implement vertical and horizontal alignment CPS for Flex Boxes
* ER 1965 Implement Flex_gap cps style for controlling number of pixels between FlexBox Items
* ER 1961 flex_wrap: wrap style with flex_direction: column

=== Fixed or implemented in ACP build 137: 22 -May-2024 ===
* ER 1986 Change the "display:flex" cps to be diagram/module level setting rather than a top level model setting
* ER 1982 Add 'Arial Narrow' to list of Sans Serif fonts in acpConfig.json because Karen/James are using it in the ACES model.
* EW 1977 Text Node within a Flex Box Item displays at bottom of flex box, but should not.

=== Fixed or implemented in ACP build 136: 14 -May-2024 ===
* EW 1980 Project pulldown menu doesn't show
* EW 1970 Auto zoom not working for a model.
* ER 1969 Embed List of Google Fonts provided by Karen.
* ER 1967 Add other usable browsers to the Sign in page.
* ER 1966 Turn off auto_zoom_diagrams when using FlexBox display.
* EW 1963 The order of the FloxBox items is different in ACP than in DTA, make it so it's the same.
* ER 1960 Give selected cells same background coloring as in Excel. Selected cells will have a gray background and the anchor cell will have a white background.
* EW 1939 Project pulldown menu shows in top bar when this model is running
* ER 1876 Select multiple cells by clicking on cell and dragging cursor to end cell,
* ER 1850 Stop showing red squiggle when entering a value into a cell. The red squiggle is spell checker indicating a bad spelling.

=== Fixed or implemented in ACP build 135: 27-Apr-2024 ===
* EW 1971 Lingering help balloons need to be closed with X button to clear them
* ER 1957 Add "Flex Wrap" cps style for diagrams with Flex Box display
* ER 1956 Add "Flex Direction" which can be used to change layout from row to column
* ER 1955 Flex Box layout. Clean up demo code and check in.
* EW 1953 Reduce cube appearances and cube flickering
* EW 1951 Can't cancel changes made to edit table in frame node
* EW 1950 Blinking caret remains in edit table cell after pressing Enter key
* ER 1946 Add filtering by date, sessions, unique users to the sessions log model.
* EW 1297 When pasting more than a few cells into ACP the spinning cube flickers on and off for a while

=== Fixed or implemented in ACP build 134: 17-Apr-2024 ===
* EW 1949 Table cell becomes deselected when clicked..
* ER 1948 For Tables, keyboard combo shift+ctrl+arrow key should select the entire row or column.
* ER 1947 For tables, keyboard combo ctrl+arrow should move the selected cell to the beginning or end of a row or column.
* ER 1944 Add Try / Catch block to AcpConfig.json to show an error popup if there's mis-spelled flags.
* ER 1911 With multiple cells selected, arrow keys reselects to a single cell in the direction of the arrow key as in Excel.
* ER 1910 Allow editing in the anchor cell with multiple cells selected.
* EW 1902 Extra items on the privilege list for the Subscription Administration project.
* ER 1823 Add periodic heartbeat message on websocket.

=== Fixed or implemented in ACP build 133: 9-Apr-2024 ===
* EW 1943 Node flickering while rendering the diagram, hidden nodes appear briefly then disappear.
* EW 1942 Slider control automatically changes value when it should not (after change from another slider).
* EW 1936 Can't enter " double quote into a cell after it is selected with a single click.
* EW 1934 An extra 'email' in the cue text for the email invite email address.
* EW 1933 Balloon help for the copy download button doesn't word wrap properly.
* EW 1931 Tall nodes don't work after font change.

=== Fixed or implemented in ACP build 132: 13-Mar-2024 ===

* EW 1929 Publish fails at sign in
* ER 1928 Detect whether someone is using a mobile device and add pop-up message.
* ER 1926 When you update a cell in ACP and hit enter, go to the next cell down, as in Excel and sheets.
* EW 1924 Table widths not the same in ACP as in DTA.
* EW 1920 Diagram hang - can't exit because of spinning cube.
* ER 1918 When editing a table cell, pressing tab should move cell selection to the next cell to the right.
* ER 1917 Configure ACP for connecting to a Domain controller over ldaps
* EW 1916 Default columns widths do not match DTA, they're a bit larger in ACP
* ER 1909 In top toolbar, change model title font from Arial to Century Gothic (w/ fallbacks)
* EW 1906 Crash after pressing sort icon in multitable
* ER 1905 Turn off sorting icon on edit multitables where it doesn't work.
* EW 1904 Text nodes with large title font are overlapped.
* EW 1815 Problem pasting cells from DTA tables into ACP tables

== Fixed or implemented in ACP build 131: 5-Feb-2024==

* ER 1914 Add not_even_slicers to the options for setting show index menus in the ACP Style library.
* EW 1899 Project showing for Individual account in ACP Toolbar in the Portal.
* ER 1895 Need a new message for firebase with email enumeration protection for new users or wrong password.
* ER 1890 Change Lumina.com links to analytica.com.
* EW 1843 Wrong word wrapping in a text node title. Not the same as 1837 which was implemented in build 127.

== Fixed or implemented in ACP build 130: 30-Jan-2024==

* ER 1892 Change Tech Support... to Report a bug or get tech support...
* ER 1890 Max: Change Lumina.com links to analytica.com
* ER 1889 Change position of the order icon so that it doesn't move the search bar on mouseover.
* ER 1888 Minor tweaks to the UI 25 Jan 24
** The triangle indicating pulldown menus looks a bit fuzzy - make it clearer.
** The icon that appears when you mouseover a column header should be neither forward nor backward sort, but unspecified (until you click it). Change to an icon with wider middle bar and narrower top and bottom.
*** Move that icon a tad further right from the header text "Model" etc.
** Remove the faint square around The '?' icon. (help ? menu icon)
* ER 1886 Add more space between the Analytica cube on the top bar and left of the first menu, similar spacing when running a model.
* ER 1885 Removed the downward triangle if the project or account pulldown menu has only 1 item, and removed the popup menu.
* ER 1883 Add tooltips for account name and project name pulldown menus on the new top bar.
* EW 1882 User name on the top bar with membership in only 1 project is inconsistent before and after opening a model.
* EW 1881 Long Project (or account) name overlaps the down arrow

== Fixed or implemented in ACP build 129: 22-Jan-2024==
* EW 1877 Missing choice pulldown menu on top left account name pulldown menu
* ER 1875 Make Arrow keys work in tables similarly to the way they work in Excel/Sheets
** Click on a cell (this is the "anchor" cell), then using arrow keys moves the selected cell e.g. a right arrow key moves the selected cell to the right.
** Hold down the shift key and press an arrow keys. This should expand (or contract) the selected cell region.
** Hold down the ctrl key and press arrow keys. E.g. Press right arrow key w/ ctrl key down. This should move the selected cell to the the row
* ER 1873 Single-click to edit cell: When you click on a cell in sheets/excel you can just type to edit. In ACP you have you double click on it to edit. c.f. 1845.
* ER 1871 ACP Portal change 6: Change ascending and descending triangles with three bars in Models listing table header
* ER 1870 ACP Portal change 5: Make model's listing (and User listing) table header vertically narrower
* ER 1869 ACP Portal change 4: Move 'Add Project' button closer to Project pulldown menu
* ER 1868 ACP Portal change 3: Make Home and Project pulldown menu triangles white open triangles
* ER 1867 ACP Portal change 2: Change color of border on Account and Project pulldown menus to light teal
* ER 1866 Portal changes 1: Move up text in Account and Project pulldown menus
* ER 1860 Portal Users tab:
** Title of button "Email invite" -> "Email invitation".
** Put a "+" in button "+ add users"
* ER 1859 The models table should stretch down to the top of the footer bar (with logos).
* ER 1858 The rest of the background of Users tab should be consistent mid gray, including behind section titles and buttons on the right side.
* ER 1857 Background of users table should be the same color as background of the models table.
* ER 1856 The heading bar for the Users table should be the same style (size, background color, font etc) as for the Models table.
* ER 1855 Tweaks to heading of Models Listing in portal.
** Move heading higher.
** Change background color, a slightly lighter gray background.
** Magnifying glass same size as search box.
* ER 1845 Make Edit table cells update when they are selected and someone starts typing. c.f. 1873
* ER 1783 Make UI simpler and more consistent with ACP model view.
** Move the account menu, and project menu (when relevant) to the teal bar in white Century Gothic 16pt, to replace the account name and project name that already appear there. Puts the account and project above the Models/account tabs, which is more logical.
** Reduce the vertical white space between teal bar and top of tabs (similar to model UI).
** Put a rounded rectangle thin gray line around sides and bottom of Models, Account, and Users views (similar to model UI).

== Fixed or implemented in ACP build 128: 8-Jan-2024 ==
* ER 1853 Make ACP3 Enhancements and fixes public, and link to the from the what's new page.
* EW 1849 Downloaded csv table was populating table with all ones for tall output node - only for certain tables.
* ER 1844 Update build number. Dropped 3.1 and added the build number to the sign-in page. Also moved the build number to acpConfig.json
* ER 1835 prevent user from clicking on anything other than ‘Cancel’ when cube is spinning

== Fixed or implemented in ACP build 127: 23-Dec-2023 ==
* EW 1838 Swap Axes icon didn't work in Safari desktop, shows a blue box with white question mark
* EW 1837 Wrong word wrapping in a Text node title.
* EW 1836 Pasting of cells does not work in edit table when data is larger than the available cells.
* EW 1833 After change password - no tabs visible
* EW 1832 Selection box is way off when clicking on a choice input cell in an edit table
* EW 1830 Blank warning message appears after entering blank value into edit table cell
* EW 1809 Crash when adding acp style library from hamburger menu - Web socket closes

== Fixed or implemented in ACP build 126: 18-Dec-2023 ==
* EW 1829 Error after deleting a value in a table cell.
* EW 1828 Heat Pump model is displaying some nodes with a serif font on Safari browser.
* ER 1825 Setup CSS font fallbacks for common Serif, Sans-Serif and Monospace fonts
* ER 1824 Setup CSS font fallback for Century Gothic to be Century Gothic, Avant Garde, Arial, San-serif
* EW 1819 Privileges table appears below Role menu in Users tab of Portal

== Fixed or implemented in ACP build 125: 5-Dec-2023 ==
* EW 1821 Horizontal scrollbar appears on Users tab of User Portal when it should not
* EW 1819 Privileges table appears below Role menu in Users tab of Portal
* ER 1818 When you copy it should give a little visual feedback.
* ER 1808 Align the top of the Alert text with the top of the tabs.
* ER 1767 Add UI response to hovering and clicking Inputs and Outputs in Object view
* ER 1763 A way to keep cells selected while scrolling in a table.
* ER 1762 When you paste a range into an edit table, it takes a while. It should show some feedback — e.g. dashed lines around the range — to show it is working.

== Fixed or implemented in ACP build 124: 25-Nov-2023 ==
* EW 1800 Slider labels overlap - auto scaling needs to be improved
* EW 1764 Pasting numbers with a "%" or "," pastes as text.

== Fixed or implemented in ACP build 123: 12-Nov-2023 ==

* EW 1807 Fix sliders so there's no "bounce back" in James' Single Family Load Predictions
* ER 1806 Add an alert asking people to schedule a meeting using Calendery
* EW 1805 Discreet slider doesn't work properly when diagram zooming is present
* EW 1804 Discrete slider in edit table doesn't update correctly when the track is clicked
* EW 1801 Crash after selecting checkbox to add a slider in a table.

== Fixed or implemented in ACP build 122: 8-Nov-2023 ==
* ER 1797 Get Object view working for frame nodes and tall nodes that contain edit tables
* ER 1796 Get Object View working in tall output nodes
* EW 1792 Pasting into an edit table causes slow down of ACP
* ER 1790 Add hover icons to Object view when displayed in a frame/tall node
* ER 1788 Get Object_in_frame style working correctly at model level and node level
* ER 1787 Put thin line at top in Top_diagram_only style (and no hierarchy bar)
* ER 1782 Add a way to alert ACP users to new releases and other ACP-relevant information
* ER 1771 Show Underline of clickable variable names when the cursor is anywhere over the variable name.
* ER 1757 Move “Remove” to last item in the Role menu and reorder them in decreasing power.

== Fixed or implemented in ACP build 121: 18-Oct-2023 ==
* ER 1786 Show Object icon button in frame/tall nodes, part 1 if ACP Style Object_in_frame is present
* ER 1770 Strange message while drawing graph
* ER 1759 Distribution popup. Remove close button. Add padding to rhs of description text area between wrapping text and scroll bar. Align left edge of Distribution pulldown with description. Make parameters input wider.
* ER 1755 Add click feedback to graph hover icons, make them smaller when clicked
* ER 1753 Improve appearance and positioning of Close (x) button use in ACP popup dialogs
* EW 1752 Top of pulldown menu and text box in Distribution Popup are cut off sometimes.
* EW 1751 Fix word wrapping problems in Description box of Distribution popup
* EW 1750 Crash when clicking Sequence input node button
* EW 1748 UI seems to crash after clicking on node
* ER 1697 Implement copy / paste from edit table to edit table
* ER 1696 Pasting of cells does not work in edit table when data is larger than the available cells.
* ER 1632 Add graph hover icon for swapping horizontal and vertical axes.

== Fixed or implemented in ACP build 120: 4-Oct-2023 ==
* EW 1773 ACP Sessions log model shows repeats the first model of a session for every model run of the session.
* EW 1749 Self-Choice is MultiTable not using array-valued domain in ACP
# ER Address vulnerabilities reported by Guidehouse from their scanning tool.
* EW 1746 Some input node formnode buttons still showing border when they should not
* EW 1745 Input node defined as sequence with Icon style not showing icon
* EW 1741 Update fav icon (icon that shows in chrome tab) to match that used in analytica.com
* EW 1737 Don't show full path to users' files in file system error messages.

== Fixed or implemented in ACP build 119: 23- Sep-2023 ==
* ER 1739 Add a confirmation message box when uploading a file that has the same name as a file present in the folder.
* ER 1735 Formnode border color should match original node when using 'flat' button style
* ER 1734 Don't show border of formnode buttons when using Flat button style and original node has no border.
* EW 1732 Can't upload an update to existing file using Publish to Cloud or User Portal
* ER 1731 Table cells should be vertically aligned to "top" and not "center" by default, same as DTA
* ER 1730 Make mutliline text cells have text left aligned, same as DTA
* EW 1729 unexpectedly small limit on # of simultaneous heat pump calc instances
* EW 1727 Table width doesn't fill out frame node.
* EW 1726 Pressing the Autoscale icon changes from Log to Linear scale, and is irreversible - you can't get back to where you started.
* EW 1712 Error when opening Suan Account admin in ACP
* EW 1709 Numbers with dollar sign number format paste as text into edit table
* EW 1682 Choice controls using an array-valued computed domain don't update when computed domain changes.
* ER 1652 Flat button style
* EW 1636 Output node uncertainty menu appears a long way from the node when clicked
* ER 1296 Numbers with dollar signs should paste as numbers (not text)

== Fixed or implemented in ACP build 118: 22- August-2023 ==
* EW 1722 Error messages appearing, User Portal file list not showing.
* EW 1729 Cursor remains a hand when not hovering over a link in the email invite status message.
* Ew 1719 Add space before and after the number model runs remaining in the status message in Premium group account.
* EW 1718 stray numbers in the account tab when count model runs is turned off.
* EW 1716 Graph zoom shows blank graph
* EW 1715 In Portal Models listing, if you click on an xlsx or xlms file, ACP tries to open it and hangs
* EW 1714 Upload dialog is only showing .ana files initially, but it should include xlsx, txt and csv
* EW 1710 Mis-aligned text in the Account tab for purchased credits (depends on user name)
* EW 1671 The Calc button on formnodes not working (at least in this model).

== Fixed or implemented in ACP build 117: 2- August-2023 ==
* ER 1708 ACP Model Runs.ana top diagram not showing in ACP due to frame node issue
* ER 1707 Allow Gravelroad to have 10 users even after changing the limit to 4 users for Group accounts.
* ER 1706 Use purchased credits when launching a model evite.
* ER 1705 Count purchased credits when launching a model in ACP Portal.
* ER 1704 Count purchased credits when launching a model in ACP Portal.
* EW 1702 ACP hangs on MTAIR model.
* EW 1699 A certain [calc] button doesn't calc when clicked.
* ER 1691 When creating a project, the cursor should be automatically placed in the project name input field
* EW 1690 Cells in a table with Cell fills don't paste values into an edit table.
* ER 1689 Add the [Credit Sales] table creation to the Create Suan DB.ana model file.
* ER 1687 Add Table [Credit Sales] to Suan Subscriptions database on Suan-stage and acp.lumina.com.
* EW 1686 When a user has just one subscription, there should be a space between the colon and the subscription name.
* ER 1684 Provide feedback when 'Sign up' button is pressed on log in page.
* EW 1683 In Account tab of User Portal, Account choice pulldown menu is not aligned properly.
* ER 1681 Remove [Number of credits used] column the Credit Sales table in the Suan database.
* ER 1680 Change "session credits" to "model run credits" in in status messages in 'Launch eVite.ana'.
* EW 1678 Out of session credits Message contains a link which is formatted as text and non clickable.
* ER 1677 Move model run limits from Session Limits to Model Run Credits.ana.
* EW 1675 With 0 sessions remaining, the account tab show a blank area next tothe number os sessions remaining.
* ER 1663 Change "Session credits" to "model runs" in ACP UI and message boxes.

== Fixed or implemented in ACP build 116: 6- july-2023 ==
* EW 1693 Style library sets top tabs when added as default instead of outline
* EW 1676 Some url encoded keys are not supposed to be passed into ACP for security reasons.
* EW 1673 Sometimes model doesn't launch when file name is clicked in model listing.
* ER 1597 Pass data on URL query string to model.

== Fixed or implemented in ACP build 115: 29- jun-2023 ==
* EW 1670 Hide Definitions still doesn't hide them when set at the module level.
* ER 1669 Don't enforce model run limits when opening an invite for Lumina accounts and lumina.com accounts
* EW 1668 A hidden definition can be viewed (e.g., in the Object tab) in ACP.
* EW 1667 Graph shown ACP1 Graph tab is a little too short initially.
* ER 1664 Move model runs limits (session credits) from acpConfig.js
* ER 1661 Change ACP "Sessions" to be same as "Model runs"
* EW 1658 Images in nodes in Txc example model exceed the nodes' borders
* ER 1657 Create new flag for turning off counting of session credits
* EW 1656 Number appears below Models Listing after pressing Email Invite button
* ER 1654 Don't show hidden modules as Top/Side navigation tab
* ER 1653 Show Session Info for Individual accounts in the User Portal's Account tab
* ER 1651 Add exclusion to the Lumina group account and lumina.com individual accounts to enforcing session limits
* ER 1649 Add warning messages when number of sessions is getting low
* ER 1648 Limit file upload sizes for Individual, Group and Group Premium plans in User Portal
* ER 1642 Limit session credit usage for Individual accounts, same as is already done for group accounts
* ER 1641 Update message shown to users when they have exhausted the accounts session credits.
* ER 1639 Enforce session credit limits when opening an invite in account that has reached its limit
* EW 1637 Sessions are not decremented when this model is launched.
* EW 1630 With top tabs, outliner, and no frame/tall node, graph is too tall
* EW 1574 After Publish to Cloud from DTA, model should open in ACP (but does not)

== Fixed or implemented in ACP build 114: 17-May-2023 ==
* EW 1668 Hidden Definitions aren't hidden
* EW 1666 In the ACP sessions model, when you set subscr to ‘All’ it gives this error message.
* ER 1631 Add a warning message for people using ACP in FireFox, advising them to use Chrome.
* ER 1628 Show the number of sessions remaining for a group account in the User Portal.
* EW 1627 Text alignment wrong for some rows in result table in Max's Enterprise model.
* EW 1626 Max: Get delete projects working or remove button.
* ER 1625 Many table cell formats styles are not yet in ACP.
* ER 1623 Remove the link to the ACP and Lumina terms of use agreement
* ER 1618 When opening a model (evite), make it just one progress bar for the Reading Model File and Checking Definitions.
* ER 1617 Make progress bar wider.
* ER 1616 Input and outnode node buttons appear briefly and are then replaced by icons.
* ER 1615 Update the lumina logo on the model listing's footer to the new style
* EW 1614 A model with a quote in the file name throws an error when pressing email invite.
* ER 1612 Update logo colors in loading screen.
* EW 1589 Can't add email invite addresses with a + sign in the address.
* ER 1514 Ability to select across multiple rows from result tables.
* EW 1453 Scalar user output nodes with dates won't show result.

== Fixed or implemented in ACP build 113: 28-Apr-2023 ==
* ER 1611 Old Analytica logo on sign-in page
* ER 1610 Give ACP Portal tabs the same hover and click feedback that tabs "Tabs across the top" has.
* ER 1609 Update Icon in Title Toolbar
* ER 1608 Enforce session credit limits when opening a model the user portal
* EW 1606 Using slider in edit table crashes ACP
* ER 1605 Add configuration settings to AcpConfig for max number of users allowed in Basic and Premium plans
* ER 1603 Exempt 'Lumina' premium group plan from the new limits on number of users
* ER 1601 Round bottom corners of diagram when outline is showing
* EW 1600 slider control non responsive in frame node edit table cell
* ER 1598 When clicking on input node with numeric % format, select only the digits as DTA does.
* ER 1596 When a group account has reached its limit of users, show informative message when the 'Add users' button
* ER 1594 When double- clicking on a table cell to edit a number, select the digits, same as DTA in browse mode
* ER 1591 Limit number of users for Basic Group Accounts and Premium Group Accounts
* ER 1310 When entering edit mode for an edit table cell, have the current contents become selected.

== Fixed or implemented in ACP build 112: 13-Apr-2023 ==
* EW 1595 When logged in with auth string. new invitees get the authstring in their invite email
* ER 1587 Give hover feedback when mousing over buttons in Users tab or ACP portal

== Fixed or implemented in ACP build 111: 1-Apr-2023 ==
* EW 1586 Multichoice Filter Crash
* EW 1584 Continuous slider not working well when using auto_zoom_diagrams: yes
* EW 1581 Bottom rhs Lumina logo partially off screen when viewing table/graph w/ top tabs
* EW 1580 There should be a white margin to right of the diagram/tabs area to match the white margin to left of the Outline area.
* ER 1579 Bottom corners of diagram area should be rounded to match bottom corners of Outline area
* ER 1578 Change background color for selected item in the outliner
* ER 1577 Bottom of diagram area should align with bottom of Outline area
* ER 1576 Make top/side module tab title font white when tab has a dark background color.
* EW 1575 Cells with percent format don't enter the way Hadi wants it for heat pump model (back to ie 20= 2000%)
* EW 1572 Wrong parent tab is shown when changing to another diagram by clicking on output variable.
* EW 1571 Table does not pivot correctly when index menu pivoter is changed.
* EW 1569 Slider labels do not show with style lablesbelow
* ER 1567 Add the model file name to the help balloon that appears when you hover over the title in the toolbar
* ER 1565 Remove internal borders from cell selection in edit tables.
* EW 1357 Cell border remains highlighted after clicking outside the edit table

== Fixed or implemented in ACP build 110: 1-Mar-2023 ==
* EW 1560 Error selecting a file in the model listing.
* EW 1558 Error message with new ACP account.

== Fixed or implemented in ACP build 109: 18-Febuary-2023 ==
* EW 1546 Enhance json returned by useObjAtt(oid, "_sliderState") to include number formatting and tick marks

== Fixed or implemented in ACP build 108: 16-Febuary-2023 ==
* EW 1555 No messages when clicking the sign up button.
* EW 1553 No feedback when clicking the Get a new password button. (And other buttons on the sign in page.)c.f. 1555
* ER 1549 Change setVal for _sliderState to accept an array of vals/pos(s) for sliders in edit tables.
* EW 794 Arrows show between modules when top tabs nav style is used

== Fixed or implemented in ACP build 107: 13-Febuary-2023 ==
* EW 1552 Warning about password field exposes user's password.
* ER 1551 Node titles not wrapping when they should, in this case no spaces in the title
* ER 1548 Get setVal working for discrete slider input nodes.
* EW 1544 Showwindow() not working for definition window
* EW 794 Arrows show between modules when top tabs nav style is used

== Fixed or implemented in ACP build 106: 7-Febuary-2023 ==
* EW 1550 There should be a message box w/ caption "Standard ACP Settings?" after adding style lib
* ER 1543 Make Download this model option off by default
* ER 1542 Implement the "Labels Below" style for discrete slider input nodes
* ER 1539 Implement input node control that is a slider with two thumbs (discrete)
* ER 1537 Implement input node control that is a slider with two thumbs (continuous)
* ER 1535 Sliders with first and last options labels at ends for discrete sliders

== Fixed or implemented in ACP build 105: 21-January-2023 ==
* ER 1534 Implement 'Discrete single thumb' slider for slider input nodes
* ER 1533 Sliders w/ lower bound and upper bound labels "At Ends"
* EW 1529 Slider state update does not appear to be working when using useObjAtt(oid, "_sliderState");

== Fixed or implemented in ACP build 104: 19-January-2023 ==
* EW 1532 Arrows below initial scroll view don't display.
* ER 1531 Complete thumb shapes for sliders i.e. Block, Line, Diamond shapes
* EW 1529 Slider state update does not appear to be working when using useObjAtt(oid, "_sliderState");
* EW 1528 useObjAtt(oid, "_sliderState") returns malformed JSON when slider has two thumbs
* ER 1527 Implement "Needle" and "Rectangle" thumb shapes for sliders
* ER 1526 Slider w/ no thumb
* EW 1524 allow_model_download:false / show_menu_download:no causes extra line '0' in close menu.
* ER 1523 Continuous single thumb slider w/ circular thumb

== Fixed or implemented in ACP build 103: 15-January-2023 ==
* ER 1522 For large tables, implement a way to get a totals cell using useQuery({req: "cell" ...})
* ER 1520 Rename ACP Style controlling the appearance of the "Download Mode" menu option in the toolbar
* ER 1519 Move "Download model" menu options from Hamburger menu to the Save/Close menu
* ER 1518 Add "Download model" menu item to the hamburger menu
* ER 1517 Add click feedback for Hamburger and Close menu items
* ER 1516 Have diagram tabs zoom out to match auto zoom of diagrams
* EW 1513 List output node not showing "List" on its button when set to text
* EW 1510 useQuery(req: "cell"...) no longer working, always returns undefined

== Fixed or implemented in ACP build 102: 13-December-2022 ==
* EW 1508 ACP white screen crash when double clicking on date in edit table

== Fixed or implemented in ACP build 101: 7-December-2022 ==
* EW 1504 Can't upload and overwrite a model
* EW 1502 Description Balloon not showing for graph in tall node
* EW 1501 Lingering description balloon
* EW 1497 List input node not showing icon when it should be
* EW 1494 Show help balloon for frame node table/graphs when show_description: 0 is present
* EW 1477 Come up with a way to change uncertainty view for atomic output nodes

== Fixed or implemented in ACP build 100: 23-November-2022 ==
* ER 1496 If model using Century Gothic diagram font, and that font is not present, then use 'sans-serif'
* EW 1495 Get help balloon close button working to handle lingering balloons
* EW 1489 Model crashes after editing a table cell
* EW 1488 Help balloon not showing in tall nodes when show_description: 0/no is set at the model level

== Fixed or implemented in ACP build 99: 17-November-2022 ==
* EW 1487 Add close button to help balloon just in case it lingers.
* EW 1486 White screen crash when viewing large table from Bayer model.
* EW 1485 Large table crashes with Table truncation.
* ER 1484 Merge Lonnie's and Fred's large table truncation ERs.
* ER 1482 Add choice list filtering for long multichoice inputs.
* ER 1481 Change how percent cells are updated in edit tables (e.g. 20 = 20% not 2000%).
* EW 1475 Self-Choice in table doesn't work with array-valued domain.
* EW 1470 No indication that the model is still loading loading (while csv i is being read).
* ER 1468 ACP API enhancements for Slider controls.
* EW 183 Cell formatting doesn't work in header cells.

== Fixed or implemented in ACP build 98: 31-October-2022 ==
* ER 1474 Move white list of allowable upload types to acpConfig.json
* ER 1472 Give click feedback to button nodes
* ER 1471 Give click feedback when clicking form node buttons e.g. make text white

==Build 97 - skipped - same as build 96==

== Fixed or implemented in ACP build 96: 21-October-2022 ==
* EW 1465 Don't show message box twice about updating to latest version of style library
* ER 1464 Only show choice menu filter when the menu has more 10 items.
* ER 1463 Add choice input filter feature for choice input nodes
* ER 1462 Don't show message about replacing ACP Style Lib twice
* ER 1461 Truncate large tables - interim solution - This is what we did in ACP1 and no complaints.
* EW 1460 rhs border of hierarchy stripe and diagram don't match
* EW 1457 Help Balloon lingers when using choice input
* EW 1455 Result table column is too narrow

== Fixed or implemented in ACP build 95: 8-October-2022 ==
* EW 1450 Pressing Email Invite button causes white screen in models listing
* EW 1448 Can't upload .xlsx file
* ER 1447 Add mouse feedback for msgbox() dialog buttons
* ER Add mouse feedback to close button on Connection Status dialog
* ER 1445 Only allow certain files types to be uploaded in the user portal
* ER 1444 When ACP web socket connection is closed, provide feedback and reconnect
* EW 1443 Remove new line characters in title for formnodes
* ER 1440 No response when you click Download button in portal models listing
* EW Cannot show probabilistic result for distribution - model specific.
* EW 1275 Users can upload other types of files
* EW 1263 Title wraps too soon in form node labels sometimes.

== Fixed or implemented in ACP build 94: 26-September-2022 ==

* ER 1436 Add click feedback and close popup menu when 'download csv' is clicked
* ER 1435 Download CSV should show wait icon
* EW 1434 Tooltips not working for top toolbar or icons in embedded notes
* EW 1335 Header is squashed in edit table without title showing

== Fixed or implemented in ACP build 93: 23-September-2022 ==
*
* EW 1422 Units of Embeddded edit table in wrong location
* EW 1428 Add vertical scroll bar to help balloon when text doesn't fit
* EW 1430 Can't switch to pdf table from graph in frame node.
* EW 1431 Top of Help Balloon is too high, off top of screen

== Fixed or implemented in ACP build 92: 18-September-2022 ==
* EW 1423 Error when opening Cory's model
* ER 1425 Add feedback when clicking on model name in portal's model listing

== Fixed or implemented in ACP build 91: 15-September-2022 ==
* EW 1407 W/tall output node X + Frame node, X should not appear in Frame node.
* EW 1421 Error when trying to download csv of Cory's edit table

== Fixed or implemented in ACP build 90: 14-September-2022 ==
* EW 1417 "Error occurred while processing query" message appears when viewing tables
* ER 1416 Have a double click open a choice input inside an edit table

== Fixed or implemented in ACP build 89: 14-September-2022 ==
* EW 1415 Bayer model: Suan crashes when changing project status to deleted.
* EW 1414 Suan crashes when deleting a case in the Bayer model
* EW 1413 Long Index values extend outside the slicer text Fields.
* EW 1411 No spinning cube indication of ongoing calculation for framenode.
* ER 1405 Add Filtering capability for choice inputs (initially in edit tables)
* EW 1393 Probabilistic results not showing up in Car Cost model. (For non-prob variable)

== Fixed or implemented in ACP build 88: 31-August-2022 ==
* ER 1404 Choice input in edit table cell, make clickable region highlight on mouse hover.
* ER 1403 Choice input in edit table, expansion of the sensitive area around the menu triangle.
* ER 1401 Show a message when selecting a probabilistic result for a non-prob node.
* EW 1400 Can't change projects/accounts.
* ER 1392 Lists should show as a single list not repeated in a table

== Fixed or implemented in ACP build 87: 26-August-2022 ==
* EW 1399 In ACP1 tabs, click on graphs doesn't show graph data point balloon.
* ER 1398 Don't show non prob views for non prob variables
* EW 1397 Prob view selector pulldown doesn't work in tall nodes for graphs.
* ER 1395 Message boxes should be centered on the browser screen
* ER 1387 Reload ACP style lib option in hamburger menu
* ER 1354 Prompt user to save model when closing model

== Fixed or implemented in ACP build 86: 15-August-2022 ==
* EW 1386 After adding style library from hamburger menu, model listing does not show when closing model.
* EW 1381 Unresponsive Spinning cube after closing a model (caused by fix for EW 1367).
* ER 1367 Add feedback when closing model because sometimes takes a long time.

== Fixed or implemented in ACP build 85: 28-July-2022 ==

* EW 1382 Show effects of multichoice selections as they are clicked . (Or choice input popup displaying wrong menu items when clicked after updating another dependent choice/multichoice input.)
* EW 1380 Don't show message "This cell can't be edited" for cells in a result table.
* ER 1379 When you copy a selected cell with a choice menu, it should copy the value selected in the menu (text or number).

== Fixed or implemented in ACP build 84: 22-July-2022 ==

* ER 1377 Give choice input cells a green selection border when clicked
* ER 1376 Pasting copied cell into selected cells in an edit table
* ER 1375 Help menu should display options when reportissue.vbs is not present. All but Tech support.
* ER 1374 Style library - move save frame views to the esoteric styles module.
* ER 1373 Change UX for 'Save as' dialog when overwriting existing files
* ER 1372 Users portal, change 'Not member' menu option to 'Remove'
* ER 1371 Display "This field can't be edited." when someone double clicks on a read only edit table cell
* ER 1370 Give read only cells in edit tables a gray background
* ER 1367 Add feedback when closing model because sometimes takes a long time
* ER 1366 Add time to "Save date" column in Models listing in Portal
* EW 1365 Remove excess corners from gray highlight on mouseover of Frame
* ER 1364 Too much information when loading and checking a large model
* ER 1323 change choice menu opening for edit tables so it only opens on arrow click
* EW 1287 Images should not be paste-able in edit tables.
* EW 1286 JavaScript crash when result in output node is an image

== Fixed or implemented in ACP build 83: 5-July-2022 ==
* ER 1363 Change behavior for ctrl+a when deselecting items in multichoice input. When all elements are selected, make Ctrl+A, unselect all, and select the item the cursor is hovering on at the same time.
* ER 1361 For multichoice input nodes, move "First only", "All" and "None" to top of listing.
* ER 1360 Column is too wide in a result table (FWB: But the column header needs space for the index name, totals icon and sort icon).
* EW 1359 Text does not fit in text node.
* ER 1358 Syntax errors etc should not ask if you want to edit the Definition.
* ER 1356 Add tool tips for logos in the footer
* ER 1374 Max' Style library update - move save frame views to the esoteric styles module
* DTA ER 20520 - Max' Style library update - Add the remove save menu options to the Style library

== Fixed or implemented in ACP build 82: 27-June-2022 ==
* EW 1355 Cannot make a user 'not a member' of a project
* ER 1353 Prompt user with message box when attempting to save a model with the same name as an existing model
* EW 1350 Strange and inappropriate error message when saving file.

== Fixed or implemented in ACP 3.1 build 81: 25-June-2022 ==
* EW 1352 Asking to save changes before opening a model
* ER 1349 Make footer larger and increase size of Lumina logo in footer
* ER 1347 For tall text input with control on left, align title with text area
* ER 1346 Remove "List" from ACP permissions table
* ER 1345 Make text input background white (not color of original node)
* ER 1344 Redo 1332 When using ShowWindow() to switch diagrams, update selected top/side tab
* ER 1343 Increase the wait time to show a balloon from ~0.5 seconds to 1 second
* ER 1340 Add drop shadow to help balloon
* ER 1339 Remove 'Disconnect' and 'Sign out' buttons from Connection Status dialog
* ER 1338 New 'All', 'None' and 'First only' options for multichoice inputs

== Fixed or implemented in ACP build 80: 9-June-2022 ==
* EW 1337 CellFont(underline:true) doesn't work, bad JSON
* EW 1334 Green check and red X button show in result graph

== Fixed or implemented in ACP build 79: 8-June-2022 ==
* ER 170 Implement the cell-level formatting feature, CellOnClick.

== Fixed or implemented in ACP build 78: 7-June-2022 ==
* ER 1332 When using ShowWindow() to switch diagrams, update selected top/side tab
* ER 1330 Add '+ Add' button to list editing dialog

== Fixed or implemented in ACP build 77: 4-June-2022 ==
* ER 1329 Get 'Download CSV' working for Edit Tables
* ER 1328 Show the Download/Copy icon for edit tables
* ER 1327 Show Index Menus icon for edit tables
* ER 1325 Get copy from edit table working
* ER 1324 Change border for selected cell in tables
* ER 1322 Show help balloon for Tall Nodes

== Fixed or implemented in ACP build 76: 26-May-2022 ==
* ER 1321 When displaying the result table for an Index, make row headers blank
* ER 1320 New ACP Styles setting "Add_help_menu_option"

== Fixed or implemented in ACP build 75: 22-May-2022 ==
* ER 1319 New ACP Styles Remove_help_menu_options
* ER 1318 Add [X] button to Connection Status popup
* ER 1317 Add tooltip for A cube, and show web page when clicked
* ER 1316 Add “Status” window as option in ? instead of an icon that shows up when you click the “a” cube
* EW 1315 Cannot see port number completely in Server Connection popup
* ER 1313 Tool tips for top toolbar elements
* EW 1312 Tall inputs should not use bold font for title
* EW 1311 Error message when trying to download Last 1000 Sessions table as csv
* ER 1309 Change edit table UX for editing cells to double click
* ER 1308 Update users permissions table

== Fixed or implemented in ACP build 74: 11-May-2022 ==
* EW 1307 Make pasting cells into an edit table work using ctrl+v after a single click on a cell
* EW 1305 Add a black border or outline to edit table cell when clicked (single click)
* EW 1304 Get ride of clipboard icon in edit table cells
* EW 1279 Diagram crash when hierarchy is turned off while using Style library in orphans

== Fixed or implemented in ACP build 73: 3-May-2022 ==
* EW 1303 Error when adding users
* EW 1299 Can't send email invite
* EW 1265 ReadBinaryFile doesn't prompt user to upload a file

== Fixed or implemented in ACP build 72: 31-Apr-2022 ==
(This build mostly is js code added to implementatons still in progress so we can check it)
Add a flag to acpConfig.json for turning off clipboard icon in edit tables
* EW 1298 PG&E server: Cannot create FileSystemObject error when deleting file.
* ER 1292 Add a flag to acpConfig.json for turning off clipboard icon in edit tables

== Fixed or implemented in ACP build 71: 29-Apr-2022 ==
* EW 1293 Chrome times out after 60 seconds
* EW 1288 Suan.exe displays "Accept licensing terms" dialog even though server.config has DesktopUI=0
* EW 1285 Binary Data terms display incorrectly
* ER 1283 ER: Limit zooming of diagram to a factor of 2 -- i.e. down to 50% or up to 200%. If it doesn't fit at 50% it should show scroll bars.
* ER 1273 Cory: Don't show model model internals when someone clicks Cancel
* ER 380 ReadBinaryFile() and ReadImageFile() upload capability.

== Fixed or implemented in ACP build 70: 19-Apr-2022 ==
* EW 1284 Error in the Chrome developer tools console when using apache auth.
* EW 1278 Change "auto zoom" ACP Styles setting again "auto_zoom_diagrams: yes" or "auto_zoom_diagrams: no"
* EW 1264 Edit table's accept and cancel buttons in wrong location
* EW 1165 Tabs should respond to mouse-over and click
* EW 1160 Auto Zoom diagram
* EW 783 Mis-spelled Acpstyle causes diagram not to load
* Analytica EW 20510 Add Acp styles auto_zoom_diagrams and hide_save_button to the Acp styles library

== Fixed or implemented in ACP build 69: 18-Apr-2022 ==
* EW 1277 Implement hide_save_button ACP Style for Cory
* EW 1276 Can't go back to the main model from styles library in orphans if top tabs selected.

== Fixed or implemented in ACP build 68: 17-Apr-2022 ==
* EW 1272 Change CPS Style for auto zoom and remove acpConfig.json setting for auto zoom.
* EW 1267 Get OnClick working for top/side tabs

== Fixed or implemented in ACP build 67: 15-Apr-2022 ==
* EW 1271 Add CPS Flag to turn on/off auto zoom feature
* EW 1270 Add flag to acpConfig.json for turn on/off the ability of reviewers to upload data files
* EW 1269 Allow reviewers to upload spreadsheets and text files
* EW 1262 Help balloons inconsistent for icons in Frame nodes
* EW 1255 Graph/Table icon tooltips position bad part 2

== Fixed or implemented in ACP build 66: 12-Apr-2022 ==
* EW1260 ACP hangs when pressing buttons in Heat Pump model

== Fixed or implemented in ACP build 65: 8-Apr-2022 ==
* EW 1259 Suan.exe won't launch on Server 2012. SetThreadDescription error.
* EW1258 Inputs/Outputs popup location is off with zooming
* EW1256 Slicer popup menu location off when zooming
* EW1255 Graph/Table icon tooltips position bad part 2

== Fixed or implemented in ACP build 64: 6-Apr-2022 ==
* EW 1249 Multiple Suan Server processes for robustness.
* EW1256 Restart crashed or hung suan processes and do ping check programatically.

== Fixed or implemented in ACP build 63: 31-Mar-2022 ==
* EW 1248 Mouse over table/graph highlights title region of frame/tall node
* EW 1245 Help Balloon tail not correct for Top Tabs
* EW 1243 Choice popup location bad when control is on right hand side of the diagram
* EW 1242 Choice popup menu location still bad for choice inputs in embedded edit tables
* EW 1240 Choice popup in wrong location when located in the bottom of the screen.
* EW 1236 With nodes located at bottom of diagram, help balloon tail needs to be adjusted
* EW 1235 Help balloon location is bad with nodes on right or bottom of diagram
* EW 1233 Auto zoom leaves a wider space than necessary when a non visible module node is present.
* EW 1218 Graph clicks not working correctly when zoom effect is present

== Fixed or implemented in ACP build 62 : 21-Mar-2022==
* 1244 Tab for top diagram doesn't show initially when opening style library from hamburger menu (in this model)
* EW 1237 Minor typo in tooltips for copy table icon.
* EW 1235 Help balloon location is bad with nodes on right or bottom of diagram
* EW 1230 Put a tail on help balloons.
* ER 1226 Refinement to tooltip for copy/download icon.
* EW 1223 Choice input popup menu location is incorrect with auto zooming feature
* EW 1222 Graph zooming not working as desired when autozoom is on
* EW 1220 Help Balloon location off when diagram is zoomed.
* ER 1216 Have "auto zoom" feature zoom in and out.
* ER 1215 Increase right and bottom margins when using autozoom.
* ER 1213 Have top/side and toolbar tabs show a white background when clicked.
* EW 1212 side tabs looks bad
* ER 1207 Implement tab color change on mouse over for side tabs
* ER 1041 Get blue links to variables working (Fixed as a side effect before build 62).
* W 911 Blue links to nodes should work or not be blue. (Fixed as a side effect before build 62).

== Fixed or implemented in ACP build 61 : 10-Mar-2022==
* EW 1229 Styles library sets show_description: No instead of show_Description: 0
* EW 1225 ACP styles library has mix-matched settings for defaults, Also residual bad settings for some nodes.
* EW 1221 Style library from hamburger menu is not presetting styles correctly
* ER 1209 Change copy/download icon again
* EW 1208 Tooltip for uncertainty view pulldown menu is not showing useful text
* ER 1207 Implement tab color change on mouse over for side tabs
* ER 1204 Have Top/Side tabs change color on mouse hover (top tabs for now)
* ER 1203 Have toolbar tabs change color when mouse is hovering over them
* ER 1202 Add tooltip for Uncertainty View selector
* EW 1201 Copy download graph/table font is too big. And partly covered up
* ER1200 Add tooltips for table/graph icons
* ER 1199 Click response for icon buttons
* EW 1198 Tall Graphs don't show sometimes. Calculations showing continuously in dual interface

== Fixed or implemented in ACP build 60 : 8-Mar-2022==
* ER 1199 Click response for icon buttons
* ER 1197 Add flag to acpConfig.json for turning on or off the new Auto Zoom feature
* ER 1196 "auto zoom" for diagrams
* ER 1194 Model's saved should include '.ana' extension
* EW 1193 Minor layout problem with Model Listing view
* EW 1192 Borders on Hierarchy Strip are too wide
* EW 1191 Two_top_tabs or Two_side_tabs cause warning when loading style library
* EW 1183 Error with 'Download CSV' when there's no row index.
* EW 1179 Get Download CSV to include row and column headers
* EW 1177 Don't show 'Download CSV' menu item for atomic result
* EW 1175 Download csv throws error without column index
* ER 1161 Change copy icon to a downward pointing arrow

== Fixed or implemented in ACP build 59 : 21-Feb-2022==
* EW 1188 Problems with Style Library - Not ready for import, and wrong tabs in top tabs.
* EW 1173 Copy table buggy behavior with totals and cell fills
* EW 1171 Incomplete Acpstyle causes blank screen when model is opened
* EW 1170 Don't show 'ACP Styles Library' menu item when playing an invite.
* EW 1169 Conflict with identifiers after using ACP styles library from the hamburger menu.
* EW 1168 Deleting in a list deletes the wrong item
* ER 1167 Add download CSV capability for tables
* EW 1163 Row headers missing from copied table
* EW 1157 User portal still says Release 3.0
* EW 1128 Bizarre display of numerous nodes on diagram when reloading the style library.

== Fixed or implemented in ACP build 58==
* ER 1155 Get SkipLogin working when using firebase
* EW 1154 Can't hover over description bubble to use hyperlinks
* EW 1153 Hyperlink not displaying correctly in ACP Help Balloon (Markup)
* EW 1150 Turn off spell check red underline in Save as box
* EW 1004 Change password accepts password after new password does not match.
* EW 434 ACP Top Tabs Style Prevents swapping between graph & table views
* EW 433 Stuck in Object window when using Top Tabs ACP

== Fixed or implemented in ACP build 57==
* EW 1147Error when adding styles library from hamburger menu
* EW 1137 LaunchEvite.ana has an error at load time.
* EW 1111 Index menus icon overlaps the accept/cancel icons
* ER1107 Move acpConfig.js settings to a text file
* EW 1064 Model with proactive eval run at load time and AskMsgChoice() doesn't open with evite
* EW 911 Blue links to nodes should work or not be blue

== Fixed or implemented in ACP build 56==
* ER 1136 Add Copy Graph for embedded graphs
* ER 1135 Add new flag to acpConfig.json for showing copy table button
* EW 1133 Suan process crashes with Anagram
* EW 1132 Problem with special characters in Publish to cloud
* EW 866 Don’t show [Calc] button while computing tall node
* EW 196 Edit tables and result tables should show a "Copy table" button, same as ACP1.

== Fixed or implemented in ACP build 55==
* EW 1129 Don't show 'Orphans' in Hierarchy Stripe when displaying Styles diagram
* EW 1126 Some problems with displaying and saving special characters
* ER 1123 With users set to not email addresses, Change cue text to say add users, not email addresses
* ER 1118 Don't show green check or red x buttons when edit table has proactivelyevaluate set to 16
* ER 1114 Move add ACP Styles menu items from help menu to hamburger menu

== Fixed or implemented in ACP build 54==
* EW 1124 Change js code to use full path when calling AddModuleOrLibrary
* EW 1122 Fly-in and toggle table/graph icons should only appear on mouse over
* EW 1119 Toggle to graph icon present in edit table frame node
* EW 1113 Add flag for showing the add ACP Styles menu item(s)

Builds 52-53 are for using Apache authentication with windows passwords. No Firebase option

== Fixed or implemented in ACP build 53==
* EW 1102 When I sign in Suan account model throws uninformative errors.
* EW 1100 Turn off email validation when using apache auth

== Fixed or implemented in ACP build 52==
* ER 1103 Remove the change password link from the Account tab
* ER 1099 Remove 'Sign out' menus from ACP when using apache auth.
* ER 1096 Add a way for turning off the Email Invites in the ACP Portal.
* ER 1095 With apache/windows auth, get users name to show up in toolbar.

== Fixed or implemented in ACP build 51==
* EW 1089 You can't change the value of a slicer in some edit and result tables on ACP.
* EW 1085 Diagram crashes on opening
* EW 1083 Diagram crashes when changing navigation style
* ER 1081 Add toggle table/graph button for tables and graphs in top/side tabs
* EW 1079 Table in side tabs should have 8px margin on right, left and bottom sides

== Fixed or implemented in ACP build 50==
* EW 1077 Top and side borders wrong in object, table, graph views for side tabs
* EW 1074 Table doesn't look good in side tabs
* EW 1073 Result table too big when using Top tabs
* EW 1072 Role in Project pulldown in the Subscription Administration project is disabled
* EW 1071 Come up with a way to turn off "self sign up" on a dedicated customer server.
* EW 1068 Footer on sign in page should appear below the sign in form
* ER 1065 Add Organization/Group name next to Project name in top teal toolbar
* EW 1063 Add 8px white margin on rhs of diagram when using Outline (default) navigation style
* ER 1062 Reduce white gap above outline and acp1 tabs to 8px
* ER 1058 Adjust the margin at the top of the ACP diagram.
* ER 1055 Change ACPStyle show_tabs to show_toolbar.
* EW 1053 Multichoice menu doesn’t close if you click on another variable
* EW 1051 Balloon goes off the edge of the diagram
* EW 1050 Cannot proactively evaluate choice selections inside a table in ACP
* EW 1048 Characters with accents and chinese characters not displaying correctly when model is uploaded via DTA Publish to Cloud
* EW 1046 Bulleted lists look bad in ACP after publishing to cloud
* EW 1038 balloonText not acknowledged in ACP3
* Ew 1032 MultiChoice should display «None» when there's nothing selected
* EW 995 Graph too wide when using side tabs
* ER 908 Hierarchy bar should include top level module name in non-tab views.
* EW 781 Balloon contents overlap the edge of the diagram
* EW 509 Help balloon goes off the bottom of the diagram

A list of EW issues - Bugs or Enhancements - that were fixed or implemented in the most recent ACP build
== Fixed or implemented in Build 0.45 (same as release 3.0)==
* EW 1067 Remove beta from login page.
* EW 1066 Unminimized javascript visible in Chrome Developers tools
* ER 1044 Remove add_scroll_bars from library and wiki
* ER 1043 Stop showing message box when someone clicks on blue link text in a table
* EW 1040 Hierarchy strip is a pixel or two too wide
* ER 1039 Make help menu forms (a) all dialogs have the same width, and (b) have a consistent top location, so that changes would affect only the length/height.
* ER 1034 Add new Help menu icon to the left of the Close menu icon in top toolbar
* ER 1033 Change wording on tech support form
* EW 1029 Tweak uneven margins for graphs in top tabs
* EW 1028 Add margin to tables shown in top tabs w/o frame/tall node
* EW 1027 Footer with logos not visible viewing result in top tabs
* EW 1024 Graph autoscale (zoom out) hover icon not working for comparison variables.
* EW 1023 Wrong index menus view. Similar to 1006.
* EW 1020 Graph goes blank after an OnClick event
* EW 1015 Units not showing in Tall Nodes
* EW 1003 Delete Project button in wrong location.
* EW 966 Result table takes a long time to display result.
* ER 920 Report issue dialog and result

== Fixed or implemented in Build 0.44==
* EW 1017 Styles Lib preview, show title not working in preview.
* EW 1016 'Show_title: no' does not work with tall result tables.
* EW 1007 Crash when evaluating empty string for text only input node.
* EW 1006 Odd presentation of index menus - mix matched.
* ER 1000 Make last item in Hierarchy Stripe bold.
* EW Diagram crashes when changing Nav styles.
* ER 913 Make Diagram tooltab go to parent diagram and eliminate parent button.
* ER 816 Implement framenode ACP styles for variables.

== Fixed or implemented in Build 0.43==
* ER 998 Put Outline in rounded rectangle
* EW 997 In Airplane NLP model, the outliner indentation is missing for items with long title
* EW 990 Form for adding users has significant layout problems
* EW 989 Outliner Scroll bar overlaps the Analytica logo
* EW 987 Can't see the entire email invite ui
* EW 986 ACP1 tabs should not wrap when window is narrow
* EW 984 ACP Change password ui is unresponsive
* EW 978 Show title:no also hides uncertainty view menu and table_graph/index_menus icons
* ER 696 Some outline view issues. A couple bugs and some ER's
* ER 594 Put Outline in rounded rectangle and many more

== Fixed or implemented in Build 0.42==
* EW994 Graph size off when using Side Tabs with Use Top Diagiam Size
* EW 983 Style library does not show when I think it should
* EW 974 Parenthesis showing on models' diagram
* EW 973 Don’t show scrollbars when not needed
* ER 972 Show description of Module in balloon on mouseover of tab.
* ER 968 Tabs across the top should be fitted across the diagram, not the browser window width
* ER 967 When using show_title:no and no other graph header ui, graph fills entire frame/tall node
* ER 965 Some issues I had with the acp admin folder and suan account admin model.
* EW 961 Small gap at between graph and bottom of tall node. There should be no gap.
* EW 960 Excessive gap between graph and title in Tall Node
* EW 955 White area below Graph tab present, but should be gray.
* EW 953 Can't see the bottom of a graph in ACP1 Graph tab.
* ER 828 Analytica branding in ACP

== Fixed or implemented in Build 0.41==
* EW 964 Email address reported as not valid
* EW 963 Delete User is poorly conceived. Problematic
* EW 962 The Privileges table clips
* EW 956 ACP tabs not visible in Navigation style side tabs - when the style is show_tabs:yes.
* EW 811 Show_title should work for Tall node as well as Frame
* EW 780 Table in Tall node doesn't use entire width
* ER 530 DB change for Add/Remove project permissions

== Fixed or implemented in Build 0.40==
* EW 952 Can't change file name in Save As... dialog
* EW 951 Gray outline showing through the glow hover highlight on mouseover.
* EW 949 Text input for some inputs have a thick 2 pixel border, but should be only 1 px
* ER 946 Minor enhancement to text input boxes when they have focus.
* EW 945 Scroll bars not visible or only partially visible
* ER 942 Change appearance of "You are about to timeout" message box.
* EW 940 Model tab should read "Main"
* EW 939 Issues with navigation_style:two_top_tabs
* EW 938 Module node doesn't show on top diagram when module tabs are on.
* EW 937 Units showing above tall tables/graphs
* EW 874 Subtable with single text cell should not show as table in tall node
* EW 678 Getting stuck in a tab/diagram
* EW 472 Result does not show in top tabs style without frame node/tall node

(build 35-39 failed the acceptance test - including the fixes in these builds here)
== Fixed or implemented in Build 0.39==
''(Note: this build failed the acceptance test)''
* ER 936 Don't show text selection mouse pointer when using Close Menu
* ER 935 Give visual feedback when a formnode button is clicked.
* EW 932 Zoom selects wrong axis range
* EW 931 Crash when changing tabs
* EW 930 ACP diagram layout not quite the same as DTA
* EW 929 Screen shows scroll bars when not needed
* EW 928 ACP Crashes - goes to blank screen
* EW 927 Unnecessary scroll bar in single cell input
* EW 925 Result in frame node Very slow to show results, and then redisplays the results multiple times
* ER 922 Sort projects pulldown menu alphabetically
* ER 918 Make border thinner for Module nodes
* ER 914 Save model as dialog should be same style as Message box dialog.
* ER 909 Change defaults for show_uncertainty_view
* ER 906 Implement cloudplayerstyle show_index_menus:fly-in for framenodes and tall nodes.
* EW 905 Wrong pivot in the Horizontal axis menu
* EW 901 Choice input menu with blank option selected is too short, ARC
* EW 899 Text inputs in ARC model have tiny scrollbars
* EW 898 Tall edit tables that are subtables do not display as automatically, and they are not embedded.
* EW 890 White screen after closing optimizer model after OptStatusText evaluation
* EW 856 Z-level of nodes wrong
* ER 823 Change to show_index_menus:no ACP style setting "Show slicer indexes by default even when Show_index: No.
* ER 822 Add ACP style Show_index_menus: Not_even_slicers.
* EW 760 Can't view result graph for scalar chance variable.
* EW 747 Add support for Show_uncertainty_view: no/yes for individual nodes
* ER 309 Hide index menus above tables/graphs in Tall nodes

== Fixed or implemented in Build 0.38==
''(Note: this build failed the acceptance test)''
* EW 895 Pivot table doesn't work, body cells not updating.
* EW 887 Tech support (or report issue) from Email invite gives white screen
* EW 886 Restart ACP from Email invite gives web socket error
* ER 870 When you enter text into a field and press enter, you need to use the mouse to enter replacement info.
* EW 861 Respect Z-order for Frame and other nodes
* EW 853 ARC -Choice menu control is too narrow - Unusable
* EW 850 Problem with inputs/inputs in ARC model
* EW 466 Suan.exe crashes (vanishes) at model load with a model from guidehouse
* EW 353 Weird view while starting a model

== Fixed or implemented in Build 0.37==
''(Note: this build failed the acceptance test)''
* EW 891 Tall result tables exceed bottom border.
* EW 852 Embedded tall subtable has too many titles
* ER 821 New ACP style option: Show_graph_table_icon: No.
* ER 812 Put empty Index for pivoter menus as last not first
* ER 808 Don't show balloon description for Frame or tall node when it is already showing its description.
* EW 807 Show description doesn’t work for Tall nodes

== Fixed or implemented in Build 0.36==
''(Note: this build failed the acceptance test)''
* EW 883 Save as dialog has transparent background, but should not.
* EW 882 Significant problem with tall nodes in build 35.
* EW 876 show_as_tab: No doesn’t work (for non - top diagram modules)
* EW 865 Close model after Save model gives blank screen
* EW 720 Very slow or crash when displaying a large table

== Fixed or implemented in Build 0.35==
''(Note: this build failed the acceptance test)''
* ER 879 Don't show quotes for cells that are specified as text only format.
* EW 878 Server crash when you select an item in a tall node choice list.
* EW 877 Message box appears on DTA desktop when it shouldn't in dual-interface mode.
* EW 875 Table shows diagonal lines across cells
* ER 874 Subtable with single text cell should not show as table in tall node
* EW 873 Multichoice button is not the same width as in DTA
* EW 869 Multichoice won’t accept selections if you click below, above, or to the left of the menu
* EW 848 Bottom of graph cut off in ACP1 tabs
* EW 846 pivoters start to show at the top of a frame node when they should not
* EW 845 Background color for pivoters / slicers is gray when should be transparent in tall edit table
* ER 844 Implement show_index_menus: yes/no for the model's top level CPS
* EW 793 Changes to ShowHier not showing in ACP3
* EW 680 Can't pivot a result table.
* EW Table header slides up to the top of the diagram.
* ER 642 Add help / support info e.g. acp@lumina.com
* ER 294 A tall multichoice user input node should display as a list selection.

== Fixed or implemented in Build 0.34==
* EW 881 Uncertainly selector vanishes . (when changed to mid view - a previously implemented ER)
* ER 872 Implement Save as
* EW 849 Pivoters and slicers missing above table when viewed in ACP1 tabs
* ER 841 Adjust margins for tall and frame node tables based on corner radius.
* EW 840 For tall nodes and frame node, give graphs rounded bottom corners that match the tall/frame nodes
* EW 839 Debug MsgBox appears in List edit, says key=4, and changed doesn't take.
* EW 827 Non-parsing JSON during Graph in TXC
* ER 819 Icon buttons in Tall and Frame nodes appear on mouse-over
* EW 814 Bottom border of tall node is a bit thin when showing graph
* EW 809 Expand consistent margins around Graph, Table, and Object views in Frame
* ER 806 Replace Fly-in indexes pivoter with simply showing/hiding indexes
* ER 804 Make node shadows smaller
* EW 803 Description shows ‘0’ when ‘No’ in Frame node with Graph
* EW 802 Model title not showing in teal top banner
* EW 798 Graph is greyed out after mouse-over.
* EW 786 Model name is truncated when it doesn't need to be
* EW 498 JSON did not parse error during edit table
* EW 194 Result tables don't yet have Slicer totals.
* ER 153 Session timeout

== Fixed or implemented in Build 0.33==
* EW 792 Add toggle table/graph icon Tall output nodes
* ER 791 Change icon in ACP1 tabs for result table.
* EW 777 Tall table not showing slicer
* EW 776 Pivoter background color for tall graphs should not be gray
* ER 775 ER for showing pivoters for Tall result graphs
* ER 773 Spec for showing pivoters/slicers in frame and tall nodes. And ACP1 tabs.
* EW 766 Inconsistent display of description in frame nodes.
* EW 738 Graphs re-render many times, slow
* EW 669 Frame node not showing description for edit table

== Fixed or implemented in Build 0.32==
*ER 772 Don't show row pivoter in frame nodes or tall nodes (unless "show_index_menus: yes" is set).
* ER 770 Add 8 pixel margin around table in ACP1 tabs
* EW 768 Column pivoter not aligned with left edge of first column
* EW 767 Fly in pivoters visible above tall result graph. It should not be.
* EW 764 Empty help balloon appearing on tall node
* ER 759 Make tall node titles bold
* EW 758 "fly in" pivoters box not aligned correctly
* ER 757 No hover highlight for Tall Nodes
* EW 756 Scroll bar appears when hovering over last column header in table
* ER 755 Tall node titles should be left aligned with table's left edge and bold
* EW 754 Can't close MultiChoice popup in table cell.
* ER 742 Don’t show Origin index or make it work
* EW 741 Clicking on this list button goes to a white screen. Can't get back into the model
* EW 735 Can't publish model to cloud which contains Style library
* EW 721 Sorting doesn’t work for Checkboxes and Choice menus.
* EW 683 show_index_menus is not working (w/spec)
* EW 665 Graph hover icons appear in the wrong place.
* EW 557 Publish to cloud will not upload large models

== Fixed or implemented in Build 0.31==
* ER 745 Change Close menu for clarity.
* ER 744 Complete cleanup of Table outer border
* EW 743 Button shows content beneath it on hover.
* EW 740 'All' in choice list does not stick when selected.
* ER 730 Support «All» option for Slicers
* EW 708 Embedded object view exceeds frame node boundaries

== Fixed or implemented in Build 0.30==
* ER 739 Selection and hoverhighlight colors.
* ER 737 Formnodes with fill should show hover highlight outside of nodes' border.
* ER 734 Change hover highlight for input/output nodes.
* ER 733 Make table margins for frame/tall nodes equal to the corner radius of the frame/tall node.
* ER 731 Slicer pulldowns column-wrap when they should not.
* ER 729 Fill and borders for row index cell (and column index cell) (part 2)
* EW 725 Wrong cursor icon
* EW 723 User inputs that are atomic elements of a subtable show expression “Subtable(.” rather than the number or text value expected.
* ER 717 Put units to left of the the Uncertainty view menu
* ER 716 White margin between the table border and the Frame border
* EW 715 Bottom corners of table overlap rounded frame corners
* EW 713 Icons in input/output nodes not centered vertically, but should be
* EW 712 Bottom corner of frame node borders missing in Portfolio Planner when graph is showing in frame node
* EW 710 Graph in Frame Node too tall initially
* EW 708 Embedded object view exceeds frame node boundaries
* EW 707 Labels for formnodes are not showing up.
* EW 695 Frame border gets thinner where the graph is.
* EW 655 Square graph corners extend outside of rounded framenode corners.
* ER 609 Don't use reverse video for selected nodes, use gray

== Fixed or implemented in Build 0.29==

* EW 704 UI Crashes when clicking on input in the object window
* EW 703 Stray curly bracket on the change password page
* EW 702 Need to log playing of eVites
* EW 699 Insufficient read access to folder
* ER 673 Change required by May 2021. (NPM - javascript update)
* ER 528 Open model in ACP after publishing
* EW 514 Changes in edit table don't stick when you go to other tab.

==Fixed or implemented in Build 0.28==

* EW 698 On large table, part of scroll bar is being clipped i.e. not visible.
* EW 697 White gap at bottom of object window.
* EW 693 More Table Layout Style changes
* EW 692 WebSocket connection drops
* EW 691 Click on UDF should go to Object window
* ER 690 Change toggle to graph icon
* EW 689 No vertical scrollbar in object window
* EW 688 Tall output nodes should have margin on top and rhs of title
* ER 687 Object window option in Att_FrameNodeShowing
* EW 684 When adding new users, email subject is 'Invitation to Suan'.
* ER 681 Sortable table columns
* ER 666 Change attribute identifier to AcpStyles
* ER 654 Move Row pivot control to table corner cell.
* EW 647 Spreadsheetopen() with undefined showdialog attribute is acting as if the attribute was 'false'
* EW 627 Graph in tall nodes is not centered horizontally
* EW 604 SysVar AnalyticaEdition needs a tweak.
* EW 585 Suan shows graph when it should show table
* EW 576 ACP3 version shows doesn't show correct cell number formats (%, $ sign)
* EW 556 Cell-level number format not reflected in table.
* EW 531 Remove "Group name" from email sent when adding user to project
* ER 517 Syntax coloring for definitions
* EW 398 Input nodes show wrong number format
* EW 387 Problem pivoting prob bands table
* EW 141 Some input titles are missing in Daylight Analyzer example model
* EW 68 The number format for a table index doesn't match DTA
* EW 44 Click on node opens graph, should be result table.
* EW 15 User text box input has wrong number format - .06 instead of 6.00%

==Fixed or implemented n Build 0.27==

* EW 672 JavaScript crash on fontSize
* EW 671 ACAP model not using correct font
* EW 670 Graph/Table hover icon needs higher Z-order.
* EW 668 Scrollbar in tall edit table should be adjacent to the table
* EW 664 Crash after viewing frame node graph and re-opening model.
* EW 663 Frame node not defined yet, and FrameNode not working
* ER 662 Graphing roles could be arranged into multiple columns when the view is wide enough.
* ER 660 Change module icon in Outline view
* ER 659 Clean up of Table design
* EW 658 Selection bubble for Output & Input nodes are different size
* ER 657 No node hover for Frame Node objects
* ER 656 No need for "Edit Table of" in the title of edit tables
* EW 648 Framenode is not showing results dup 663
* EW 646 Make text node and frame node borders look the same.
* EW 641 Glitchy table header artifact appears on embedded table.
* EW 635 ACP not consuming available browser space.
* EW 617 Nodes' font is lost when going to Object window and then back to diagram.
* EW 592 The rightmost tab “Model details” goes off the right side.
* EW 559 Forgot password not working in publish to cloud
* ER 535 Reduce the number of registry keys needed to publish to a non 'acp.analytica.com' server.

==Fixed or implemented in Build 0.26==

* ER 640: Add SuanAssets reg key
* EW 639: There should be a gap between top tabs and teal banner, but there is not sometimes
* ER 638: Change default for "show_model_title"
* ER 634: libXl error: Marshalled for a different thread
* ER 633: Implement "Show_uncertainty_view: no" CPS flag
* ER 632: Change name of CPS flag "Hide_uncertainty_view: no" to "Show_uncertainty_view: yes"
* ER 631: Make Text and FrameNode borders the same
* EW 630: Spreadsheetopen(filename) with the filename being an existing file does not appear to be working to spec.
* ER 628: Implement consistent margins in graphs
* ER 637: Graph in tall nodes is not centered horizontally
* ER 623: Model doesn't open to diagram. Suan.exe session crash.
* EW 603: Allow addition of 'Not a member' users to other projects.
* EW 599: DTA not recognizing ACP licenses
* ER 575: Configure Proactive User Outputs breaks with upstream change
* ER 535: Reduce the number of registry keys needed to publish to a non 'acp.analytica.com' server
* EW 516: Problem switch from edit table to result or graph tab
* EW 366: Edit tables and results don't display automatically

==Fixed or implemented n Build 0.25==

* ER 623: Make text nodes and frame nodes have rounded corners
* EW 622: Output node "Calc/Result" buttons using the wrong font
* EW 621: Tall text input nodes not showing Title when they should be
* EW 620: Text inputs not using node font style when they should
* EW 619: Input node button labels not using diagram/node font styles
* EW 618: Choice input pulldown not using correct font.
* EW 616: Unable to upload models
* EW 611: User output value is not in the custom font
* EW 604: SysVar AnalyticaEdition needs a tweak
* ER 595: Reduce white space between tabs and top teal band
* ER 591: When loading model, show a progress bar
* EW 582: Choice inputs should use the diagram or node font settings.
* EW 542: Don’t show model internals while loading
* ER 437: Remove RT and UI from top stripe in release
* EW 420: Weird diagram appears while starting up a model
* ER 413: ShowProgressBar not implemented yet

==Fixed or implemented n Build 0.24==

* ER 615: Cloud Platform Styles flag "Hide_uncertainty_view: no"
* ER 614: If a variable is showing Mid view, then the uncertainty selector does not show - same as in Acp1.
* EW 613: Clicking on FrameNode should not show object window or error message.
* ER 612: Can't add/append/insert/delete/reorder elements in a list
* EW 610: Server process crash, in graphing code (Ecoplexus).
* EW 606: Some problems with Tall edit tables, affects transdev. Pivoters / slicers showing when they should not. Gray background in header area. Table exceeds node borders at the bottom.
* EW 605: Server-side memory leak with tables.
* EW 602: SpreadsheetOpen/Close (Transdev)
* ER 598: Tweaks to input/outputs popup that appears when clicking on left/right side of nodes.
* ER 593: Don’t show units for user input/output arrays.
* ER 590: Highlight node on mouse-over enhancements.
* ER 587: Make rotating cube wait view smaller.
* EW 581: Undefined nodes should not show object window and should show an error when clicked
* ER 579: Change ACP page title from "Analytica Cloud Platform" to simply "Analytica".
* EW 547: Diagram with two Frame nodes doesn’t always work
* EW 545: Uncertainty view should be to the right of Title for Graphs (as for Tables).
* EW 543: Error message on model load

==Fixed or implemented n Build 0.23==

* EW 566 Transdev: Warning message goes off the bottom of the canvas - can't read it all and can't close it
* EW 558 Text node title a little too large
* EW 551 Glitch on right end of Show hierarchy bar
* EW 550 Default font size and align Title of Text node same as Title in Graph or Table in Frame
* EW 548 Make description text in graph/table left aligned with Title above it.
* EW 546 Text node border too thick
* EW 544 Table view overlaps top of Frame node
* EW 537 Signin: Bad message shown to user when email address without password is used with 'Get a new password'
* EW 536 Odd message presented to user when closing google sign in popup
* EW 533 After setting up group account, user doesn't exist.
* EW 512 Multichoice popup does not disappear when clicking on the diagram background

''Fixed or implemented n Build 0.22'

* EW 529 After creating a new group account, user could not add projects.
* EW 527 Some eVites don't play.
* EW 526 Enforce file permissions when launching an eVite.
* EW 525 Update message shown to user when user is unable to establish a connection.
* EW 506 Text with extended characters entered into text box control corrupt.
* ER 505 An EMF image (in a picture node) does not display.
* ER 504 Error during query **TO DO** displays.
* ER 239 REST method handlers.
* ER 149 Support "Publish to cloud..."

==Fixed or implemented n Build 0.21==

* EW 503 Output node result text not aligned correctly
* EW 502 Invite email says "Analytica Cloud Player" in body
* EW 501 When playing invite, "Signin skipped" appears in toolbar, but should not.
* EW 500 Show less options on "Close Menu" when viewing invite.
* EW 497 Text node titles not using correct font in some cases.
* EW 496 Problem viewing Exceedance Probably results.
* ER 495 Re-enable file functions. [Read|Write][Text|Binary|Export|Image]File() functions
* EW 494 Control near top is clipped.
* ER 492 Built-in file functions should only allow access to your own project folder.
* EW 491 Graph slicer not working initially in Cory's So Cal Gas model.
* EW 490 Big problem with indexes that are dates.
* EW 489 Cory: Te1299802109 does not center on the ACP diagram though it does on the desktop.
* EW 488 Cory: Therm_Savings_by_Wav shows up as a table rather than a graph, and shows statistics rather than the desktop selection of probability density.
* EW 487 Cory: Input/Output Node colors are different than in the desktop model,
* EW 486 Cory: Historical_Savings1, HDD_Data, HDD_Data, HDD_Coeff_Data_to_In input does not show the inputs at all when evaluated.
* EW 485 Cory: Svgs_Delta_Dist_due_ , Second_Year_Program_ , Second_Year_Program_, Therm_cust_savings_a (and probably some others in the diagrams I haven’t checked) show up as a table even though graph was selected in desktop model.
* EW 484 Cory: HDD_Lognormal shows up as a probability distribution (in a table) even though Mid (and a graph)
* EW 482 Cory: Statistics don’t change on graph for Therm_Savings_by_Wav.
* EW 480 Cory: Result for Total_Forecast_Savin does not display when output node is clicked.
* EW 479 Max: For bare icon (and icon) input/output button style, icon is not vertically centered.
* ER 476 Make background above table gray when using ACP1 tabs.
* EW 471 Max: Table rows with no data are too short
* ER 382 The WriteTextFile( ) function displays a file selector dialog on the server, causing the application to apparently lock up.

==Fixed or implemented n Build 0.20==

* EW 478 - The black border around a selected button of an output node was mis-aligned and showed as 2 odd looking lines.
* ER 475 - Some style changes to Graph Tooltip.
* ER 474 - Some style changes to Message boxes.
* ER 473 - Added support for Distribution input nodes showing icons button style.
* ER 470 - A couple changes to table style. White background header and moved the View Selector pulldown to the right side.
* EW 469 -Text input fields, change to Use default model font, not fixed width.
* EW 468 - Diagram showing wrong font for nodes.
* ER 465 - Include the Rent vs Buy example model when an Individual account is first created.
* ER 464 - The shading around each button is too contrasty.
* EW 415 - Choice nodes are too tall.

Using Python from Analytica

2026-02-12T00:03:50Z

Mhenrion: /* Introduction */

[[category:Python integration]]
''New in [[Analytica 7.0]]''

Requires the [[Analytica Developer]] (formerly [[Analytica Enterprise]] edition.)

== Introduction ==

Analytica provides a two-way bridge between Analytica and Python. You can write Python code in the definitions of Analytica Variables and Functions. Analytica can access Python variables and call Python functions, pass data—including multi-dimensional arrays—to it, and retrieve the results. Conversely, Python code can call back into Analytica to evaluate variables or expressions. Together the two environments combine Analytica’s intuitive influence-diagram interface, intelligent arrays, and built-in uncertainty analysis with Python’s vast open-source ecosystem.

We recommend using Python versions '''3.8+''', although the integration also supports versions '''3.3+''',

[https://videos.analytica.com/Analytica-Python/AnaPythonBasics.mp4 Watch video on Analytica-Python integration basics]

=== Motivation: Why use Python? ===
Python offers thousands of purpose-built libraries that extend what you can do in a model. Here are just a few:

{| class="wikitable"
! Python library !! What it adds to Analytica
|-
|[https://numpy.org/ NumPy], [https://pandas.pydata.org/ Pandas]|| Efficient numerical arrays and data-frame operations that underlie many other Python analytics libraries
|-
|[https://pillow.readthedocs.io/en/stable/ Pillow]|| Programmatic image manipulation for tasks such as satellite-image preprocessing before feeding data back into Analytica.
|-
|[https://matplotlib.org/ Matplotlib], [https://seaborn.pydata.org/ Seaborn]|| Visualizations not native to Analytica, including violin plots, heatmaps, network graphs, and 3-D surface plots.
|-
|[https://pytorch.org/ PyTorch], [https://www.tensorflow.org/ Tensorflow]|| Training or running machine-learning models, then passing predictions into Analytica for further probabilistic analysis.
|}

=== Advantages: When to use Python in Analytica ===
{| class="wikitable"
! Situation in Analytica !! Why using Python helps
|-
| Want custom visualizations beyond Analytica graphs || Generate plots with [https://matplotlib.org/ Matplotlib] or [https://seaborn.pydata.org/ Seaborn], save images, and display them in a Result window
|-
| Require advanced text or Natural-Language Processing || Apply Python packages like [https://spacy.io/ spaCy], [https://www.nltk.org/ NLTK], or built-in <code>re</code> for parsing, classification, and transformation
|-
| Need a specialized statistical, ML, or optimization algorithm not built into Analytica || Leverage PyPI libraries such as [https://scikit-learn.org/ scikit-learn], [https://pandas.pydata.org/ pandas], or [https://coin-or.github.io/pulp/ pulp] without re-implementing the math
|}

===Python downsides: When native Analytica is often better ===
{| class="wikitable"
! Concern !! Why pure Analytica can be preferable
|-
|[[Array Abstraction|Array abstraction]]|| Operating on arrays with different dimensions is often a one-liner in Analytica but requires verbose reshape/broadcast code in NumPy or Pandas.
|-
| Performance overhead || Transferring data and compiling Python incurs latency. Tight loops or lightweight formulas run much faster as native Analytica expressions. For repeated Python calls, define a [[Callable]] to compile once and reuse.
|-
|[[Monte Carlo and probabilistic simulation|Monte Carlo]]|| Analytica’s built-in stochastic simulation is deeply integrated. Recreating them in Python is rarely worth the effort.
|}

== Setting up a Python environment ==

=== Installing Conda ===
Download and run the Anaconda or Miniconda [https://www.anaconda.com/download/success installer] for Windows.

=== Creating and activating a Python environment ===
Open the newly installed '''Anaconda Prompt''' app and run this command, which will create a new Python 3.11 environment named <code>MyEnv</code> and install the Python libraries [https://pandas.pydata.org/ Pandas] and [https://numpy.org/ NumPy]:

<code>conda create -n MyEnv python=3.11 pandas numpy</code>

=== Telling Analytica which Python environment to use ===
Open the '''Definition / Application integration / Python''' submenu.

Set either '''Python Environment''' or '''Python Model Environment''' to the environment’s name (e.g. <code>MyEnv</code>) or to the full folder path of the Python installation home directory, for example:

<code>C:\Users\username\anaconda3\envs\MyEnv</code>

'''Python Environment''' is stored with the Analytica installation and becomes the default for any model that does not set '''Python Model Environment'''.

'''Python Model Environment''' is saved inside the current model and overrides the installation-wide setting.

''See [[Using Python from Analytica/Setting up a Python environment|Setting up a Python environment]] for a detailed walkthrough.''

=== Loading and Unloading of Python ===

Python (core, environment, and libraries) loads only when your model first executes or evaluates Python code, and unloads when you close the model. Reopening the same model, or opening another that uses Python, starts a fresh Python session; any prior Python state (variables, imports) is lost. If the new model uses a different environment, it may run a different Python release.

If Python is already loaded and you change the '''Python Environment''' or '''Python Model Environment''', Python unloads immediately. The selected environment’s Python loads the next time your model runs Python code. Unloading discards all Python state (variables, imports).

Python runs in the same process as Analytica.

== The Python menu ==

The core Analytica functions and system variables for configuring and interacting with Python are found on the '''Definition / Application integration / Python''' submenu.

<center>[[image:Python menu.png]]</center>

== Importing Python libraries ==

The ''preferred'' way to make Python libraries available in Analytica models is to place their import statements in the system variable '''PythonStartupCode'''. These lines execute when Python gets loaded, so the libraries are ready for use in later Python code.

''If you edit '''PythonStartupCode''' after Python has already been loaded in the current Analytica model, you must reload the model (or close and reopen Analytica) for the modified startup code to take effect.''

=== Importing from nodes ===
When creating a filed Analytica library or module, it is ''highly recommended'' to perform imports within a [[Variable]] or [[Callable]] node inside the library/module itself. This practice ensures that the library/module remains self-contained, as '''PythonStartupCode''' is not saved as part of a filed module or library. You should then create dependencies from nodes that use the Python libraries to the import node(s) to ensure the Python libraries are loaded before use.

Python supports two main import styles:

* Module import – e.g., <code>import numpy</code>
* Selective / wildcard import – e.g., <code>from numpy import array, zeros</code> or <code>from numpy import *</code>

When an import statement is the final expression, Analytica returns its value:

{| class="wikitable"
! Import statement
! Return value when it is the last statement
! Output image
|-
| <code>import numpy as np, os</code>
| The module’s string representation e.g.,<br/><code>«Python <module 'numpy' from …>»</code><br/><code>«Python <module 'os' from …>»</code>)
| [[Image:PythonMultipleModuleImports.png|thumb|250px]]
|-
| <code>from numpy import array, zeros</code>
| A list of the imported names (alias names if provided, otherwise the original names)
| [[Image:PythonMultipleSelectiveImports.png|thumb|250px]]
|}

== Python <code>py::</code> namespace ==
Analytica exposes the embedded Python interpreter through the <code>py::</code> namespace prefix. Any name visible at the top level of the interpreter—global variables, functions, classes, or imported modules—can be accessed through Analytica with the same spelling and case, preceded by <code>py::</code>.

Example: Incrementing a Python global variable '''counter''' by 2

<code>py::counter := py::counter + 2;</code>

== Calling a Python function ==
Invoking a Python function from Analytica is as simple as writing it:

<code>py::len(MyArray)</code>

Arguments may be:
* Analytica scalars
* Analytica arrays (which get [[Array Abstraction|array abstracted]])
* Python objects

=== Keyword arguments (kwargs) ===
When a Python function accepts keyword arguments (<code>**kwargs</code>), use a syntax ''similar'' to Analytica’s [[Function calls and parameters#Name-based function calls|name-based function calls]], a colon after the parameter name, followed by the parameter value, instead of the equal sign used in Python.

<code>py::my_func("arg1", kwarg1:1, kwarg2:"abc")</code>

The equivalent call in native Python is:

<code>my_func("arg1", kwarg1=1, kwarg2="abc")</code>

=== Python <code>print()</code> function ===
The standard Python <code>print()</code> function sends its text output to Analytica's [[Typescript|Typescript console]] window, just as it appears in a native Python console.
* When called from Analytica with <code>py::print()</code>, the printed text will appear in the window.
* When called inside a Python script executed by Analytica, any <code>print()</code> statements also stream to the window.

== Using Python classes ==
=== Using an existing Python class ===
To instantiate a Python class, call its constructor with the <code>py::</code> prefix and pass any arguments exactly as you would in native Python.

<code>py::MyClass(42, 'widgets')</code>

=== Arrow operator (<code>-></code>) ===
The arrow operator (<code>-></code>) lets you access the attributes and methods of a Python object, analogous to the dot operator (<code>.</code>) in Python:

:<code>ColNames := MyDf->columns { attribute }</code>
:<code>Head5 := MyDf->head(5) { method }</code>

You can chain these accesses and calls:

<code>FirstName := MyDf->columns->tolist()</code>

You can also assign through the arrow operator; the assignment will update the underlying Python object:

<code>MyObj->value := 42</code>

== Using Python code in a definition ==
When you choose '''Python expr''' from the [[Definition]] drop-down, the entire definition is passed verbatim to the embedded Python interpreter.

=== Defining a UDF with a Python expr definition ===
When you set a Function node’s [[Definition]] to '''Python expr''', you can write the entire body in Python. Analytica recompiles that code every time the function is evaluated, which can noticeably slow large array computations. To eliminate this overhead, place the code in a reusable Python [[Callable]] so the compiled version remains cached between calls.

''Inside '''Python expr''', Analytica function parameters behave like local Python variables.''

== Callables ==

[[Callable|Callables]] let you embed full Python functions or classes directly inside Analytica, then invoke them like any other [[User-Defined Functions|UDF]].

=== Creating a Python Callable node ===
* Create a new [[Variable]] node.
* In the node’s [[Object Window|Object window]], change the [[Class details|Class]] dropdown from '''Variable''' to '''Callable'''.
* Enter your Python code in the Definition pane.

=== Writing Python Callable code ===
Use standard Python syntax to define a <code>def</code> function or a <code>class</code> inside the [[Definition]] pane of your '''Callable'''. For example:

<pre>
def compound_interest(p, r, n):
return p * (1 + r) ** n
</pre>

=== Caching compiled functions in Callables ===
When you evaluate a node, Analytica compiles your function and caches the resulting callable object as the node’s value. This differs from [[UDF|UDFs]] which cannot store a value, so they compile every time they run.

=== Parameters attribute ===
'''Callables''' do '''not''' have a Parameters attribute; all arguments are declared in your <code>def</code> or <code>class</code> signature.

=== Importing custom Python modules ===
Import modules exactly as you would in native Python. For example:

<pre>
import myutils
from mylib.finance import NPV
</pre>

Ensure the module is on Python’s <code>sys.path</code> by appending the module's directory to the path. For additional guidance, see the official [https://docs.python.org/3/tutorial/modules.html Python documentation on modules].

== Dependencies ==
Analytica's automatic dependency graph is a key advantage over working in environments like Jupyter notebooks or regular Python scripts, where you are responsible for manually re-running cells or scripts to reflect changes.

When integrating Python code, however, Analytica's dependency system cannot parse the Python script to automatically detect when an Analytica node is being used. You must explicitly declare these dependencies by drawing influence arrows. Drawing an influence arrow from any node to a node that uses '''Python Expr''' creates a true dependency, adding it to Analytica's dependency graph.

''As an alternative for nodes that access Python global variables without using '''Python Expr''', you can establish a dependency by including the Identifier of the influencing node directly within the Definition of the dependent node.''

If dependencies for Python nodes are not manually defined with arrows, your model will not invalidate results correctly. Updates to an input variable will not trigger re-computation in the Python node that depends on it, leaving it with a stale, incorrect value.

== Functions for evaluating Python code ==

=== PyEval ===
[[PyEval]] is used to evaluate a single Python expression and return its value to Analytica. It is designed to be side-effect-free, meaning it won't change the state of variables or objects in Python. This makes it ideal for safe, simple calculations.

''Since <code>PyEval</code> only evaluates a single expression, it cannot execute multi-line code or statements like variable assignments or imports.''

It also includes an optional <code>excludeTypes</code> parameter, which allows you to specify Python types that should not be converted to Analytica Values.

=== PyExec ===
[[PyExec]] is used to execute a block of Python code, which can contain multiple lines or statements. Unlike <code>PyEval</code>, <code>PyExec</code> is intended to have side effects. You can use it to import libraries, define functions, or set the values of variables in the Python environment.

Use <code>PyExec</code> when you need to run a script to set up an environment or perform operations that modify the Python state for use in later evaluations.

=== PyCall ===
[[PyCall]] offers a direct and efficient way to call a specific Python function. You provide the callable Python function object followed by its positional and keyword arguments.

This is the preferred function when your primary goal is to execute an existing Python function and retrieve its result.

== Non-scalar data structures ==
Any Python object that is not converted automatically to an Analytica type comes back as an ''opaque wrapper'' displayed as <code>«Python …»</code>, where the ellipsis is the object’s [https://docs.python.org/3/library/functions.html#repr repr]. Keep this wrapper when the object merely passes between Python calls, and invoke [[PyExplode]] when the data must be examined or manipulated within Analytica.

=== Converting from Python data to Analytica ===
When a Python function invoked from Analytica returns a result, Analytica automatically attempts to convert the Python data into the most appropriate Analytica value. For complex data structures, the dedicated [[PyExplode]] function is available to perform more specific conversions.

==== Automatic conversions ====
The following Python types are automatically converted to their corresponding Analytica equivalents without any extra steps:
{| class="wikitable"
! Python type !! Analytica type !! Notes
|-
| <code>int</code> || <code>Integer</code> ||''If the <code>int</code> exceeds the 64-bit signed-integer range, Analytica converts it to a double floating-point '''Number''' instead of an '''Integer'''.''
|-
| <code>float</code> || <code>Number</code> ||
|-
| <code>bool</code> || <code>Boolean</code> ||
|-
| <code>complex</code> || <code>ComplexNumber</code> ||
|-
| <code>str</code> || <code>Text</code> ||
|-
| <code>None</code> || <code>Null</code> ||
|-
| <code>date</code> || <code>DateTime</code> ||
|-
| <code>time</code> || <code>DateTime</code> ||
|-
| <code>datetime</code> || <code>DateTime</code> ||
|-
| <code>analytica.Value</code> || Unwrapped Analytica value ||
|-
| Any other Python object || ''Python opaque wrapper'' ||''Can be passed to other Python function calls or converted with <code>PyExplode</code>.''
|}

==== PyExplode ====
The [[PyExplode]] function provides explicit control for converting complex Python objects that are not converted automatically.

Key capabilities include:
* Unpacking Python built-in collections, like <code>list</code>, <code>tuple</code>, <code>set</code>, into a 1D Analytica array.
* Converting a Python <code>dict</code> into a 1D Analytica array, using the dictionary keys to create a new local index.
* Using nested calls to convert multi-dimensional data into multi-dimensional Analytica arrays.
* Fully converting a [https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html NumPy Array] into an n-dimensional Analytica array.
* Converting image objects from [https://pillow.readthedocs.io/en/stable/reference/Image.html#PIL.Image.Image PIL.Image] or [https://matplotlib.org/stable/api/_as_gen/matplotlib.figure.Figure.html matplotlib.figure.Figure] directly into Analytica images.
* Optionally excluding specific Python types from conversion with <code>excludeTypes</code>, which keeps them as opaque Python object handles.

''To convert a [https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.html Pandas DataFrame], you must use the <code>PyExplodeDataFrame</code> function. This function is not built-in and requires you to include the [[Python Pandas library]] in your model.''

=== Converting from Analytica to Python data structures ===
The bridge between Analytica and Python performs two kinds of mappings: ''automatic scalar conversions'' and ''explicit conversion functions'' for arrays.

==== Automatic scalar conversions ====
{| class="wikitable"
! Analytica type !! Python type
|-
| <code>Text</code> ||<code>str</code>
|-
| <code>Integer</code> ||<code>int</code>
|-
| <code>Number</code> ||<code>float</code>
|-
| <code>Boolean</code> ||<code>bool</code>
|-
| <code>ComplexNumber</code> ||<code>complex</code>
|-
| <code>DateTime</code> ||<code>datetime.datetime</code> / <code>datetime.time</code> / <code>datetime.date</code>
|-
| <code>Handle</code> ||<code>analytica.Object</code>
|-
| <code>Null / Undefined</code> ||<code>None</code>
|-
| ''Python opaque wrapper'' || unwrapped Python object
|-
| <code>Reference</code> ||<code>set</code>of the dereferenced contents
|-
| <code>Image</code> ||<code>PIL.Image.Image</code>
|-
| Everything else ||<code>analytica.Value</code> (wrapper for Analytica Values)
|}

==== Explicit conversion functions for arrays ====
Analytica has a single collection type—the array—whereas Python offers several (<code>list</code>, <code>tuple</code>, <code>dict</code>, <code>set</code>, <code>numpy.ndarray</code>, …). Because there is no one-to-one mapping, arrays are ''not'' converted implicitly; instead call one of the system functions below.

''<code>PyList</code>'', ''<code>PyTuple</code>'', ''<code>PySet</code>'', ''<code>PyDict</code> create a Python collection over the single dimension that you specify. In contrast, <code>PyArray</code> converts an entire Analytica array into a single <code>numpy.ndarray</code>.''

*[[PyList]] – Creates a Python <code>list</code> from the specified index, retaining other dimensions in Analytica.
* [[PyTuple]] – Creates a Python <code>tuple</code> from the chosen index of the array, retaining other dimensions in Analytica.
* [[PySet]] – Creates a Python <code>set</code> from the specified index, duplicate entries will be removed.
* [[PyDict]] – Creates a Python <code>dict</code> from an Analytica vector. The elements of a specified index are used as keys and the corresponding vector values become the dictionary values. The input vector must be indexed by the key index.
* [[PyArray]] – Converts an entire Analytica array into a single multi-dimensional <code>numpy.ndarray</code>. This function always converts all dimensions. The optional index parameters are used to specify the order of the axes in the resulting NumPy array. For any Analytica dimension not explicitly passed as a parameter, a local, positional index is created for that axis in the NumPy array. An optional <code>dtype</code> string passes directly to NumPy.

== Using Analytica locals from Python code ==

Analytica locals are visible by default to [[PyEval]] and [[PyExec]] when called within the same definition that introduces them (e.g., a definition using [[Local_Values|Local]] or a [[User-Defined_Functions|Function]] with parameters). To change visibility, pass explicit Python <code>globals</code> and <code>locals</code> mappings; providing an empty <code>locals</code> isolates the Python code from Analytica locals.

'''Example:''' <code>Local a := 5; PyEval("a + 1")</code> returns 6 because <code>a</code> is visible to the Python expression in that evaluation.

== Accessing Analytica objects from Python code ==
To interact with your Analytica model from Python, use the <code>analytica</code> module. This module is bundled with your Analytica installation and provides the necessary functions to access, evaluate, and manipulate objects within your model directly from Python.

To begin, you must [[#Importing Python libraries|import the module]] in your Python code:
<code>import analytica</code>

=== Getting a handle to an Analytica object ===
You can obtain a handle to any object in your model using<code>analytica.get('object_identifier')</code> in Python. This is useful when you want to refer to an object itself rather than its computed value. The function takes the identifier of the Analytica object as its argument and returns an <code>analytica.Object</code>.

''Example:''
To get a handle to a variable named <code>Revenue</code>, you would use:
<code>revenue_handle = analytica.get('Revenue')</code>

This assigns an <code>analytica.Object</code> representing the <code>Revenue</code> Analytica variable to the <code>revenue_handle</code> Python variable.

=== Evaluating an Analytica expression ===
To evaluate an Analytica expression, use <code>analytica.eval('Analytica_expression')</code>. This function evaluates the [[Evaluation Modes|mid-value]] of its string argument as an Analytica expression within the context of your model. To evaluate the [[Evaluation Modes|sample value]], use: <code>analytica.eval('Analytica expression', True)</code>.

<code>analytica.eval()</code> is the primary method for retrieving the calculated value of a variable. When it returns a value, it will [[#Converting from Analytica to Python data structures|implicitly convert]] many Analytica data types into their Python equivalents.

''Example:''
To get the computed value of the <code>Revenue</code> variable, you would evaluate its identifier:
<code>revenue_result = analytica.eval('Revenue')</code>

This executes the expression for <code>Revenue</code> and stores its final value in the <code>revenue_result</code> Python variable.

== No Python code in an input ==
Python code will not evaluate in a variable that has a [[User input node]]. This is to avoid a code injection attack in which a user of your model tries to run arbitrary code.

== Using Python in ACP or ADE ==
For security reasons, Python is not enabled on our public [https://acp.analytica.com ACP server]].

On a dedicated ACP server, python can be installed as used the same is with desktop Analytica.

Python integration can be used from an ADE deployment as well. You may want to set the default <code>Python Environment</code> by using regedit to add the string value <code>PythonEnvironment</code> to the hive
:<code>HKEY_LOCAL_MACHINE\SOFTWARE\Lumina Decision Systems\ADEW\{{#ifexpr: {{#svarget:anarelease|7.0}} > 7.0
| {{#svarget:anarelease|7.0}}
| 7.0
}}</code>
Alternatively, your model can specify the <code>Python model environment</code>.

In some ADE installations, you may want to disable Python integration for security reasons (i.e., if you don't have full control of the Analytica models that are run). To do so, add these lines to ADE's <code>Analytica.ini</code> file.
Att_whenDisallowed PyArray : 4
Att_whenDisallowed PyCall : 4
Att_whenDisallowed PyDict : 4
Att_whenDisallowed PyEval : 4
Att_whenDisallowed PyExec : 4
Att_whenDisallowed PyExplode : 4
Att_whenDisallowed _PyGet : 4
Att_whenDisallowed PyList : 4
Att_whenDisallowed PySet : 4
Att_whenDisallowed PyTuple : 4

== See also ==
* [[Using Python from Analytica/Setting up a Python environment|Setting up a Python environment]]
* [[Using Python from Analytica/Examples using Python|Examples using Python]]
* [https://videos.analytica.com/Analytica-Python/AnaPythonBasics.mp4 Video on Analytica-Python integration basics]

Using Python from Analytica

2026-02-11T23:58:09Z

Mhenrion: /* Introduction */

[[category:Python integration]]
''New in [[Analytica 7.0]]''

Requires the [[Analytica Developer]] (formerly [[Analytica Enterprise]] edition.)

== Introduction ==

Analytica provides a two-way bridge between Analytica and Python. You can write Python code in the definitions of Analytica Variables and Functions. Analytica can access Python variables and call Python functions, pass data—including multi-dimensional arrays—to it, and retrieve the results. Conversely, Python code can call back into Analytica to evaluate variables or expressions. Together the two environments combine Analytica’s intuitive influence-diagram interface, intelligent arrays, and built-in uncertainty analysis with Python’s vast open-source ecosystem.

We recommend using Python versions '''3.8+''', although ''Theoretically'' the integration supports versions '''3.3+'',

[https://videos.analytica.com/Analytica-Python/AnaPythonBasics.mp4 Watch video on Analytica-Python integration basics]

=== Motivation: Why use Python? ===
Python offers thousands of purpose-built libraries that extend what you can do in a model. Here are just a few:

{| class="wikitable"
! Library !! What it adds when used from Analytica
|-
|[https://numpy.org/ NumPy], [https://pandas.pydata.org/ Pandas]|| Efficient numerical arrays and data-frame operations that underlie many other Python analytics libraries
|-
|[https://pillow.readthedocs.io/en/stable/ Pillow]|| Programmatic image manipulation for tasks such as satellite-image preprocessing before feeding data back into Analytica.
|-
|[https://matplotlib.org/ Matplotlib], [https://seaborn.pydata.org/ Seaborn]|| Visualizations not native to Analytica, including violin plots, heatmaps, network graphs, and 3-D surface plots.
|-
|[https://pytorch.org/ PyTorch], [https://www.tensorflow.org/ Tensorflow]|| Training or running machine-learning models, then passing predictions into Analytica for further probabilistic analysis.
|}

=== Advantages: When to use Python in Analytica ===
{| class="wikitable"
! Situation in Analytica !! Why using Python helps
|-
| Want custom visualizations beyond Analytica graphs || Generate plots with [https://matplotlib.org/ Matplotlib] or [https://seaborn.pydata.org/ Seaborn], save images, and display them in a Result window
|-
| Require advanced text or Natural-Language Processing || Apply Python packages like [https://spacy.io/ spaCy], [https://www.nltk.org/ NLTK], or built-in <code>re</code> for parsing, classification, and transformation
|-
| Need a specialized statistical, ML, or optimization algorithm not built into Analytica || Leverage PyPI libraries such as [https://scikit-learn.org/ scikit-learn], [https://pandas.pydata.org/ pandas], or [https://coin-or.github.io/pulp/ pulp] without re-implementing the math
|}

=== Downsides: When native Analytica is sometimes the better choice ===
{| class="wikitable"
! Concern !! Why pure Analytica can be preferable
|-
|[[Array Abstraction|Array abstraction]]|| Operating on arrays with different dimensions is a one-liner in Analytica but often requires verbose reshape/broadcast code in NumPy or Pandas.
|-
| Performance overhead || Transferring data and compiling Python incurs latency; tight loops or lightweight formulas run much faster as native Analytica expressions. For repeated Python calls, define a [[Callable]] to compile once and reuse.
|-
|[[Monte Carlo and probabilistic simulation|Monte Carlo]]|| Analytica’s built-in stochastic simulation is deeply integrated; recreating these in Python is rarely worth the effort.
|}

== Setting up a Python environment ==

=== Installing Conda ===
Download and run the Anaconda or Miniconda [https://www.anaconda.com/download/success installer] for Windows.

=== Creating and activating a Python environment ===
Open the newly installed '''Anaconda Prompt''' app and run this command, which will create a new Python 3.11 environment named <code>MyEnv</code> and install the Python libraries [https://pandas.pydata.org/ Pandas] and [https://numpy.org/ NumPy]:

<code>conda create -n MyEnv python=3.11 pandas numpy</code>

=== Telling Analytica which Python environment to use ===
Open the '''Definition / Application integration / Python''' submenu.

Set either '''Python Environment''' or '''Python Model Environment''' to the environment’s name (e.g. <code>MyEnv</code>) or to the full folder path of the Python installation home directory, for example:

<code>C:\Users\username\anaconda3\envs\MyEnv</code>

'''Python Environment''' is stored with the Analytica installation and becomes the default for any model that does not set '''Python Model Environment'''.

'''Python Model Environment''' is saved inside the current model and overrides the installation-wide setting.

''See [[Using Python from Analytica/Setting up a Python environment|Setting up a Python environment]] for a detailed walkthrough.''

=== Loading and Unloading of Python ===

Python (core, environment, and libraries) loads only when your model first executes or evaluates Python code, and unloads when you close the model. Reopening the same model, or opening another that uses Python, starts a fresh Python session; any prior Python state (variables, imports) is lost. If the new model uses a different environment, it may run a different Python release.

If Python is already loaded and you change the '''Python Environment''' or '''Python Model Environment''', Python unloads immediately. The selected environment’s Python loads the next time your model runs Python code. Unloading discards all Python state (variables, imports).

Python runs in the same process as Analytica.

== The Python menu ==

The core Analytica functions and system variables for configuring and interacting with Python are found on the '''Definition / Application integration / Python''' submenu.

<center>[[image:Python menu.png]]</center>

== Importing Python libraries ==

The ''preferred'' way to make Python libraries available in Analytica models is to place their import statements in the system variable '''PythonStartupCode'''. These lines execute when Python gets loaded, so the libraries are ready for use in later Python code.

''If you edit '''PythonStartupCode''' after Python has already been loaded in the current Analytica model, you must reload the model (or close and reopen Analytica) for the modified startup code to take effect.''

=== Importing from nodes ===
When creating a filed Analytica library or module, it is ''highly recommended'' to perform imports within a [[Variable]] or [[Callable]] node inside the library/module itself. This practice ensures that the library/module remains self-contained, as '''PythonStartupCode''' is not saved as part of a filed module or library. You should then create dependencies from nodes that use the Python libraries to the import node(s) to ensure the Python libraries are loaded before use.

Python supports two main import styles:

* Module import – e.g., <code>import numpy</code>
* Selective / wildcard import – e.g., <code>from numpy import array, zeros</code> or <code>from numpy import *</code>

When an import statement is the final expression, Analytica returns its value:

{| class="wikitable"
! Import statement
! Return value when it is the last statement
! Output image
|-
| <code>import numpy as np, os</code>
| The module’s string representation e.g.,<br/><code>«Python <module 'numpy' from …>»</code><br/><code>«Python <module 'os' from …>»</code>)
| [[Image:PythonMultipleModuleImports.png|thumb|250px]]
|-
| <code>from numpy import array, zeros</code>
| A list of the imported names (alias names if provided, otherwise the original names)
| [[Image:PythonMultipleSelectiveImports.png|thumb|250px]]
|}

== Python <code>py::</code> namespace ==
Analytica exposes the embedded Python interpreter through the <code>py::</code> namespace prefix. Any name visible at the top level of the interpreter—global variables, functions, classes, or imported modules—can be accessed through Analytica with the same spelling and case, preceded by <code>py::</code>.

Example: Incrementing a Python global variable '''counter''' by 2

<code>py::counter := py::counter + 2;</code>

== Calling a Python function ==
Invoking a Python function from Analytica is as simple as writing it:

<code>py::len(MyArray)</code>

Arguments may be:
* Analytica scalars
* Analytica arrays (which get [[Array Abstraction|array abstracted]])
* Python objects

=== Keyword arguments (kwargs) ===
When a Python function accepts keyword arguments (<code>**kwargs</code>), use a syntax ''similar'' to Analytica’s [[Function calls and parameters#Name-based function calls|name-based function calls]], a colon after the parameter name, followed by the parameter value, instead of the equal sign used in Python.

<code>py::my_func("arg1", kwarg1:1, kwarg2:"abc")</code>

The equivalent call in native Python is:

<code>my_func("arg1", kwarg1=1, kwarg2="abc")</code>

=== Python <code>print()</code> function ===
The standard Python <code>print()</code> function sends its text output to Analytica's [[Typescript|Typescript console]] window, just as it appears in a native Python console.
* When called from Analytica with <code>py::print()</code>, the printed text will appear in the window.
* When called inside a Python script executed by Analytica, any <code>print()</code> statements also stream to the window.

== Using Python classes ==
=== Using an existing Python class ===
To instantiate a Python class, call its constructor with the <code>py::</code> prefix and pass any arguments exactly as you would in native Python.

<code>py::MyClass(42, 'widgets')</code>

=== Arrow operator (<code>-></code>) ===
The arrow operator (<code>-></code>) lets you access the attributes and methods of a Python object, analogous to the dot operator (<code>.</code>) in Python:

:<code>ColNames := MyDf->columns { attribute }</code>
:<code>Head5 := MyDf->head(5) { method }</code>

You can chain these accesses and calls:

<code>FirstName := MyDf->columns->tolist()</code>

You can also assign through the arrow operator; the assignment will update the underlying Python object:

<code>MyObj->value := 42</code>

== Using Python code in a definition ==
When you choose '''Python expr''' from the [[Definition]] drop-down, the entire definition is passed verbatim to the embedded Python interpreter.

=== Defining a UDF with a Python expr definition ===
When you set a Function node’s [[Definition]] to '''Python expr''', you can write the entire body in Python. Analytica recompiles that code every time the function is evaluated, which can noticeably slow large array computations. To eliminate this overhead, place the code in a reusable Python [[Callable]] so the compiled version remains cached between calls.

''Inside '''Python expr''', Analytica function parameters behave like local Python variables.''

== Callables ==

[[Callable|Callables]] let you embed full Python functions or classes directly inside Analytica, then invoke them like any other [[User-Defined Functions|UDF]].

=== Creating a Python Callable node ===
* Create a new [[Variable]] node.
* In the node’s [[Object Window|Object window]], change the [[Class details|Class]] dropdown from '''Variable''' to '''Callable'''.
* Enter your Python code in the Definition pane.

=== Writing Python Callable code ===
Use standard Python syntax to define a <code>def</code> function or a <code>class</code> inside the [[Definition]] pane of your '''Callable'''. For example:

<pre>
def compound_interest(p, r, n):
return p * (1 + r) ** n
</pre>

=== Caching compiled functions in Callables ===
When you evaluate a node, Analytica compiles your function and caches the resulting callable object as the node’s value. This differs from [[UDF|UDFs]] which cannot store a value, so they compile every time they run.

=== Parameters attribute ===
'''Callables''' do '''not''' have a Parameters attribute; all arguments are declared in your <code>def</code> or <code>class</code> signature.

=== Importing custom Python modules ===
Import modules exactly as you would in native Python. For example:

<pre>
import myutils
from mylib.finance import NPV
</pre>

Ensure the module is on Python’s <code>sys.path</code> by appending the module's directory to the path. For additional guidance, see the official [https://docs.python.org/3/tutorial/modules.html Python documentation on modules].

== Dependencies ==
Analytica's automatic dependency graph is a key advantage over working in environments like Jupyter notebooks or regular Python scripts, where you are responsible for manually re-running cells or scripts to reflect changes.

When integrating Python code, however, Analytica's dependency system cannot parse the Python script to automatically detect when an Analytica node is being used. You must explicitly declare these dependencies by drawing influence arrows. Drawing an influence arrow from any node to a node that uses '''Python Expr''' creates a true dependency, adding it to Analytica's dependency graph.

''As an alternative for nodes that access Python global variables without using '''Python Expr''', you can establish a dependency by including the Identifier of the influencing node directly within the Definition of the dependent node.''

If dependencies for Python nodes are not manually defined with arrows, your model will not invalidate results correctly. Updates to an input variable will not trigger re-computation in the Python node that depends on it, leaving it with a stale, incorrect value.

== Functions for evaluating Python code ==

=== PyEval ===
[[PyEval]] is used to evaluate a single Python expression and return its value to Analytica. It is designed to be side-effect-free, meaning it won't change the state of variables or objects in Python. This makes it ideal for safe, simple calculations.

''Since <code>PyEval</code> only evaluates a single expression, it cannot execute multi-line code or statements like variable assignments or imports.''

It also includes an optional <code>excludeTypes</code> parameter, which allows you to specify Python types that should not be converted to Analytica Values.

=== PyExec ===
[[PyExec]] is used to execute a block of Python code, which can contain multiple lines or statements. Unlike <code>PyEval</code>, <code>PyExec</code> is intended to have side effects. You can use it to import libraries, define functions, or set the values of variables in the Python environment.

Use <code>PyExec</code> when you need to run a script to set up an environment or perform operations that modify the Python state for use in later evaluations.

=== PyCall ===
[[PyCall]] offers a direct and efficient way to call a specific Python function. You provide the callable Python function object followed by its positional and keyword arguments.

This is the preferred function when your primary goal is to execute an existing Python function and retrieve its result.

== Non-scalar data structures ==
Any Python object that is not converted automatically to an Analytica type comes back as an ''opaque wrapper'' displayed as <code>«Python …»</code>, where the ellipsis is the object’s [https://docs.python.org/3/library/functions.html#repr repr]. Keep this wrapper when the object merely passes between Python calls, and invoke [[PyExplode]] when the data must be examined or manipulated within Analytica.

=== Converting from Python data to Analytica ===
When a Python function invoked from Analytica returns a result, Analytica automatically attempts to convert the Python data into the most appropriate Analytica value. For complex data structures, the dedicated [[PyExplode]] function is available to perform more specific conversions.

==== Automatic conversions ====
The following Python types are automatically converted to their corresponding Analytica equivalents without any extra steps:
{| class="wikitable"
! Python type !! Analytica type !! Notes
|-
| <code>int</code> || <code>Integer</code> ||''If the <code>int</code> exceeds the 64-bit signed-integer range, Analytica converts it to a double floating-point '''Number''' instead of an '''Integer'''.''
|-
| <code>float</code> || <code>Number</code> ||
|-
| <code>bool</code> || <code>Boolean</code> ||
|-
| <code>complex</code> || <code>ComplexNumber</code> ||
|-
| <code>str</code> || <code>Text</code> ||
|-
| <code>None</code> || <code>Null</code> ||
|-
| <code>date</code> || <code>DateTime</code> ||
|-
| <code>time</code> || <code>DateTime</code> ||
|-
| <code>datetime</code> || <code>DateTime</code> ||
|-
| <code>analytica.Value</code> || Unwrapped Analytica value ||
|-
| Any other Python object || ''Python opaque wrapper'' ||''Can be passed to other Python function calls or converted with <code>PyExplode</code>.''
|}

==== PyExplode ====
The [[PyExplode]] function provides explicit control for converting complex Python objects that are not converted automatically.

Key capabilities include:
* Unpacking Python built-in collections, like <code>list</code>, <code>tuple</code>, <code>set</code>, into a 1D Analytica array.
* Converting a Python <code>dict</code> into a 1D Analytica array, using the dictionary keys to create a new local index.
* Using nested calls to convert multi-dimensional data into multi-dimensional Analytica arrays.
* Fully converting a [https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html NumPy Array] into an n-dimensional Analytica array.
* Converting image objects from [https://pillow.readthedocs.io/en/stable/reference/Image.html#PIL.Image.Image PIL.Image] or [https://matplotlib.org/stable/api/_as_gen/matplotlib.figure.Figure.html matplotlib.figure.Figure] directly into Analytica images.
* Optionally excluding specific Python types from conversion with <code>excludeTypes</code>, which keeps them as opaque Python object handles.

''To convert a [https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.html Pandas DataFrame], you must use the <code>PyExplodeDataFrame</code> function. This function is not built-in and requires you to include the [[Python Pandas library]] in your model.''

=== Converting from Analytica to Python data structures ===
The bridge between Analytica and Python performs two kinds of mappings: ''automatic scalar conversions'' and ''explicit conversion functions'' for arrays.

==== Automatic scalar conversions ====
{| class="wikitable"
! Analytica type !! Python type
|-
| <code>Text</code> ||<code>str</code>
|-
| <code>Integer</code> ||<code>int</code>
|-
| <code>Number</code> ||<code>float</code>
|-
| <code>Boolean</code> ||<code>bool</code>
|-
| <code>ComplexNumber</code> ||<code>complex</code>
|-
| <code>DateTime</code> ||<code>datetime.datetime</code> / <code>datetime.time</code> / <code>datetime.date</code>
|-
| <code>Handle</code> ||<code>analytica.Object</code>
|-
| <code>Null / Undefined</code> ||<code>None</code>
|-
| ''Python opaque wrapper'' || unwrapped Python object
|-
| <code>Reference</code> ||<code>set</code>of the dereferenced contents
|-
| <code>Image</code> ||<code>PIL.Image.Image</code>
|-
| Everything else ||<code>analytica.Value</code> (wrapper for Analytica Values)
|}

==== Explicit conversion functions for arrays ====
Analytica has a single collection type—the array—whereas Python offers several (<code>list</code>, <code>tuple</code>, <code>dict</code>, <code>set</code>, <code>numpy.ndarray</code>, …). Because there is no one-to-one mapping, arrays are ''not'' converted implicitly; instead call one of the system functions below.

''<code>PyList</code>'', ''<code>PyTuple</code>'', ''<code>PySet</code>'', ''<code>PyDict</code> create a Python collection over the single dimension that you specify. In contrast, <code>PyArray</code> converts an entire Analytica array into a single <code>numpy.ndarray</code>.''

*[[PyList]] – Creates a Python <code>list</code> from the specified index, retaining other dimensions in Analytica.
* [[PyTuple]] – Creates a Python <code>tuple</code> from the chosen index of the array, retaining other dimensions in Analytica.
* [[PySet]] – Creates a Python <code>set</code> from the specified index, duplicate entries will be removed.
* [[PyDict]] – Creates a Python <code>dict</code> from an Analytica vector. The elements of a specified index are used as keys and the corresponding vector values become the dictionary values. The input vector must be indexed by the key index.
* [[PyArray]] – Converts an entire Analytica array into a single multi-dimensional <code>numpy.ndarray</code>. This function always converts all dimensions. The optional index parameters are used to specify the order of the axes in the resulting NumPy array. For any Analytica dimension not explicitly passed as a parameter, a local, positional index is created for that axis in the NumPy array. An optional <code>dtype</code> string passes directly to NumPy.

== Using Analytica locals from Python code ==

Analytica locals are visible by default to [[PyEval]] and [[PyExec]] when called within the same definition that introduces them (e.g., a definition using [[Local_Values|Local]] or a [[User-Defined_Functions|Function]] with parameters). To change visibility, pass explicit Python <code>globals</code> and <code>locals</code> mappings; providing an empty <code>locals</code> isolates the Python code from Analytica locals.

'''Example:''' <code>Local a := 5; PyEval("a + 1")</code> returns 6 because <code>a</code> is visible to the Python expression in that evaluation.

== Accessing Analytica objects from Python code ==
To interact with your Analytica model from Python, use the <code>analytica</code> module. This module is bundled with your Analytica installation and provides the necessary functions to access, evaluate, and manipulate objects within your model directly from Python.

To begin, you must [[#Importing Python libraries|import the module]] in your Python code:
<code>import analytica</code>

=== Getting a handle to an Analytica object ===
You can obtain a handle to any object in your model using<code>analytica.get('object_identifier')</code> in Python. This is useful when you want to refer to an object itself rather than its computed value. The function takes the identifier of the Analytica object as its argument and returns an <code>analytica.Object</code>.

''Example:''
To get a handle to a variable named <code>Revenue</code>, you would use:
<code>revenue_handle = analytica.get('Revenue')</code>

This assigns an <code>analytica.Object</code> representing the <code>Revenue</code> Analytica variable to the <code>revenue_handle</code> Python variable.

=== Evaluating an Analytica expression ===
To evaluate an Analytica expression, use <code>analytica.eval('Analytica_expression')</code>. This function evaluates the [[Evaluation Modes|mid-value]] of its string argument as an Analytica expression within the context of your model. To evaluate the [[Evaluation Modes|sample value]], use: <code>analytica.eval('Analytica expression', True)</code>.

<code>analytica.eval()</code> is the primary method for retrieving the calculated value of a variable. When it returns a value, it will [[#Converting from Analytica to Python data structures|implicitly convert]] many Analytica data types into their Python equivalents.

''Example:''
To get the computed value of the <code>Revenue</code> variable, you would evaluate its identifier:
<code>revenue_result = analytica.eval('Revenue')</code>

This executes the expression for <code>Revenue</code> and stores its final value in the <code>revenue_result</code> Python variable.

== No Python code in an input ==
Python code will not evaluate in a variable that has a [[User input node]]. This is to avoid a code injection attack in which a user of your model tries to run arbitrary code.

== Using Python in ACP or ADE ==
For security reasons, Python is not enabled on our public [https://acp.analytica.com ACP server]].

On a dedicated ACP server, python can be installed as used the same is with desktop Analytica.

Python integration can be used from an ADE deployment as well. You may want to set the default <code>Python Environment</code> by using regedit to add the string value <code>PythonEnvironment</code> to the hive
:<code>HKEY_LOCAL_MACHINE\SOFTWARE\Lumina Decision Systems\ADEW\{{#ifexpr: {{#svarget:anarelease|7.0}} > 7.0
| {{#svarget:anarelease|7.0}}
| 7.0
}}</code>
Alternatively, your model can specify the <code>Python model environment</code>.

In some ADE installations, you may want to disable Python integration for security reasons (i.e., if you don't have full control of the Analytica models that are run). To do so, add these lines to ADE's <code>Analytica.ini</code> file.
Att_whenDisallowed PyArray : 4
Att_whenDisallowed PyCall : 4
Att_whenDisallowed PyDict : 4
Att_whenDisallowed PyEval : 4
Att_whenDisallowed PyExec : 4
Att_whenDisallowed PyExplode : 4
Att_whenDisallowed _PyGet : 4
Att_whenDisallowed PyList : 4
Att_whenDisallowed PySet : 4
Att_whenDisallowed PyTuple : 4

== See also ==
* [[Using Python from Analytica/Setting up a Python environment|Setting up a Python environment]]
* [[Using Python from Analytica/Examples using Python|Examples using Python]]
* [https://videos.analytica.com/Analytica-Python/AnaPythonBasics.mp4 Video on Analytica-Python integration basics]

What's new in Analytica 7.0?

2026-02-11T22:28:18Z

Mhenrion: /* Index label auto updates */

[[category:What's new pages]]
[[category:Analytica releases]]

[[Analytica 7.0]] will be the next major Analytica release and is currently in [[Beta Tester Page|beta testing]]. Go to [[Beta Tester Page]] to try it. The current official release is [[Analytica 6.6]].

==Highlights of Analytica 7.0==

* '''[[#Python integration|Python integration]]:''' The major enhancement is integration with Python and hence the entire Python ecosystem of libraries. You can easily call functions from Python libraries, access Python variables, and even write Python code right inside Analytica variables and functions. So now you can mix and match Analytica and Python according to which language you think best for your modeling or coding needs.
* '''[[#Index label auto updates|Index label auto updates]]:''' A common source of errors has been when you change a text label in an Index without remembering to change expressions that refer to that same text label. Changes to labels now update automatically in expressions in most cases.
* The '''Analytica Enterprise'''' edition has been renamed the [[#Developer Edition (formerly known as Enterprise) |Developer edition]], which better reflects what it is.
* It introduces two new object Classes:
** [[Struct]] lets you bundle disparate values, like text, numbeers, atoms and arrays, together in one object that does not array abstract -- similar to Records and Classes in other languages).
** [[Callable]] is like a user-defined Function but it's Definition can be a [[handle]] to a Python class or a Python function.
* [[ParseJSON]] and [[MakeJSON]] now use Structs, which are much more convenient for representing the hierarchical structure of JSON.
* [[#SpreadsheetOpen|Read and write spreadsheets without Excel]]: This is faster and more robust, and you don't need Excel installed.

== [[Using Python from Analytica|Python integration]] ==

You can now write Python code inside Analytica definitions! It's easy to call Python functions, with Analytica-style Intelligent Arrays!. So you can access the vast ecosystem of Python libraries (''modules'' in Python lingo). Among the gazillion possibilities are specialized libraries for data visualization, statistics, machine learning, and much more.
It means that you can mix and match Analytica and Python -- write Analytica code for what's easiest in Analytica and Python code for what's easiest in Python.

See: [[Using Python from Analytica]]
(In [[Analytica Developer]] edition or better).

For the Analytica modeler, this puts a ton of resources at your fingertips.

It's also pretty cool for the Python developer. Analytica is like a new interactive development environment with a lot of unique advantages, especially during interactive code development:
* Analytica's dependency maintenance can be really convenient during interactive development, creating automatic dependency maintenance between your Python functions, classes and variables that don't exist in Python.
* The visual influence diagram layout can be a super useful to way organize and visualize your code.
* It naturally encourages declarative code practices, which leads to better and more maintainable coding style.
* You get the benefits of Analytica's edit tables, plus for results, Analytica's multi-D result tables and one-click, no-code, graphing.
* It is easy to wrap existing Python models to get Monte Carlo, parametric analysis and sensitivity analysis with Analytica ease.
* Sometimes one or the other language is more convenient for a particular task. You can freely switch between whichever language feels better suited to the immediate task, and intermix languages easily.

== Developer Edition (formerly known as Enterprise) ==

Analytica's middle-tier edition formerly known as the ''Enterprise Edition'', it is now called the [[Analytica Developer|Analytica Developer edition]]. That name better reflects what it is--software for developers of decision applications. If you're now a user of Analytica Enterprise you don't have to update your license or do anything special. The name will just change when you install Analytica 7.0. In Analytica docs, when you select "7.0" on the release bar (at the top of pages that have release-contingent content), all the docs automatically use the new Analytica Developer edition name.

== Analytica language extensions ==

=== Index label auto updates ===

When you change the identifier of a variable, Analytica automatically updates all Definitions to use the new name. But, when you change a text label in an Index, it previously cause cause errors in Definitions using that label. For example, if you have
<code>
Index Animal := ['Cat', 'Dog']
Variable Sound := IF Animal = 'Cat' THEN 'Miaow' ELSE 'Woof'
</code>
If you change <code> 'Cat'</code> to <code>'Feline' </code> in Index <code>Animal</code>, the Definition of <code>Sound</code> will now automatically update to
<code>
IF Animal = 'Feline' THEN 'Miaow' ELSE 'Woof'
</code>
It does this wherever it sees <code>Animal=<label></code>.
If you use the label in another context where the index would notnormally appear, you should the new [[Index-label dot syntax]] (<code>Animal . 'Cat'</code>) associates a text literal with its index to prevent it from getting out of sync, and to warn if it ever does. These [[Keeping text literals consistent with index labels| features]] help avoid common errors when updating text labels in Indexes.

=== Callable ===

The new object [[Class]] [[Callable]] is a variable-like object, meaning it has a [[Definition]] and a computed value, but can be used for convenience and documentation when the computed value itself is something that can be called, such as a [[Local function]] (aka ''lambda function''), a [[handle]] to an global function, a Python class or a Python function.

If you "compute" the identity of a callable data item inside a normal [[Variable]] instance, <code>X</code>, you could call it using the syntax <code>X->(a,b,c)</code>. On your influence diagram the object would have a rounded rectangle and thus would not communicate that the result is something that can be called. When you change its class to be a [[Callable]], you can then invoke the call using the syntax <code>X(a,b,c)</code> and the shape of the node changes to something that resembles a function shape, thus communicating that this holds something that is callable.

To create a callable, first create a [[Variable]] node, then use the [[Class]] dropdown from the [[Object window]] or [[Attribute pane]] to change the class to ''Callable''.

=== Struct ===
A [[Struct]] defines a new atomic, immutable data type. For use when you need to bundle multiple heterogeneous items and don't want their dimensionalities to interact. Array abstract treats an instance of a Struct as a single cell (an atom).

=== Expression and Lazy qualifiers ===
An expression passed to a function parameter declared with the qualifier as <code>[[Function_parameter_qualifiers#Expression|Expression]]</code> can now include local variable identifiers. The local variables are captured (similar to how they would be captured by a [[Local function]]).

A new function parameter qualifier, [[Function_parameter_qualifiers#Lazy]], has been added, which does lazy evaluation of the expression passed to it. In the function Definition, you can use it as if it were a normal value parameter, but evaluation occurs when the value is used rather than when the function is called, and in the evaluation context (which includes the [[Evaluation modes|evaluation mode]]) where the value is used instead as in the context of the call.

=== Excess parameter qualifier ===
A new function declaration allows a function to tolerate or capture excess named parameters in the call that are not declared as parameter names in the function's Parameters declaration. It can also be used in a [[Struct]] declaration.

== Functions ==
=== ParseJSON ===
Changed to parse to [[Struct]]s, thus greatly simplifying and improving the convenience of using JSON in Analytica expressions.

For parsing with a schema, a Struct's declaration serves as the schema, which is far easier and more familiar for an Analytica user than the former scheme for specifying a schema.

[[MakeJSON]] is able to generate JSON from a Struct (or nested structs) as well, which is the most convenient representation for JSON representations.

=== SpreadsheetOpen ===
Added a new «backend» parameter to [[SpreadsheetOpen]] with a new option of <code>'LibXl'</code>, allowing you to read and manipulate a spreadsheet without having Excel installed. But unlike the Excel backend, the <b>LibXl</b> option does not have a calculation engine (so can't recompute cell formulas after you change cells). This option is be better when you simply want to read (or write) data in a *.xlsx file format.

== Example models and libraries ==

* There is a new "Auto insurance claim risk analysis.ana" in the Example Models / Risk Analysis folder.
* The [[Mutables library]] has been updated. It provides a new [[Mutable]] [[Struct]] which is superior to the older representation, which displays the actual value in result table cells and is atomic. The legacy functions ([[MutableNew]], [[MutableSet]] and [[MutableGet]]) are still there for backward compatibility, but have been changed to just wrap the new Mutable.

== Result tables and graphs ==
* A blank (none) entry was added to the [[XY_comparison#Use_comparison_index|comparison index pulldown]]. Use this to quickly unset the comparison index without having to re-enter the [[XY_comparison]] dialog. Also, the pulldown is now visible and enabled in browse mode.
* Comparison variables are no longer summed over slicer indexes that are set to '''Totals''' when the value for that variable does not include the slicer index. Note that this results in some changes to what is displayed in table body cells and in axis scaling on graphs.

== Assista ==

You can now copy-paste from Expression blocks in Assista's response using the little copy icon in the top-right corner of the expression block.

== Experimental ==
* A way for an Analytica model running in desktop Analytica to [[MCP server in Analytica|act as a Model Context Protocol (MCP) server]] for use by Large Language Models (LLMs).

== ADE ==
* Added a new example: <code>Mcp_server</code>. This is an MCP server that wraps ADE. Among other things, it can give AI agents like Claude Code the ability to build, explore and use Analytica models.

What's new in Analytica 7.0?

2026-02-11T22:27:54Z

Mhenrion: /* Index label auto updates */

[[category:What's new pages]]
[[category:Analytica releases]]

[[Analytica 7.0]] will be the next major Analytica release and is currently in [[Beta Tester Page|beta testing]]. Go to [[Beta Tester Page]] to try it. The current official release is [[Analytica 6.6]].

==Highlights of Analytica 7.0==

* '''[[#Python integration|Python integration]]:''' The major enhancement is integration with Python and hence the entire Python ecosystem of libraries. You can easily call functions from Python libraries, access Python variables, and even write Python code right inside Analytica variables and functions. So now you can mix and match Analytica and Python according to which language you think best for your modeling or coding needs.
* '''[[#Index label auto updates|Index label auto updates]]:''' A common source of errors has been when you change a text label in an Index without remembering to change expressions that refer to that same text label. Changes to labels now update automatically in expressions in most cases.
* The '''Analytica Enterprise'''' edition has been renamed the [[#Developer Edition (formerly known as Enterprise) |Developer edition]], which better reflects what it is.
* It introduces two new object Classes:
** [[Struct]] lets you bundle disparate values, like text, numbeers, atoms and arrays, together in one object that does not array abstract -- similar to Records and Classes in other languages).
** [[Callable]] is like a user-defined Function but it's Definition can be a [[handle]] to a Python class or a Python function.
* [[ParseJSON]] and [[MakeJSON]] now use Structs, which are much more convenient for representing the hierarchical structure of JSON.
* [[#SpreadsheetOpen|Read and write spreadsheets without Excel]]: This is faster and more robust, and you don't need Excel installed.

== [[Using Python from Analytica|Python integration]] ==

You can now write Python code inside Analytica definitions! It's easy to call Python functions, with Analytica-style Intelligent Arrays!. So you can access the vast ecosystem of Python libraries (''modules'' in Python lingo). Among the gazillion possibilities are specialized libraries for data visualization, statistics, machine learning, and much more.
It means that you can mix and match Analytica and Python -- write Analytica code for what's easiest in Analytica and Python code for what's easiest in Python.

See: [[Using Python from Analytica]]
(In [[Analytica Developer]] edition or better).

For the Analytica modeler, this puts a ton of resources at your fingertips.

It's also pretty cool for the Python developer. Analytica is like a new interactive development environment with a lot of unique advantages, especially during interactive code development:
* Analytica's dependency maintenance can be really convenient during interactive development, creating automatic dependency maintenance between your Python functions, classes and variables that don't exist in Python.
* The visual influence diagram layout can be a super useful to way organize and visualize your code.
* It naturally encourages declarative code practices, which leads to better and more maintainable coding style.
* You get the benefits of Analytica's edit tables, plus for results, Analytica's multi-D result tables and one-click, no-code, graphing.
* It is easy to wrap existing Python models to get Monte Carlo, parametric analysis and sensitivity analysis with Analytica ease.
* Sometimes one or the other language is more convenient for a particular task. You can freely switch between whichever language feels better suited to the immediate task, and intermix languages easily.

== Developer Edition (formerly known as Enterprise) ==

Analytica's middle-tier edition formerly known as the ''Enterprise Edition'', it is now called the [[Analytica Developer|Analytica Developer edition]]. That name better reflects what it is--software for developers of decision applications. If you're now a user of Analytica Enterprise you don't have to update your license or do anything special. The name will just change when you install Analytica 7.0. In Analytica docs, when you select "7.0" on the release bar (at the top of pages that have release-contingent content), all the docs automatically use the new Analytica Developer edition name.

== Analytica language extensions ==

=== Index label auto updates ===

When you change the identifier of a variable, Analytica automatically updates all Definitions to use the new name. But, when you change a text label in an Index, it previously cause cause errors in Definitions using that label. For example, if you have
<code>
Index Animal := ['Cat', 'Dog']
Variable Sound := IF Animal = 'Cat' THEN 'Miaow' ELSE 'Woof'
</code>
If you change <code> 'Cat'</code> to <code>'Feline' </code> in Index <code>Animal</code>, the Definition of <code>Sound</code> will now automatically update to
<code>
IF Animal = 'Feline' THEN 'Miaow' ELSE 'Woof'
</code>)
It does this wherever it sees <code>Animal=<label></code>).
If you use the label in another context where the index would notnormally appear, you should the new [[Index-label dot syntax]] (<code>Animal . 'Cat'</code>) associates a text literal with its index to prevent it from getting out of sync, and to warn if it ever does. These [[Keeping text literals consistent with index labels| features]] help avoid common errors when updating text labels in Indexes.

=== Callable ===

The new object [[Class]] [[Callable]] is a variable-like object, meaning it has a [[Definition]] and a computed value, but can be used for convenience and documentation when the computed value itself is something that can be called, such as a [[Local function]] (aka ''lambda function''), a [[handle]] to an global function, a Python class or a Python function.

If you "compute" the identity of a callable data item inside a normal [[Variable]] instance, <code>X</code>, you could call it using the syntax <code>X->(a,b,c)</code>. On your influence diagram the object would have a rounded rectangle and thus would not communicate that the result is something that can be called. When you change its class to be a [[Callable]], you can then invoke the call using the syntax <code>X(a,b,c)</code> and the shape of the node changes to something that resembles a function shape, thus communicating that this holds something that is callable.

To create a callable, first create a [[Variable]] node, then use the [[Class]] dropdown from the [[Object window]] or [[Attribute pane]] to change the class to ''Callable''.

=== Struct ===
A [[Struct]] defines a new atomic, immutable data type. For use when you need to bundle multiple heterogeneous items and don't want their dimensionalities to interact. Array abstract treats an instance of a Struct as a single cell (an atom).

=== Expression and Lazy qualifiers ===
An expression passed to a function parameter declared with the qualifier as <code>[[Function_parameter_qualifiers#Expression|Expression]]</code> can now include local variable identifiers. The local variables are captured (similar to how they would be captured by a [[Local function]]).

A new function parameter qualifier, [[Function_parameter_qualifiers#Lazy]], has been added, which does lazy evaluation of the expression passed to it. In the function Definition, you can use it as if it were a normal value parameter, but evaluation occurs when the value is used rather than when the function is called, and in the evaluation context (which includes the [[Evaluation modes|evaluation mode]]) where the value is used instead as in the context of the call.

=== Excess parameter qualifier ===
A new function declaration allows a function to tolerate or capture excess named parameters in the call that are not declared as parameter names in the function's Parameters declaration. It can also be used in a [[Struct]] declaration.

== Functions ==
=== ParseJSON ===
Changed to parse to [[Struct]]s, thus greatly simplifying and improving the convenience of using JSON in Analytica expressions.

For parsing with a schema, a Struct's declaration serves as the schema, which is far easier and more familiar for an Analytica user than the former scheme for specifying a schema.

[[MakeJSON]] is able to generate JSON from a Struct (or nested structs) as well, which is the most convenient representation for JSON representations.

=== SpreadsheetOpen ===
Added a new «backend» parameter to [[SpreadsheetOpen]] with a new option of <code>'LibXl'</code>, allowing you to read and manipulate a spreadsheet without having Excel installed. But unlike the Excel backend, the <b>LibXl</b> option does not have a calculation engine (so can't recompute cell formulas after you change cells). This option is be better when you simply want to read (or write) data in a *.xlsx file format.

== Example models and libraries ==

* There is a new "Auto insurance claim risk analysis.ana" in the Example Models / Risk Analysis folder.
* The [[Mutables library]] has been updated. It provides a new [[Mutable]] [[Struct]] which is superior to the older representation, which displays the actual value in result table cells and is atomic. The legacy functions ([[MutableNew]], [[MutableSet]] and [[MutableGet]]) are still there for backward compatibility, but have been changed to just wrap the new Mutable.

== Result tables and graphs ==
* A blank (none) entry was added to the [[XY_comparison#Use_comparison_index|comparison index pulldown]]. Use this to quickly unset the comparison index without having to re-enter the [[XY_comparison]] dialog. Also, the pulldown is now visible and enabled in browse mode.
* Comparison variables are no longer summed over slicer indexes that are set to '''Totals''' when the value for that variable does not include the slicer index. Note that this results in some changes to what is displayed in table body cells and in axis scaling on graphs.

== Assista ==

You can now copy-paste from Expression blocks in Assista's response using the little copy icon in the top-right corner of the expression block.

== Experimental ==
* A way for an Analytica model running in desktop Analytica to [[MCP server in Analytica|act as a Model Context Protocol (MCP) server]] for use by Large Language Models (LLMs).

== ADE ==
* Added a new example: <code>Mcp_server</code>. This is an MCP server that wraps ADE. Among other things, it can give AI agents like Claude Code the ability to build, explore and use Analytica models.

What's new in Analytica 7.0?

2026-02-11T22:27:33Z

Mhenrion: /* Index label auto updates */

[[category:What's new pages]]
[[category:Analytica releases]]

[[Analytica 7.0]] will be the next major Analytica release and is currently in [[Beta Tester Page|beta testing]]. Go to [[Beta Tester Page]] to try it. The current official release is [[Analytica 6.6]].

==Highlights of Analytica 7.0==

* '''[[#Python integration|Python integration]]:''' The major enhancement is integration with Python and hence the entire Python ecosystem of libraries. You can easily call functions from Python libraries, access Python variables, and even write Python code right inside Analytica variables and functions. So now you can mix and match Analytica and Python according to which language you think best for your modeling or coding needs.
* '''[[#Index label auto updates|Index label auto updates]]:''' A common source of errors has been when you change a text label in an Index without remembering to change expressions that refer to that same text label. Changes to labels now update automatically in expressions in most cases.
* The '''Analytica Enterprise'''' edition has been renamed the [[#Developer Edition (formerly known as Enterprise) |Developer edition]], which better reflects what it is.
* It introduces two new object Classes:
** [[Struct]] lets you bundle disparate values, like text, numbeers, atoms and arrays, together in one object that does not array abstract -- similar to Records and Classes in other languages).
** [[Callable]] is like a user-defined Function but it's Definition can be a [[handle]] to a Python class or a Python function.
* [[ParseJSON]] and [[MakeJSON]] now use Structs, which are much more convenient for representing the hierarchical structure of JSON.
* [[#SpreadsheetOpen|Read and write spreadsheets without Excel]]: This is faster and more robust, and you don't need Excel installed.

== [[Using Python from Analytica|Python integration]] ==

You can now write Python code inside Analytica definitions! It's easy to call Python functions, with Analytica-style Intelligent Arrays!. So you can access the vast ecosystem of Python libraries (''modules'' in Python lingo). Among the gazillion possibilities are specialized libraries for data visualization, statistics, machine learning, and much more.
It means that you can mix and match Analytica and Python -- write Analytica code for what's easiest in Analytica and Python code for what's easiest in Python.

See: [[Using Python from Analytica]]
(In [[Analytica Developer]] edition or better).

For the Analytica modeler, this puts a ton of resources at your fingertips.

It's also pretty cool for the Python developer. Analytica is like a new interactive development environment with a lot of unique advantages, especially during interactive code development:
* Analytica's dependency maintenance can be really convenient during interactive development, creating automatic dependency maintenance between your Python functions, classes and variables that don't exist in Python.
* The visual influence diagram layout can be a super useful to way organize and visualize your code.
* It naturally encourages declarative code practices, which leads to better and more maintainable coding style.
* You get the benefits of Analytica's edit tables, plus for results, Analytica's multi-D result tables and one-click, no-code, graphing.
* It is easy to wrap existing Python models to get Monte Carlo, parametric analysis and sensitivity analysis with Analytica ease.
* Sometimes one or the other language is more convenient for a particular task. You can freely switch between whichever language feels better suited to the immediate task, and intermix languages easily.

== Developer Edition (formerly known as Enterprise) ==

Analytica's middle-tier edition formerly known as the ''Enterprise Edition'', it is now called the [[Analytica Developer|Analytica Developer edition]]. That name better reflects what it is--software for developers of decision applications. If you're now a user of Analytica Enterprise you don't have to update your license or do anything special. The name will just change when you install Analytica 7.0. In Analytica docs, when you select "7.0" on the release bar (at the top of pages that have release-contingent content), all the docs automatically use the new Analytica Developer edition name.

== Analytica language extensions ==

=== Index label auto updates ===

=== Index label auto updates ===

When you change the identifier of a variable, Analytica automatically updates all Definitions to use the new name. But, when you change a text label in an Index, it previously cause cause errors in Definitions using that label. For example, if you have
<code>
Index Animal := ['Cat', 'Dog']
Variable Sound := IF Animal = 'Cat' THEN 'Miaow' ELSE 'Woof'
</code>
If you change <code> 'Cat'</code> to <code>'Feline' </code> in Index <code>Animal</code>, the Definition of <code>Sound</code> will now automatically update to
<code>
IF Animal = 'Feline' THEN 'Miaow' ELSE 'Woof'
</code>)
It does this wherever it sees <code>Animal=<label></code>).
If you use the label in another context where the index would notnormally appear, you should the new [[Index-label dot syntax]] (<code>Animal . 'Cat'</code>) associates a text literal with its index to prevent it from getting out of sync, and to warn if it ever does. These [[Keeping text literals consistent with index labels| features]] help avoid common errors when updating text labels in Indexes.

=== Callable ===

The new object [[Class]] [[Callable]] is a variable-like object, meaning it has a [[Definition]] and a computed value, but can be used for convenience and documentation when the computed value itself is something that can be called, such as a [[Local function]] (aka ''lambda function''), a [[handle]] to an global function, a Python class or a Python function.

If you "compute" the identity of a callable data item inside a normal [[Variable]] instance, <code>X</code>, you could call it using the syntax <code>X->(a,b,c)</code>. On your influence diagram the object would have a rounded rectangle and thus would not communicate that the result is something that can be called. When you change its class to be a [[Callable]], you can then invoke the call using the syntax <code>X(a,b,c)</code> and the shape of the node changes to something that resembles a function shape, thus communicating that this holds something that is callable.

To create a callable, first create a [[Variable]] node, then use the [[Class]] dropdown from the [[Object window]] or [[Attribute pane]] to change the class to ''Callable''.

=== Struct ===
A [[Struct]] defines a new atomic, immutable data type. For use when you need to bundle multiple heterogeneous items and don't want their dimensionalities to interact. Array abstract treats an instance of a Struct as a single cell (an atom).

=== Expression and Lazy qualifiers ===
An expression passed to a function parameter declared with the qualifier as <code>[[Function_parameter_qualifiers#Expression|Expression]]</code> can now include local variable identifiers. The local variables are captured (similar to how they would be captured by a [[Local function]]).

A new function parameter qualifier, [[Function_parameter_qualifiers#Lazy]], has been added, which does lazy evaluation of the expression passed to it. In the function Definition, you can use it as if it were a normal value parameter, but evaluation occurs when the value is used rather than when the function is called, and in the evaluation context (which includes the [[Evaluation modes|evaluation mode]]) where the value is used instead as in the context of the call.

=== Excess parameter qualifier ===
A new function declaration allows a function to tolerate or capture excess named parameters in the call that are not declared as parameter names in the function's Parameters declaration. It can also be used in a [[Struct]] declaration.

== Functions ==
=== ParseJSON ===
Changed to parse to [[Struct]]s, thus greatly simplifying and improving the convenience of using JSON in Analytica expressions.

For parsing with a schema, a Struct's declaration serves as the schema, which is far easier and more familiar for an Analytica user than the former scheme for specifying a schema.

[[MakeJSON]] is able to generate JSON from a Struct (or nested structs) as well, which is the most convenient representation for JSON representations.

=== SpreadsheetOpen ===
Added a new «backend» parameter to [[SpreadsheetOpen]] with a new option of <code>'LibXl'</code>, allowing you to read and manipulate a spreadsheet without having Excel installed. But unlike the Excel backend, the <b>LibXl</b> option does not have a calculation engine (so can't recompute cell formulas after you change cells). This option is be better when you simply want to read (or write) data in a *.xlsx file format.

== Example models and libraries ==

* There is a new "Auto insurance claim risk analysis.ana" in the Example Models / Risk Analysis folder.
* The [[Mutables library]] has been updated. It provides a new [[Mutable]] [[Struct]] which is superior to the older representation, which displays the actual value in result table cells and is atomic. The legacy functions ([[MutableNew]], [[MutableSet]] and [[MutableGet]]) are still there for backward compatibility, but have been changed to just wrap the new Mutable.

== Result tables and graphs ==
* A blank (none) entry was added to the [[XY_comparison#Use_comparison_index|comparison index pulldown]]. Use this to quickly unset the comparison index without having to re-enter the [[XY_comparison]] dialog. Also, the pulldown is now visible and enabled in browse mode.
* Comparison variables are no longer summed over slicer indexes that are set to '''Totals''' when the value for that variable does not include the slicer index. Note that this results in some changes to what is displayed in table body cells and in axis scaling on graphs.

== Assista ==

You can now copy-paste from Expression blocks in Assista's response using the little copy icon in the top-right corner of the expression block.

== Experimental ==
* A way for an Analytica model running in desktop Analytica to [[MCP server in Analytica|act as a Model Context Protocol (MCP) server]] for use by Large Language Models (LLMs).

== ADE ==
* Added a new example: <code>Mcp_server</code>. This is an MCP server that wraps ADE. Among other things, it can give AI agents like Claude Code the ability to build, explore and use Analytica models.

What's new in Analytica 7.0?

2026-02-11T20:26:26Z

Mhenrion: /* Highlights of Analytica 7.0 */

[[category:What's new pages]]
[[category:Analytica releases]]

[[Analytica 7.0]] will be the next major Analytica release and is currently in [[Beta Tester Page|beta testing]]. Go to [[Beta Tester Page]] to try it. The current official release is [[Analytica 6.6]].

==Highlights of Analytica 7.0==

* '''[[#Python integration|Python integration]]:''' The major enhancement is integration with Python and hence the entire Python ecosystem of libraries. You can easily call functions from Python libraries, access Python variables, and even write Python code right inside Analytica variables and functions. So now you can mix and match Analytica and Python according to which language you think best for your modeling or coding needs.
* '''[[#Index label auto updates|Index label auto updates]]:''' A common source of errors has been when you change a text label in an Index without remembering to change expressions that refer to that same text label. Changes to labels now update automatically in expressions in most cases.
* The '''Analytica Enterprise'''' edition has been renamed the [[#Developer Edition (formerly known as Enterprise) |Developer edition]], which better reflects what it is.
* It introduces two new object Classes:
** [[Struct]] lets you bundle disparate values, like text, numbeers, atoms and arrays, together in one object that does not array abstract -- similar to Records and Classes in other languages).
** [[Callable]] is like a user-defined Function but it's Definition can be a [[handle]] to a Python class or a Python function.
* [[ParseJSON]] and [[MakeJSON]] now use Structs, which are much more convenient for representing the hierarchical structure of JSON.
* [[#SpreadsheetOpen|Read and write spreadsheets without Excel]]: This is faster and more robust, and you don't need Excel installed.

== [[Using Python from Analytica|Python integration]] ==

You can now write Python code inside Analytica definitions! It's easy to call Python functions, with Analytica-style Intelligent Arrays!. So you can access the vast ecosystem of Python libraries (''modules'' in Python lingo). Among the gazillion possibilities are specialized libraries for data visualization, statistics, machine learning, and much more.
It means that you can mix and match Analytica and Python -- write Analytica code for what's easiest in Analytica and Python code for what's easiest in Python.

See: [[Using Python from Analytica]]
(In [[Analytica Developer]] edition or better).

For the Analytica modeler, this puts a ton of resources at your fingertips.

It's also pretty cool for the Python developer. Analytica is like a new interactive development environment with a lot of unique advantages, especially during interactive code development:
* Analytica's dependency maintenance can be really convenient during interactive development, creating automatic dependency maintenance between your Python functions, classes and variables that don't exist in Python.
* The visual influence diagram layout can be a super useful to way organize and visualize your code.
* It naturally encourages declarative code practices, which leads to better and more maintainable coding style.
* You get the benefits of Analytica's edit tables, plus for results, Analytica's multi-D result tables and one-click, no-code, graphing.
* It is easy to wrap existing Python models to get Monte Carlo, parametric analysis and sensitivity analysis with Analytica ease.
* Sometimes one or the other language is more convenient for a particular task. You can freely switch between whichever language feels better suited to the immediate task, and intermix languages easily.

== Developer Edition (formerly known as Enterprise) ==

Analytica's middle-tier edition formerly known as the ''Enterprise Edition'', it is now called the [[Analytica Developer|Analytica Developer edition]]. That name better reflects what it is--software for developers of decision applications. If you're now a user of Analytica Enterprise you don't have to update your license or do anything special. The name will just change when you install Analytica 7.0. In Analytica docs, when you select "7.0" on the release bar (at the top of pages that have release-contingent content), all the docs automatically use the new Analytica Developer edition name.

== Analytica language extensions ==

=== Index label auto updates ===

When you change a text label in an Index, it can update code to use the new text label. Iit automatically updates text literals in other expressions that compare to or subscript on an index. The new [[Index-label dot syntax]] ( <code>I . "label"</code>) associates a text literal with its index to prevent it from getting out of sync, and to warn if it ever does. These [[Keeping text literals consistent with index labels| features]] help avoid common errors when updating text labels in Indexes.

=== Callable ===

The new object [[Class]] [[Callable]] is a variable-like object, meaning it has a [[Definition]] and a computed value, but can be used for convenience and documentation when the computed value itself is something that can be called, such as a [[Local function]] (aka ''lambda function''), a [[handle]] to an global function, a Python class or a Python function.

If you "compute" the identity of a callable data item inside a normal [[Variable]] instance, <code>X</code>, you could call it using the syntax <code>X->(a,b,c)</code>. On your influence diagram the object would have a rounded rectangle and thus would not communicate that the result is something that can be called. When you change its class to be a [[Callable]], you can then invoke the call using the syntax <code>X(a,b,c)</code> and the shape of the node changes to something that resembles a function shape, thus communicating that this holds something that is callable.

To create a callable, first create a [[Variable]] node, then use the [[Class]] dropdown from the [[Object window]] or [[Attribute pane]] to change the class to ''Callable''.

=== Struct ===
A [[Struct]] defines a new atomic, immutable data type. For use when you need to bundle multiple heterogeneous items and don't want their dimensionalities to interact. Array abstract treats an instance of a Struct as a single cell (an atom).

=== Expression and Lazy qualifiers ===
An expression passed to a function parameter declared with the qualifier as <code>[[Function_parameter_qualifiers#Expression|Expression]]</code> can now include local variable identifiers. The local variables are captured (similar to how they would be captured by a [[Local function]]).

A new function parameter qualifier, [[Function_parameter_qualifiers#Lazy]], has been added, which does lazy evaluation of the expression passed to it. In the function Definition, you can use it as if it were a normal value parameter, but evaluation occurs when the value is used rather than when the function is called, and in the evaluation context (which includes the [[Evaluation modes|evaluation mode]]) where the value is used instead as in the context of the call.

=== Excess parameter qualifier ===
A new function declaration allows a function to tolerate or capture excess named parameters in the call that are not declared as parameter names in the function's Parameters declaration. It can also be used in a [[Struct]] declaration.

== Functions ==
=== ParseJSON ===
Changed to parse to [[Struct]]s, thus greatly simplifying and improving the convenience of using JSON in Analytica expressions.

For parsing with a schema, a Struct's declaration serves as the schema, which is far easier and more familiar for an Analytica user than the former scheme for specifying a schema.

[[MakeJSON]] is able to generate JSON from a Struct (or nested structs) as well, which is the most convenient representation for JSON representations.

=== SpreadsheetOpen ===
Added a new «backend» parameter to [[SpreadsheetOpen]] with a new option of <code>'LibXl'</code>, allowing you to read and manipulate a spreadsheet without having Excel installed. But unlike the Excel backend, the <b>LibXl</b> option does not have a calculation engine (so can't recompute cell formulas after you change cells). This option is be better when you simply want to read (or write) data in a *.xlsx file format.

== Example models and libraries ==

* There is a new "Auto insurance claim risk analysis.ana" in the Example Models / Risk Analysis folder.
* The [[Mutables library]] has been updated. It provides a new [[Mutable]] [[Struct]] which is superior to the older representation, which displays the actual value in result table cells and is atomic. The legacy functions ([[MutableNew]], [[MutableSet]] and [[MutableGet]]) are still there for backward compatibility, but have been changed to just wrap the new Mutable.

== Result tables and graphs ==
* A blank (none) entry was added to the [[XY_comparison#Use_comparison_index|comparison index pulldown]]. Use this to quickly unset the comparison index without having to re-enter the [[XY_comparison]] dialog. Also, the pulldown is now visible and enabled in browse mode.
* Comparison variables are no longer summed over slicer indexes that are set to '''Totals''' when the value for that variable does not include the slicer index. Note that this results in some changes to what is displayed in table body cells and in axis scaling on graphs.

== Assista ==

You can now copy-paste from Expression blocks in Assista's response using the little copy icon in the top-right corner of the expression block.

== Experimental ==
* A way for an Analytica model running in desktop Analytica to [[MCP server in Analytica|act as a Model Context Protocol (MCP) server]] for use by Large Language Models (LLMs).

== ADE ==
* Added a new example: <code>Mcp_server</code>. This is an MCP server that wraps ADE. Among other things, it can give AI agents like Claude Code the ability to build, explore and use Analytica models.

What's new in Analytica 7.0?

2026-02-11T20:25:55Z

Mhenrion: /* Highlights of Analytica 7.0 */

[[category:What's new pages]]
[[category:Analytica releases]]

[[Analytica 7.0]] will be the next major Analytica release and is currently in [[Beta Tester Page|beta testing]]. Go to [[Beta Tester Page]] to try it. The current official release is [[Analytica 6.6]].

==Highlights of Analytica 7.0==

* '''[[#Python integration|Python integration]]:''' The major enhancement is integration with Python and hence the entire Python ecosystem of libraries. You can easily call functions from Python libraries, access Python variables, and even write Python code right inside Analytica variables and functions. So now you can mix and match Analytica and Python according to which language you think best for your modeling or coding needs.
* '''[[#Index label auto updates|Index label auto updates:''' A common source of errors has been when you change a text label in an Index without remembering to change expressions that refer to that same text label. Changes to labels now update automatically in expressions in most cases.
* The '''Analytica Enterprise'''' edition has been renamed the [[#Developer Edition (formerly known as Enterprise) |Developer edition]], which better reflects what it is.
* It introduces two new object Classes:
** [[Struct]] lets you bundle disparate values, like text, numbeers, atoms and arrays, together in one object that does not array abstract -- similar to Records and Classes in other languages).
** [[Callable]] is like a user-defined Function but it's Definition can be a [[handle]] to a Python class or a Python function.
* [[ParseJSON]] and [[MakeJSON]] now use Structs, which are much more convenient for representing the hierarchical structure of JSON.
* [[#SpreadsheetOpen|Read and write spreadsheets without Excel]]: This is faster and more robust, and you don't need Excel installed.

== [[Using Python from Analytica|Python integration]] ==

You can now write Python code inside Analytica definitions! It's easy to call Python functions, with Analytica-style Intelligent Arrays!. So you can access the vast ecosystem of Python libraries (''modules'' in Python lingo). Among the gazillion possibilities are specialized libraries for data visualization, statistics, machine learning, and much more.
It means that you can mix and match Analytica and Python -- write Analytica code for what's easiest in Analytica and Python code for what's easiest in Python.

See: [[Using Python from Analytica]]
(In [[Analytica Developer]] edition or better).

For the Analytica modeler, this puts a ton of resources at your fingertips.

It's also pretty cool for the Python developer. Analytica is like a new interactive development environment with a lot of unique advantages, especially during interactive code development:
* Analytica's dependency maintenance can be really convenient during interactive development, creating automatic dependency maintenance between your Python functions, classes and variables that don't exist in Python.
* The visual influence diagram layout can be a super useful to way organize and visualize your code.
* It naturally encourages declarative code practices, which leads to better and more maintainable coding style.
* You get the benefits of Analytica's edit tables, plus for results, Analytica's multi-D result tables and one-click, no-code, graphing.
* It is easy to wrap existing Python models to get Monte Carlo, parametric analysis and sensitivity analysis with Analytica ease.
* Sometimes one or the other language is more convenient for a particular task. You can freely switch between whichever language feels better suited to the immediate task, and intermix languages easily.

== Developer Edition (formerly known as Enterprise) ==

Analytica's middle-tier edition formerly known as the ''Enterprise Edition'', it is now called the [[Analytica Developer|Analytica Developer edition]]. That name better reflects what it is--software for developers of decision applications. If you're now a user of Analytica Enterprise you don't have to update your license or do anything special. The name will just change when you install Analytica 7.0. In Analytica docs, when you select "7.0" on the release bar (at the top of pages that have release-contingent content), all the docs automatically use the new Analytica Developer edition name.

== Analytica language extensions ==

=== Index label auto updates ===

When you change a text label in an Index, it can update code to use the new text label. Iit automatically updates text literals in other expressions that compare to or subscript on an index. The new [[Index-label dot syntax]] ( <code>I . "label"</code>) associates a text literal with its index to prevent it from getting out of sync, and to warn if it ever does. These [[Keeping text literals consistent with index labels| features]] help avoid common errors when updating text labels in Indexes.

=== Callable ===

The new object [[Class]] [[Callable]] is a variable-like object, meaning it has a [[Definition]] and a computed value, but can be used for convenience and documentation when the computed value itself is something that can be called, such as a [[Local function]] (aka ''lambda function''), a [[handle]] to an global function, a Python class or a Python function.

If you "compute" the identity of a callable data item inside a normal [[Variable]] instance, <code>X</code>, you could call it using the syntax <code>X->(a,b,c)</code>. On your influence diagram the object would have a rounded rectangle and thus would not communicate that the result is something that can be called. When you change its class to be a [[Callable]], you can then invoke the call using the syntax <code>X(a,b,c)</code> and the shape of the node changes to something that resembles a function shape, thus communicating that this holds something that is callable.

To create a callable, first create a [[Variable]] node, then use the [[Class]] dropdown from the [[Object window]] or [[Attribute pane]] to change the class to ''Callable''.

=== Struct ===
A [[Struct]] defines a new atomic, immutable data type. For use when you need to bundle multiple heterogeneous items and don't want their dimensionalities to interact. Array abstract treats an instance of a Struct as a single cell (an atom).

=== Expression and Lazy qualifiers ===
An expression passed to a function parameter declared with the qualifier as <code>[[Function_parameter_qualifiers#Expression|Expression]]</code> can now include local variable identifiers. The local variables are captured (similar to how they would be captured by a [[Local function]]).

A new function parameter qualifier, [[Function_parameter_qualifiers#Lazy]], has been added, which does lazy evaluation of the expression passed to it. In the function Definition, you can use it as if it were a normal value parameter, but evaluation occurs when the value is used rather than when the function is called, and in the evaluation context (which includes the [[Evaluation modes|evaluation mode]]) where the value is used instead as in the context of the call.

=== Excess parameter qualifier ===
A new function declaration allows a function to tolerate or capture excess named parameters in the call that are not declared as parameter names in the function's Parameters declaration. It can also be used in a [[Struct]] declaration.

== Functions ==
=== ParseJSON ===
Changed to parse to [[Struct]]s, thus greatly simplifying and improving the convenience of using JSON in Analytica expressions.

For parsing with a schema, a Struct's declaration serves as the schema, which is far easier and more familiar for an Analytica user than the former scheme for specifying a schema.

[[MakeJSON]] is able to generate JSON from a Struct (or nested structs) as well, which is the most convenient representation for JSON representations.

=== SpreadsheetOpen ===
Added a new «backend» parameter to [[SpreadsheetOpen]] with a new option of <code>'LibXl'</code>, allowing you to read and manipulate a spreadsheet without having Excel installed. But unlike the Excel backend, the <b>LibXl</b> option does not have a calculation engine (so can't recompute cell formulas after you change cells). This option is be better when you simply want to read (or write) data in a *.xlsx file format.

== Example models and libraries ==

* There is a new "Auto insurance claim risk analysis.ana" in the Example Models / Risk Analysis folder.
* The [[Mutables library]] has been updated. It provides a new [[Mutable]] [[Struct]] which is superior to the older representation, which displays the actual value in result table cells and is atomic. The legacy functions ([[MutableNew]], [[MutableSet]] and [[MutableGet]]) are still there for backward compatibility, but have been changed to just wrap the new Mutable.

== Result tables and graphs ==
* A blank (none) entry was added to the [[XY_comparison#Use_comparison_index|comparison index pulldown]]. Use this to quickly unset the comparison index without having to re-enter the [[XY_comparison]] dialog. Also, the pulldown is now visible and enabled in browse mode.
* Comparison variables are no longer summed over slicer indexes that are set to '''Totals''' when the value for that variable does not include the slicer index. Note that this results in some changes to what is displayed in table body cells and in axis scaling on graphs.

== Assista ==

You can now copy-paste from Expression blocks in Assista's response using the little copy icon in the top-right corner of the expression block.

== Experimental ==
* A way for an Analytica model running in desktop Analytica to [[MCP server in Analytica|act as a Model Context Protocol (MCP) server]] for use by Large Language Models (LLMs).

== ADE ==
* Added a new example: <code>Mcp_server</code>. This is an MCP server that wraps ADE. Among other things, it can give AI agents like Claude Code the ability to build, explore and use Analytica models.

Analytica Enterprise

2026-01-28T01:09:54Z

Mhenrion:

[[Category:Analytica User Guide]]
[[Category: Analytica Enterprise]]

<breadcrumbs>Analytica User Guide >Working with Large Models > {{PAGENAME}}</breadcrumbs><br />
{{ReleaseBar}}

The {{Analytica Enterprise}} edition {{Release|7.0||(formerly known as the Analytica Enterprise edition prior to [[Analytica 7.0]])}} offers all the functionality of Analytica Professional, plus your model can:
* read from and write to external data sources (e.g., [[Database access|databases]], [[ReadTextFile|text]], [[ParseCSV|csv]], [[ParseJSON|JSON]], {{Release|5.0||or binary data}} files, web pages and [[ReadFromUrl|web services]])
* run and communicate with other applications with [[COM Integration|COM]]
* use [[Analytica Enterprise#Huge Arrays|Huge Arrays]] (up to 100 million elements per Index dimension)
* apply the [[Performance Profiler library|Performance Profiler]] to see computational effort by variable
* create [[Obfuscated and Browse-Only Models|Browse-only models]]
* [[Obfuscated and Browse-Only Models|encrypt (obfuscate)]] sensitive and confidential data or algorithms.

You need either {{Analytica Enterprise}} or [[Analytica_Optimizer_Guide|Analytica Optimizer]] to create very large models or to integrate Analytica with external data sources and databases. You can use [[Analytica Cloud Platform|ACP]] or the [[ADE_User_Guide|Analytica Decision Engine]] to run models created with {{Analytica Enterprise}} or Optimizer with these features. You can use any edition of Analytica to run a model that uses buttons, or was saved as browse-only with hidden definitions.

You can order or upgrade to Analytica {{Developer}} [http://www.lumina.com/shoppingcart/productorder/ here].

==Huge Arrays==

Free Analytica and Analytica Professional are limited to Index sizes (and Sample sizes) of 32,000 elements. {{Analytica Enterprise}} and above ([[Analytica Optimizer Guide|Optimizer]], [[Analytica Cloud Platform|ACP]]. and [[ADE User Guide|ADE]]) can manage indexes and arrays of up to two billion elements in any dimension. The only practical limit on model sizes is the memory on your computer. It also lets you read in large datasets from databases, using the ODBC functions.
Huge Arrays means they can also handle sample size for probabilistic simulation up to this size. You can set this in the [[Uncertainty Setup dialog]] from the [[Result menu]].
===Typescript Window===

The [[Typescript]] window offers an old-fashioned command-line user interface, like the Windows CMD program or a Unix shell, showing a prompt — the title of the model or module — at the start of each line. You can type in a [[script]] command. It prints any results as text, and show another prompt. This window is occasionally useful for advanced users who wish to inspect internal details of a model. You can also use it to test out commands that you want to use in a [[Buttons#Script_Attribute|button script]].

To open the [[Typescript]] window, press the '''F12''' key.

:[[File:huge_arrays_1.png|400px]]

== See Also ==
* [[Editions of Analytica]]
* [http://www.lumina.com/shoppingcart/productorder/ order Analytica {{Developer}}]
* [[Arrays and Indexes]]
* [[Working with Large Models]]
* [[Editions of Analytica]]
* [[Analytica Optimizer Guide]]
* [[ADE User Guide]]
* [[Typescript]]
* [[Analytica Script]]
* [[Scripting Guide]]
<footer>Performance Profiler library / {{PAGENAME}} / User-defined Functions and Libraries</footer>

What's new in Analytica 7.0?

2026-01-28T00:30:13Z

Mhenrion: /* Experimental */

[[category:What's new pages]]
[[category:Analytica releases]]

[[Analytica 7.0]] will be the next major Analytica release and is currently in [[Beta Tester Page|beta testing]]. Go to [[Beta Tester Page]] to try it. The current official release is [[Analytica 6.6]].

==Highlights of Analytica 7.0==

* '''[[#Python integration|Python integration]]:''' The major enhancement is integration with Python and hence the entire Python ecosystem of libraries. You can easily call functions from Python libraries, access Python variables, and even write Python code right inside Analytica variables and functions. So now you can mix and match Analytica and Python according to which language you think best for your modeling or coding needs.
* '''Index label updating:''' A common source of errors has been when you change a text label in an Index without remembering to change expressions that refer to that same text label. [[# Index label auto updates|New features]] now automatically update these labels, and so eliminate most of those errors.
* The '''Analytica Enterprise'''' edition has been renamed the [[#Developer Edition (formerly known as Enterprise) |Developer edition]], which better reflects what it is.
* It introduces two new object Classes:
** [[Struct]] lets you bundle disparate values, like text, numbeers, atoms and arrays, together in one object that does not array abstract -- similar to Records and Classes in other languages).
** [[Callable]] is like a user-defined Function but it's Definition can be a [[handle]] to a Python class or a Python function.
* [[ParseJSON]] and [[MakeJSON]] now use Structs, which are much more convenient for representing the hierarchical structure of JSON.
* [[#SpreadsheetOpen|Read and write spreadsheets without Excel]]: This is faster and more robust, and you don't need Excel installed.

== [[Using Python from Analytica|Python integration]] ==

You can now write Python code inside Analytica definitions! It's easy to call Python functions, with Analytica-style Intelligent Arrays!. So you can access the vast ecosystem of Python libraries (''modules'' in Python lingo). Among the gazillion possibilities are specialized libraries for data visualization, statistics, machine learning, and much more.
It means that you can mix and match Analytica and Python -- write Analytica code for what's easiest in Analytica and Python code for what's easiest in Python.

See: [[Using Python from Analytica]]
(In [[Analytica Developer]] edition or better).

For the Analytica modeler, this puts a ton of resources at your fingertips.

It's also pretty cool for the Python developer. Analytica is like a new interactive development environment with a lot of unique advantages, especially during interactive code development:
* Analytica's dependency maintenance can be really convenient during interactive development, creating automatic dependency maintenance between your Python functions, classes and variables that don't exist in Python.
* The visual influence diagram layout can be a super useful to way organize and visualize your code.
* It naturally encourages declarative code practices, which leads to better and more maintainable coding style.
* You get the benefits of Analytica's edit tables, plus for results, Analytica's multi-D result tables and one-click, no-code, graphing.
* It is easy to wrap existing Python models to get Monte Carlo, parametric analysis and sensitivity analysis with Analytica ease.
* Sometimes one or the other language is more convenient for a particular task. You can freely switch between whichever language feels better suited to the immediate task, and intermix languages easily.

== Developer Edition (formerly known as Enterprise) ==

Analytica's middle-tier edition formerly known as the ''Enterprise Edition'', it is now called the [[Analytica Developer|Analytica Developer edition]]. That name better reflects what it is--software for developers of decision applications. If you're now a user of Analytica Enterprise you don't have to update your license or do anything special. The name will just change when you install Analytica 7.0. In Analytica docs, when you select "7.0" on the release bar (at the top of pages that have release-contingent content), all the docs automatically use the new Analytica Developer edition name.

== Analytica language extensions ==

=== Index label auto updates ===

When you change a text label in an Index, it can update code to use the new text label. Iit automatically updates text literals in other expressions that compare to or subscript on an index. The new [[Index-label dot syntax]] ( <code>I . "label"</code>) associates a text literal with its index to prevent it from getting out of sync, and to warn if it ever does. These [[Keeping text literals consistent with index labels| features]] help avoid common errors when updating text labels in Indexes.

=== Callable ===

The new object [[Class]] [[Callable]] is a variable-like object, meaning it has a [[Definition]] and a computed value, but can be used for convenience and documentation when the computed value itself is something that can be called, such as a [[Local function]] (aka ''lambda function''), a [[handle]] to an global function, a Python class or a Python function.

If you "compute" the identity of a callable data item inside a normal [[Variable]] instance, <code>X</code>, you could call it using the syntax <code>X->(a,b,c)</code>. On your influence diagram the object would have a rounded rectangle and thus would not communicate that the result is something that can be called. When you change its class to be a [[Callable]], you can then invoke the call using the syntax <code>X(a,b,c)</code> and the shape of the node changes to something that resembles a function shape, thus communicating that this holds something that is callable.

To create a callable, first create a [[Variable]] node, then use the [[Class]] dropdown from the [[Object window]] or [[Attribute pane]] to change the class to ''Callable''.

=== Struct ===
A [[Struct]] defines a new atomic, immutable data type. For use when you need to bundle multiple heterogeneous items and don't want their dimensionalities to interact. Array abstract treats an instance of a Struct as a single cell (an atom).

=== Expression and Lazy qualifiers ===
An expression passed to a function parameter declared with the qualifier as <code>[[Function_parameter_qualifiers#Expression|Expression]]</code> can now include local variable identifiers. The local variables are captured (similar to how they would be captured by a [[Local function]]).

A new function parameter qualifier, [[Function_parameter_qualifiers#Lazy]], has been added, which does lazy evaluation of the expression passed to it. In the function Definition, you can use it as if it were a normal value parameter, but evaluation occurs when the value is used rather than when the function is called, and in the evaluation context (which includes the [[Evaluation modes|evaluation mode]]) where the value is used instead as in the context of the call.

=== Excess parameter qualifier ===
A new function declaration allows a function to tolerate or capture excess named parameters in the call that are not declared as parameter names in the function's Parameters declaration. It can also be used in a [[Struct]] declaration.

== Functions ==
=== ParseJSON ===
Changed to parse to [[Struct]]s, thus greatly simplifying and improving the convenience of using JSON in Analytica expressions.

For parsing with a schema, a Struct's declaration serves as the schema, which is far easier and more familiar for an Analytica user than the former scheme for specifying a schema.

[[MakeJSON]] is able to generate JSON from a Struct (or nested structs) as well, which is the most convenient representation for JSON representations.

=== SpreadsheetOpen ===
Added a new «backend» parameter to [[SpreadsheetOpen]] with a new option of <code>'LibXl'</code>, allowing you to read and manipulate a spreadsheet without having Excel installed. But unlike the Excel backend, the <b>LibXl</b> option does not have a calculation engine (so can't recompute cell formulas after you change cells). This option is be better when you simply want to read (or write) data in a *.xlsx file format.

== Example models and libraries ==

* There is a new "Auto insurance claim risk analysis.ana" in the Example Models / Risk Analysis folder.
* The [[Mutables library]] has been updated. It provides a new [[Mutable]] [[Struct]] which is superior to the older representation, which displays the actual value in result table cells and is atomic. The legacy functions ([[MutableNew]], [[MutableSet]] and [[MutableGet]]) are still there for backward compatibility, but have been changed to just wrap the new Mutable.

== Result tables and graphs ==
* A blank (none) entry was added to the [[XY_comparison#Use_comparison_index|comparison index pulldown]]. Use this to quickly unset the comparison index without having to re-enter the [[XY_comparison]] dialog. Also, the pulldown is now visible and enabled in browse mode.
* Comparison variables are no longer summed over slicer indexes that are set to '''Totals''' when the value for that variable does not include the slicer index. Note that this results in some changes to what is displayed in table body cells and in axis scaling on graphs.

== Assista ==

You can now copy-paste from Expression blocks in Assista's response using the little copy icon in the top-right corner of the expression block.

== Experimental ==
* A way for an Analytica model running in desktop Analytica to [[MCP server in Analytica|act as a Model Context Protocol (MCP) server]] for use by Large Language Models (LLMs).

== ADE ==
* Added a new example: <code>Mcp_server</code>. This is an MCP server that wraps ADE. Among other things, it can give AI agents like Claude Code the ability to build, explore and use Analytica models.

What's new in Analytica 7.0?

2026-01-28T00:29:08Z

Mhenrion: /* Highlights of Analytica 7.0 */

[[category:What's new pages]]
[[category:Analytica releases]]

[[Analytica 7.0]] will be the next major Analytica release and is currently in [[Beta Tester Page|beta testing]]. Go to [[Beta Tester Page]] to try it. The current official release is [[Analytica 6.6]].

==Highlights of Analytica 7.0==

* '''[[#Python integration|Python integration]]:''' The major enhancement is integration with Python and hence the entire Python ecosystem of libraries. You can easily call functions from Python libraries, access Python variables, and even write Python code right inside Analytica variables and functions. So now you can mix and match Analytica and Python according to which language you think best for your modeling or coding needs.
* '''Index label updating:''' A common source of errors has been when you change a text label in an Index without remembering to change expressions that refer to that same text label. [[# Index label auto updates|New features]] now automatically update these labels, and so eliminate most of those errors.
* The '''Analytica Enterprise'''' edition has been renamed the [[#Developer Edition (formerly known as Enterprise) |Developer edition]], which better reflects what it is.
* It introduces two new object Classes:
** [[Struct]] lets you bundle disparate values, like text, numbeers, atoms and arrays, together in one object that does not array abstract -- similar to Records and Classes in other languages).
** [[Callable]] is like a user-defined Function but it's Definition can be a [[handle]] to a Python class or a Python function.
* [[ParseJSON]] and [[MakeJSON]] now use Structs, which are much more convenient for representing the hierarchical structure of JSON.
* [[#SpreadsheetOpen|Read and write spreadsheets without Excel]]: This is faster and more robust, and you don't need Excel installed.

== [[Using Python from Analytica|Python integration]] ==

You can now write Python code inside Analytica definitions! It's easy to call Python functions, with Analytica-style Intelligent Arrays!. So you can access the vast ecosystem of Python libraries (''modules'' in Python lingo). Among the gazillion possibilities are specialized libraries for data visualization, statistics, machine learning, and much more.
It means that you can mix and match Analytica and Python -- write Analytica code for what's easiest in Analytica and Python code for what's easiest in Python.

See: [[Using Python from Analytica]]
(In [[Analytica Developer]] edition or better).

For the Analytica modeler, this puts a ton of resources at your fingertips.

It's also pretty cool for the Python developer. Analytica is like a new interactive development environment with a lot of unique advantages, especially during interactive code development:
* Analytica's dependency maintenance can be really convenient during interactive development, creating automatic dependency maintenance between your Python functions, classes and variables that don't exist in Python.
* The visual influence diagram layout can be a super useful to way organize and visualize your code.
* It naturally encourages declarative code practices, which leads to better and more maintainable coding style.
* You get the benefits of Analytica's edit tables, plus for results, Analytica's multi-D result tables and one-click, no-code, graphing.
* It is easy to wrap existing Python models to get Monte Carlo, parametric analysis and sensitivity analysis with Analytica ease.
* Sometimes one or the other language is more convenient for a particular task. You can freely switch between whichever language feels better suited to the immediate task, and intermix languages easily.

== Developer Edition (formerly known as Enterprise) ==

Analytica's middle-tier edition formerly known as the ''Enterprise Edition'', it is now called the [[Analytica Developer|Analytica Developer edition]]. That name better reflects what it is--software for developers of decision applications. If you're now a user of Analytica Enterprise you don't have to update your license or do anything special. The name will just change when you install Analytica 7.0. In Analytica docs, when you select "7.0" on the release bar (at the top of pages that have release-contingent content), all the docs automatically use the new Analytica Developer edition name.

== Analytica language extensions ==

=== Index label auto updates ===

When you change a text label in an Index, it can update code to use the new text label. Iit automatically updates text literals in other expressions that compare to or subscript on an index. The new [[Index-label dot syntax]] ( <code>I . "label"</code>) associates a text literal with its index to prevent it from getting out of sync, and to warn if it ever does. These [[Keeping text literals consistent with index labels| features]] help avoid common errors when updating text labels in Indexes.

=== Callable ===

The new object [[Class]] [[Callable]] is a variable-like object, meaning it has a [[Definition]] and a computed value, but can be used for convenience and documentation when the computed value itself is something that can be called, such as a [[Local function]] (aka ''lambda function''), a [[handle]] to an global function, a Python class or a Python function.

If you "compute" the identity of a callable data item inside a normal [[Variable]] instance, <code>X</code>, you could call it using the syntax <code>X->(a,b,c)</code>. On your influence diagram the object would have a rounded rectangle and thus would not communicate that the result is something that can be called. When you change its class to be a [[Callable]], you can then invoke the call using the syntax <code>X(a,b,c)</code> and the shape of the node changes to something that resembles a function shape, thus communicating that this holds something that is callable.

To create a callable, first create a [[Variable]] node, then use the [[Class]] dropdown from the [[Object window]] or [[Attribute pane]] to change the class to ''Callable''.

=== Struct ===
A [[Struct]] defines a new atomic, immutable data type. For use when you need to bundle multiple heterogeneous items and don't want their dimensionalities to interact. Array abstract treats an instance of a Struct as a single cell (an atom).

=== Expression and Lazy qualifiers ===
An expression passed to a function parameter declared with the qualifier as <code>[[Function_parameter_qualifiers#Expression|Expression]]</code> can now include local variable identifiers. The local variables are captured (similar to how they would be captured by a [[Local function]]).

A new function parameter qualifier, [[Function_parameter_qualifiers#Lazy]], has been added, which does lazy evaluation of the expression passed to it. In the function Definition, you can use it as if it were a normal value parameter, but evaluation occurs when the value is used rather than when the function is called, and in the evaluation context (which includes the [[Evaluation modes|evaluation mode]]) where the value is used instead as in the context of the call.

=== Excess parameter qualifier ===
A new function declaration allows a function to tolerate or capture excess named parameters in the call that are not declared as parameter names in the function's Parameters declaration. It can also be used in a [[Struct]] declaration.

== Functions ==
=== ParseJSON ===
Changed to parse to [[Struct]]s, thus greatly simplifying and improving the convenience of using JSON in Analytica expressions.

For parsing with a schema, a Struct's declaration serves as the schema, which is far easier and more familiar for an Analytica user than the former scheme for specifying a schema.

[[MakeJSON]] is able to generate JSON from a Struct (or nested structs) as well, which is the most convenient representation for JSON representations.

=== SpreadsheetOpen ===
Added a new «backend» parameter to [[SpreadsheetOpen]] with a new option of <code>'LibXl'</code>, allowing you to read and manipulate a spreadsheet without having Excel installed. But unlike the Excel backend, the <b>LibXl</b> option does not have a calculation engine (so can't recompute cell formulas after you change cells). This option is be better when you simply want to read (or write) data in a *.xlsx file format.

== Example models and libraries ==

* There is a new "Auto insurance claim risk analysis.ana" in the Example Models / Risk Analysis folder.
* The [[Mutables library]] has been updated. It provides a new [[Mutable]] [[Struct]] which is superior to the older representation, which displays the actual value in result table cells and is atomic. The legacy functions ([[MutableNew]], [[MutableSet]] and [[MutableGet]]) are still there for backward compatibility, but have been changed to just wrap the new Mutable.

== Result tables and graphs ==
* A blank (none) entry was added to the [[XY_comparison#Use_comparison_index|comparison index pulldown]]. Use this to quickly unset the comparison index without having to re-enter the [[XY_comparison]] dialog. Also, the pulldown is now visible and enabled in browse mode.
* Comparison variables are no longer summed over slicer indexes that are set to '''Totals''' when the value for that variable does not include the slicer index. Note that this results in some changes to what is displayed in table body cells and in axis scaling on graphs.

== Assista ==

You can now copy-paste from Expression blocks in Assista's response using the little copy icon in the top-right corner of the expression block.

== Experimental ==
* A way for an Analytica model running in desktop Analytica to [[MCP server in Analytica|act as a Model Context Protocol (MCP) server]].

== ADE ==
* Added a new example: <code>Mcp_server</code>. This is an MCP server that wraps ADE. Among other things, it can give AI agents like Claude Code the ability to build, explore and use Analytica models.

What's new in Analytica 7.0?

2026-01-28T00:27:02Z

Mhenrion: /* Python integration */

[[category:What's new pages]]
[[category:Analytica releases]]

[[Analytica 7.0]] will be the next major Analytica release and is currently in [[Beta Tester Page|beta testing]]. Go to [[Beta Tester Page]] to try it. The current official release is [[Analytica 6.6]].

==Highlights of Analytica 7.0==

* '''Python integration:''' The major enhancement is integration with Python and hence the entire Python ecosystem of libraries. You can easily call functions from Python libraries, access Python variables, and even write Python code right inside Analytica variables and functions. So now you can mix and match Analytica and Python according to which language you think best for your modeling or coding needs.
* '''Index label updating:''' A common source of errors has been when you change a text label in an Index without remembering to change expressions that refer to that same text label. [[# Index label auto updates|New features]] now automatically update these labels, and so eliminate most of those errors.
* '''Enterprise renamed Developer edition:''' The Analytica Enterprise edition has been renamed the [[#Developer Edition (formerly known as Enterprise) |Developer edition]], which better reflects what it is.
* It introduces two new object Classes:
** [[Struct]] lets you bundle disparate values, like text, numbeers, atoms and arrays, together in one object that does not array abstract -- similar to Records and Classes in other languages).
** [[Callable]] is like a user-defined Function but it's Definition can be a [[handle]] to a Python class or a Python function.
* [[ParseJSON]] and [[MakeJSON]] now use Structs, which are much more convenient for representing the hierarchical structure of JSON.
* [[#SpreadsheetOpen|Read and write spreadsheets without Excel]]: This is faster and more robust, and you don't need Excel installed.

== [[Using Python from Analytica|Python integration]] ==

You can now write Python code inside Analytica definitions! It's easy to call Python functions, with Analytica-style Intelligent Arrays!. So you can access the vast ecosystem of Python libraries (''modules'' in Python lingo). Among the gazillion possibilities are specialized libraries for data visualization, statistics, machine learning, and much more.
It means that you can mix and match Analytica and Python -- write Analytica code for what's easiest in Analytica and Python code for what's easiest in Python.

See: [[Using Python from Analytica]]
(In [[Analytica Developer]] edition or better).

For the Analytica modeler, this puts a ton of resources at your fingertips.

It's also pretty cool for the Python developer. Analytica is like a new interactive development environment with a lot of unique advantages, especially during interactive code development:
* Analytica's dependency maintenance can be really convenient during interactive development, creating automatic dependency maintenance between your Python functions, classes and variables that don't exist in Python.
* The visual influence diagram layout can be a super useful to way organize and visualize your code.
* It naturally encourages declarative code practices, which leads to better and more maintainable coding style.
* You get the benefits of Analytica's edit tables, plus for results, Analytica's multi-D result tables and one-click, no-code, graphing.
* It is easy to wrap existing Python models to get Monte Carlo, parametric analysis and sensitivity analysis with Analytica ease.
* Sometimes one or the other language is more convenient for a particular task. You can freely switch between whichever language feels better suited to the immediate task, and intermix languages easily.

== Developer Edition (formerly known as Enterprise) ==

Analytica's middle-tier edition formerly known as the ''Enterprise Edition'', it is now called the [[Analytica Developer|Analytica Developer edition]]. That name better reflects what it is--software for developers of decision applications. If you're now a user of Analytica Enterprise you don't have to update your license or do anything special. The name will just change when you install Analytica 7.0. In Analytica docs, when you select "7.0" on the release bar (at the top of pages that have release-contingent content), all the docs automatically use the new Analytica Developer edition name.

== Analytica language extensions ==

=== Index label auto updates ===

When you change a text label in an Index, it can update code to use the new text label. Iit automatically updates text literals in other expressions that compare to or subscript on an index. The new [[Index-label dot syntax]] ( <code>I . "label"</code>) associates a text literal with its index to prevent it from getting out of sync, and to warn if it ever does. These [[Keeping text literals consistent with index labels| features]] help avoid common errors when updating text labels in Indexes.

=== Callable ===

The new object [[Class]] [[Callable]] is a variable-like object, meaning it has a [[Definition]] and a computed value, but can be used for convenience and documentation when the computed value itself is something that can be called, such as a [[Local function]] (aka ''lambda function''), a [[handle]] to an global function, a Python class or a Python function.

If you "compute" the identity of a callable data item inside a normal [[Variable]] instance, <code>X</code>, you could call it using the syntax <code>X->(a,b,c)</code>. On your influence diagram the object would have a rounded rectangle and thus would not communicate that the result is something that can be called. When you change its class to be a [[Callable]], you can then invoke the call using the syntax <code>X(a,b,c)</code> and the shape of the node changes to something that resembles a function shape, thus communicating that this holds something that is callable.

To create a callable, first create a [[Variable]] node, then use the [[Class]] dropdown from the [[Object window]] or [[Attribute pane]] to change the class to ''Callable''.

=== Struct ===
A [[Struct]] defines a new atomic, immutable data type. For use when you need to bundle multiple heterogeneous items and don't want their dimensionalities to interact. Array abstract treats an instance of a Struct as a single cell (an atom).

=== Expression and Lazy qualifiers ===
An expression passed to a function parameter declared with the qualifier as <code>[[Function_parameter_qualifiers#Expression|Expression]]</code> can now include local variable identifiers. The local variables are captured (similar to how they would be captured by a [[Local function]]).

A new function parameter qualifier, [[Function_parameter_qualifiers#Lazy]], has been added, which does lazy evaluation of the expression passed to it. In the function Definition, you can use it as if it were a normal value parameter, but evaluation occurs when the value is used rather than when the function is called, and in the evaluation context (which includes the [[Evaluation modes|evaluation mode]]) where the value is used instead as in the context of the call.

=== Excess parameter qualifier ===
A new function declaration allows a function to tolerate or capture excess named parameters in the call that are not declared as parameter names in the function's Parameters declaration. It can also be used in a [[Struct]] declaration.

== Functions ==
=== ParseJSON ===
Changed to parse to [[Struct]]s, thus greatly simplifying and improving the convenience of using JSON in Analytica expressions.

For parsing with a schema, a Struct's declaration serves as the schema, which is far easier and more familiar for an Analytica user than the former scheme for specifying a schema.

[[MakeJSON]] is able to generate JSON from a Struct (or nested structs) as well, which is the most convenient representation for JSON representations.

=== SpreadsheetOpen ===
Added a new «backend» parameter to [[SpreadsheetOpen]] with a new option of <code>'LibXl'</code>, allowing you to read and manipulate a spreadsheet without having Excel installed. But unlike the Excel backend, the <b>LibXl</b> option does not have a calculation engine (so can't recompute cell formulas after you change cells). This option is be better when you simply want to read (or write) data in a *.xlsx file format.

== Example models and libraries ==

* There is a new "Auto insurance claim risk analysis.ana" in the Example Models / Risk Analysis folder.
* The [[Mutables library]] has been updated. It provides a new [[Mutable]] [[Struct]] which is superior to the older representation, which displays the actual value in result table cells and is atomic. The legacy functions ([[MutableNew]], [[MutableSet]] and [[MutableGet]]) are still there for backward compatibility, but have been changed to just wrap the new Mutable.

== Result tables and graphs ==
* A blank (none) entry was added to the [[XY_comparison#Use_comparison_index|comparison index pulldown]]. Use this to quickly unset the comparison index without having to re-enter the [[XY_comparison]] dialog. Also, the pulldown is now visible and enabled in browse mode.
* Comparison variables are no longer summed over slicer indexes that are set to '''Totals''' when the value for that variable does not include the slicer index. Note that this results in some changes to what is displayed in table body cells and in axis scaling on graphs.

== Assista ==

You can now copy-paste from Expression blocks in Assista's response using the little copy icon in the top-right corner of the expression block.

== Experimental ==
* A way for an Analytica model running in desktop Analytica to [[MCP server in Analytica|act as a Model Context Protocol (MCP) server]].

== ADE ==
* Added a new example: <code>Mcp_server</code>. This is an MCP server that wraps ADE. Among other things, it can give AI agents like Claude Code the ability to build, explore and use Analytica models.

What's new in Analytica 7.0?

2026-01-28T00:12:18Z

Mhenrion: /* Highlights of Analytica 7.0 */

[[category:What's new pages]]
[[category:Analytica releases]]

[[Analytica 7.0]] will be the next major Analytica release and is currently in [[Beta Tester Page|beta testing]]. Go to [[Beta Tester Page]] to try it. The current official release is [[Analytica 6.6]].

==Highlights of Analytica 7.0==

* '''Python integration:''' The major enhancement is integration with Python and hence the entire Python ecosystem of libraries. You can easily call functions from Python libraries, access Python variables, and even write Python code right inside Analytica variables and functions. So now you can mix and match Analytica and Python according to which language you think best for your modeling or coding needs.
* '''Index label updating:''' A common source of errors has been when you change a text label in an Index without remembering to change expressions that refer to that same text label. [[# Index label auto updates|New features]] now automatically update these labels, and so eliminate most of those errors.
* '''Enterprise renamed Developer edition:''' The Analytica Enterprise edition has been renamed the [[#Developer Edition (formerly known as Enterprise) |Developer edition]], which better reflects what it is.
* It introduces two new object Classes:
** [[Struct]] lets you bundle disparate values, like text, numbeers, atoms and arrays, together in one object that does not array abstract -- similar to Records and Classes in other languages).
** [[Callable]] is like a user-defined Function but it's Definition can be a [[handle]] to a Python class or a Python function.
* [[ParseJSON]] and [[MakeJSON]] now use Structs, which are much more convenient for representing the hierarchical structure of JSON.
* [[#SpreadsheetOpen|Read and write spreadsheets without Excel]]: This is faster and more robust, and you don't need Excel installed.

== [[Using Python from Analytica|Python integration]] ==

You can now benefit from the large ecosystem of Python libraries from the [[Analytica Developer]] edition or better (i.e., [[Analytica Optimizer]] edition or [[ADE]]). Use Python libraries (called modules in Python lingo) or Python code directly from your Analytica model, and it is super easy and convenient to do so! Among the gazillion possibilities are specialized data visualizations, using machine learning libraries, third party libraries, etc.

See: [[Using Python from Analytica]]

For the Analytica modeler, this puts a ton of resources at your fingertips.

For the Python developer, this is also pretty cool. Analytica is like a new interactive development environment in which there are a lot of unique advantages, especially during interactive code development, including these:
* Analytica's dependency maintenance can be really convenient during interactive development, creating automatic dependency maintenance between your python functions, classes and variables that don't exist in Python.
* The visual influence diagram layout can be a super useful to way organize and visualize your code.
* It naturally encourages declarative code practices, which leads to better and more maintainable coding style.
* You get the benefits of Analytica's edit tables, plus for results, Analytica's multi-D result tables and one-click, no-code, graphing.
* It is easy to wrap existing Python models to get Monte Carlo, parametric analysis and sensitivity analysis with Analytica ease.
* Sometimes one or the other language is more convenient for a particular task. You can freely switch between whichever language feels better suited to the immediate task, and intermix languages easily.

== Developer Edition (formerly known as Enterprise) ==

Analytica's middle-tier edition formerly known as the ''Enterprise Edition'', it is now called the [[Analytica Developer|Analytica Developer edition]]. That name better reflects what it is--software for developers of decision applications. If you're now a user of Analytica Enterprise you don't have to update your license or do anything special. The name will just change when you install Analytica 7.0. In Analytica docs, when you select "7.0" on the release bar (at the top of pages that have release-contingent content), all the docs automatically use the new Analytica Developer edition name.

== Analytica language extensions ==

=== Index label auto updates ===

When you change a text label in an Index, it can update code to use the new text label. Iit automatically updates text literals in other expressions that compare to or subscript on an index. The new [[Index-label dot syntax]] ( <code>I . "label"</code>) associates a text literal with its index to prevent it from getting out of sync, and to warn if it ever does. These [[Keeping text literals consistent with index labels| features]] help avoid common errors when updating text labels in Indexes.

=== Callable ===

The new object [[Class]] [[Callable]] is a variable-like object, meaning it has a [[Definition]] and a computed value, but can be used for convenience and documentation when the computed value itself is something that can be called, such as a [[Local function]] (aka ''lambda function''), a [[handle]] to an global function, a Python class or a Python function.

If you "compute" the identity of a callable data item inside a normal [[Variable]] instance, <code>X</code>, you could call it using the syntax <code>X->(a,b,c)</code>. On your influence diagram the object would have a rounded rectangle and thus would not communicate that the result is something that can be called. When you change its class to be a [[Callable]], you can then invoke the call using the syntax <code>X(a,b,c)</code> and the shape of the node changes to something that resembles a function shape, thus communicating that this holds something that is callable.

To create a callable, first create a [[Variable]] node, then use the [[Class]] dropdown from the [[Object window]] or [[Attribute pane]] to change the class to ''Callable''.

=== Struct ===
A [[Struct]] defines a new atomic, immutable data type. For use when you need to bundle multiple heterogeneous items and don't want their dimensionalities to interact. Array abstract treats an instance of a Struct as a single cell (an atom).

=== Expression and Lazy qualifiers ===
An expression passed to a function parameter declared with the qualifier as <code>[[Function_parameter_qualifiers#Expression|Expression]]</code> can now include local variable identifiers. The local variables are captured (similar to how they would be captured by a [[Local function]]).

A new function parameter qualifier, [[Function_parameter_qualifiers#Lazy]], has been added, which does lazy evaluation of the expression passed to it. In the function Definition, you can use it as if it were a normal value parameter, but evaluation occurs when the value is used rather than when the function is called, and in the evaluation context (which includes the [[Evaluation modes|evaluation mode]]) where the value is used instead as in the context of the call.

=== Excess parameter qualifier ===
A new function declaration allows a function to tolerate or capture excess named parameters in the call that are not declared as parameter names in the function's Parameters declaration. It can also be used in a [[Struct]] declaration.

== Functions ==
=== ParseJSON ===
Changed to parse to [[Struct]]s, thus greatly simplifying and improving the convenience of using JSON in Analytica expressions.

For parsing with a schema, a Struct's declaration serves as the schema, which is far easier and more familiar for an Analytica user than the former scheme for specifying a schema.

[[MakeJSON]] is able to generate JSON from a Struct (or nested structs) as well, which is the most convenient representation for JSON representations.

=== SpreadsheetOpen ===
Added a new «backend» parameter to [[SpreadsheetOpen]] with a new option of <code>'LibXl'</code>, allowing you to read and manipulate a spreadsheet without having Excel installed. But unlike the Excel backend, the <b>LibXl</b> option does not have a calculation engine (so can't recompute cell formulas after you change cells). This option is be better when you simply want to read (or write) data in a *.xlsx file format.

== Example models and libraries ==

* There is a new "Auto insurance claim risk analysis.ana" in the Example Models / Risk Analysis folder.
* The [[Mutables library]] has been updated. It provides a new [[Mutable]] [[Struct]] which is superior to the older representation, which displays the actual value in result table cells and is atomic. The legacy functions ([[MutableNew]], [[MutableSet]] and [[MutableGet]]) are still there for backward compatibility, but have been changed to just wrap the new Mutable.

== Result tables and graphs ==
* A blank (none) entry was added to the [[XY_comparison#Use_comparison_index|comparison index pulldown]]. Use this to quickly unset the comparison index without having to re-enter the [[XY_comparison]] dialog. Also, the pulldown is now visible and enabled in browse mode.
* Comparison variables are no longer summed over slicer indexes that are set to '''Totals''' when the value for that variable does not include the slicer index. Note that this results in some changes to what is displayed in table body cells and in axis scaling on graphs.

== Assista ==

You can now copy-paste from Expression blocks in Assista's response using the little copy icon in the top-right corner of the expression block.

== Experimental ==
* A way for an Analytica model running in desktop Analytica to [[MCP server in Analytica|act as a Model Context Protocol (MCP) server]].

== ADE ==
* Added a new example: <code>Mcp_server</code>. This is an MCP server that wraps ADE. Among other things, it can give AI agents like Claude Code the ability to build, explore and use Analytica models.

What's new in Analytica 7.0?

2026-01-27T22:59:04Z

Mhenrion: /* Highlights of Analytica 7.0 */

[[category:What's new pages]]
[[category:Analytica releases]]

[[Analytica 7.0]] will be the next major Analytica release and is currently in [[Beta Tester Page|beta testing]]. Go to [[Beta Tester Page]] to try it. The current official release is [[Analytica 6.6]].

==Highlights of Analytica 7.0==

* '''Python integration:''' The major enhancement is integration with Python and hence the entire Python ecosystem of libraries. You can easily call functions from Python libraries, access Python variables, and even write Python code right inside Analytica variables and functions. So now you can mix and match Analytica and Python according to which language you think best for your modeling or coding needs.
* '''Index label updating:''' A common source of errors has been when you change a text label in an Index without remembering to change expressions that refer to that same text label. [[# Index label auto updates|New features]] now automatically update these labels, and so eliminate most of those errors.
* '''Enterprise renamed Developer edition:''' The Analytica Enterprise edition has been renamed the [[#Developer Edition (formerly known as Enterprise) |Developer edition]], which better reflects what it is.
* It introduces two new object Classes:
** [[Struct]] lets you bundle disparate values, like text, numbeers, atoms and arrays, together in one object that does not array abstract -- similar to Records and Classes in other languages).
** [[Callable]] is like a user-defined Function but it's Definition can be a [[handle]] to a Python class or a Python function.
* [[ParseJSON]] and [[MakeJSON]] now use Structs, which are much more convenient for representing the hierarchical structure of JSON.

== [[Using Python from Analytica|Python integration]] ==

You can now benefit from the large ecosystem of Python libraries from the [[Analytica Developer]] edition or better (i.e., [[Analytica Optimizer]] edition or [[ADE]]). Use Python libraries (called modules in Python lingo) or Python code directly from your Analytica model, and it is super easy and convenient to do so! Among the gazillion possibilities are specialized data visualizations, using machine learning libraries, third party libraries, etc.

See: [[Using Python from Analytica]]

For the Analytica modeler, this puts a ton of resources at your fingertips.

For the Python developer, this is also pretty cool. Analytica is like a new interactive development environment in which there are a lot of unique advantages, especially during interactive code development, including these:
* Analytica's dependency maintenance can be really convenient during interactive development, creating automatic dependency maintenance between your python functions, classes and variables that don't exist in Python.
* The visual influence diagram layout can be a super useful to way organize and visualize your code.
* It naturally encourages declarative code practices, which leads to better and more maintainable coding style.
* You get the benefits of Analytica's edit tables, plus for results, Analytica's multi-D result tables and one-click, no-code, graphing.
* It is easy to wrap existing Python models to get Monte Carlo, parametric analysis and sensitivity analysis with Analytica ease.
* Sometimes one or the other language is more convenient for a particular task. You can freely switch between whichever language feels better suited to the immediate task, and intermix languages easily.

== Developer Edition (formerly known as Enterprise) ==

Analytica's middle-tier edition formerly known as the ''Enterprise Edition'', it is now called the [[Analytica Developer|Analytica Developer edition]]. That name better reflects what it is--software for developers of decision applications. If you're now a user of Analytica Enterprise you don't have to update your license or do anything special. The name will just change when you install Analytica 7.0. In Analytica docs, when you select "7.0" on the release bar (at the top of pages that have release-contingent content), all the docs automatically use the new Analytica Developer edition name.

== Analytica language extensions ==

=== Index label auto updates ===

When you change a text label in an Index, it can update code to use the new text label. Iit automatically updates text literals in other expressions that compare to or subscript on an index. The new [[Index-label dot syntax]] ( <code>I . "label"</code>) associates a text literal with its index to prevent it from getting out of sync, and to warn if it ever does. These [[Keeping text literals consistent with index labels| features]] help avoid common errors when updating text labels in Indexes.

=== Callable ===

The new object [[Class]] [[Callable]] is a variable-like object, meaning it has a [[Definition]] and a computed value, but can be used for convenience and documentation when the computed value itself is something that can be called, such as a [[Local function]] (aka ''lambda function''), a [[handle]] to an global function, a Python class or a Python function.

If you "compute" the identity of a callable data item inside a normal [[Variable]] instance, <code>X</code>, you could call it using the syntax <code>X->(a,b,c)</code>. On your influence diagram the object would have a rounded rectangle and thus would not communicate that the result is something that can be called. When you change its class to be a [[Callable]], you can then invoke the call using the syntax <code>X(a,b,c)</code> and the shape of the node changes to something that resembles a function shape, thus communicating that this holds something that is callable.

To create a callable, first create a [[Variable]] node, then use the [[Class]] dropdown from the [[Object window]] or [[Attribute pane]] to change the class to ''Callable''.

=== Struct ===
A [[Struct]] defines a new atomic, immutable data type. For use when you need to bundle multiple heterogeneous items and don't want their dimensionalities to interact. Array abstract treats an instance of a Struct as a single cell (an atom).

=== Expression and Lazy qualifiers ===
An expression passed to a function parameter declared with the qualifier as <code>[[Function_parameter_qualifiers#Expression|Expression]]</code> can now include local variable identifiers. The local variables are captured (similar to how they would be captured by a [[Local function]]).

A new function parameter qualifier, [[Function_parameter_qualifiers#Lazy]], has been added, which does lazy evaluation of the expression passed to it. In the function Definition, you can use it as if it were a normal value parameter, but evaluation occurs when the value is used rather than when the function is called, and in the evaluation context (which includes the [[Evaluation modes|evaluation mode]]) where the value is used instead as in the context of the call.

=== Excess parameter qualifier ===
A new function declaration allows a function to tolerate or capture excess named parameters in the call that are not declared as parameter names in the function's Parameters declaration. It can also be used in a [[Struct]] declaration.

== Functions ==
=== ParseJSON ===
Changed to parse to [[Struct]]s, thus greatly simplifying and improving the convenience of using JSON in Analytica expressions.

For parsing with a schema, a Struct's declaration serves as the schema, which is far easier and more familiar for an Analytica user than the former scheme for specifying a schema.

[[MakeJSON]] is able to generate JSON from a Struct (or nested structs) as well, which is the most convenient representation for JSON representations.

=== SpreadsheetOpen ===
Added a new «backend» parameter to [[SpreadsheetOpen]] with a new option of <code>'LibXl'</code>, allowing you to read and manipulate a spreadsheet without having Excel installed. But unlike the Excel backend, the <b>LibXl</b> option does not have a calculation engine (so can't recompute cell formulas after you change cells). This option is be better when you simply want to read (or write) data in a *.xlsx file format.

== Example models and libraries ==

* There is a new "Auto insurance claim risk analysis.ana" in the Example Models / Risk Analysis folder.
* The [[Mutables library]] has been updated. It provides a new [[Mutable]] [[Struct]] which is superior to the older representation, which displays the actual value in result table cells and is atomic. The legacy functions ([[MutableNew]], [[MutableSet]] and [[MutableGet]]) are still there for backward compatibility, but have been changed to just wrap the new Mutable.

== Result tables and graphs ==
* A blank (none) entry was added to the [[XY_comparison#Use_comparison_index|comparison index pulldown]]. Use this to quickly unset the comparison index without having to re-enter the [[XY_comparison]] dialog. Also, the pulldown is now visible and enabled in browse mode.
* Comparison variables are no longer summed over slicer indexes that are set to '''Totals''' when the value for that variable does not include the slicer index. Note that this results in some changes to what is displayed in table body cells and in axis scaling on graphs.

== Assista ==

You can now copy-paste from Expression blocks in Assista's response using the little copy icon in the top-right corner of the expression block.

== Experimental ==
* A way for an Analytica model running in desktop Analytica to [[MCP server in Analytica|act as a Model Context Protocol (MCP) server]].

== ADE ==
* Added a new example: <code>Mcp_server</code>. This is an MCP server that wraps ADE. Among other things, it can give AI agents like Claude Code the ability to build, explore and use Analytica models.

ChangeNodeVisibility

2026-01-20T23:46:45Z

Mhenrion: /* See Also */

[[category:User-interface functions]]
{{ReleaseBar}}
''new to [[Analytica 5.0]]''

== ChangeNodeVisibility(obj, option'', what'') ==

This function can hide or show a node in its Diagram, or display it as "disabled" -- i.e. grayed out to show it is not currently available. For example:
ChangeNodeVisibility(A, 'Hidden')
hides the node for object A in its Diagram. You can use it to create a dynamic user interface in which certain user inputs or user outputs appear or disappear based on the state of other user inputs. In such cases, you might use ChangeNodeVisibility() in the [[OnChange]] attribute of a checkbox or Choice menu user input to control whether other user inputs or outputs are shown.

You can also use this function to query the current visibility state of the node. For example:
ChangeNodeVisibility(A, 'Is Visible?')
returns true if node A is currently visible.

=== «obj» parameter ===

The «obj» parameter is a handle to the node that you want to change or query.

=== «option» parameter ===

Change the visibility state by setting the «option» parameter to:
* <code>"Hidden"</code>: The node is not visible in its parent diagram.
* <code>"Disabled"</code>: The node is visible but disabled. It appears "grayed out" and does not respond to user input.
* <code>"Visible"</code>: The node is visible in the diagram user interface.
* <code>"Enabled"</code>: Synonymous with ''Visible'', but this parameter definition may be clearer to a reviewer if your interface is disabling and enabling user inputs (rather than making them visible or hidden).

While a "Hidden" node is invisible in its diagram, the object will still appear and its [[Object Window]] accessible in the [[Outline window]], [[Find Dialog]], and links to it that might appear in results, or in inputs and outputs of other variables, etc. It also remains selectable on the diagram in edit mode, even though it is invisible. These options let you hide it more securely:
* <code>"Very hidden"</code>: Node is invisible in its diagram, the [[Outline window]], hierarchy stripe, [[Find Dialog]], etc. However, you can still hyperlink to it if a hyperlink exists.
* <code>"Extremely hidden"</code>: Set so that you can't reach the node via existing hyperlinks get to it from the Analytica UI in general. At this level, it appears to the end-user as if it doesn't exist

It is sometimes useful to hide (or disable) a node in Browse mode but enable it in Edit mode. Hence these options:
* <code>"Hidden in browse"</code>: Make the node is present and visible is edit mode, but does not appear on the diagram in browse mode.
* <code>"Disabled in browse"</code>: Make the node disabled in browse mode. It is enabled in edit mode.
{{Release|1=6.6|2=|3=
And sometimes it is nice to just hide the node entirely while calculations are in progress:
* <code>"Hidden while computing"</code>: (New to [[Analytica 6.6]]) Hidden while a calculation is in progress, visible otherwise.}}

These options let you query a nodes visibility state. (Note that they all end with a question mark.):
* <code>"Is Visible?"</code>: Returns true if the node is visible, and true if disabled but visible. False if not visible on influence diagram.
* <code>"Is Hidden?"</code>: Returns true if the node is hidden (not visible), true otherwise.
* <code>"Is Disabled?"</code>: Returns true if the node is hidden or disabled. True if visible and enabled.
* <code>"Is Enabled?"</code>: Returns true if the node is visible and enabled. False otherwise.
* <code>"How hidden?"</code>: Returns the option text describing the visibility state; <code>"Visible", "Hidden", "Hidden in browse", "Very Hidden", "Extremely hidden", "Disabled", </code> or <code>"Disabled in browse"</code>.

When you query the visibility state and specify «what» to be <code>'UserInputs'</code> or <code>'UserOutputs'</code>, the result is a 1-D array with a local index, where the local index contains the handles of each user input or each user output node, and the value is the result for that node.

=== «what» parameter ===

By default, if you omit «what», the functions changes (or queries) the visibility of the node for «obj». But, you can also change the visibility of the user inputs or outputs for a Variable. You set «what» to <code>'UserInputs'</code> or <code>'UserOutputs'</code> to change the visibility of all inputs or all outputs of the variable. If you want to changed the visibility of a single user input or user output node, then you should ensure that this is a handle to the user input node, not a handle to the original variable node, and that «what» is omitted. You can also pass <code>'Original'</code> to «what» to change the visibility of the original (not the alias) of «obj».

== Examples ==

Hide, show, disable or re-enable the user inputs for variable <code>Gender</code>:
:[[ChangeNodeVisibility]]( [[Handle]](Gender), 'Hidden', 'UserInputs' )
:[[ChangeNodeVisibility]]( [[Handle]](Gender), 'Visible', 'UserInputs' )
:[[ChangeNodeVisibility]]( [[Handle]](Gender), 'Disabled', 'UserInputs' )
:[[ChangeNodeVisibility]]( [[Handle]](Gender), 'Enabled', 'UserInputs' )

Hide your model details module node from your end user:
:[[ChangeNodeVisibility]]( Handle(Model_details), 'Hidden in browse' )

Make visible user input nodes only when the user makes the choice to edit them. In this example, we augment the car cost model which begins in [[Tutorial: Create a model]]. With the following addition to the OnChange field, the user may change the estimated annual maintenance cost and the estimated miles driven per year:<br>
:<code>Variable := Choice(Self, 2, 0)</code><br>
:[[ChangeNodeVisibility]]( [[handle]]( Maintenance_cost ), IF Self = 'No' THEN 'Hidden' ELSE 'Visible', 'UserInputs' );
:[[ChangeNodeVisibility]]( [[handle]]( Mpy ), IF Self = 'No' THEN 'Hidden' ELSE 'Visible', 'UserInputs' )

:[[image:Onchange_example1.gif]]
:[[image:Onchange_example2.gif]]

== Example Video ==

<center>
<iframe width="640" height="360" src="https://www.youtube.com/embed/LshPSRoTl7o" frameborder="0" allowfullscreen></iframe>

'''Video:''' [https://youtu.be/LshPSRoTl7o Hiding and disabling UI elements] (5 minutes)
</center>

== See Also ==

* [http://lumina.com/blog/analytica-5.0-video-short-hiding-and-disabling-model-user-interface-control Analytica Video Short: Hiding and Disabling Model User-Interface Controls] on the Lumina Blog
* [[NodeInfo]] attribute
* [[OnChange]]
* [[OnClick]]

'''Keywords:''' Show node, Make visible, Hide node, Make invisible

What's new in Analytica 7.0?

2025-12-17T02:24:36Z

Mhenrion: added highlights section, reordered sections, and more.

[[category:What's new pages]]
[[category:Analytica releases]]

[[Analytica 7.0]] will be the next major Analytica release and is currently in [[Beta Tester Page|beta testing]]. Go to [[Beta Tester Page]] to try it. The current official release is [[Analytica 6.6]].

==Highlights of Analytica 7.0==

* The major enhancement is integration with Python and hence the entire Python ecosystem of libraries. You can easily call functions from Python libraries, access Python variables, and even write Python code right inside Analytica variables and functions. So now you can mix and match Analytica and Python according to which language you think best for your modeling or coding needs.
* A common source of errors has been when you change a text label in an Index without remembering to change expressions that refer to that same text label. [[# Index label auto updates|New features]] now automatically update these labels, and so eliminate most of those errors.
* The Analytica Enterprise edition has been renamed the [[#Developer Edition (formerly known as Enterprise) |Developer edition]], which better reflects what it is.
* It introduces two new object Classes:
** [[Struct]] lets you bundle disparate values, like text, numbeers, atoms and arrays, together in one object that does not array abstract -- similar to Records and Classes in other languages).
** [[Callable]] is like a user-defined Function but it's Definition can be a [[handle]] to a Python class or a Python function.
* [[ParseJSON]] and [[MakeJSON]] now use Structs, which are much more convenient for representing the hierarchical structure of JSON.

== [[Using Python from Analytica|Python integration]] ==

You can now benefit from the large ecosystem of Python libraries from the [[Analytica Developer]] edition or better (i.e., [[Analytica Optimizer]] edition or [[ADE]]). Use Python libraries (called modules in Python lingo) or Python code directly from your Analytica model, and it is super easy and convenient to do so! Among the gazillion possibilities are specialized data visualizations, using machine learning libraries, third party libraries, etc.

See: [[Using Python from Analytica]]

For the Analytica modeler, this puts a ton of resources at your fingertips.

For the Python developer, this is also pretty cool. Analytica is like a new interactive development environment in which there are a lot of unique advantages, especially during interactive code development, including these:
* Analytica's dependency maintenance can be really convenient during interactive development, creating automatic dependency maintenance between your python functions, classes and variables that don't exist in Python.
* The visual influence diagram layout can be a super useful to way organize and visualize your code.
* It naturally encourages declarative code practices, which leads to better and more maintainable coding style.
* You get the benefits of Analytica's edit tables, plus for results, Analytica's multi-D result tables and one-click, no-code, graphing.
* It is easy to wrap existing Python models to get Monte Carlo, parametric analysis and sensitivity analysis with Analytica ease.
* Sometimes one or the other language is more convenient for a particular task. You can freely switch between whichever language feels better suited to the immediate task, and intermix languages easily.

== Developer Edition (formerly known as Enterprise) ==

Analytica's middle-tier edition formerly known as the ''Enterprise Edition'', it is now called the [[Analytica Developer|Analytica Developer edition]]. That name better reflects what it is--software for developers of decision applications. If you're now a user of Analytica Enterprise you don't have to update your license or do anything special. The name will just change when you install Analytica 7.0. In Analytica docs, when you select "7.0" on the release bar (at the top of pages that have release-contingent content), all the docs automatically use the new Analytica Developer edition name.

== Analytica language extensions ==

=== Index label auto updates ===

When you change a text label in an Index, it can update code to use the new text label. Iit automatically updates text literals in other expressions that compare to or subscript on an index. The new [[Index-label dot syntax]] ( <code>I . "label"</code>) associates a text literal with its index to prevent it from getting out of sync, and to warn if it ever does. These [[Keeping text literals consistent with index labels| features]] help avoid common errors when updating text labels in Indexes.

=== Callable ===

The new object [[Class]] [[Callable]] is a variable-like object, meaning it has a [[Definition]] and a computed value, but can be used for convenience and documentation when the computed value itself is something that can be called, such as a [[Local function]] (aka ''lambda function''), a [[handle]] to an global function, a Python class or a Python function.

If you "compute" the identity of a callable data item inside a normal [[Variable]] instance, <code>X</code>, you could call it using the syntax <code>X->(a,b,c)</code>. On your influence diagram the object would have a rounded rectangle and thus would not communicate that the result is something that can be called. When you change its class to be a [[Callable]], you can then invoke the call using the syntax <code>X(a,b,c)</code> and the shape of the node changes to something that resembles a function shape, thus communicating that this holds something that is callable.

To create a callable, first create a [[Variable]] node, then use the [[Class]] dropdown from the [[Object window]] or [[Attribute pane]] to change the class to ''Callable''.

=== Struct ===
A [[Struct]] defines a new atomic, immutable data type. For use when you need to bundle multiple heterogeneous items and don't want their dimensionalities to interact. Array abstract treats an instance of a Struct as a single cell (an atom).

=== Expression and Lazy qualifiers ===
An expression passed to a function parameter declared with the qualifier as <code>[[Function_parameter_qualifiers#Expression|Expression]]</code> can now include local variable identifiers. The local variables are captured (similar to how they would be captured by a [[Local function]]).

A new function parameter qualifier, [[Function_parameter_qualifiers#Lazy]], has been added, which does lazy evaluation of the expression passed to it. In the function Definition, you can use it as if it were a normal value parameter, but evaluation occurs when the value is used rather than when the function is called, and in the evaluation context (which includes the [[Evaluation modes|evaluation mode]]) where the value is used instead as in the context of the call.

=== Excess parameter qualifier ===
A new function declaration allows a function to tolerate or capture excess named parameters in the call that are not declared as parameter names in the function's Parameters declaration. It can also be used in a [[Struct]] declaration.

== Functions ==
=== ParseJSON ===
Changed to parse to [[Struct]]s, thus greatly simplifying and improving the convenience of using JSON in Analytica expressions.

For parsing with a schema, a Struct's declaration serves as the schema, which is far easier and more familiar for an Analytica user than the former scheme for specifying a schema.

[[MakeJSON]] is able to generate JSON from a Struct (or nested structs) as well, which is the most convenient representation for JSON representations.

== Example models and libraries ==

* There is a new "Auto insurance claim risk analysis.ana" in the Example Models / Risk Analysis folder.
* The [[Mutables library]] has been updated. It provides a new [[Mutable]] [[Struct]] which is superior to the older representation, which displays the actual value in result table cells and is atomic. The legacy functions ([[MutableNew]], [[MutableSet]] and [[MutableGet]]) are still there for backward compatibility, but have been changed to just wrap the new Mutable.

== Result tables and graphs ==
* A blank (none) entry was added to the [[XY_comparison#Use_comparison_index|comparison index pulldown]]. Use this to quickly unset the comparison index without having to re-enter the [[XY_comparison]] dialog. Also, the pulldown is now visible and enabled in browse mode.
* Comparison variables are no longer summed over slicer indexes that are set to '''Totals''' when the value for that variable does not include the slicer index. Note that this results in some changes to what is displayed in table body cells and in axis scaling on graphs.

Why Analytica doesn't need Map and Reduce functions

2025-12-17T01:38:32Z

Mhenrion:

''Map'' and ''reduce'' are operations in many modern programming languages. ''Map'' applies an operation over every element of an array, while ''reduce'' applies an operation repeatedly to eliminate a dimension. They accept a function or operator, which often takes the form of a '''[[Lambda function]]'''. Analytica has no need for an explicit map function, because (almost) all functions and operators automatically generalize to work over array dimensions. It has no need for a reduce function because functions like, Sum(), Average(), Min() and other array-reducing functions automatically work over specified dimensions (indexes). Even user-defined functions automatically generalize to work over arrays. Where conventional procedural languages like Python, and even the latest versions of Excel, require explicit instructions for array operations, Analytica's declarative structure and Intelligent Arrays handle the heavy lifting automatically.

=== What is a Lambda function? ===

A Lambda is a small, anonymous (nameless) function that can be stored and manipulated as a data value in a variable or array. Languages that need map and reduce to apply functions and operations to an array, they let you specify the function as a lambda function. Analytica doesn't need them for that purpose. But it does support lambda functions, called [[Local functions]], for some other use cases wherer the concise, inline logic of lambda functions can be useful.

==== In Python ====
In Python, a lambda is often used with higher-order functions like <code>map()</code> and <code>filter()</code>.

<pre>
# A list of numbers
numbers = [1, 2, 3, 4, 5]

# Using lambda with map() to square each number
squared_numbers = list(map(lambda x: x**2, numbers))
print(squared_numbers)
# Output: [1, 4, 9, 16, 25]
</pre>

==== In Excel ====
Microsoft 365 introduced the <code>LAMBDA</code> function to give users a way to create reusable custom functions directly within Excel's formula language. Unlike Python and other languages, you must still give it a name to be used elsewhere.

<pre>
# In the Name Manager, you define a named lambda:
Name: CircleArea
Refers to: =LAMBDA(r, PI()*r^2)

# Now you can apply your custom function to a cell:
=CircleArea(A1)
</pre>

=== Why Analytica rarely needs Lambdas ===

The core reason Analytica doesn't need a lambda function for map, reduce and filter operations lies in its architecture. It is a '''declarative, array-based language''', which means you focus on describing ''what'' a variable is, not ''how'' to compute it.

==== 1. Declarative vs. procedural approach ====
Most programming languages are procedural—they require you to specify a sequence of steps. Lambda functions are a solution for making this process more concise for simple operations. Analytica, on the other hand, is a declarative language, much like Excel's formula model. The software handles the execution order based on the dependencies you define, freeing you from worrying about control flow.

==== 2. Intelligent Arrays (Array abstraction) ====
Analytica’s "Intelligent Arrays" allow operators and functions to work on entire arrays simultaneously, eliminating the need for <code>MAP</code>, <code>REDUCE</code>, or explicit loops. When you write <code>Revenue - Costs</code>, Analytica automatically applies that subtraction to every corresponding element in the <code>Revenue</code> and <code>Costs</code> arrays. This is array abstraction at its finest.

Here is how Analytica's approach compares to procedural languages:

{| class="wikitable"
|-
! Operation
! Excel with <code>MAP</code>
! Python with <code>lambda</code>/<code>map</code>
! Analytica (Intelligent Arrays)
|-
| '''Square all numbers'''
| <code>=MAP(A1:A5, LAMBDA(x, x^2))</code>
| <code>list(map(lambda x: x**2, numbers))</code>
| <code>numbers^2</code>
|-
| '''Calculate total demand over routes'''
| Uses helper column or <code>REDUCE</code>
| <code>sum(map(lambda j: demands[j], route))</code>
| <code>[[Sum]](Demands, Route)</code>
|-
| '''Filter for even numbers'''
| <code>=FILTER(A1:A5, MAP(A1:A5, LAMBDA(x, ISEVEN(x))))</code>
| <code>list(filter(lambda x: x % 2 == 0, numbers))</code>
| <code>[[Subset]]([[Mod]](numbers, 2) = 0)</code>
|}

''Note:'' Python programmers usually prefer to use ''comprehension'' syntax rather than calling map or filter functions with lambda functions. The table shows the map and reduce syntax since that is the topic of this page. But for completeness, we note that the above examples can be written in Python using comprehensions as:
* <code>[ x**2 for x in numbers]</code>
* <code>sum( [demands[j] for j in route] )</code>
* <code>[ x for x in numbers if x % 2 == 0 ]</code>
Even so, unlike Analytica these still require you to explicitly specify the iteration.

==== 3. Simpler, more reliable code ====
By replacing complex looping constructs with intuitive, natural expressions, Analytica makes code both simpler to write and easier to understand.
* '''Readability:''' The final formula for a variable is a clear description of its purpose. <code>Profit = Revenue - Expenses</code> is far more transparent than a multi-step formula involving helper columns or complex array functions.
* '''Flexibility:''' Adding a new dimension—like "Time" or "Region"—is as simple as adding an index. The formulas that depend on those variables automatically adjust without error-prone code changes.
* '''Less code, fewer errors:''' The reduction in explicit instructions dramatically reduces the number of formulas needed, which in turn reduces the chances of human error.

=== Local functions in Analytica ===
Although you don't need to use [[Lambda function]]s for map, reduce and filter operations, they can still be useful in Analytica. In fact, although [[Lambda function]]s have recently found their way to procedural languages like Python and C++, they actually originated in functional languages, even to the point where some definitions of what qualifies as a functional language center around the ability to manipulate anonymous functions similar to any other data type. Analytica's ability to manipulate functions as data, and to create custom lambdas on the fly during evaluation, enables numerous capabilities that fall into the category of advanced programming. There are esoteric cases in advanced algorithms where you don't want array abstraction's automatic map-reduce behavior, and [[Local functions]] can be a useful abstraction to avoid those difficulties.

=== A simpler way of thinking ===
Analytica's declarative, array-based philosophy is fundamentally different from the procedural mindset that requires lambdas. It's a paradigm shift that allows users to model complex problems more directly and with greater clarity, ultimately simplifying the entire process of writing and understanding code. Instead of focusing on the mechanics of how a calculation is performed, you can focus on the logic of the problem itself.

Why Analytica doesn't need Map and Reduce functions

2025-12-17T01:25:32Z

Mhenrion: /* Why Analytica doesn't need Lambdas in many common cases */

''Map'' and ''reduce'' are operations in many modern programming languages. ''Map'' applies an operation over every element of an array, while ''reduce'' applies an operation repeatedly to eliminate a dimension. The accept a function or operator, which often takes the form of a '''[[Lambda function]]'''. In Analytica, there is no need for separate and explicit map and reduce operations. This difference highlights a fundamental distinction in how these languages operate: while procedural languages like Python, and even the latest versions of Excel, require explicit instructions for array operations, Analytica's declarative structure and Intelligent Arrays handle the heavy lifting automatically.

=== What is a Lambda function? ===

A Lambda is a small, anonymous (nameless) function that can be stored and manipulated as a data value, such as being held in an array or variable. In Analytica, they are called [[Local functions]]. With respect to their use case for the map and reduce functions found in other languages, they often passed as an argument to apply repeatedly. It allows for concise, inline logic without the need for a formal function definition.

==== In Python ====
In Python, a lambda is often used with higher-order functions like <code>map()</code> and <code>filter()</code>.

<pre>
# A list of numbers
numbers = [1, 2, 3, 4, 5]

# Using lambda with map() to square each number
squared_numbers = list(map(lambda x: x**2, numbers))
print(squared_numbers)
# Output: [1, 4, 9, 16, 25]
</pre>

==== In Excel ====
Microsoft 365 introduced the <code>LAMBDA</code> function to give users a way to create reusable custom functions directly within Excel's formula language. Unlike Python and other languages, you must still give it a name to be used elsewhere.

<pre>
# In the Name Manager, you define a named lambda:
Name: CircleArea
Refers to: =LAMBDA(r, PI()*r^2)

# Now you can apply your custom function to a cell:
=CircleArea(A1)
</pre>

=== Why Analytica doesn't usually need Lambdas ===

The core reason Analytica doesn't need a lambda function for map, reduce and filter operations lies in its architecture. It is a '''declarative, array-based language''', which means you focus on describing ''what'' a variable is, not ''how'' to compute it.

==== 1. Declarative vs. procedural approach ====
Most programming languages are procedural—they require you to specify a sequence of steps. Lambda functions are a solution for making this process more concise for simple operations. Analytica, on the other hand, is a declarative language, much like Excel's formula model. The software handles the execution order based on the dependencies you define, freeing you from worrying about control flow.

==== 2. Intelligent Arrays (Array abstraction) ====
Analytica’s "Intelligent Arrays" allow operators and functions to work on entire arrays simultaneously, eliminating the need for <code>MAP</code>, <code>REDUCE</code>, or explicit loops. When you write <code>Revenue - Costs</code>, Analytica automatically applies that subtraction to every corresponding element in the <code>Revenue</code> and <code>Costs</code> arrays. This is array abstraction at its finest.

Here is how Analytica's approach compares to procedural languages:

{| class="wikitable"
|-
! Operation
! Excel with <code>MAP</code>
! Python with <code>lambda</code>/<code>map</code>
! Analytica (Intelligent Arrays)
|-
| '''Square all numbers'''
| <code>=MAP(A1:A5, LAMBDA(x, x^2))</code>
| <code>list(map(lambda x: x**2, numbers))</code>
| <code>numbers^2</code>
|-
| '''Calculate total demand over routes'''
| Uses helper column or <code>REDUCE</code>
| <code>sum(map(lambda j: demands[j], route))</code>
| <code>[[Sum]](Demands, Route)</code>
|-
| '''Filter for even numbers'''
| <code>=FILTER(A1:A5, MAP(A1:A5, LAMBDA(x, ISEVEN(x))))</code>
| <code>list(filter(lambda x: x % 2 == 0, numbers))</code>
| <code>[[Subset]]([[Mod]](numbers, 2) = 0)</code>
|}

''Note:'' Python programmers usually prefer to use ''comprehension'' syntax rather than calling map or filter functions with lambda functions. The table shows the map and reduce syntax since that is the topic of this page. But for completeness, we note that the above examples can be written in Python using comprehensions as:
* <code>[ x**2 for x in numbers]</code>
* <code>sum( [demands[j] for j in route] )</code>
* <code>[ x for x in numbers if x % 2 == 0 ]</code>
Even so, unlike Analytica these still require you to explicitly specify the iteration.

==== 3. Simpler, more reliable code ====
By replacing complex looping constructs with intuitive, natural expressions, Analytica makes code both simpler to write and easier to understand.
* '''Readability:''' The final formula for a variable is a clear description of its purpose. <code>Profit = Revenue - Expenses</code> is far more transparent than a multi-step formula involving helper columns or complex array functions.
* '''Flexibility:''' Adding a new dimension—like "Time" or "Region"—is as simple as adding an index. The formulas that depend on those variables automatically adjust without error-prone code changes.
* '''Less code, fewer errors:''' The reduction in explicit instructions dramatically reduces the number of formulas needed, which in turn reduces the chances of human error.

=== Local functions in Analytica ===
Although you don't need to use [[Lambda function]]s for map, reduce and filter operations, they can still be useful in Analytica. In fact, although [[Lambda function]]s have recently found their way to procedural languages like Python and C++, they actually originated in functional languages, even to the point where some definitions of what qualifies as a functional language center around the ability to manipulate anonymous functions similar to any other data type. Analytica's ability to manipulate functions as data, and to create custom lambdas on the fly during evaluation, enables numerous capabilities that fall into the category of advanced programming. There are esoteric cases in advanced algorithms where you don't want array abstraction's automatic map-reduce behavior, and [[Local functions]] can be a useful abstraction to avoid those difficulties.

=== A simpler way of thinking ===
Analytica's declarative, array-based philosophy is fundamentally different from the procedural mindset that requires lambdas. It's a paradigm shift that allows users to model complex problems more directly and with greater clarity, ultimately simplifying the entire process of writing and understanding code. Instead of focusing on the mechanics of how a calculation is performed, you can focus on the logic of the problem itself.

What's new in Analytica 6.6?

2025-12-16T22:22:06Z

Mhenrion: /* Graphing */

[[category:What's new pages]]
[[category:Analytica releases]]

This page lists new features in release 6.6 (the current release) of Analytica (including [[ACP]] and [[ADE]]) since the previous [[Analytica 6.5]] release.

Analytica normally prompts you to download and install the new release the next time you run it.
If not, you can download it from [https://analytica.com/users/renew-upgrade/ Renew, upgrade or download].

== Highlights of 6.6 ==

* [[#Assista|Assista]], the Analytica AI Assistant, is faster and more reponsive.
* The [[#Keelin Metalog distribution 2.0|Keelin (or Metalog) distribution]] is now the preferred method to define any continuous distribution, because it now avoids the occasional infeasibility problem that previously bedeviled it.
* You can select [[#Diagrams and controls|All in Checkboxes]] for parametric analysis and in Multichoice.
* You can use [[Links_or_URL_in_model_attributes#Extended_HTML_markup| html to set text styles in text nodes]], including bold, italic, underline, bold, colors, bullets, and more in desktop Analytica. Even more html tags work in ACP.
* [[#Expression language|Sum(x, All) sums over All indexes of x]]. Similar for Min, Max, Product, and more.
* The new [[OAuth2Authorize]] function lets you access web services, such as Google docs, sheets, Salesforce, etc to read or write data.
* You can specify a [[#Graphing|Fill origin for graphs]] to let you show colored bands around the center line -- e.g. for probability bands over time.

== Assista ==
* The chat UI is faster. Responses start streaming sooner.
* You can use the Enter key (or Ctrl+Alt) to submit responses without having to click to submit button. The Return key adds a new line (the behavior elsewhere in Analytica). If you have the [[Preferences_dialog#Personal_Preferences|Use Return to enter data]] preference set, then the Return key will submit responses and the Enter key adds a new line.

== Keelin Metalog distribution 2.0 ==
Introducing the '''''always feasible''''', [[Keelin|infinitely flexible distribution]]!

The [[Keelin (MetaLog) distribution]] has become popular due to its ability to closely match the shapes of all the standard continuous distributions as well as offering enormous flexibility in matching amost any shape. But up until now it has been plagued by finding some parameter combinations ''infleasible'', so it would sometimes fail t to find a valid distribution to fit.

[[Analytica 6.6]] fixes this problem with the MetaLog 2.0 distribution. It includes many new results from
* Manel Baucells, Lonnie Chrisman, Thomas W. Keelin and Stephen Xu (2025), "[https://papers.ssrn.com/sol3/papers.cfm?abstract_id=5279416 On the properties of the Metalog distribution]" (preprint), forthcoming.

New features include:
* The resulting [[Keelin (MetaLog) distribution]]s are ''always'' feasible.
* There are closed-form analytic expressions for all central and standardized moments (see [[KeelinPropertyFromA#Basic_statistics_and_moments]]).
* There is a closed-form analytic expression for partial expectation (see [[KeelinPropertyFromA#Partial_expectation]]). This makes the Keelin distribution especially convenient for many problems that use piecewise-linear transformations of an uncertain quantity.
* It uses the superior basis order of the MetaLog 2.0.
* You can also specify the desired «mean», in addition to «values» (data points).
* New set of functions with names of the form <code><x>KeelinFromA(...)</code>use the «a» coefficient vector from [[KeelinCoefficients]]:
** <code>[[KeelinFromA]](...)</code> -- analog to <code>[[Keelin]](...)</code>
** <code>[[DensKeelinFromA]](...)</code> -- analog to <code>[[DensKeelin]](...)</code>
** <code>[[CumKeelinFromA]](...)</code> -- analog to <code>[[CumKeelin]](...)</code>
** <code>[[CumKeelinInvFromA]](...)</code> -- analog to <code>[[CumKeelinInv]](...)</code>
** <code>[[KeelinPropertyFromA]](...)</code> -- ''new to [[Analytica 6.6]]''
*:When using the Keelin distribution, you can either use a quantile parameterization or an «a»-vector parameterization. These new functions make it clearer that you are using the «a»-vector parameterization, instead of using the original (analogous) functions with a special flag.
* A new option uses a [https://docs.analytica.com/index.php?title=Keelin_(MetaLog)_distribution&anarelease=6.6#Using_direct_method_for_bounds direct method for bounded support] as an alternative to the previous [https://docs.analytica.com/index.php?title=Keelin_(MetaLog)_distribution&anarelease=6.6#Using_the_Transform_method_for_bounds transform-method for bounded support].

== Diagrams and controls ==
* [[Checkbox]] now has an "include ALL" option, enabling [[Parametric analysis]] even with a checkbox.
* [[Multichoice]] controls include a new option at the top to ''select '''all''''', ''select '''none''''' or ''select '''first''''', depending on the context. These are more obvious to the user than using the <code>Ctrl+A</code> key.
* A text node can display several [[Links_or_URL_in_model_attributes#Extended_HTML_markup|new html formatting options]], including changes to text color, bullets and numbered lists.
* A new [[ChangeNodeVisibility|node visibility option]] lets you hide a node while Analytica is computing.

== Expression language ==
* There is a new separate <code>Boolean</code> data type. To preserve backward compatibility, the values continue to display as 0 or 1, but the [[Number format dialog]] provides an option to display values with the boolean data type as True or False to distinguish them from 0 and 1.
* You can now find the maximum over all indexes of <code>X</code> using
*::<code>[[Max]](X, All)</code>
*:as a shortcut for
*::<code>[[Max]]( X, ...[[IndexesOf]](X) )</code>
*:which uses [[Repeated parameter forwarding]]. The <code>All</code> keyword works for these array-reducing functions, [[Sum]], [[Min]], [[BitAnd]], [[BitOr]] and [[BitXOr]].
* If you write your own function, and want it to accept the keyword <code>All</code> for a repeated index parameter, you can include a new <code>OrAll</code> [[Function parameter qualifiers|function parameter qualifier]].
* When passing a [[Local function]] (aka '''lambda function''') as a parameter to a function call, you no longer have to include a function name (which wasn't used anyway).
* You can use '.. operator ([[Repeated parameter forwarding]]) on literal lists to "splat" lists (or 1-D arrays) together into the list. Example:
*:<code>[[Local]] s1 := 'c'..'f', s2 := 'h'..'k' Do [ 'a', 'b', ...s1, 'g', ...s2, 'l' ]</code>
*::→ <code>['a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l']</code>

== Built-in functions ==
* [[OAuth2Authorize]]: A new function to log into web services such as Google docs, sheets, Salesforce, etc., which makes it much easier for Analytica models to access (read from or write to) web applications that require authentication.
* <code>[[TypeOf]](x, shallow: True)</code> now returns <code>"Image"</code> when <code>x</code> is an image.
* When <code>x</code> is an image, <code>f"{x:H}"</code> returns the long hex string that appears in a [[Pict]] attribute in a model file (but without the parens around it that appear in the model file).
* [[ReadTextFile]] returns the file encoding as its fourth return value.
* [[RunConsoleProcess]] is able to launch several applications that it previous could not, including PowerShell.
* New syntactic extensions added to the [[Arrow_operator#x_.E2.86.92_.5Bi.5D|arrow operator]], namely <code>x→[n]</code> and <code>x→[m..n]</code> for [[Text values]] and [[In-memory binary data terms]].

== File saving and loading ==
* '''Add Library...''' defaults to ''Link to filed module or library'' for almost all the standard libraries, which is the preferred way to add libraries to your model. (Except it still defaults to ''Embed a copy'' for the [[ACP Style Library]] since that library acts more module-like and changes its internal state).
* You can now set the [[Att_Dirties]] attribute (to 0) for your own user Variables. When set to 0, a change to the Definition doesn't dirty the Library or module that contains the Variable.

== Example models and libraries ==
* A new example model included: <code>"Engineering / Generator availability.ana"</code>
* An able to handle file paths > 256 characters in most cases. Actually taking advantage of this requires you to have long paths enabled in Windows, e.g., by setting the registry setting
*::<code>HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\FileSystem :: LongPathsEnabled = 1</code>
*:or by using the <code>\\unc\.... </code> syntax for file paths. However, long file paths are not supported by Microsoft One drive or by Microsoft office, including Excel, so you cannot use long paths for files within a One drive folder or when opening a spreadsheet file.
* Several of the diagram themes in the [[Themes Library]] were renamed.

== Graphing ==
* For Filled-area charts, in '''Graph set up''' you can now set the '''Fill type''' to "From origin"., and then select the '''Fill origin''' in the graph. A common use is in probability bands plot to select <code>.Probability=0.5</code> as the fill origin, to produce a plot like this:
*:::[[image:filled_bands_plot.png]]
*: You could previously do this by placing the [[Plot solid prob bands]] function in the [[OnGraphDraw]] attribute, but the new feature is much easier to configure, with just a few clicks in the [[Graph setup dialog]].
* '''Graph Setup / Text / Adapt displayed font sizes to graph height''' now uses the current height of the graph window you were viewing as the reference height, so that the font sizes you select in the graph setup dialog will be correct when the graph is at that height. Font sizes automatically adjust when you change the graph window size. Previously the reference height was fixed at the default result window height (a graph of 241 pixels tall), which tended to make the fonts way too large for normal window heights. We now recommend using this setting by default so that text on graphs is easily legible at various sizes.

== Other GUI ==
* There are a few new options on the '''Windows''' menu:
** Bring next window to front
** Bring previous window to front
** [[Typescript window|Typescript console]] to show the Typescript window. (Still also available with ctrl+'.)

== Licensing ==
* [[ParseJSON]] and [[MakeJSON]] no longer require {{Analytica Enterprise}}.

Graph setup dialog

2025-12-16T21:41:59Z

Mhenrion: /* Chart Type tab */

[[Category:Analytica User Guide]]
[[Category: Windows and dialogs]]
[[Category: Graphs]]

<breadcrumbs>Analytica User Guide > Graphs > {{PAGENAME}}</breadcrumbs>
{{ReleaseBar}}

==About graph setup==
The '''Graph setup dialog''' lets you apply a wide variety of graphing styles and options to the selected graph, or as the new defaults for all graphs in this model. It also lets you use or define graph templates, to apply a standard collection of styles and options to a graph.

When you display the result of a variable, it shows it as a table or graph, according to how you last viewed it. The first time you view a result, it appears as a graph, unless you changed the default result view in the [[Preferences]] dialog.

When displaying a graph, Analytica uses the default graphing settings, unless you have selected other settings for it. You can modify these with the [[Graph setup dialog]].

'''To open the Graph setup dialog''': First display a graph. Then do one of these:

* Select '''Graph Setup '''from the [[Result menu]].
* Select '''Graph Setup '''from the [[right mouse button menu]].
* Double-click the graph in the [[Result window]].

The graph setup dialog has six tabs:

* '''[[#Chart Type tab|Chart Type]]:''' Select the line style, effects, area fill, border, stacked, and assign color, symbol, or dash styles.
* '''[[#Axis Ranges tab|Axis Ranges]]:''' Set the ranges or autoscale, type (reverse, categorical, log, or hide) labels and number of ticks ticks on each axis.
* '''[[#Style tab|Style]]:''' Style of grid, frame, tick marks, and where to display the Key.
* '''[[#Text tab|Text]]:''' Set the font, size, style,a nd color for axis and key titles and labels.
* '''[[#Background tab|Background]]:''' Fill color, gradient, or pattern for the graph background (main, plot, or key areas.)
* '''[[#Preview tab|Preview]]:''' Show the graph with current settings so you can see their effects before you apply or cancel them.

Each tabs shows the style template menu, and these three buttons:

* '''Apply: '''Apply any changes to settings to the current graph, and close the dialog.
* '''Set Default: '''Save any changed settings on the current tab as the default for all graphs, and close the dialog. It does not affect any settings that you have not changed since you opened the '''Graph setup '''dialog. Changing a default affects all graphs that use the default, but not graphs for which you override the default (in the past or future).
* '''Cancel: '''Close the dialog without changing or saving anything.

==Chart Type tab==
This tab lets you set the style and arrangement of the graph.

:{{Release||5.9|[[Image:GraphSetupDialog_LineStyleSettings5.png]]}}{{Release|6.0|6.2|[[Image:GraphSetupDialog_LineStyleSettings6.png]]}}{{Release|6.3||
[[Image:GraphSetupDialog LineStyleSettings6.3.png]]}}

'''Line style''':

:[[File:Chapter7 13.png]] Line segments join the data points.

:[[File:Chapter7 14.png]] Line segments, with a symbol at each data point.

:[[File:Chapter7 15.png]] A symbol at each data point with no lines.

:[[File:Chapter7 16.png]] A pixel at each data point, with no line.

:[[File:Chapter7 17.png]] A histogram or step function, with a vertical line and horizontal line from each data point to the next.

:[[File:Chapter7 18.png]] A bar centered on each x value, with height showing the y value. Forces the graph to be discrete.

'''Swap horizontal and vertical''': Check this box to exchange the x and y axes, so that x axis is vertical and y axis is horizontal. If x values are discrete with long labels, swapping axes gives a more easily legible bar graph.

'''3D effects''': Check to use three-dimensional style to view graphs. For a bar graph line style, it offers the choice of ''Box ''or ''Cylindrical ''shapes for the bars.

'''Sort by data spread''': Shows up in [[Analytica 5.0]] or later when your independent axis (X-axis) is categorical. Causes the categories in the X-axis to be re-ordered in decreasing order of data spread (or increasing order when you ''reverse order'' in the '''Axis Ranges''' tab). This is extremely useful when creating Tornado charts, since it automatically orders your tornado bars for you.

'''Line style settings''': Displays when you select a line style showing lines.

* '''Area fill:''' Check to fill in the area beneath each line with a solid color. If there are multiple lines, the graph has a '''''key index'''''. It draws the fill areas from last to first element of the key index, which works well if the y values are sorted from smallest to largest over the key index. Otherwise, later values obscure earlier ones. Here’s an example.

:[[File:Chapter7 19.png]]

* '''Fill type: '''Normally it fills the area from the Y-origin to the curve. If you select " When you create an XY plot, each of your curves may define a polygon, in which case the Polygon fill types instead fill the areas surrounded by the curve. When your curve crosses itself, the option ''Polygon alternate'' fills the areas that are surrounded an odd number of times, whereas "Polygon solid" fills areas surrounded any number of times.{{Release|6.3||
* ''With border: ''Appears with Area fill turned. Controls whether a think black border line appears along the edge of a filled area line style.}}
* ''Transparency: ''Drag the cursor to change transparency of fill colors between opaque and transparent. Transparency lets you see fill lines and areas that would otherwise be obscured behind others.
* ''Line thickness: ''Select the thickness of lines to display. (Only for styles that show lines.)
* ''Use separate color/symbol keys: ''Check to display two key index roles, one indicated by color and the other by symbol type or size.{{Release|6.0||
* ''Separate dash style key: ''Check to display the dash style role selector, which you can use to depict the values along one index using a dash style at the same time you use color to depict a different value, which separate keys. Since there are only 5 distinct dash styles, works best for indexes having five or fewer different values.}}
* ''Allow variable symbol size: ''Check to have the size of symbols vary with their value.
* ''Symbol size: ''Enter a number to specify size of symbols in typographic points.
* ''Min symbol size and Max symbol size: ''If you check ''Allow variable symbol size'', use these fields to specify the range of symbol sizes from smallest and largest.{{Release|5.3||
* ''Where steps transition: ''This option appears for step charts, and controls where the step transition occurs. Left and right transitions change in Y at the point, whereas Mid steps at the midpoint between points. }}

'''Bar graph settings''': Displays when you select ''Bar ''graph line style:
* ''Shape: Box / Cylindrical'': When '''3-D effects''' are on, different 3-D shapes for the bar prisms.
* ''Enable bar outlines'': ([[Analytica 5.0]] or later). When on (default), a fine black line appears around the edges of the bars delineating their outline. (Note: If the bars get too narrow, the outline is automatically removed).
* ''Stacked bars: ''Check to show bars stacked one on top of the other over the key index, instead of side by side. The values for each bar are cumulated over the key index.
* ''Variable origin: ''Check if you want to set the origin (starting point) for each bar other than zero (the default). The graph then displays a '''Bar Origin '''menu to let you select the bar origin.
* ''Bar overlap: ''With stacked bars, they overlap 100%. You can specify partial overlap between 0 and 100%.

== Axis Ranges tab ==
This tab lets you control the display for each axis, vertical and horizontal, including scaling, range, and tickmarks.

:{{Release||5.9|[[Image:GraphSetupDialog_AxisRanges5.png]]}}{{Release|6.0||[[Image:GraphSetupDialog_AxisRanges6.png]]}}

'''Autoscale''': Uncheck this box if you want to specify the range for the axis, instead of letting Analytica select the range automatically to include all values.

'''Max and Min''': The maximum and minimum values of the range to use when you have unchecked '''Autoscale'''. '''Include zero'''Check if you want to include the origin (zero) in the range. You can also select the manual scaling range while viewing the graph graph using [[Interactive graph zooming]].

'''Approx. <nowiki>#</nowiki> ticks''': Specify the number of tick marks to display along the axis. Analytica might not match the number exactly, in the interests of clarity.

'''Reverse order''': Check this box if you want to show the values ordered from large to small instead of the default small to large.

'''Categorical''': Treat this axis as categorical. Usually, Analytica figures out the quantity is categorical without help. Occasionally, if the values are numerical, you might want to control it yourself. See [[Probability density and mass graphs]].

'''Log scale''': Check if you want to display this on a log scale. This is useful for numbers that vary by several orders of magnitude. It uses a “double log” scale with zero if the values include negative and positive numbers.

'''Set default''': If you have changed settings for an axis that is an index of the variable being graphed, clicking this button applies these changes to that index for ''all ''graphs that use that index. For example, if the scale is the '''Index Time''', you can use this to change the [[Time]] scale (e.g., start and end year) for every graph that displays a value over [[Time]], unless you want to override that default in another graph.

{{Release|6.0||
'''Hide labels''': When checked, the values are not shown on the corresponding axis. }}

== Style tab ==
The '''Style '''tab lets you modify the display of the style and color of the grid, frame, and tick marks, and where to display the key.

:{{Release||5.9|[[Image:GraphSetupDialog_Style5.png]]}}{{Release|6.0||[[Image:GraphSetupDialog_Style6.png]]}}

'''Grid''': Select the radio button to control the display of the grid over the graphing area. You can also select the color. A light or medium gray is often a good choice.

'''Frame''': Select the radio button to control the display of the lines framing the graphing area. You can also select the color for the frame. It is usually best to make the frame the same color as the grid, or a darker shade of the same color.

'''Tick marks''': The top radio buttons control where to show tick marks. The lower ones control how they are displayed.

'''Display key''': Select the radio button to control where to display the key on the graph. Select the ''Show border'' checkbox to display an outline rectangle around the key.

== Text tab ==
The '''Text '''tab lets you change the font, size, style, and color on the graph for the text of axis titles, axis labels (i.e., numbers or text identifying points along each axis), {{Release|6.0||graph title (appearing above the graph)}}, key titles, and key labels (i.e., identifying values in the key).

:{{Release||5.9|[[Image:GraphSetupDialog_Text5.png]]}}{{Release|6.0||[[Image:GraphSetupDialog_Text6.png]]}}

'''Font''': Select the font family. Graphic designers recommend using the same font for all text, which you can easily do by leaving all except axis titles as “(Same as axis titles).”

'''Size''': The size in typographic points. Set to 0 if you want that type of text to not display.

'''Color''': Select the color.

'''Bold, Italics, and Underline''': Check these boxes to add bold, italic, and underlined formats to the text.

:[[File:Chapter7 23.png]]

'''Axis Label Rotation''': Enter a number from -90 to 90 degrees to rotate the labels for each axis. For example, for a bar graph with many long labels along the horizontal axis, they won’t all fit. By rotating them by 45 or 90 degrees, you can make them all fit without getting truncated.

'''Adapt displayed font sizes to graph height''': If you check this box, the font size automatically adjusts when you make the graph window larger or smaller. This can be useful when you give a demo and want to expand graphs so they are easily readable to people at the back of the room. The font sizes match those specified at the default graph height of 300 pixels.

== Background tab ==
This tab lets you control the fill color, gradient, or pattern on the graph background. The main area covers the entire graph window (exclusive of the top area containing indexes). The plot area is the rectangle showing the graph values. If you leave or set the '''Fill '''to '''None '''for the '''Plot area '''or '''Key area''', they show the same fill settings (if any) as the '''Main area'''.

:[[File:Chapter7 24.png]]

'''Fill''': Select from:

* '''None: '''No fill. Default to blank (white) background.
* '''Solid: '''Use a solid fill with the selected '''Color 1'''.
* '''Gradient: '''Use a gradient of color, going from '''Color 1 '''to '''Color 2''', in the direction you specify in '''Gradient style'''.
* '''Hatch: '''Use a hatched fill using the selected '''Hatch Style '''with '''Color 1 '''and '''Color 2'''.

Graphic designers recommend avoiding hatched backgrounds, and using solid or gradient back- grounds with pale colors, if at all. The data should not be overwhelmed by the background.

== Preview tab ==
This tab shows the graph using the current settings so that you can see their effects before you decide to '''Apply '''or '''Cancel '''them.

:[[File:Chapter7 25.png]]

== Categorical and Continuous Plots ==
Distinctions regarding whether your results are treated as being '''''categorical''''', '''''continuous''''', or '''''discrete''''' impact how the data is plotted. Analytica usually infers the appropriate distinctions, but occasionally you might need to provide explicit setting information.

The [[discrete]]] vs. [[continuous]] distinction is determined by the [[domain attribute]], and determines whether probability plots are density and cumulative density plots (continuous) or probability mass and cumulative probability (discrete) plots.

The categorical vs. continuous distinction determines how a graphing axis is laid out. Continuous dimensions require numeric values. The determination of whether a graphing dimension is categorical or continuous is partially determined by the domain attribute. However, the values actually occurring in the dimension are determined by the chart type (bar or non-bar chart) and by the ''Categorical ''checkbox in the axis range setting.

== Exporting graph image type ==
You can export a graph as an image file in most common formats, including BMP, JPEG, TIFF, PNG, and Enhanced Windows Metafile (EMF):

# Display the graph the way you want.
# Select '''Export '''from the '''File '''menu, to open the '''Save Graph Image as '''file browser dialog. <br /> [[File:Chapter7 26.png]]
# If you want to change the defaults, edit the '''File name '''and select the '''Save as type''', i.e., the file format.
# Click '''Save'''.

==See Also==
* [[Graph view of a result]]
* [[Graph settings]]
* [[Graph Setting Associations]]
* [[Interactive graph zooming]]
* [[Toggling Key Item Visibility]]
* [[Graph templates]]
* [[Graph Style Templates]]
* [[Graphs]]
* [[Customization of Graph Colors]]
* [[Graphing roles]]
* [[Graphics, frames, and text in a diagram]]
* [[Preferences]]

<footer>Graphing roles / {{PAGENAME}} / Changing Series Colors</footer>

Graph setup dialog

2025-12-16T21:40:49Z

Mhenrion: /* Chart Type tab */

[[Category:Analytica User Guide]]
[[Category: Windows and dialogs]]
[[Category: Graphs]]

<breadcrumbs>Analytica User Guide > Graphs > {{PAGENAME}}</breadcrumbs>
{{ReleaseBar}}

==About graph setup==
The '''Graph setup dialog''' lets you apply a wide variety of graphing styles and options to the selected graph, or as the new defaults for all graphs in this model. It also lets you use or define graph templates, to apply a standard collection of styles and options to a graph.

When you display the result of a variable, it shows it as a table or graph, according to how you last viewed it. The first time you view a result, it appears as a graph, unless you changed the default result view in the [[Preferences]] dialog.

When displaying a graph, Analytica uses the default graphing settings, unless you have selected other settings for it. You can modify these with the [[Graph setup dialog]].

'''To open the Graph setup dialog''': First display a graph. Then do one of these:

* Select '''Graph Setup '''from the [[Result menu]].
* Select '''Graph Setup '''from the [[right mouse button menu]].
* Double-click the graph in the [[Result window]].

The graph setup dialog has six tabs:

* '''[[#Chart Type tab|Chart Type]]:''' Select the line style, effects, area fill, border, stacked, and assign color, symbol, or dash styles.
* '''[[#Axis Ranges tab|Axis Ranges]]:''' Set the ranges or autoscale, type (reverse, categorical, log, or hide) labels and number of ticks ticks on each axis.
* '''[[#Style tab|Style]]:''' Style of grid, frame, tick marks, and where to display the Key.
* '''[[#Text tab|Text]]:''' Set the font, size, style,a nd color for axis and key titles and labels.
* '''[[#Background tab|Background]]:''' Fill color, gradient, or pattern for the graph background (main, plot, or key areas.)
* '''[[#Preview tab|Preview]]:''' Show the graph with current settings so you can see their effects before you apply or cancel them.

Each tabs shows the style template menu, and these three buttons:

* '''Apply: '''Apply any changes to settings to the current graph, and close the dialog.
* '''Set Default: '''Save any changed settings on the current tab as the default for all graphs, and close the dialog. It does not affect any settings that you have not changed since you opened the '''Graph setup '''dialog. Changing a default affects all graphs that use the default, but not graphs for which you override the default (in the past or future).
* '''Cancel: '''Close the dialog without changing or saving anything.

==Chart Type tab==
This tab shows options for modifying the style and arrangement of the graph.

:{{Release||5.9|[[Image:GraphSetupDialog_LineStyleSettings5.png]]}}{{Release|6.0|6.2|[[Image:GraphSetupDialog_LineStyleSettings6.png]]}}{{Release|6.3||
[[Image:GraphSetupDialog LineStyleSettings6.3.png]]}}

'''Line style''':

:[[File:Chapter7 13.png]] Line segments join the data points.

:[[File:Chapter7 14.png]] Line segments, with a symbol at each data point.

:[[File:Chapter7 15.png]] A symbol at each data point with no lines.

:[[File:Chapter7 16.png]] A pixel at each data point, with no line.

:[[File:Chapter7 17.png]] A histogram or step function, with a vertical line and horizontal line from each data point to the next.

:[[File:Chapter7 18.png]] A bar centered on each x value, with height showing the y value. Forces the graph to be discrete.

'''Swap horizontal and vertical''': Check this box to exchange the x and y axes, so that x axis is vertical and y axis is horizontal. If x values are discrete with long labels, swapping axes gives a more easily legible bar graph.

'''3D effects''': Check to use three-dimensional style to view graphs. For a bar graph line style, it offers the choice of ''Box ''or ''Cylindrical ''shapes for the bars.

'''Sort by data spread''': Shows up in [[Analytica 5.0]] or later when your independent axis (X-axis) is categorical. Causes the categories in the X-axis to be re-ordered in decreasing order of data spread (or increasing order when you ''reverse order'' in the '''Axis Ranges''' tab). This is extremely useful when creating Tornado charts, since it automatically orders your tornado bars for you.

'''Line style settings''': Displays when you select a line style showing lines.

* '''Area fill:''' Check to fill in the area beneath each line with a solid color. If there are multiple lines, the graph has a '''''key index'''''. It draws the fill areas from last to first element of the key index, which works well if the y values are sorted from smallest to largest over the key index. Otherwise, later values obscure earlier ones. Here’s an example.

:[[File:Chapter7 19.png]]

* '''Fill type: '''Normally it fills the area from the Y-origin to the curve. If you select " When you create an XY plot, each of your curves may define a polygon, in which case the Polygon fill types instead fill the areas surrounded by the curve. When your curve crosses itself, the option ''Polygon alternate'' fills the areas that are surrounded an odd number of times, whereas "Polygon solid" fills areas surrounded any number of times.{{Release|6.3||
* ''With border: ''Appears with Area fill turned. Controls whether a think black border line appears along the edge of a filled area line style.}}
* ''Transparency: ''Drag the cursor to change transparency of fill colors between opaque and transparent. Transparency lets you see fill lines and areas that would otherwise be obscured behind others.
* ''Line thickness: ''Select the thickness of lines to display. (Only for styles that show lines.)
* ''Use separate color/symbol keys: ''Check to display two key index roles, one indicated by color and the other by symbol type or size.{{Release|6.0||
* ''Separate dash style key: ''Check to display the dash style role selector, which you can use to depict the values along one index using a dash style at the same time you use color to depict a different value, which separate keys. Since there are only 5 distinct dash styles, works best for indexes having five or fewer different values.}}
* ''Allow variable symbol size: ''Check to have the size of symbols vary with their value.
* ''Symbol size: ''Enter a number to specify size of symbols in typographic points.
* ''Min symbol size and Max symbol size: ''If you check ''Allow variable symbol size'', use these fields to specify the range of symbol sizes from smallest and largest.{{Release|5.3||
* ''Where steps transition: ''This option appears for step charts, and controls where the step transition occurs. Left and right transitions change in Y at the point, whereas Mid steps at the midpoint between points. }}

'''Bar graph settings''': Displays when you select ''Bar ''graph line style:
* ''Shape: Box / Cylindrical'': When '''3-D effects''' are on, different 3-D shapes for the bar prisms.
* ''Enable bar outlines'': ([[Analytica 5.0]] or later). When on (default), a fine black line appears around the edges of the bars delineating their outline. (Note: If the bars get too narrow, the outline is automatically removed).
* ''Stacked bars: ''Check to show bars stacked one on top of the other over the key index, instead of side by side. The values for each bar are cumulated over the key index.
* ''Variable origin: ''Check if you want to set the origin (starting point) for each bar other than zero (the default). The graph then displays a '''Bar Origin '''menu to let you select the bar origin.
* ''Bar overlap: ''With stacked bars, they overlap 100%. You can specify partial overlap between 0 and 100%.

== Axis Ranges tab ==
This tab lets you control the display for each axis, vertical and horizontal, including scaling, range, and tickmarks.

:{{Release||5.9|[[Image:GraphSetupDialog_AxisRanges5.png]]}}{{Release|6.0||[[Image:GraphSetupDialog_AxisRanges6.png]]}}

'''Autoscale''': Uncheck this box if you want to specify the range for the axis, instead of letting Analytica select the range automatically to include all values.

'''Max and Min''': The maximum and minimum values of the range to use when you have unchecked '''Autoscale'''. '''Include zero'''Check if you want to include the origin (zero) in the range. You can also select the manual scaling range while viewing the graph graph using [[Interactive graph zooming]].

'''Approx. <nowiki>#</nowiki> ticks''': Specify the number of tick marks to display along the axis. Analytica might not match the number exactly, in the interests of clarity.

'''Reverse order''': Check this box if you want to show the values ordered from large to small instead of the default small to large.

'''Categorical''': Treat this axis as categorical. Usually, Analytica figures out the quantity is categorical without help. Occasionally, if the values are numerical, you might want to control it yourself. See [[Probability density and mass graphs]].

'''Log scale''': Check if you want to display this on a log scale. This is useful for numbers that vary by several orders of magnitude. It uses a “double log” scale with zero if the values include negative and positive numbers.

'''Set default''': If you have changed settings for an axis that is an index of the variable being graphed, clicking this button applies these changes to that index for ''all ''graphs that use that index. For example, if the scale is the '''Index Time''', you can use this to change the [[Time]] scale (e.g., start and end year) for every graph that displays a value over [[Time]], unless you want to override that default in another graph.

{{Release|6.0||
'''Hide labels''': When checked, the values are not shown on the corresponding axis. }}

== Style tab ==
The '''Style '''tab lets you modify the display of the style and color of the grid, frame, and tick marks, and where to display the key.

:{{Release||5.9|[[Image:GraphSetupDialog_Style5.png]]}}{{Release|6.0||[[Image:GraphSetupDialog_Style6.png]]}}

'''Grid''': Select the radio button to control the display of the grid over the graphing area. You can also select the color. A light or medium gray is often a good choice.

'''Frame''': Select the radio button to control the display of the lines framing the graphing area. You can also select the color for the frame. It is usually best to make the frame the same color as the grid, or a darker shade of the same color.

'''Tick marks''': The top radio buttons control where to show tick marks. The lower ones control how they are displayed.

'''Display key''': Select the radio button to control where to display the key on the graph. Select the ''Show border'' checkbox to display an outline rectangle around the key.

== Text tab ==
The '''Text '''tab lets you change the font, size, style, and color on the graph for the text of axis titles, axis labels (i.e., numbers or text identifying points along each axis), {{Release|6.0||graph title (appearing above the graph)}}, key titles, and key labels (i.e., identifying values in the key).

:{{Release||5.9|[[Image:GraphSetupDialog_Text5.png]]}}{{Release|6.0||[[Image:GraphSetupDialog_Text6.png]]}}

'''Font''': Select the font family. Graphic designers recommend using the same font for all text, which you can easily do by leaving all except axis titles as “(Same as axis titles).”

'''Size''': The size in typographic points. Set to 0 if you want that type of text to not display.

'''Color''': Select the color.

'''Bold, Italics, and Underline''': Check these boxes to add bold, italic, and underlined formats to the text.

:[[File:Chapter7 23.png]]

'''Axis Label Rotation''': Enter a number from -90 to 90 degrees to rotate the labels for each axis. For example, for a bar graph with many long labels along the horizontal axis, they won’t all fit. By rotating them by 45 or 90 degrees, you can make them all fit without getting truncated.

'''Adapt displayed font sizes to graph height''': If you check this box, the font size automatically adjusts when you make the graph window larger or smaller. This can be useful when you give a demo and want to expand graphs so they are easily readable to people at the back of the room. The font sizes match those specified at the default graph height of 300 pixels.

== Background tab ==
This tab lets you control the fill color, gradient, or pattern on the graph background. The main area covers the entire graph window (exclusive of the top area containing indexes). The plot area is the rectangle showing the graph values. If you leave or set the '''Fill '''to '''None '''for the '''Plot area '''or '''Key area''', they show the same fill settings (if any) as the '''Main area'''.

:[[File:Chapter7 24.png]]

'''Fill''': Select from:

* '''None: '''No fill. Default to blank (white) background.
* '''Solid: '''Use a solid fill with the selected '''Color 1'''.
* '''Gradient: '''Use a gradient of color, going from '''Color 1 '''to '''Color 2''', in the direction you specify in '''Gradient style'''.
* '''Hatch: '''Use a hatched fill using the selected '''Hatch Style '''with '''Color 1 '''and '''Color 2'''.

Graphic designers recommend avoiding hatched backgrounds, and using solid or gradient back- grounds with pale colors, if at all. The data should not be overwhelmed by the background.

== Preview tab ==
This tab shows the graph using the current settings so that you can see their effects before you decide to '''Apply '''or '''Cancel '''them.

:[[File:Chapter7 25.png]]

== Categorical and Continuous Plots ==
Distinctions regarding whether your results are treated as being '''''categorical''''', '''''continuous''''', or '''''discrete''''' impact how the data is plotted. Analytica usually infers the appropriate distinctions, but occasionally you might need to provide explicit setting information.

The [[discrete]]] vs. [[continuous]] distinction is determined by the [[domain attribute]], and determines whether probability plots are density and cumulative density plots (continuous) or probability mass and cumulative probability (discrete) plots.

The categorical vs. continuous distinction determines how a graphing axis is laid out. Continuous dimensions require numeric values. The determination of whether a graphing dimension is categorical or continuous is partially determined by the domain attribute. However, the values actually occurring in the dimension are determined by the chart type (bar or non-bar chart) and by the ''Categorical ''checkbox in the axis range setting.

== Exporting graph image type ==
You can export a graph as an image file in most common formats, including BMP, JPEG, TIFF, PNG, and Enhanced Windows Metafile (EMF):

# Display the graph the way you want.
# Select '''Export '''from the '''File '''menu, to open the '''Save Graph Image as '''file browser dialog. <br /> [[File:Chapter7 26.png]]
# If you want to change the defaults, edit the '''File name '''and select the '''Save as type''', i.e., the file format.
# Click '''Save'''.

==See Also==
* [[Graph view of a result]]
* [[Graph settings]]
* [[Graph Setting Associations]]
* [[Interactive graph zooming]]
* [[Toggling Key Item Visibility]]
* [[Graph templates]]
* [[Graph Style Templates]]
* [[Graphs]]
* [[Customization of Graph Colors]]
* [[Graphing roles]]
* [[Graphics, frames, and text in a diagram]]
* [[Preferences]]

<footer>Graphing roles / {{PAGENAME}} / Changing Series Colors</footer>

Graph setup dialog

2025-12-16T21:35:03Z

Mhenrion: Added summary of the 6 tabs with links

[[Category:Analytica User Guide]]
[[Category: Windows and dialogs]]
[[Category: Graphs]]

<breadcrumbs>Analytica User Guide > Graphs > {{PAGENAME}}</breadcrumbs>
{{ReleaseBar}}

==About graph setup==
The '''Graph setup dialog''' lets you apply a wide variety of graphing styles and options to the selected graph, or as the new defaults for all graphs in this model. It also lets you use or define graph templates, to apply a standard collection of styles and options to a graph.

When you display the result of a variable, it shows it as a table or graph, according to how you last viewed it. The first time you view a result, it appears as a graph, unless you changed the default result view in the [[Preferences]] dialog.

When displaying a graph, Analytica uses the default graphing settings, unless you have selected other settings for it. You can modify these with the [[Graph setup dialog]].

'''To open the Graph setup dialog''': First display a graph. Then do one of these:

* Select '''Graph Setup '''from the [[Result menu]].
* Select '''Graph Setup '''from the [[right mouse button menu]].
* Double-click the graph in the [[Result window]].

The graph setup dialog has six tabs:

* '''[[#Chart Type tab|Chart Type]]:''' Select the line style, effects, area fill, border, stacked, and assign color, symbol, or dash styles.
* '''[[#Axis Ranges tab|Axis Ranges]]:''' Set the ranges or autoscale, type (reverse, categorical, log, or hide) labels and number of ticks ticks on each axis.
* '''[[#Style tab|Style]]:''' Style of grid, frame, tick marks, and where to display the Key.
* '''[[#Text tab|Text]]:''' Set the font, size, style,a nd color for axis and key titles and labels.
* '''[[#Background tab|Background]]:''' Fill color, gradient, or pattern for the graph background (main, plot, or key areas.)
* '''[[#Preview tab|Preview]]:''' Show the graph with current settings so you can see their effects before you apply or cancel them.

Each tabs shows the style template menu, and these three buttons:

* '''Apply: '''Apply any changes to settings to the current graph, and close the dialog.
* '''Set Default: '''Save any changed settings on the current tab as the default for all graphs, and close the dialog. It does not affect any settings that you have not changed since you opened the '''Graph setup '''dialog. Changing a default affects all graphs that use the default, but not graphs for which you override the default (in the past or future).
* '''Cancel: '''Close the dialog without changing or saving anything.

==Chart Type tab==
This tab shows options for modifying the style and arrangement of the graph.

:{{Release||5.9|[[Image:GraphSetupDialog_LineStyleSettings5.png]]}}{{Release|6.0|6.2|[[Image:GraphSetupDialog_LineStyleSettings6.png]]}}{{Release|6.3||
[[Image:GraphSetupDialog LineStyleSettings6.3.png]]}}

'''Line style''':

:[[File:Chapter7 13.png]] Line segments join the data points.

:[[File:Chapter7 14.png]] Line segments, with a symbol at each data point.

:[[File:Chapter7 15.png]] A symbol at each data point with no lines.

:[[File:Chapter7 16.png]] A pixel at each data point, with no line.

:[[File:Chapter7 17.png]] A histogram or step function, with a vertical line and horizontal line from each data point to the next.

:[[File:Chapter7 18.png]] A bar centered on each x value, with height showing the y value. Forces the graph to be discrete.

'''Swap horizontal and vertical''': Check this box to exchange the x and y axes, so that x axis is vertical and y axis is horizontal. If x values are discrete with long labels, swapping axes gives a more easily legible bar graph.

'''3D effects''': Check to use three-dimensional style to view graphs. For a bar graph line style, it offers the choice of ''Box ''or ''Cylindrical ''shapes for the bars.

'''Sort by data spread''': Shows up in [[Analytica 5.0]] or later when your independent axis (X-axis) is categorical. Causes the categories in the X-axis to be re-ordered in decreasing order of data spread (or increasing order when you ''reverse order'' in the '''Axis Ranges''' tab). This is extremely useful when creating Tornado charts, since it automatically orders your tornado bars for you.

'''Line style settings''': Displays when you select a line style showing lines.

* ''Area fill: ''Check to fill in the area beneath each line with a solid color. If there are multiple lines, the graph has a '''''key index'''''. It draws the fill areas from last to first element of the key index, which works well if the y values are sorted from smallest to largest over the key index. Otherwise, later values obscure earlier ones. Here’s an example.

:[[File:Chapter7 19.png]]

* ''Fill type: ''Normally an area fill paints the area from the Y-origin to the curve. When you create an XY plot, each of your curves may define a polygon, in which case the Polygon fill types instead fill the areas surrounded by the curve. When your curve crosses itself, the option ''Polygon alternate'' fills the areas that are surrounded an odd number of times, whereas "Polygon solid" fills areas surrounded any number of times.{{Release|6.3||
* ''With border: ''Appears with Area fill turned. Controls whether a think black border line appears along the edge of a filled area line style.}}
* ''Transparency: ''Drag the cursor to change transparency of fill colors between opaque and transparent. Transparency lets you see fill lines and areas that would otherwise be obscured behind others.
* ''Line thickness: ''Select the thickness of lines to display. (Only for styles that show lines.)
* ''Use separate color/symbol keys: ''Check to display two key index roles, one indicated by color and the other by symbol type or size.{{Release|6.0||
* ''Separate dash style key: ''Check to display the dash style role selector, which you can use to depict the values along one index using a dash style at the same time you use color to depict a different value, which separate keys. Since there are only 5 distinct dash styles, works best for indexes having five or fewer different values.}}
* ''Allow variable symbol size: ''Check to have the size of symbols vary with their value.
* ''Symbol size: ''Enter a number to specify size of symbols in typographic points.
* ''Min symbol size and Max symbol size: ''If you check ''Allow variable symbol size'', use these fields to specify the range of symbol sizes from smallest and largest.{{Release|5.3||
* ''Where steps transition: ''This option appears for step charts, and controls where the step transition occurs. Left and right transitions change in Y at the point, whereas Mid steps at the midpoint between points. }}

'''Bar graph settings''': Displays when you select ''Bar ''graph line style:
* ''Shape: Box / Cylindrical'': When '''3-D effects''' are on, different 3-D shapes for the bar prisms.
* ''Enable bar outlines'': ([[Analytica 5.0]] or later). When on (default), a fine black line appears around the edges of the bars delineating their outline. (Note: If the bars get too narrow, the outline is automatically removed).
* ''Stacked bars: ''Check to show bars stacked one on top of the other over the key index, instead of side by side. The values for each bar are cumulated over the key index.
* ''Variable origin: ''Check if you want to set the origin (starting point) for each bar other than zero (the default). The graph then displays a '''Bar Origin '''menu to let you select the bar origin.
* ''Bar overlap: ''With stacked bars, they overlap 100%. You can specify partial overlap between 0 and 100%.

== Axis Ranges tab ==
This tab lets you control the display for each axis, vertical and horizontal, including scaling, range, and tickmarks.

:{{Release||5.9|[[Image:GraphSetupDialog_AxisRanges5.png]]}}{{Release|6.0||[[Image:GraphSetupDialog_AxisRanges6.png]]}}

'''Autoscale''': Uncheck this box if you want to specify the range for the axis, instead of letting Analytica select the range automatically to include all values.

'''Max and Min''': The maximum and minimum values of the range to use when you have unchecked '''Autoscale'''. '''Include zero'''Check if you want to include the origin (zero) in the range. You can also select the manual scaling range while viewing the graph graph using [[Interactive graph zooming]].

'''Approx. <nowiki>#</nowiki> ticks''': Specify the number of tick marks to display along the axis. Analytica might not match the number exactly, in the interests of clarity.

'''Reverse order''': Check this box if you want to show the values ordered from large to small instead of the default small to large.

'''Categorical''': Treat this axis as categorical. Usually, Analytica figures out the quantity is categorical without help. Occasionally, if the values are numerical, you might want to control it yourself. See [[Probability density and mass graphs]].

'''Log scale''': Check if you want to display this on a log scale. This is useful for numbers that vary by several orders of magnitude. It uses a “double log” scale with zero if the values include negative and positive numbers.

'''Set default''': If you have changed settings for an axis that is an index of the variable being graphed, clicking this button applies these changes to that index for ''all ''graphs that use that index. For example, if the scale is the '''Index Time''', you can use this to change the [[Time]] scale (e.g., start and end year) for every graph that displays a value over [[Time]], unless you want to override that default in another graph.

{{Release|6.0||
'''Hide labels''': When checked, the values are not shown on the corresponding axis. }}

== Style tab ==
The '''Style '''tab lets you modify the display of the style and color of the grid, frame, and tick marks, and where to display the key.

:{{Release||5.9|[[Image:GraphSetupDialog_Style5.png]]}}{{Release|6.0||[[Image:GraphSetupDialog_Style6.png]]}}

'''Grid''': Select the radio button to control the display of the grid over the graphing area. You can also select the color. A light or medium gray is often a good choice.

'''Frame''': Select the radio button to control the display of the lines framing the graphing area. You can also select the color for the frame. It is usually best to make the frame the same color as the grid, or a darker shade of the same color.

'''Tick marks''': The top radio buttons control where to show tick marks. The lower ones control how they are displayed.

'''Display key''': Select the radio button to control where to display the key on the graph. Select the ''Show border'' checkbox to display an outline rectangle around the key.

== Text tab ==
The '''Text '''tab lets you change the font, size, style, and color on the graph for the text of axis titles, axis labels (i.e., numbers or text identifying points along each axis), {{Release|6.0||graph title (appearing above the graph)}}, key titles, and key labels (i.e., identifying values in the key).

:{{Release||5.9|[[Image:GraphSetupDialog_Text5.png]]}}{{Release|6.0||[[Image:GraphSetupDialog_Text6.png]]}}

'''Font''': Select the font family. Graphic designers recommend using the same font for all text, which you can easily do by leaving all except axis titles as “(Same as axis titles).”

'''Size''': The size in typographic points. Set to 0 if you want that type of text to not display.

'''Color''': Select the color.

'''Bold, Italics, and Underline''': Check these boxes to add bold, italic, and underlined formats to the text.

:[[File:Chapter7 23.png]]

'''Axis Label Rotation''': Enter a number from -90 to 90 degrees to rotate the labels for each axis. For example, for a bar graph with many long labels along the horizontal axis, they won’t all fit. By rotating them by 45 or 90 degrees, you can make them all fit without getting truncated.

'''Adapt displayed font sizes to graph height''': If you check this box, the font size automatically adjusts when you make the graph window larger or smaller. This can be useful when you give a demo and want to expand graphs so they are easily readable to people at the back of the room. The font sizes match those specified at the default graph height of 300 pixels.

== Background tab ==
This tab lets you control the fill color, gradient, or pattern on the graph background. The main area covers the entire graph window (exclusive of the top area containing indexes). The plot area is the rectangle showing the graph values. If you leave or set the '''Fill '''to '''None '''for the '''Plot area '''or '''Key area''', they show the same fill settings (if any) as the '''Main area'''.

:[[File:Chapter7 24.png]]

'''Fill''': Select from:

* '''None: '''No fill. Default to blank (white) background.
* '''Solid: '''Use a solid fill with the selected '''Color 1'''.
* '''Gradient: '''Use a gradient of color, going from '''Color 1 '''to '''Color 2''', in the direction you specify in '''Gradient style'''.
* '''Hatch: '''Use a hatched fill using the selected '''Hatch Style '''with '''Color 1 '''and '''Color 2'''.

Graphic designers recommend avoiding hatched backgrounds, and using solid or gradient back- grounds with pale colors, if at all. The data should not be overwhelmed by the background.

== Preview tab ==
This tab shows the graph using the current settings so that you can see their effects before you decide to '''Apply '''or '''Cancel '''them.

:[[File:Chapter7 25.png]]

== Categorical and Continuous Plots ==
Distinctions regarding whether your results are treated as being '''''categorical''''', '''''continuous''''', or '''''discrete''''' impact how the data is plotted. Analytica usually infers the appropriate distinctions, but occasionally you might need to provide explicit setting information.

The [[discrete]]] vs. [[continuous]] distinction is determined by the [[domain attribute]], and determines whether probability plots are density and cumulative density plots (continuous) or probability mass and cumulative probability (discrete) plots.

The categorical vs. continuous distinction determines how a graphing axis is laid out. Continuous dimensions require numeric values. The determination of whether a graphing dimension is categorical or continuous is partially determined by the domain attribute. However, the values actually occurring in the dimension are determined by the chart type (bar or non-bar chart) and by the ''Categorical ''checkbox in the axis range setting.

== Exporting graph image type ==
You can export a graph as an image file in most common formats, including BMP, JPEG, TIFF, PNG, and Enhanced Windows Metafile (EMF):

# Display the graph the way you want.
# Select '''Export '''from the '''File '''menu, to open the '''Save Graph Image as '''file browser dialog. <br /> [[File:Chapter7 26.png]]
# If you want to change the defaults, edit the '''File name '''and select the '''Save as type''', i.e., the file format.
# Click '''Save'''.

==See Also==
* [[Graph view of a result]]
* [[Graph settings]]
* [[Graph Setting Associations]]
* [[Interactive graph zooming]]
* [[Toggling Key Item Visibility]]
* [[Graph templates]]
* [[Graph Style Templates]]
* [[Graphs]]
* [[Customization of Graph Colors]]
* [[Graphing roles]]
* [[Graphics, frames, and text in a diagram]]
* [[Preferences]]

<footer>Graphing roles / {{PAGENAME}} / Changing Series Colors</footer>

What's new in Analytica 6.6?

2025-12-16T21:24:18Z

Mhenrion: /* Graphing */

[[category:What's new pages]]
[[category:Analytica releases]]

This page lists new features in release 6.6 (the current release) of Analytica (including [[ACP]] and [[ADE]]) since the previous [[Analytica 6.5]] release.

Analytica normally prompts you to download and install the new release the next time you run it.
If not, you can download it from [https://analytica.com/users/renew-upgrade/ Renew, upgrade or download].

== Highlights of 6.6 ==

* [[#Assista|Assista]], the Analytica AI Assistant, is faster and more reponsive.
* The [[#Keelin Metalog distribution 2.0|Keelin (or Metalog) distribution]] is now the preferred method to define any continuous distribution, because it now avoids the occasional infeasibility problem that previously bedeviled it.
* You can select [[#Diagrams and controls|All in Checkboxes]] for parametric analysis and in Multichoice.
* You can use [[Links_or_URL_in_model_attributes#Extended_HTML_markup| html to set text styles in text nodes]], including bold, italic, underline, bold, colors, bullets, and more in desktop Analytica. Even more html tags work in ACP.
* [[#Expression language|Sum(x, All) sums over All indexes of x]]. Similar for Min, Max, Product, and more.
* The new [[OAuth2Authorize]] function lets you access web services, such as Google docs, sheets, Salesforce, etc to read or write data.
* You can specify a [[#Graphing|Fill origin for graphs]] to let you show colored bands around the center line -- e.g. for probability bands over time.

== Assista ==
* The chat UI is faster. Responses start streaming sooner.
* You can use the Enter key (or Ctrl+Alt) to submit responses without having to click to submit button. The Return key adds a new line (the behavior elsewhere in Analytica). If you have the [[Preferences_dialog#Personal_Preferences|Use Return to enter data]] preference set, then the Return key will submit responses and the Enter key adds a new line.

== Keelin Metalog distribution 2.0 ==
Introducing the '''''always feasible''''', [[Keelin|infinitely flexible distribution]]!

The [[Keelin (MetaLog) distribution]] has become popular due to its ability to closely match the shapes of all the standard continuous distributions as well as offering enormous flexibility in matching amost any shape. But up until now it has been plagued by finding some parameter combinations ''infleasible'', so it would sometimes fail t to find a valid distribution to fit.

[[Analytica 6.6]] fixes this problem with the MetaLog 2.0 distribution. It includes many new results from
* Manel Baucells, Lonnie Chrisman, Thomas W. Keelin and Stephen Xu (2025), "[https://papers.ssrn.com/sol3/papers.cfm?abstract_id=5279416 On the properties of the Metalog distribution]" (preprint), forthcoming.

New features include:
* The resulting [[Keelin (MetaLog) distribution]]s are ''always'' feasible.
* There are closed-form analytic expressions for all central and standardized moments (see [[KeelinPropertyFromA#Basic_statistics_and_moments]]).
* There is a closed-form analytic expression for partial expectation (see [[KeelinPropertyFromA#Partial_expectation]]). This makes the Keelin distribution especially convenient for many problems that use piecewise-linear transformations of an uncertain quantity.
* It uses the superior basis order of the MetaLog 2.0.
* You can also specify the desired «mean», in addition to «values» (data points).
* New set of functions with names of the form <code><x>KeelinFromA(...)</code>use the «a» coefficient vector from [[KeelinCoefficients]]:
** <code>[[KeelinFromA]](...)</code> -- analog to <code>[[Keelin]](...)</code>
** <code>[[DensKeelinFromA]](...)</code> -- analog to <code>[[DensKeelin]](...)</code>
** <code>[[CumKeelinFromA]](...)</code> -- analog to <code>[[CumKeelin]](...)</code>
** <code>[[CumKeelinInvFromA]](...)</code> -- analog to <code>[[CumKeelinInv]](...)</code>
** <code>[[KeelinPropertyFromA]](...)</code> -- ''new to [[Analytica 6.6]]''
*:When using the Keelin distribution, you can either use a quantile parameterization or an «a»-vector parameterization. These new functions make it clearer that you are using the «a»-vector parameterization, instead of using the original (analogous) functions with a special flag.
* A new option uses a [https://docs.analytica.com/index.php?title=Keelin_(MetaLog)_distribution&anarelease=6.6#Using_direct_method_for_bounds direct method for bounded support] as an alternative to the previous [https://docs.analytica.com/index.php?title=Keelin_(MetaLog)_distribution&anarelease=6.6#Using_the_Transform_method_for_bounds transform-method for bounded support].

== Diagrams and controls ==
* [[Checkbox]] now has an "include ALL" option, enabling [[Parametric analysis]] even with a checkbox.
* [[Multichoice]] controls include a new option at the top to ''select '''all''''', ''select '''none''''' or ''select '''first''''', depending on the context. These are more obvious to the user than using the <code>Ctrl+A</code> key.
* A text node can display several [[Links_or_URL_in_model_attributes#Extended_HTML_markup|new html formatting options]], including changes to text color, bullets and numbered lists.
* A new [[ChangeNodeVisibility|node visibility option]] lets you hide a node while Analytica is computing.

== Expression language ==
* There is a new separate <code>Boolean</code> data type. To preserve backward compatibility, the values continue to display as 0 or 1, but the [[Number format dialog]] provides an option to display values with the boolean data type as True or False to distinguish them from 0 and 1.
* You can now find the maximum over all indexes of <code>X</code> using
*::<code>[[Max]](X, All)</code>
*:as a shortcut for
*::<code>[[Max]]( X, ...[[IndexesOf]](X) )</code>
*:which uses [[Repeated parameter forwarding]]. The <code>All</code> keyword works for these array-reducing functions, [[Sum]], [[Min]], [[BitAnd]], [[BitOr]] and [[BitXOr]].
* If you write your own function, and want it to accept the keyword <code>All</code> for a repeated index parameter, you can include a new <code>OrAll</code> [[Function parameter qualifiers|function parameter qualifier]].
* When passing a [[Local function]] (aka '''lambda function''') as a parameter to a function call, you no longer have to include a function name (which wasn't used anyway).
* You can use '.. operator ([[Repeated parameter forwarding]]) on literal lists to "splat" lists (or 1-D arrays) together into the list. Example:
*:<code>[[Local]] s1 := 'c'..'f', s2 := 'h'..'k' Do [ 'a', 'b', ...s1, 'g', ...s2, 'l' ]</code>
*::→ <code>['a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l']</code>

== Built-in functions ==
* [[OAuth2Authorize]]: A new function to log into web services such as Google docs, sheets, Salesforce, etc., which makes it much easier for Analytica models to access (read from or write to) web applications that require authentication.
* <code>[[TypeOf]](x, shallow: True)</code> now returns <code>"Image"</code> when <code>x</code> is an image.
* When <code>x</code> is an image, <code>f"{x:H}"</code> returns the long hex string that appears in a [[Pict]] attribute in a model file (but without the parens around it that appear in the model file).
* [[ReadTextFile]] returns the file encoding as its fourth return value.
* [[RunConsoleProcess]] is able to launch several applications that it previous could not, including PowerShell.
* New syntactic extensions added to the [[Arrow_operator#x_.E2.86.92_.5Bi.5D|arrow operator]], namely <code>x→[n]</code> and <code>x→[m..n]</code> for [[Text values]] and [[In-memory binary data terms]].

== File saving and loading ==
* '''Add Library...''' defaults to ''Link to filed module or library'' for almost all the standard libraries, which is the preferred way to add libraries to your model. (Except it still defaults to ''Embed a copy'' for the [[ACP Style Library]] since that library acts more module-like and changes its internal state).
* You can now set the [[Att_Dirties]] attribute (to 0) for your own user Variables. When set to 0, a change to the Definition doesn't dirty the Library or module that contains the Variable.

== Example models and libraries ==
* A new example model included: <code>"Engineering / Generator availability.ana"</code>
* An able to handle file paths > 256 characters in most cases. Actually taking advantage of this requires you to have long paths enabled in Windows, e.g., by setting the registry setting
*::<code>HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\FileSystem :: LongPathsEnabled = 1</code>
*:or by using the <code>\\unc\.... </code> syntax for file paths. However, long file paths are not supported by Microsoft One drive or by Microsoft office, including Excel, so you cannot use long paths for files within a One drive folder or when opening a spreadsheet file.
* Several of the diagram themes in the [[Themes Library]] were renamed.

== Graphing ==
* For Filled-area charts, you can now set the Fill type to "From origin".
*: One example usage for this is to select <code>.Probability=0.5</code> as the fill origin in a probability bands plot, which results in a plot like this one
*:::[[image:filled_bands_plot.png]]
*: You could previously do this by placing the [[Plot solid prob bands]] function in the [[OnGraphDraw]] attribute, but the new feature is much easier to configure, with just a few clicks in the [[Graph setup dialog]].
* '''Graph Setup / Text / Adapt displayed font sizes to graph height''' now uses the current height of the graph window you were viewing as the reference height, so that the font sizes you select in the graph setup dialog will be correct when the graph is at that height. Font sizes automatically adjust when you change the graph window size. Previously the reference height was fixed at the default result window height (a graph of 241 pixels tall), which tended to make the fonts way too large for normal window heights. We now recommend using this setting by default so that text on graphs is easily legible at various sizes.

== Other GUI ==
* There are a few new options on the '''Windows''' menu:
** Bring next window to front
** Bring previous window to front
** [[Typescript window|Typescript console]] to show the Typescript window. (Still also available with ctrl+'.)

== Licensing ==
* [[ParseJSON]] and [[MakeJSON]] no longer require {{Analytica Enterprise}}.

What's new in Analytica 6.6?

2025-12-16T19:49:35Z

Mhenrion: /* Other GUI */

[[category:What's new pages]]
[[category:Analytica releases]]

This page lists new features in release 6.6 (the current release) of Analytica (including [[ACP]] and [[ADE]]) since the previous [[Analytica 6.5]] release.

Analytica normally prompts you to download and install the new release the next time you run it.
If not, you can download it from [https://analytica.com/users/renew-upgrade/ Renew, upgrade or download].

== Highlights of 6.6 ==

* [[#Assista|Assista]], the Analytica AI Assistant, is faster and more reponsive.
* The [[#Keelin Metalog distribution 2.0|Keelin (or Metalog) distribution]] is now the preferred method to define any continuous distribution, because it now avoids the occasional infeasibility problem that previously bedeviled it.
* You can select [[#Diagrams and controls|All in Checkboxes]] for parametric analysis and in Multichoice.
* You can use [[Links_or_URL_in_model_attributes#Extended_HTML_markup| html to set text styles in text nodes]], including bold, italic, underline, bold, colors, bullets, and more in desktop Analytica. Even more html tags work in ACP.
* [[#Expression language|Sum(x, All) sums over All indexes of x]]. Similar for Min, Max, Product, and more.
* The new [[OAuth2Authorize]] function lets you access web services, such as Google docs, sheets, Salesforce, etc to read or write data.
* You can specify a [[#Graphing|Fill origin for graphs]] to let you show colored bands around the center line -- e.g. for probability bands over time.

== Assista ==
* The chat UI is faster. Responses start streaming sooner.
* You can use the Enter key (or Ctrl+Alt) to submit responses without having to click to submit button. The Return key adds a new line (the behavior elsewhere in Analytica). If you have the [[Preferences_dialog#Personal_Preferences|Use Return to enter data]] preference set, then the Return key will submit responses and the Enter key adds a new line.

== Keelin Metalog distribution 2.0 ==
Introducing the '''''always feasible''''', [[Keelin|infinitely flexible distribution]]!

The [[Keelin (MetaLog) distribution]] has become popular due to its ability to closely match the shapes of all the standard continuous distributions as well as offering enormous flexibility in matching amost any shape. But up until now it has been plagued by finding some parameter combinations ''infleasible'', so it would sometimes fail t to find a valid distribution to fit.

[[Analytica 6.6]] fixes this problem with the MetaLog 2.0 distribution. It includes many new results from
* Manel Baucells, Lonnie Chrisman, Thomas W. Keelin and Stephen Xu (2025), "[https://papers.ssrn.com/sol3/papers.cfm?abstract_id=5279416 On the properties of the Metalog distribution]" (preprint), forthcoming.

New features include:
* The resulting [[Keelin (MetaLog) distribution]]s are ''always'' feasible.
* There are closed-form analytic expressions for all central and standardized moments (see [[KeelinPropertyFromA#Basic_statistics_and_moments]]).
* There is a closed-form analytic expression for partial expectation (see [[KeelinPropertyFromA#Partial_expectation]]). This makes the Keelin distribution especially convenient for many problems that use piecewise-linear transformations of an uncertain quantity.
* It uses the superior basis order of the MetaLog 2.0.
* You can also specify the desired «mean», in addition to «values» (data points).
* New set of functions with names of the form <code><x>KeelinFromA(...)</code>use the «a» coefficient vector from [[KeelinCoefficients]]:
** <code>[[KeelinFromA]](...)</code> -- analog to <code>[[Keelin]](...)</code>
** <code>[[DensKeelinFromA]](...)</code> -- analog to <code>[[DensKeelin]](...)</code>
** <code>[[CumKeelinFromA]](...)</code> -- analog to <code>[[CumKeelin]](...)</code>
** <code>[[CumKeelinInvFromA]](...)</code> -- analog to <code>[[CumKeelinInv]](...)</code>
** <code>[[KeelinPropertyFromA]](...)</code> -- ''new to [[Analytica 6.6]]''
*:When using the Keelin distribution, you can either use a quantile parameterization or an «a»-vector parameterization. These new functions make it clearer that you are using the «a»-vector parameterization, instead of using the original (analogous) functions with a special flag.
* A new option uses a [https://docs.analytica.com/index.php?title=Keelin_(MetaLog)_distribution&anarelease=6.6#Using_direct_method_for_bounds direct method for bounded support] as an alternative to the previous [https://docs.analytica.com/index.php?title=Keelin_(MetaLog)_distribution&anarelease=6.6#Using_the_Transform_method_for_bounds transform-method for bounded support].

== Diagrams and controls ==
* [[Checkbox]] now has an "include ALL" option, enabling [[Parametric analysis]] even with a checkbox.
* [[Multichoice]] controls include a new option at the top to ''select '''all''''', ''select '''none''''' or ''select '''first''''', depending on the context. These are more obvious to the user than using the <code>Ctrl+A</code> key.
* A text node can display several [[Links_or_URL_in_model_attributes#Extended_HTML_markup|new html formatting options]], including changes to text color, bullets and numbered lists.
* A new [[ChangeNodeVisibility|node visibility option]] lets you hide a node while Analytica is computing.

== Expression language ==
* There is a new separate <code>Boolean</code> data type. To preserve backward compatibility, the values continue to display as 0 or 1, but the [[Number format dialog]] provides an option to display values with the boolean data type as True or False to distinguish them from 0 and 1.
* You can now find the maximum over all indexes of <code>X</code> using
*::<code>[[Max]](X, All)</code>
*:as a shortcut for
*::<code>[[Max]]( X, ...[[IndexesOf]](X) )</code>
*:which uses [[Repeated parameter forwarding]]. The <code>All</code> keyword works for these array-reducing functions, [[Sum]], [[Min]], [[BitAnd]], [[BitOr]] and [[BitXOr]].
* If you write your own function, and want it to accept the keyword <code>All</code> for a repeated index parameter, you can include a new <code>OrAll</code> [[Function parameter qualifiers|function parameter qualifier]].
* When passing a [[Local function]] (aka '''lambda function''') as a parameter to a function call, you no longer have to include a function name (which wasn't used anyway).
* You can use '.. operator ([[Repeated parameter forwarding]]) on literal lists to "splat" lists (or 1-D arrays) together into the list. Example:
*:<code>[[Local]] s1 := 'c'..'f', s2 := 'h'..'k' Do [ 'a', 'b', ...s1, 'g', ...s2, 'l' ]</code>
*::→ <code>['a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l']</code>

== Built-in functions ==
* [[OAuth2Authorize]]: A new function to log into web services such as Google docs, sheets, Salesforce, etc., which makes it much easier for Analytica models to access (read from or write to) web applications that require authentication.
* <code>[[TypeOf]](x, shallow: True)</code> now returns <code>"Image"</code> when <code>x</code> is an image.
* When <code>x</code> is an image, <code>f"{x:H}"</code> returns the long hex string that appears in a [[Pict]] attribute in a model file (but without the parens around it that appear in the model file).
* [[ReadTextFile]] returns the file encoding as its fourth return value.
* [[RunConsoleProcess]] is able to launch several applications that it previous could not, including PowerShell.
* New syntactic extensions added to the [[Arrow_operator#x_.E2.86.92_.5Bi.5D|arrow operator]], namely <code>x→[n]</code> and <code>x→[m..n]</code> for [[Text values]] and [[In-memory binary data terms]].

== File saving and loading ==
* '''Add Library...''' defaults to ''Link to filed module or library'' for almost all the standard libraries, which is the preferred way to add libraries to your model. (Except it still defaults to ''Embed a copy'' for the [[ACP Style Library]] since that library acts more module-like and changes its internal state).
* You can now set the [[Att_Dirties]] attribute (to 0) for your own user Variables. When set to 0, a change to the Definition doesn't dirty the Library or module that contains the Variable.

== Example models and libraries ==
* A new example model included: <code>"Engineering / Generator availability.ana"</code>
* An able to handle file paths > 256 characters in most cases. Actually taking advantage of this requires you to have long paths enabled in Windows, e.g., by setting the registry setting
*::<code>HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\FileSystem :: LongPathsEnabled = 1</code>
*:or by using the <code>\\unc\.... </code> syntax for file paths. However, long file paths are not supported by Microsoft One drive or by Microsoft office, including Excel, so you cannot use long paths for files within a One drive folder or when opening a spreadsheet file.
* Several of the diagram themes in the [[Themes Library]] were renamed.

== Graphing ==
* Control over the fill origin for a filled-area line chart using Fill type = "From origin".
*: One example usage for this is to select <code>.Probability=0.5</code> as the fill origin in a probability bands plot, which results in a plot like this one
*:::[[image:filled_bands_plot.png]]
*: You could previously do this by placing the [[Plot solid prob bands]] function in the [[OnGraphDraw]] attribute, but the new feature is much easier to configure, with just a few clicks in the [[Graph setup dialog]].
* '''Graph Setup / Text / Adapt displayed font sizes to graph height''' now uses the current height of the graph window you were viewing as the reference height, so that the font sizes you select in the graph setup dialog will be correct when the graph is at that height. Font sizes automatically adjust when you change the graph window size. Previously the reference height was fixed at the default result window height (a graph of 241 pixels tall), which tended to make the fonts way too large for normal window heights. We now recommend using this setting by default so that text on graphs is easily legible at various sizes.

== Other GUI ==
* There are a few new options on the '''Windows''' menu:
** Bring next window to front
** Bring previous window to front
** [[Typescript window|Typescript console]] to show the Typescript window. (Still also available with ctrl+'.)

== Licensing ==
* [[ParseJSON]] and [[MakeJSON]] no longer require {{Analytica Enterprise}}.

What's new in Analytica 6.6?

2025-12-16T19:48:26Z

Mhenrion: /* Graphing */

[[category:What's new pages]]
[[category:Analytica releases]]

This page lists new features in release 6.6 (the current release) of Analytica (including [[ACP]] and [[ADE]]) since the previous [[Analytica 6.5]] release.

Analytica normally prompts you to download and install the new release the next time you run it.
If not, you can download it from [https://analytica.com/users/renew-upgrade/ Renew, upgrade or download].

== Highlights of 6.6 ==

* [[#Assista|Assista]], the Analytica AI Assistant, is faster and more reponsive.
* The [[#Keelin Metalog distribution 2.0|Keelin (or Metalog) distribution]] is now the preferred method to define any continuous distribution, because it now avoids the occasional infeasibility problem that previously bedeviled it.
* You can select [[#Diagrams and controls|All in Checkboxes]] for parametric analysis and in Multichoice.
* You can use [[Links_or_URL_in_model_attributes#Extended_HTML_markup| html to set text styles in text nodes]], including bold, italic, underline, bold, colors, bullets, and more in desktop Analytica. Even more html tags work in ACP.
* [[#Expression language|Sum(x, All) sums over All indexes of x]]. Similar for Min, Max, Product, and more.
* The new [[OAuth2Authorize]] function lets you access web services, such as Google docs, sheets, Salesforce, etc to read or write data.
* You can specify a [[#Graphing|Fill origin for graphs]] to let you show colored bands around the center line -- e.g. for probability bands over time.

== Assista ==
* The chat UI is faster. Responses start streaming sooner.
* You can use the Enter key (or Ctrl+Alt) to submit responses without having to click to submit button. The Return key adds a new line (the behavior elsewhere in Analytica). If you have the [[Preferences_dialog#Personal_Preferences|Use Return to enter data]] preference set, then the Return key will submit responses and the Enter key adds a new line.

== Keelin Metalog distribution 2.0 ==
Introducing the '''''always feasible''''', [[Keelin|infinitely flexible distribution]]!

The [[Keelin (MetaLog) distribution]] has become popular due to its ability to closely match the shapes of all the standard continuous distributions as well as offering enormous flexibility in matching amost any shape. But up until now it has been plagued by finding some parameter combinations ''infleasible'', so it would sometimes fail t to find a valid distribution to fit.

[[Analytica 6.6]] fixes this problem with the MetaLog 2.0 distribution. It includes many new results from
* Manel Baucells, Lonnie Chrisman, Thomas W. Keelin and Stephen Xu (2025), "[https://papers.ssrn.com/sol3/papers.cfm?abstract_id=5279416 On the properties of the Metalog distribution]" (preprint), forthcoming.

New features include:
* The resulting [[Keelin (MetaLog) distribution]]s are ''always'' feasible.
* There are closed-form analytic expressions for all central and standardized moments (see [[KeelinPropertyFromA#Basic_statistics_and_moments]]).
* There is a closed-form analytic expression for partial expectation (see [[KeelinPropertyFromA#Partial_expectation]]). This makes the Keelin distribution especially convenient for many problems that use piecewise-linear transformations of an uncertain quantity.
* It uses the superior basis order of the MetaLog 2.0.
* You can also specify the desired «mean», in addition to «values» (data points).
* New set of functions with names of the form <code><x>KeelinFromA(...)</code>use the «a» coefficient vector from [[KeelinCoefficients]]:
** <code>[[KeelinFromA]](...)</code> -- analog to <code>[[Keelin]](...)</code>
** <code>[[DensKeelinFromA]](...)</code> -- analog to <code>[[DensKeelin]](...)</code>
** <code>[[CumKeelinFromA]](...)</code> -- analog to <code>[[CumKeelin]](...)</code>
** <code>[[CumKeelinInvFromA]](...)</code> -- analog to <code>[[CumKeelinInv]](...)</code>
** <code>[[KeelinPropertyFromA]](...)</code> -- ''new to [[Analytica 6.6]]''
*:When using the Keelin distribution, you can either use a quantile parameterization or an «a»-vector parameterization. These new functions make it clearer that you are using the «a»-vector parameterization, instead of using the original (analogous) functions with a special flag.
* A new option uses a [https://docs.analytica.com/index.php?title=Keelin_(MetaLog)_distribution&anarelease=6.6#Using_direct_method_for_bounds direct method for bounded support] as an alternative to the previous [https://docs.analytica.com/index.php?title=Keelin_(MetaLog)_distribution&anarelease=6.6#Using_the_Transform_method_for_bounds transform-method for bounded support].

== Diagrams and controls ==
* [[Checkbox]] now has an "include ALL" option, enabling [[Parametric analysis]] even with a checkbox.
* [[Multichoice]] controls include a new option at the top to ''select '''all''''', ''select '''none''''' or ''select '''first''''', depending on the context. These are more obvious to the user than using the <code>Ctrl+A</code> key.
* A text node can display several [[Links_or_URL_in_model_attributes#Extended_HTML_markup|new html formatting options]], including changes to text color, bullets and numbered lists.
* A new [[ChangeNodeVisibility|node visibility option]] lets you hide a node while Analytica is computing.

== Expression language ==
* There is a new separate <code>Boolean</code> data type. To preserve backward compatibility, the values continue to display as 0 or 1, but the [[Number format dialog]] provides an option to display values with the boolean data type as True or False to distinguish them from 0 and 1.
* You can now find the maximum over all indexes of <code>X</code> using
*::<code>[[Max]](X, All)</code>
*:as a shortcut for
*::<code>[[Max]]( X, ...[[IndexesOf]](X) )</code>
*:which uses [[Repeated parameter forwarding]]. The <code>All</code> keyword works for these array-reducing functions, [[Sum]], [[Min]], [[BitAnd]], [[BitOr]] and [[BitXOr]].
* If you write your own function, and want it to accept the keyword <code>All</code> for a repeated index parameter, you can include a new <code>OrAll</code> [[Function parameter qualifiers|function parameter qualifier]].
* When passing a [[Local function]] (aka '''lambda function''') as a parameter to a function call, you no longer have to include a function name (which wasn't used anyway).
* You can use '.. operator ([[Repeated parameter forwarding]]) on literal lists to "splat" lists (or 1-D arrays) together into the list. Example:
*:<code>[[Local]] s1 := 'c'..'f', s2 := 'h'..'k' Do [ 'a', 'b', ...s1, 'g', ...s2, 'l' ]</code>
*::→ <code>['a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l']</code>

== Built-in functions ==
* [[OAuth2Authorize]]: A new function to log into web services such as Google docs, sheets, Salesforce, etc., which makes it much easier for Analytica models to access (read from or write to) web applications that require authentication.
* <code>[[TypeOf]](x, shallow: True)</code> now returns <code>"Image"</code> when <code>x</code> is an image.
* When <code>x</code> is an image, <code>f"{x:H}"</code> returns the long hex string that appears in a [[Pict]] attribute in a model file (but without the parens around it that appear in the model file).
* [[ReadTextFile]] returns the file encoding as its fourth return value.
* [[RunConsoleProcess]] is able to launch several applications that it previous could not, including PowerShell.
* New syntactic extensions added to the [[Arrow_operator#x_.E2.86.92_.5Bi.5D|arrow operator]], namely <code>x→[n]</code> and <code>x→[m..n]</code> for [[Text values]] and [[In-memory binary data terms]].

== File saving and loading ==
* '''Add Library...''' defaults to ''Link to filed module or library'' for almost all the standard libraries, which is the preferred way to add libraries to your model. (Except it still defaults to ''Embed a copy'' for the [[ACP Style Library]] since that library acts more module-like and changes its internal state).
* You can now set the [[Att_Dirties]] attribute (to 0) for your own user Variables. When set to 0, a change to the Definition doesn't dirty the Library or module that contains the Variable.

== Example models and libraries ==
* A new example model included: <code>"Engineering / Generator availability.ana"</code>
* An able to handle file paths > 256 characters in most cases. Actually taking advantage of this requires you to have long paths enabled in Windows, e.g., by setting the registry setting
*::<code>HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\FileSystem :: LongPathsEnabled = 1</code>
*:or by using the <code>\\unc\.... </code> syntax for file paths. However, long file paths are not supported by Microsoft One drive or by Microsoft office, including Excel, so you cannot use long paths for files within a One drive folder or when opening a spreadsheet file.
* Several of the diagram themes in the [[Themes Library]] were renamed.

== Graphing ==
* Control over the fill origin for a filled-area line chart using Fill type = "From origin".
*: One example usage for this is to select <code>.Probability=0.5</code> as the fill origin in a probability bands plot, which results in a plot like this one
*:::[[image:filled_bands_plot.png]]
*: You could previously do this by placing the [[Plot solid prob bands]] function in the [[OnGraphDraw]] attribute, but the new feature is much easier to configure, with just a few clicks in the [[Graph setup dialog]].
* '''Graph Setup / Text / Adapt displayed font sizes to graph height''' now uses the current height of the graph window you were viewing as the reference height, so that the font sizes you select in the graph setup dialog will be correct when the graph is at that height. Font sizes automatically adjust when you change the graph window size. Previously the reference height was fixed at the default result window height (a graph of 241 pixels tall), which tended to make the fonts way too large for normal window heights. We now recommend using this setting by default so that text on graphs is easily legible at various sizes.

== Other GUI ==
* There are a few new options on the '''Windows''' menu:
** Bring next window to front
** Bring previous window to front
** [[Typescript window|Typescript console]]

== Licensing ==
* [[ParseJSON]] and [[MakeJSON]] no longer require {{Analytica Enterprise}}.

What's new in Analytica 6.6?

2025-12-16T19:41:25Z

Mhenrion: /* Built-in functions */

[[category:What's new pages]]
[[category:Analytica releases]]

This page lists new features in release 6.6 (the current release) of Analytica (including [[ACP]] and [[ADE]]) since the previous [[Analytica 6.5]] release.

Analytica normally prompts you to download and install the new release the next time you run it.
If not, you can download it from [https://analytica.com/users/renew-upgrade/ Renew, upgrade or download].

== Highlights of 6.6 ==

* [[#Assista|Assista]], the Analytica AI Assistant, is faster and more reponsive.
* The [[#Keelin Metalog distribution 2.0|Keelin (or Metalog) distribution]] is now the preferred method to define any continuous distribution, because it now avoids the occasional infeasibility problem that previously bedeviled it.
* You can select [[#Diagrams and controls|All in Checkboxes]] for parametric analysis and in Multichoice.
* You can use [[Links_or_URL_in_model_attributes#Extended_HTML_markup| html to set text styles in text nodes]], including bold, italic, underline, bold, colors, bullets, and more in desktop Analytica. Even more html tags work in ACP.
* [[#Expression language|Sum(x, All) sums over All indexes of x]]. Similar for Min, Max, Product, and more.
* The new [[OAuth2Authorize]] function lets you access web services, such as Google docs, sheets, Salesforce, etc to read or write data.
* You can specify a [[#Graphing|Fill origin for graphs]] to let you show colored bands around the center line -- e.g. for probability bands over time.

== Assista ==
* The chat UI is faster. Responses start streaming sooner.
* You can use the Enter key (or Ctrl+Alt) to submit responses without having to click to submit button. The Return key adds a new line (the behavior elsewhere in Analytica). If you have the [[Preferences_dialog#Personal_Preferences|Use Return to enter data]] preference set, then the Return key will submit responses and the Enter key adds a new line.

== Keelin Metalog distribution 2.0 ==
Introducing the '''''always feasible''''', [[Keelin|infinitely flexible distribution]]!

The [[Keelin (MetaLog) distribution]] has become popular due to its ability to closely match the shapes of all the standard continuous distributions as well as offering enormous flexibility in matching amost any shape. But up until now it has been plagued by finding some parameter combinations ''infleasible'', so it would sometimes fail t to find a valid distribution to fit.

[[Analytica 6.6]] fixes this problem with the MetaLog 2.0 distribution. It includes many new results from
* Manel Baucells, Lonnie Chrisman, Thomas W. Keelin and Stephen Xu (2025), "[https://papers.ssrn.com/sol3/papers.cfm?abstract_id=5279416 On the properties of the Metalog distribution]" (preprint), forthcoming.

New features include:
* The resulting [[Keelin (MetaLog) distribution]]s are ''always'' feasible.
* There are closed-form analytic expressions for all central and standardized moments (see [[KeelinPropertyFromA#Basic_statistics_and_moments]]).
* There is a closed-form analytic expression for partial expectation (see [[KeelinPropertyFromA#Partial_expectation]]). This makes the Keelin distribution especially convenient for many problems that use piecewise-linear transformations of an uncertain quantity.
* It uses the superior basis order of the MetaLog 2.0.
* You can also specify the desired «mean», in addition to «values» (data points).
* New set of functions with names of the form <code><x>KeelinFromA(...)</code>use the «a» coefficient vector from [[KeelinCoefficients]]:
** <code>[[KeelinFromA]](...)</code> -- analog to <code>[[Keelin]](...)</code>
** <code>[[DensKeelinFromA]](...)</code> -- analog to <code>[[DensKeelin]](...)</code>
** <code>[[CumKeelinFromA]](...)</code> -- analog to <code>[[CumKeelin]](...)</code>
** <code>[[CumKeelinInvFromA]](...)</code> -- analog to <code>[[CumKeelinInv]](...)</code>
** <code>[[KeelinPropertyFromA]](...)</code> -- ''new to [[Analytica 6.6]]''
*:When using the Keelin distribution, you can either use a quantile parameterization or an «a»-vector parameterization. These new functions make it clearer that you are using the «a»-vector parameterization, instead of using the original (analogous) functions with a special flag.
* A new option uses a [https://docs.analytica.com/index.php?title=Keelin_(MetaLog)_distribution&anarelease=6.6#Using_direct_method_for_bounds direct method for bounded support] as an alternative to the previous [https://docs.analytica.com/index.php?title=Keelin_(MetaLog)_distribution&anarelease=6.6#Using_the_Transform_method_for_bounds transform-method for bounded support].

== Diagrams and controls ==
* [[Checkbox]] now has an "include ALL" option, enabling [[Parametric analysis]] even with a checkbox.
* [[Multichoice]] controls include a new option at the top to ''select '''all''''', ''select '''none''''' or ''select '''first''''', depending on the context. These are more obvious to the user than using the <code>Ctrl+A</code> key.
* A text node can display several [[Links_or_URL_in_model_attributes#Extended_HTML_markup|new html formatting options]], including changes to text color, bullets and numbered lists.
* A new [[ChangeNodeVisibility|node visibility option]] lets you hide a node while Analytica is computing.

== Expression language ==
* There is a new separate <code>Boolean</code> data type. To preserve backward compatibility, the values continue to display as 0 or 1, but the [[Number format dialog]] provides an option to display values with the boolean data type as True or False to distinguish them from 0 and 1.
* You can now find the maximum over all indexes of <code>X</code> using
*::<code>[[Max]](X, All)</code>
*:as a shortcut for
*::<code>[[Max]]( X, ...[[IndexesOf]](X) )</code>
*:which uses [[Repeated parameter forwarding]]. The <code>All</code> keyword works for these array-reducing functions, [[Sum]], [[Min]], [[BitAnd]], [[BitOr]] and [[BitXOr]].
* If you write your own function, and want it to accept the keyword <code>All</code> for a repeated index parameter, you can include a new <code>OrAll</code> [[Function parameter qualifiers|function parameter qualifier]].
* When passing a [[Local function]] (aka '''lambda function''') as a parameter to a function call, you no longer have to include a function name (which wasn't used anyway).
* You can use '.. operator ([[Repeated parameter forwarding]]) on literal lists to "splat" lists (or 1-D arrays) together into the list. Example:
*:<code>[[Local]] s1 := 'c'..'f', s2 := 'h'..'k' Do [ 'a', 'b', ...s1, 'g', ...s2, 'l' ]</code>
*::→ <code>['a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l']</code>

== Built-in functions ==
* [[OAuth2Authorize]]: A new function to log into web services such as Google docs, sheets, Salesforce, etc., which makes it much easier for Analytica models to access (read from or write to) web applications that require authentication.
* <code>[[TypeOf]](x, shallow: True)</code> now returns <code>"Image"</code> when <code>x</code> is an image.
* When <code>x</code> is an image, <code>f"{x:H}"</code> returns the long hex string that appears in a [[Pict]] attribute in a model file (but without the parens around it that appear in the model file).
* [[ReadTextFile]] returns the file encoding as its fourth return value.
* [[RunConsoleProcess]] is able to launch several applications that it previous could not, including PowerShell.
* New syntactic extensions added to the [[Arrow_operator#x_.E2.86.92_.5Bi.5D|arrow operator]], namely <code>x→[n]</code> and <code>x→[m..n]</code> for [[Text values]] and [[In-memory binary data terms]].

== File saving and loading ==
* '''Add Library...''' defaults to ''Link to filed module or library'' for almost all the standard libraries, which is the preferred way to add libraries to your model. (Except it still defaults to ''Embed a copy'' for the [[ACP Style Library]] since that library acts more module-like and changes its internal state).
* You can now set the [[Att_Dirties]] attribute (to 0) for your own user Variables. When set to 0, a change to the Definition doesn't dirty the Library or module that contains the Variable.

== Example models and libraries ==
* A new example model included: <code>"Engineering / Generator availability.ana"</code>
* An able to handle file paths > 256 characters in most cases. Actually taking advantage of this requires you to have long paths enabled in Windows, e.g., by setting the registry setting
*::<code>HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\FileSystem :: LongPathsEnabled = 1</code>
*:or by using the <code>\\unc\.... </code> syntax for file paths. However, long file paths are not supported by Microsoft One drive or by Microsoft office, including Excel, so you cannot use long paths for files within a One drive folder or when opening a spreadsheet file.
* Several of the diagram themes in the [[Themes Library]] were renamed.

== Graphing ==
* Control over the fill origin for a filled-area line chart using Fill type = "From origin".
*: One example usage for this is to select <code>.Probability=0.5</code> as the fill origin in a probability bands plot, which results in a plot like this one
*:::[[image:filled_bands_plot.png]]
*: This example is already easily achieved by placing the [[Plot solid prob bands]] function in the [[OnGraphDraw]] attribute, but with the new feature it is also directly configurable with a few [[Graph setup dialog]] clicks.
* When you turn on '''Graph Setup / Text / Adapt displayed font sizes to graph height''', it now uses the current height of the graph you were viewing as the reference height, such that when the graph has that same height, the point sizes shown in the graph setup dialog will be the correct font sizes. Previously the reference height was fixed at the default result window height (a graph of 241 pixels tall).

== Other GUI ==
* There are a few new options on the '''Windows''' menu:
** Bring next window to front
** Bring previous window to front
** [[Typescript window|Typescript console]]

== Licensing ==
* [[ParseJSON]] and [[MakeJSON]] no longer require {{Analytica Enterprise}}.

What's new in Analytica 6.6?

2025-12-16T19:37:44Z

Mhenrion: /* Expression language */

[[category:What's new pages]]
[[category:Analytica releases]]

This page lists new features in release 6.6 (the current release) of Analytica (including [[ACP]] and [[ADE]]) since the previous [[Analytica 6.5]] release.

Analytica normally prompts you to download and install the new release the next time you run it.
If not, you can download it from [https://analytica.com/users/renew-upgrade/ Renew, upgrade or download].

== Highlights of 6.6 ==

* [[#Assista|Assista]], the Analytica AI Assistant, is faster and more reponsive.
* The [[#Keelin Metalog distribution 2.0|Keelin (or Metalog) distribution]] is now the preferred method to define any continuous distribution, because it now avoids the occasional infeasibility problem that previously bedeviled it.
* You can select [[#Diagrams and controls|All in Checkboxes]] for parametric analysis and in Multichoice.
* You can use [[Links_or_URL_in_model_attributes#Extended_HTML_markup| html to set text styles in text nodes]], including bold, italic, underline, bold, colors, bullets, and more in desktop Analytica. Even more html tags work in ACP.
* [[#Expression language|Sum(x, All) sums over All indexes of x]]. Similar for Min, Max, Product, and more.
* The new [[OAuth2Authorize]] function lets you access web services, such as Google docs, sheets, Salesforce, etc to read or write data.
* You can specify a [[#Graphing|Fill origin for graphs]] to let you show colored bands around the center line -- e.g. for probability bands over time.

== Assista ==
* The chat UI is faster. Responses start streaming sooner.
* You can use the Enter key (or Ctrl+Alt) to submit responses without having to click to submit button. The Return key adds a new line (the behavior elsewhere in Analytica). If you have the [[Preferences_dialog#Personal_Preferences|Use Return to enter data]] preference set, then the Return key will submit responses and the Enter key adds a new line.

== Keelin Metalog distribution 2.0 ==
Introducing the '''''always feasible''''', [[Keelin|infinitely flexible distribution]]!

The [[Keelin (MetaLog) distribution]] has become popular due to its ability to closely match the shapes of all the standard continuous distributions as well as offering enormous flexibility in matching amost any shape. But up until now it has been plagued by finding some parameter combinations ''infleasible'', so it would sometimes fail t to find a valid distribution to fit.

[[Analytica 6.6]] fixes this problem with the MetaLog 2.0 distribution. It includes many new results from
* Manel Baucells, Lonnie Chrisman, Thomas W. Keelin and Stephen Xu (2025), "[https://papers.ssrn.com/sol3/papers.cfm?abstract_id=5279416 On the properties of the Metalog distribution]" (preprint), forthcoming.

New features include:
* The resulting [[Keelin (MetaLog) distribution]]s are ''always'' feasible.
* There are closed-form analytic expressions for all central and standardized moments (see [[KeelinPropertyFromA#Basic_statistics_and_moments]]).
* There is a closed-form analytic expression for partial expectation (see [[KeelinPropertyFromA#Partial_expectation]]). This makes the Keelin distribution especially convenient for many problems that use piecewise-linear transformations of an uncertain quantity.
* It uses the superior basis order of the MetaLog 2.0.
* You can also specify the desired «mean», in addition to «values» (data points).
* New set of functions with names of the form <code><x>KeelinFromA(...)</code>use the «a» coefficient vector from [[KeelinCoefficients]]:
** <code>[[KeelinFromA]](...)</code> -- analog to <code>[[Keelin]](...)</code>
** <code>[[DensKeelinFromA]](...)</code> -- analog to <code>[[DensKeelin]](...)</code>
** <code>[[CumKeelinFromA]](...)</code> -- analog to <code>[[CumKeelin]](...)</code>
** <code>[[CumKeelinInvFromA]](...)</code> -- analog to <code>[[CumKeelinInv]](...)</code>
** <code>[[KeelinPropertyFromA]](...)</code> -- ''new to [[Analytica 6.6]]''
*:When using the Keelin distribution, you can either use a quantile parameterization or an «a»-vector parameterization. These new functions make it clearer that you are using the «a»-vector parameterization, instead of using the original (analogous) functions with a special flag.
* A new option uses a [https://docs.analytica.com/index.php?title=Keelin_(MetaLog)_distribution&anarelease=6.6#Using_direct_method_for_bounds direct method for bounded support] as an alternative to the previous [https://docs.analytica.com/index.php?title=Keelin_(MetaLog)_distribution&anarelease=6.6#Using_the_Transform_method_for_bounds transform-method for bounded support].

== Diagrams and controls ==
* [[Checkbox]] now has an "include ALL" option, enabling [[Parametric analysis]] even with a checkbox.
* [[Multichoice]] controls include a new option at the top to ''select '''all''''', ''select '''none''''' or ''select '''first''''', depending on the context. These are more obvious to the user than using the <code>Ctrl+A</code> key.
* A text node can display several [[Links_or_URL_in_model_attributes#Extended_HTML_markup|new html formatting options]], including changes to text color, bullets and numbered lists.
* A new [[ChangeNodeVisibility|node visibility option]] lets you hide a node while Analytica is computing.

== Expression language ==
* There is a new separate <code>Boolean</code> data type. To preserve backward compatibility, the values continue to display as 0 or 1, but the [[Number format dialog]] provides an option to display values with the boolean data type as True or False to distinguish them from 0 and 1.
* You can now find the maximum over all indexes of <code>X</code> using
*::<code>[[Max]](X, All)</code>
*:as a shortcut for
*::<code>[[Max]]( X, ...[[IndexesOf]](X) )</code>
*:which uses [[Repeated parameter forwarding]]. The <code>All</code> keyword works for these array-reducing functions, [[Sum]], [[Min]], [[BitAnd]], [[BitOr]] and [[BitXOr]].
* If you write your own function, and want it to accept the keyword <code>All</code> for a repeated index parameter, you can include a new <code>OrAll</code> [[Function parameter qualifiers|function parameter qualifier]].
* When passing a [[Local function]] (aka '''lambda function''') as a parameter to a function call, you no longer have to include a function name (which wasn't used anyway).
* You can use '.. operator ([[Repeated parameter forwarding]]) on literal lists to "splat" lists (or 1-D arrays) together into the list. Example:
*:<code>[[Local]] s1 := 'c'..'f', s2 := 'h'..'k' Do [ 'a', 'b', ...s1, 'g', ...s2, 'l' ]</code>
*::→ <code>['a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l']</code>

== Built-in functions ==
* New function [[OAuth2Authorize]]. This is used to log into web services such as Google docs, etc.
* <code>[[TypeOf]]( x, shallow:True )</code> now returns <code>"Image"</code> when <code>x</code> is an image.
* When <code>x</code> is an image, <code>f"{x:H}"</code> returns the long hex string that appears in a [[Pict]] attribute in a model file (but without the parens around it that appear in the model file).
* [[ReadTextFile]] returns the file encoding as its fourth return value.
* [[RunConsoleProcess]] is able to launch several applications that it previous could not, including PowerShell.
* New syntactic extensions added to the [[Arrow_operator#x_.E2.86.92_.5Bi.5D|arrow operator]], namely <code>x→[n]</code> and <code>x→[m..n]</code> for [[Text values]] and [[In-memory binary data terms]].

== File saving and loading ==
* '''Add Library...''' defaults to ''Link to filed module or library'' for almost all the standard libraries, which is the preferred way to add libraries to your model. (Except it still defaults to ''Embed a copy'' for the [[ACP Style Library]] since that library acts more module-like and changes its internal state).
* You can now set the [[Att_Dirties]] attribute (to 0) for your own user Variables. When set to 0, a change to the Definition doesn't dirty the Library or module that contains the Variable.

== Example models and libraries ==
* A new example model included: <code>"Engineering / Generator availability.ana"</code>
* An able to handle file paths > 256 characters in most cases. Actually taking advantage of this requires you to have long paths enabled in Windows, e.g., by setting the registry setting
*::<code>HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\FileSystem :: LongPathsEnabled = 1</code>
*:or by using the <code>\\unc\.... </code> syntax for file paths. However, long file paths are not supported by Microsoft One drive or by Microsoft office, including Excel, so you cannot use long paths for files within a One drive folder or when opening a spreadsheet file.
* Several of the diagram themes in the [[Themes Library]] were renamed.

== Graphing ==
* Control over the fill origin for a filled-area line chart using Fill type = "From origin".
*: One example usage for this is to select <code>.Probability=0.5</code> as the fill origin in a probability bands plot, which results in a plot like this one
*:::[[image:filled_bands_plot.png]]
*: This example is already easily achieved by placing the [[Plot solid prob bands]] function in the [[OnGraphDraw]] attribute, but with the new feature it is also directly configurable with a few [[Graph setup dialog]] clicks.
* When you turn on '''Graph Setup / Text / Adapt displayed font sizes to graph height''', it now uses the current height of the graph you were viewing as the reference height, such that when the graph has that same height, the point sizes shown in the graph setup dialog will be the correct font sizes. Previously the reference height was fixed at the default result window height (a graph of 241 pixels tall).

== Other GUI ==
* There are a few new options on the '''Windows''' menu:
** Bring next window to front
** Bring previous window to front
** [[Typescript window|Typescript console]]

== Licensing ==
* [[ParseJSON]] and [[MakeJSON]] no longer require {{Analytica Enterprise}}.

What's new in Analytica 6.6?

2025-12-16T19:28:01Z

Mhenrion: /* Diagrams and controls */

[[category:What's new pages]]
[[category:Analytica releases]]

This page lists new features in release 6.6 (the current release) of Analytica (including [[ACP]] and [[ADE]]) since the previous [[Analytica 6.5]] release.

Analytica normally prompts you to download and install the new release the next time you run it.
If not, you can download it from [https://analytica.com/users/renew-upgrade/ Renew, upgrade or download].

== Highlights of 6.6 ==

* [[#Assista|Assista]], the Analytica AI Assistant, is faster and more reponsive.
* The [[#Keelin Metalog distribution 2.0|Keelin (or Metalog) distribution]] is now the preferred method to define any continuous distribution, because it now avoids the occasional infeasibility problem that previously bedeviled it.
* You can select [[#Diagrams and controls|All in Checkboxes]] for parametric analysis and in Multichoice.
* You can use [[Links_or_URL_in_model_attributes#Extended_HTML_markup| html to set text styles in text nodes]], including bold, italic, underline, bold, colors, bullets, and more in desktop Analytica. Even more html tags work in ACP.
* [[#Expression language|Sum(x, All) sums over All indexes of x]]. Similar for Min, Max, Product, and more.
* The new [[OAuth2Authorize]] function lets you access web services, such as Google docs, sheets, Salesforce, etc to read or write data.
* You can specify a [[#Graphing|Fill origin for graphs]] to let you show colored bands around the center line -- e.g. for probability bands over time.

== Assista ==
* The chat UI is faster. Responses start streaming sooner.
* You can use the Enter key (or Ctrl+Alt) to submit responses without having to click to submit button. The Return key adds a new line (the behavior elsewhere in Analytica). If you have the [[Preferences_dialog#Personal_Preferences|Use Return to enter data]] preference set, then the Return key will submit responses and the Enter key adds a new line.

== Keelin Metalog distribution 2.0 ==
Introducing the '''''always feasible''''', [[Keelin|infinitely flexible distribution]]!

The [[Keelin (MetaLog) distribution]] has become popular due to its ability to closely match the shapes of all the standard continuous distributions as well as offering enormous flexibility in matching amost any shape. But up until now it has been plagued by finding some parameter combinations ''infleasible'', so it would sometimes fail t to find a valid distribution to fit.

[[Analytica 6.6]] fixes this problem with the MetaLog 2.0 distribution. It includes many new results from
* Manel Baucells, Lonnie Chrisman, Thomas W. Keelin and Stephen Xu (2025), "[https://papers.ssrn.com/sol3/papers.cfm?abstract_id=5279416 On the properties of the Metalog distribution]" (preprint), forthcoming.

New features include:
* The resulting [[Keelin (MetaLog) distribution]]s are ''always'' feasible.
* There are closed-form analytic expressions for all central and standardized moments (see [[KeelinPropertyFromA#Basic_statistics_and_moments]]).
* There is a closed-form analytic expression for partial expectation (see [[KeelinPropertyFromA#Partial_expectation]]). This makes the Keelin distribution especially convenient for many problems that use piecewise-linear transformations of an uncertain quantity.
* It uses the superior basis order of the MetaLog 2.0.
* You can also specify the desired «mean», in addition to «values» (data points).
* New set of functions with names of the form <code><x>KeelinFromA(...)</code>use the «a» coefficient vector from [[KeelinCoefficients]]:
** <code>[[KeelinFromA]](...)</code> -- analog to <code>[[Keelin]](...)</code>
** <code>[[DensKeelinFromA]](...)</code> -- analog to <code>[[DensKeelin]](...)</code>
** <code>[[CumKeelinFromA]](...)</code> -- analog to <code>[[CumKeelin]](...)</code>
** <code>[[CumKeelinInvFromA]](...)</code> -- analog to <code>[[CumKeelinInv]](...)</code>
** <code>[[KeelinPropertyFromA]](...)</code> -- ''new to [[Analytica 6.6]]''
*:When using the Keelin distribution, you can either use a quantile parameterization or an «a»-vector parameterization. These new functions make it clearer that you are using the «a»-vector parameterization, instead of using the original (analogous) functions with a special flag.
* A new option uses a [https://docs.analytica.com/index.php?title=Keelin_(MetaLog)_distribution&anarelease=6.6#Using_direct_method_for_bounds direct method for bounded support] as an alternative to the previous [https://docs.analytica.com/index.php?title=Keelin_(MetaLog)_distribution&anarelease=6.6#Using_the_Transform_method_for_bounds transform-method for bounded support].

== Diagrams and controls ==
* [[Checkbox]] now has an "include ALL" option, enabling [[Parametric analysis]] even with a checkbox.
* [[Multichoice]] controls include a new option at the top to ''select '''all''''', ''select '''none''''' or ''select '''first''''', depending on the context. These are more obvious to the user than using the <code>Ctrl+A</code> key.
* A text node can display several [[Links_or_URL_in_model_attributes#Extended_HTML_markup|new html formatting options]], including changes to text color, bullets and numbered lists.
* A new [[ChangeNodeVisibility|node visibility option]] lets you hide a node while Analytica is computing.

== Expression language ==
* There is a new separate <code>Boolean</code> data type. To preserve backward compatibility, the values continue to display as 0 or 1, but the [[Number format dialog]] provides an option to display values with the boolean data type as True or False to distinguish them from 0 and 1.
* You can now find the maximum over all indexes of <code>X</code> using
*::<code>[[Max]]( X, All }</code>
*:This is a shortcut for
*::<code>[[Max]]( X, ...[[IndexesOf]](X) )</code>
*:which uses [[Repeated parameter forwarding]]. The <code>All</code> keyword can be used in this fashion with [[Min]], [[Sum]], [[BitAnd]], [[BitOr]] and [[BitXOr]].
* If you write your own function, and want it to accept the keyword <code>All</code> for a repeated index parameter, you can include a new <code>OrAll</code> [[Function parameter qualifiers|function parameter qualifier]].
* When passing a [[Local function]] (aka '''lambda function''') as a parameter to a function call, you no longer have to include a function name (which wasn't used anyway).
* [[Repeated parameter forwarding]] can now be used on literal lists to "splat" lists (or 1-D arrays) together into the list. Example:
*:<code>[[Local]] s1 := 'c'..'f', s2 := 'h'..'k' Do [ 'a', 'b', ...s1, 'g', ...s2, 'l' ]</code>
*::→ <code>['a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l']</code>

== Built-in functions ==
* New function [[OAuth2Authorize]]. This is used to log into web services such as Google docs, etc.
* <code>[[TypeOf]]( x, shallow:True )</code> now returns <code>"Image"</code> when <code>x</code> is an image.
* When <code>x</code> is an image, <code>f"{x:H}"</code> returns the long hex string that appears in a [[Pict]] attribute in a model file (but without the parens around it that appear in the model file).
* [[ReadTextFile]] returns the file encoding as its fourth return value.
* [[RunConsoleProcess]] is able to launch several applications that it previous could not, including PowerShell.
* New syntactic extensions added to the [[Arrow_operator#x_.E2.86.92_.5Bi.5D|arrow operator]], namely <code>x→[n]</code> and <code>x→[m..n]</code> for [[Text values]] and [[In-memory binary data terms]].

== File saving and loading ==
* '''Add Library...''' defaults to ''Link to filed module or library'' for almost all the standard libraries, which is the preferred way to add libraries to your model. (Except it still defaults to ''Embed a copy'' for the [[ACP Style Library]] since that library acts more module-like and changes its internal state).
* You can now set the [[Att_Dirties]] attribute (to 0) for your own user Variables. When set to 0, a change to the Definition doesn't dirty the Library or module that contains the Variable.

== Example models and libraries ==
* A new example model included: <code>"Engineering / Generator availability.ana"</code>
* An able to handle file paths > 256 characters in most cases. Actually taking advantage of this requires you to have long paths enabled in Windows, e.g., by setting the registry setting
*::<code>HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\FileSystem :: LongPathsEnabled = 1</code>
*:or by using the <code>\\unc\.... </code> syntax for file paths. However, long file paths are not supported by Microsoft One drive or by Microsoft office, including Excel, so you cannot use long paths for files within a One drive folder or when opening a spreadsheet file.
* Several of the diagram themes in the [[Themes Library]] were renamed.

== Graphing ==
* Control over the fill origin for a filled-area line chart using Fill type = "From origin".
*: One example usage for this is to select <code>.Probability=0.5</code> as the fill origin in a probability bands plot, which results in a plot like this one
*:::[[image:filled_bands_plot.png]]
*: This example is already easily achieved by placing the [[Plot solid prob bands]] function in the [[OnGraphDraw]] attribute, but with the new feature it is also directly configurable with a few [[Graph setup dialog]] clicks.
* When you turn on '''Graph Setup / Text / Adapt displayed font sizes to graph height''', it now uses the current height of the graph you were viewing as the reference height, such that when the graph has that same height, the point sizes shown in the graph setup dialog will be the correct font sizes. Previously the reference height was fixed at the default result window height (a graph of 241 pixels tall).

== Other GUI ==
* There are a few new options on the '''Windows''' menu:
** Bring next window to front
** Bring previous window to front
** [[Typescript window|Typescript console]]

== Licensing ==
* [[ParseJSON]] and [[MakeJSON]] no longer require {{Analytica Enterprise}}.

What's new in Analytica 6.6?

2025-12-16T19:25:08Z

Mhenrion: /* Keelin Metalog distribution 2.0 */

[[category:What's new pages]]
[[category:Analytica releases]]

This page lists new features in release 6.6 (the current release) of Analytica (including [[ACP]] and [[ADE]]) since the previous [[Analytica 6.5]] release.

Analytica normally prompts you to download and install the new release the next time you run it.
If not, you can download it from [https://analytica.com/users/renew-upgrade/ Renew, upgrade or download].

== Highlights of 6.6 ==

* [[#Assista|Assista]], the Analytica AI Assistant, is faster and more reponsive.
* The [[#Keelin Metalog distribution 2.0|Keelin (or Metalog) distribution]] is now the preferred method to define any continuous distribution, because it now avoids the occasional infeasibility problem that previously bedeviled it.
* You can select [[#Diagrams and controls|All in Checkboxes]] for parametric analysis and in Multichoice.
* You can use [[Links_or_URL_in_model_attributes#Extended_HTML_markup| html to set text styles in text nodes]], including bold, italic, underline, bold, colors, bullets, and more in desktop Analytica. Even more html tags work in ACP.
* [[#Expression language|Sum(x, All) sums over All indexes of x]]. Similar for Min, Max, Product, and more.
* The new [[OAuth2Authorize]] function lets you access web services, such as Google docs, sheets, Salesforce, etc to read or write data.
* You can specify a [[#Graphing|Fill origin for graphs]] to let you show colored bands around the center line -- e.g. for probability bands over time.

== Assista ==
* The chat UI is faster. Responses start streaming sooner.
* You can use the Enter key (or Ctrl+Alt) to submit responses without having to click to submit button. The Return key adds a new line (the behavior elsewhere in Analytica). If you have the [[Preferences_dialog#Personal_Preferences|Use Return to enter data]] preference set, then the Return key will submit responses and the Enter key adds a new line.

== Keelin Metalog distribution 2.0 ==
Introducing the '''''always feasible''''', [[Keelin|infinitely flexible distribution]]!

The [[Keelin (MetaLog) distribution]] has become popular due to its ability to closely match the shapes of all the standard continuous distributions as well as offering enormous flexibility in matching amost any shape. But up until now it has been plagued by finding some parameter combinations ''infleasible'', so it would sometimes fail t to find a valid distribution to fit.

[[Analytica 6.6]] fixes this problem with the MetaLog 2.0 distribution. It includes many new results from
* Manel Baucells, Lonnie Chrisman, Thomas W. Keelin and Stephen Xu (2025), "[https://papers.ssrn.com/sol3/papers.cfm?abstract_id=5279416 On the properties of the Metalog distribution]" (preprint), forthcoming.

New features include:
* The resulting [[Keelin (MetaLog) distribution]]s are ''always'' feasible.
* There are closed-form analytic expressions for all central and standardized moments (see [[KeelinPropertyFromA#Basic_statistics_and_moments]]).
* There is a closed-form analytic expression for partial expectation (see [[KeelinPropertyFromA#Partial_expectation]]). This makes the Keelin distribution especially convenient for many problems that use piecewise-linear transformations of an uncertain quantity.
* It uses the superior basis order of the MetaLog 2.0.
* You can also specify the desired «mean», in addition to «values» (data points).
* New set of functions with names of the form <code><x>KeelinFromA(...)</code>use the «a» coefficient vector from [[KeelinCoefficients]]:
** <code>[[KeelinFromA]](...)</code> -- analog to <code>[[Keelin]](...)</code>
** <code>[[DensKeelinFromA]](...)</code> -- analog to <code>[[DensKeelin]](...)</code>
** <code>[[CumKeelinFromA]](...)</code> -- analog to <code>[[CumKeelin]](...)</code>
** <code>[[CumKeelinInvFromA]](...)</code> -- analog to <code>[[CumKeelinInv]](...)</code>
** <code>[[KeelinPropertyFromA]](...)</code> -- ''new to [[Analytica 6.6]]''
*:When using the Keelin distribution, you can either use a quantile parameterization or an «a»-vector parameterization. These new functions make it clearer that you are using the «a»-vector parameterization, instead of using the original (analogous) functions with a special flag.
* A new option uses a [https://docs.analytica.com/index.php?title=Keelin_(MetaLog)_distribution&anarelease=6.6#Using_direct_method_for_bounds direct method for bounded support] as an alternative to the previous [https://docs.analytica.com/index.php?title=Keelin_(MetaLog)_distribution&anarelease=6.6#Using_the_Transform_method_for_bounds transform-method for bounded support].

== Diagrams and controls ==
* [[Checkbox]] now has an "include ALL" option, enabling [[Parametric analysis]] even with a checkbox.
* A [[Multichoice]] control includes a new "meta-item" at the top to ''select '''all''''', ''select '''none''''' or ''select '''first''''', depending on the context. These mimic the behavior of the <code>Ctrl+A</code> key.
* A text node can display several [[Links_or_URL_in_model_attributes#Extended_HTML_markup|new formatting options corresponding to html tags]], including changes to text color, bullets and numbered lists.
* A new [[ChangeNodeVisibility|node visibility option]] allows you to hide a node while Analytica is computing.

== Expression language ==
* There is a new separate <code>Boolean</code> data type. To preserve backward compatibility, the values continue to display as 0 or 1, but the [[Number format dialog]] provides an option to display values with the boolean data type as True or False to distinguish them from 0 and 1.
* You can now find the maximum over all indexes of <code>X</code> using
*::<code>[[Max]]( X, All }</code>
*:This is a shortcut for
*::<code>[[Max]]( X, ...[[IndexesOf]](X) )</code>
*:which uses [[Repeated parameter forwarding]]. The <code>All</code> keyword can be used in this fashion with [[Min]], [[Sum]], [[BitAnd]], [[BitOr]] and [[BitXOr]].
* If you write your own function, and want it to accept the keyword <code>All</code> for a repeated index parameter, you can include a new <code>OrAll</code> [[Function parameter qualifiers|function parameter qualifier]].
* When passing a [[Local function]] (aka '''lambda function''') as a parameter to a function call, you no longer have to include a function name (which wasn't used anyway).
* [[Repeated parameter forwarding]] can now be used on literal lists to "splat" lists (or 1-D arrays) together into the list. Example:
*:<code>[[Local]] s1 := 'c'..'f', s2 := 'h'..'k' Do [ 'a', 'b', ...s1, 'g', ...s2, 'l' ]</code>
*::→ <code>['a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l']</code>

== Built-in functions ==
* New function [[OAuth2Authorize]]. This is used to log into web services such as Google docs, etc.
* <code>[[TypeOf]]( x, shallow:True )</code> now returns <code>"Image"</code> when <code>x</code> is an image.
* When <code>x</code> is an image, <code>f"{x:H}"</code> returns the long hex string that appears in a [[Pict]] attribute in a model file (but without the parens around it that appear in the model file).
* [[ReadTextFile]] returns the file encoding as its fourth return value.
* [[RunConsoleProcess]] is able to launch several applications that it previous could not, including PowerShell.
* New syntactic extensions added to the [[Arrow_operator#x_.E2.86.92_.5Bi.5D|arrow operator]], namely <code>x→[n]</code> and <code>x→[m..n]</code> for [[Text values]] and [[In-memory binary data terms]].

== File saving and loading ==
* '''Add Library...''' defaults to ''Link to filed module or library'' for almost all the standard libraries, which is the preferred way to add libraries to your model. (Except it still defaults to ''Embed a copy'' for the [[ACP Style Library]] since that library acts more module-like and changes its internal state).
* You can now set the [[Att_Dirties]] attribute (to 0) for your own user Variables. When set to 0, a change to the Definition doesn't dirty the Library or module that contains the Variable.

== Example models and libraries ==
* A new example model included: <code>"Engineering / Generator availability.ana"</code>
* An able to handle file paths > 256 characters in most cases. Actually taking advantage of this requires you to have long paths enabled in Windows, e.g., by setting the registry setting
*::<code>HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\FileSystem :: LongPathsEnabled = 1</code>
*:or by using the <code>\\unc\.... </code> syntax for file paths. However, long file paths are not supported by Microsoft One drive or by Microsoft office, including Excel, so you cannot use long paths for files within a One drive folder or when opening a spreadsheet file.
* Several of the diagram themes in the [[Themes Library]] were renamed.

== Graphing ==
* Control over the fill origin for a filled-area line chart using Fill type = "From origin".
*: One example usage for this is to select <code>.Probability=0.5</code> as the fill origin in a probability bands plot, which results in a plot like this one
*:::[[image:filled_bands_plot.png]]
*: This example is already easily achieved by placing the [[Plot solid prob bands]] function in the [[OnGraphDraw]] attribute, but with the new feature it is also directly configurable with a few [[Graph setup dialog]] clicks.
* When you turn on '''Graph Setup / Text / Adapt displayed font sizes to graph height''', it now uses the current height of the graph you were viewing as the reference height, such that when the graph has that same height, the point sizes shown in the graph setup dialog will be the correct font sizes. Previously the reference height was fixed at the default result window height (a graph of 241 pixels tall).

== Other GUI ==
* There are a few new options on the '''Windows''' menu:
** Bring next window to front
** Bring previous window to front
** [[Typescript window|Typescript console]]

== Licensing ==
* [[ParseJSON]] and [[MakeJSON]] no longer require {{Analytica Enterprise}}.

Struct

2025-12-14T21:04:12Z

Mhenrion: /* Member functions */

[[category:Objects]]
[[category:Variables]]
''new to [[Analytica 7.0]]''

Most programming languages have a way to bundle a set of disparate data into a packet, often called Records, Classes, or Structs. In Analytica, you can do this using an array with an [[Index]], but this doesn't work so well if the values in the array are disparate, for example, if they include numbers, text, references to other data, or array values with different dimensions. For example, if you want to create lists or hierarchies, represent JSON data or html. Thta's why Analytica has introduced Structs to represent these kinds of data structures.

A struct instance can have multiple member fields, which can be of varioust data types and dimensionality. For example, a struct could have a scalar member, a 1-D member and a 2-D member, where the dimensions of the members are unrelated. Each struct value is treated as an atomic element, and it does not apply Array abstraction within the Struct.

== Struct class ==

A [[Struct]] object defines a new atomic data type. It appears on a diagram with a shape that resembles a function, but with flat midsections on both the left and right.

<center>[[image:MyDtype_Struct.png]]</center>

After you define a [[Struct]], you can create instances of it. Instances are ''atomic'' and ''immutable'': ''Atomic''meaning that [[Array Abstraction]] treats it as a single cell -- even though it may have multiple elements.''Immutable'' meaning that, it cannot be destructively altered after it's been created.

A [[Struct]] is an [[Objects and Values|Object]]. An instance of a struct is a [[Objects and Values|Value]].

== When to use a Struct ==

These are examples of when a Struct may be convenient:
* To represent hierarchical data, such as from html or JSON.

* If you want your data type to be an opaque atomic unit with multiple internal items.

* To [[Returning multiple values|return multiple return values]] with varying dimensions as an alternative to capturing multiple return values.

* To pass complex data structures among user-defined functions.

* To enforce a distinction that does not exist in Analytica, but is used in another platform or service that you are integrating with.

== Defining a Struct ==
To define a [[Struct]], you can first create a [[UDF|user function]] object by draggin the functio node from the [[Create and edit nodes|object Toolbar]]). Then change its class to <code>Struct</code> in its [[Object window]] or [[Attribute window]].

A Struct uses the [[Parameters]] attribute with the same [[Function Parameter Qualifiers]] as a [[User-Defined Function]] (UDF), for example:

:<code>Struct MyDtype( a : atom ; b : Text [I] ; c: Number[J] )</code>

This Struct has three members -- <code>a</code> with any atomic data type, <code>b</code>, which is text and may be an array of texts with index <code>I</code>, and <code>c</code>, which must be a numberand may have index <code>J</code>.

The default [[Definition]] of a Struct is <code>Self</code>. Sometimes you may specify a more specialized definition -- see [[#Constructor customization]] below.

== Instantiating a value ==

To create an instance of a Struct, you simply call the name of your struct as if it were a function from within an expression. In the previous example, that might be:

:<code>MyDtype( Category, Category_aliases, Category_IDs )</code>

If any value passed to a constructor parameter has extra indexes (dimensions), i.e. other than those specified in each paramter, [[Array Abstraction]] kicks in and creates an array of struct instances over those extra indexes.

== Accessing member values ==
Use the [[Arrow operator]] to access a member values of a Struct. E.g.,

:<code>inst -> b</code>

where <code>inst</code> was obtained by calling the Struct.

The left-hand side of the arrow can be a single instance, an array of instances, or even [[Null]]. The right-hand side of the arrow is the name of a member value.

== Member functions ==

You can define ''member functions'' to access values from a Struct, for example:
:<code>inst -> F(x, y)</code>
The parameters must be passed by value (e.g., no Index parameters). Keep in mind that the instance is immutable so these functions can't usually modify the internal state of the instance (see Section [[#Immutability]] for exceptions).

You can define a Struct ''member function'' using a standard user-defined function. Open the [[Struct]]'s diagram (as you would open up the diagram of a Module node) and drag a Function object into the diagram. In the Function's [[Object window]], set its parameters ensuring that the first parameter is declared as Self using the Struct datatype and [[Objects and Values|Atom]] qualifier, for example:

:<code>Function F( Self: MyDtype Atom; param1; param2)</code>

It can have zero or more additional parameters. These are the ones passed to the function when it is called using the syntax <code>inst → F(x,y)</code>. These parameters can have any data type qualifier, dimensionality declaration; however, for now they cannot handle [[Function_parameter_qualifiers#Evaluation_Mode_Qualifiers|evaluation mode qualifiers]] or [[Function_parameter_qualifiers#Object_Class_Qualifiers|Object class qualifiers]].

You can also introduce global variables that are "private" to the Struct and its member functions by adding normal variable nodes to the diagram. Note that these are contained in the Struct definition, not in each instance. To have a value that varies with each instance, you must use a member value.

== Constructor customization ==
The member values of an instance are usually the parameter names that appear in the [[Parameter]] attribute of the struct (its Constructor's parameter names). However, in some use cases the constructor may change the member values, such as by adding new members, transforming the named members, or even removing members. These changes must be performed in the [[Definition]] of the constructor.

When you first view the [[Object window]] of a [[Struct]], the [[Definition]] might not be visible (because altering the member values is somewhat esoteric). If you don't see it, use the [[Object_Window#Selecting_Attributes_to_Display|Attribute visibility popup]] to make it visible.

Inside the constructor (and only in the constructor) the members can be assigned. For example:

[[Struct]] MyDType( a : atom ; b : Text [I] ; c : Number [J] )
'''Definition''':
Self -> creationTime := [[Today]](true);
Self -> c := c / [[Sum]](C, J);
Self

The final value is always <code>Self</code> whether or not your Definition actually returns <code>Self</code>, although it is clearer to do. Notice that in this example, it adds a new member value, <code>creationTime</code>, and changes the member value <code>c</code> to the normalized value.

When you change the member values in the constructor, you should consider whether you will ever assign values of your Struct to a definition or other expression attribute, or whether instances will even need to be saved directly in the model file. These cases require a text representation that is valid expression and which results in an equivalent instance. In the event that you alter the members, you may need to add a custom [[#ExpressionText]] member function that prints out a constructor call expression.

== Using an excess parameter in the constructor ==

An ''excess parameter'' is a catch-all parameter that allows the caller to include named parameters that aren't listed in the parameters. It can be either named or unnamed.

The constructor has an unnamed excess parameter when the last parameter is named <code>"..."</code>. For example,

[[Struct]] MyDType2( a : atom ; b : Text[I] ; ... )

When declared in this fashion, a caller can specify parameters other than <code>a</code> and <code>b</code>, for example:

MyDType2( a:5, b:f"I={I}", c:14, d:=J^2 )

When an unnamed excess parameter is used in this way, the additional parameters are automatically added as members. Hence, in this example, <code>MyDType2</code> has members <code>['a', 'b', 'c', 'd']</code>. Because the excess parameter is unnamed, there is no way to refer to it in the constructor's definition.

To specify that the excess parameters not be added to the struct instance, you can use
[[Struct]] MyDType3( a : atom ; b : Text[I] ; ... : nonMember )

A ''named excess parameter'' is declared using a named that starts with <code>"..."</code>, which again must be the last parameter in the declaration. For example,

[[Struct]] MyDType3( a : atom ; b : Text[I] ; ...kw )

Inside the constructor's definition, it can now refer to the local variable <code>kw</code>. The value of <code>kw</code> is itself a struct instance where each argument is a member. For example, when called as
MyDType3( a:5, b:f"{I}", y:43, z:'hello' )
The Definition of MyDType3 could reference <code>kw->y</code> or <code>kw->z</code> when called in this example; however, those would fail with an error when <code>y</code> or <code>z</code> is not specified.

== Equality and comparison ==

Two struct instances are equal (i.e., <code>s1=s2</code> is true) only when they are of the same Struct, have the same member names and have the same member values. In other words, <code>s1=s2</code> is based on "deep equality".

Shallow equality tests whether two instances are the exact same instance (as opposed to whether the two instances are equal). The following can be used to test whether two instances are the exact same instance:
:<code>s1->_addr = s2->_addr</code>
The special <code>_addr</code> member value returns an integer that is unique to each instance.

Inequality comparisons are also based on the "deep" member values, based on the internal member value ordering.

== Basic properties about an instance ==

You can get a list of the member value names using:
:<code>inst -> _members</code>

You can test whether it has a given member using:
:<code>inst -> Has('name')</code>

If you have the name of a member value as text in a variable memberName, you can access its value using:
:<code>`->`( inst, memberName )</code>

With this syntax, you can also specify a default value to use when the instance does not have the specified name by specifying the optional «defVal» parameter:
:<code>`->`( inst, memberName, defVal: Null )</code>

Note that it wouldn't work to write <code>inst -> memberName</code> because that would look for a member value named "memberName".

You can get a handle to the instance's Struct object using
:<code>inst -> _type</code>
You can get the name of the Struct (without a [[Namespaces|namespace]] prefix) from <code>[[TypeOf]](inst)</code>. You can detect that an atom is a struct instance using
:<code>[[TypeOf]]( inst, shallow:true ) = "Struct"</code>

== Special member functions ==

You can customize the behavior of your struct instances by adding special member functions (with reserved member function names). You add these as you would your own member functions to your Struct's diagram using the reserved name. Your implementation must match the required parameters for the special function.

=== Customizing how a value is printed ===
My default, an instance of your Struct will display in a result table cell or in the [[Typescript window|Typescript console]] as, e.g., <code>«YourStructName»</code>. You can customize this by adding a member function named <code>DisplayName</code>. E.g.,

Function DisplayName( Self : MyDtype atom )
'''Definition''': f"«{[[TypeOf]](Self)} a={Self->a}»"

Because <code>DisplayName</code> occurs while individual cells are drawing on the screen, errors that occur while it is evaluating are not displayed. If an error occurs, it will silently fall back to the default display name.

When your instance is "printed" to an expression (e.g., as a result of an assignment), you need to ensure that the text is a valid expression that creates a logically equivalent instance. This happens by default unless you alter the members in your constructor (see [[#Constructor customization]] above). To control this, add a member function name <code>ExpressionText(Self)</code>.

=== Value expansion (in a result table) ===
When a struct instance appears in the cell of a result table, it appears as a hyperlink. Double clicking on it expands the value. By default, it expands into the member values. You can change this by adding a member function named <code>Expand(Self)</code>.

Your expansion code cannot simply create an array of your member values (assuming they have different dimensionalities) since this would combine their dimensions. Instead, you should wrap each non-atomic value in <code>_HyperlinkedCellvalue</code>. For example:

Function Expand( Self )
'''Definition''': [ 'a' : Self->a,
'b' : _HyperlinkedCellValue( Self->b ),
'c' : _HyperlinkedCellValue( Self->c ) ]

You can also introduce a local index for the expansion.

After it expands, the result table displays a title showing the current "path" to the result view. Ideally this title is also a valid expression that produces the same result. When you customize the expansion, you may also need to customize the expansion title. You can do this by adding a member function

:<code>Function TitleForExpand(Self : Tuple atom ; subTitle : text atom ; memberNum : optional positive atom )</code>

The «subTitle» is the title up to the point of this expansion, and «memberNum» exposes which cell number was expanded from the previous level.

=== Finalizers ===

A finalizer is a member function that is called when the struct instance value is released for last time.

You can add a customized finalizer, for example, to ensure that a resource gets cleaned up. An example use case would be when your [[Struct]] is a temporary file, with the finalizer ensuring that the temporary file is deleted when the instance is released. This is an example where the constructor would pick a unique file name that doesn't already exist, and the finalizer calls [[FileSystemDelete]].

To add a finalizer, add a member function named <code>Finalizer(Self)</code>.

Finalizers should have a low probability of an error occurring while the finalizer is evaluating. In the event that an error occurs, it is not possible for Analytica to report the error, so the error will occur silently. If you do not catch it (in a [[Try]]), your full finalizer code might not run.

=== Callable values ===

You can make an instance of your Struct "''callable''", such that you can call the instance using e.g.,

:<code>inst -> ( x, y )</code>

To make it callable, create a member function named <code>`()`</code> -- make sure to include the backtics as part of the name, and no spaces between the parens. For example:

Function `()`( alpha, pwr )
'''Definition''': (1-alpha) * Self->a + alpha * [[Sum]]( b^pwr, I )

If you do this, you can also use a [[Callable]] object class to hold your instance (or an array of instances) and then call it using the name of your callable as if it were a normal function (even though the logical function itself is computed), e.g.,

:[[Callable]] F1 := MyDType( x,y,z )</code>

And call it:
:<code>F1(0.3, 2) </code>

=== Custom atomic subscripting ===
Your data type can support the syntax
:<code>inst -> [n]</code>
by adding a member function named <code>`[]`</code>. It can have either one or two parameters (after <code>Self</code>). With one parameter, only <code>inst -> [n]</code> is supported (so that <code>inst -> [m..n]</code> would array abstract returning a list). With two parameters, where the second parameter is optional, it can include special handling of <code>inst -> [m..n]</code>, for example by returning a new collection instance of the same type.

Function `[]`( Self : Tuple atom ; m,n : optional number atom )

In this example, if <code>inst -> [m]</code> is called, then the «n» parameter is omitted. If <code>inst -> [m..n]</code> is called, both parameters are provided. If <code>inst -> [m..]</code> is called, then «n» is [[INF]]. And if <code>inst->[..n]</code> is called, then «m» is omitted.

=== Operator overloading ===

At present, only these operators can be overloaded by adding a member function with the given name.

* Function `#`( Self )

=== Overloading the <code>`->`</code> operator ===

It is possible to overload the right-arrow operator for a Struct, intercepting attempts to read a member value or to set a member value.

If you only want to intercept attempts to read member values, add the following member function in your struct:
Function `->`( Self : '''''YourStruct''''' atom ; member : Text atom ; defVal : optional named )
By sure to change '''''YourStruct''''' to the actual name of your struct. This will be called when code evaluates
:<code>inst -> member</code>
on an instance <code>inst</code> of your struct. Your function can return values for members that don't actually exist, or deny members that might exist, or just intercept the read and then forward it in the usual way.

Exceptions: Member functions with names beginning with an underscore are never intercepted (such as the special <code>inst->_members</code>, <code>inst->_type</code> and <code>inst->_addr</code> virtual members). Also, calls to member local functions or member functions are never intercepted -- this intercepts member value access only.

Your implementation of the overload will often want to access the actual members of the class. It must not use the usual arrow operator for this because that would result in an infinite recursion. Instead, you can use the raw member access function, <code>`->!`</code>, which behaves the same same as <code>`->`</code> except that it cannot be overridden. This function can only be called using a function call syntax, it cannot be used as an infix operator.

Here is a contrived example that makes is look like the file contents is a member value. (It would be better to just add a member function for this, but it makes for an easy example).

Struct TextFile( filename : Text atom )

Function TextFile::`->`( Self : TextFile atom ; member : Text atom ; defVal : optional named )
'''Definition''':
[[If]] TextLowerCase(member) = "contents" Then
[[ReadTextFile]](filename)
[[Else]]
`->!`( Self, member, defVal:defVal )

You can also use an override of <code>`->`</code> to intercept attempts to assign to a member, such as an assignment like
inst -> val := newVal

A struct instance is itself immutable, so such assignments are not generally valid, but using an override you can make it appear that a member is mutable. This could be useful, for example, when using a struct to wrap an object from a different programming language, or in a web service, where members can be assigned. The overload could send the change through an API, keeping a familiar assignment syntax.

To add an overload that can also intercept member assignments (as well as reading member values), the member function should have this signature:

Function `->`( Self : '''''YourStruct''''' atom ; member : Text atom ; defVal : optional named ; rhs : optional named )

Inside the definition, use <code>IsNotSpecified(rhs)</code> to determine whether it is a read or an assignment.

== Assignment ==
Sometimes a button's [[OnClick]] expression assigns a result value to a global variable. When you do so, it sets the definition of the global variable to an expression that results in the same value when evaluated. It is also an expression that can be saved with a model file.

In the case of a Struct, this means that the expression must be a call to the Struct's constructor with parameter values that result in a logically equivalent instance.

In the cases where you have customized constructor logic that alters what member values are actually stored, if you want assignment (and saving to a model file) to work successfully, you need to include the custom member function:

Function ToExpression( Self : MyStruct atom )

This can return the textual expression that results in an equivalent value, but in general, it can be difficult to get the textual expression correct. Hence, the recommended way to implement the function is to return an instance of the generic built-in <code>_Struct</code> with member names that correspond to your constructor parameter names.

=== Example ===

This example uses the [[Mutables library]].

Struct S( x : nonMember )
'''Definition: ''' Self->mutable_val := Mutable(x)
 
Function ToExpression( Self : S atom )
'''Definition:''' _Struct( x: Self->mutable_val->val )

The <code>_Struct</code> returned has the parameter name </code>x, which matches the parameter name in <code>S</code>'s constructor with the value that should appear in the call to the constructor.

When you assign a value containing an instance of <code>S</code> to a global, the definition contains something like <code>S( 'Foo' )</code> -- a valid call to the constructor.

=== Repeated parameters ===
When your constructor has a repeated parameter, you need to set the <code>_Struct</code> element to a list, where each item in the list corresponds to one argument passed to the parameter. If all of the items that should be passed to the repeated parameter have the same dimensionality and none are a scalar reference, then a list is fine.

Struct S2( people : ... Text atom nonMember )
'''Definition:''' Self->people_ids := PersonToId( people )
 
Function ToExpression( Self : S2 atom )
'''Definition:'''
Local people := IdToPerson( Self->people_ids ); { This is a list of text }
_Struct( people : people )

A more nuanced case occurs when the items to the repeated parameter may have different dimensionalities. In this case, you need to take the [[reference]] of each item in the list so that its dimensions don't combine with the indexes of its sibling elements.

Struct S3( items : ... nonMember )
'''Definition:'''
Self->first := items[@=1];
[[Local]] refd := ([[For]] xi := repeated items Do \xi); {refs to keep dims separate}
Self->rest := refd[@=2..[[Size]](items,listLen:true)]
 
Function ToExpression( Self : S3 atom )
'''Definition:''' _Struct( items : [\Self->first, ...Self->rest ] )

To keep the dimensionalities separate for each item is <code>Self->Rest</code>, the constructor takes the reference of each repeated item. In <code>ToExpression</code>, these are already references so it simply forwards them into the list for «items».

== Immutability ==
The <code>Self</code> members can be altered from within the [[Struct]] constructor, but cannot be altered once the fully-constructed instance has been returned by the constructor. From that point on, the members of a struct instance are never changed.

However, a struct can hold a [[Mutable]] or a [[Local_functions_and_local_value_captures#Local_value_capture|captured local]] which actually makes it possible for the internal state of an instance to be changed. The mutable or the local's identity never changes, and changes to this type of internal state does not result in any downstream invalidation.

== Generic Struct ==
A built-in struct named <code>_Struct</code> (with an underscore) can be used as a generic Struct that you can instantiate on arbitrary members without having to define your own Struct object. To instantiate, every parameter must be named, but can be whatever name you want, e.g.,

_Struct( date:Today(), name: 'Donald', address: '1600 Pennsylvania Avenue' )

== Examples ==

Examples in this section demonstrate various aspects of a Struct and member functions.

=== Tuple ===
A Tuple is a ordered list of items, each item having a different dimensionality. It can be implemented as a Struct.

To create a tuple (after the Tuple Struct is defined), use:
Tuple( x, y, z )
with any number of values. The values passed can have different dimensionalities. The collection is held in a single cell (if you have an array of Tuples), and the dimensionalities of the items are kept separate.

Struct Tuple( items : ... ;
direct : hidden optional named boolean atom )
'''Definition''':
[[If]] direct [[Then]] (
[[For]] xi:= repeated items Do
[[If]] [[Not]] [[IsReference]](xi) then
Error("When using direct:True to Tuple, all «items» must be references");
Self->items := items
) [[Else]] (
Self->items := ([[For]] xi := repeated items Do \xi)
)

Function Tuple::Length( Self : Tuple atom )
'''Definition''':
[[Size]]( Self->items, True )

Function Tuple::Expand ( Self : Tuple atom )
'''Definition''':
[[Local]] i:=f"[{1..[[size]](Self->items)}]";
[[For]] ii:=@i do (
[[Local]] xi := #(Self->items[@=ii]);
[[If]] [[Size]]([[IndexesOf]](xi))>0 then
_HyperlinkedCellValue(xi)
[[Else]]
xi
)

Function Tuple::`[]`(Self : Tuple atom ; m,n : optional number atom )
'''Definition''':
[[If]] [[IsNotSpecified]](n) Then
#(Self->items[@=m,defVal:Null])
[[Else]] (
[[If]] [[IsNotSpecified]](m) [[Then]] m := 1;
[[If]] n>[[Size]](Self->items) [[Then]] n := [[Size]](Self->items);
Tuple( ...Self->items[@=m..n], direct:True )
)

Function Tuple::TitleForExpand(Self : Tuple atom ; subTitle : text atom ; memberNum : optional positive atom )
'''Definition''':
[[If]] [[IsNotSpecified]](memberNum) [[Then]]
f"{subTitle}->"
[[Else]]
f"{subTitle}->[{memberNum:I}]"

Function Tuple::ToExpression( Self : Tuple atom )
'''Definition''': _Struct( items: Self->items )

=== Reference ===
This example demonstrates how a [[reference]] could be implemented using Struct if it weren't already built into the Analytica language. Note that the keywords Ref and Reference are already in use, so we need to pick a different name.

Struct _Ref( r : [I] ; I : optional ... index = common )

Function _Ref::`#`( Self : _Ref atom )
'''Definition''': Self->r

Function _Ref::Expand( Self : _Ref atom )
'''Definition''': `#`(Self)

Function _Ref::TitleForExpand(Self : _Ref atom ; subTitle : text atom ; memberNum : optional positive atom )
'''Definition''':
f"#{subTitle}"

== See also ==
* [[Arrow operator]]
* [[Callable]]
* [[User-Defined Functions]]
* [[Function Parameter Qualifiers]]

Struct

2025-12-14T20:57:15Z

Mhenrion: /* Instantiating a value */

[[category:Objects]]
[[category:Variables]]
''new to [[Analytica 7.0]]''

Most programming languages have a way to bundle a set of disparate data into a packet, often called Records, Classes, or Structs. In Analytica, you can do this using an array with an [[Index]], but this doesn't work so well if the values in the array are disparate, for example, if they include numbers, text, references to other data, or array values with different dimensions. For example, if you want to create lists or hierarchies, represent JSON data or html. Thta's why Analytica has introduced Structs to represent these kinds of data structures.

A struct instance can have multiple member fields, which can be of varioust data types and dimensionality. For example, a struct could have a scalar member, a 1-D member and a 2-D member, where the dimensions of the members are unrelated. Each struct value is treated as an atomic element, and it does not apply Array abstraction within the Struct.

== Struct class ==

A [[Struct]] object defines a new atomic data type. It appears on a diagram with a shape that resembles a function, but with flat midsections on both the left and right.

<center>[[image:MyDtype_Struct.png]]</center>

After you define a [[Struct]], you can create instances of it. Instances are ''atomic'' and ''immutable'': ''Atomic''meaning that [[Array Abstraction]] treats it as a single cell -- even though it may have multiple elements.''Immutable'' meaning that, it cannot be destructively altered after it's been created.

A [[Struct]] is an [[Objects and Values|Object]]. An instance of a struct is a [[Objects and Values|Value]].

== When to use a Struct ==

These are examples of when a Struct may be convenient:
* To represent hierarchical data, such as from html or JSON.

* If you want your data type to be an opaque atomic unit with multiple internal items.

* To [[Returning multiple values|return multiple return values]] with varying dimensions as an alternative to capturing multiple return values.

* To pass complex data structures among user-defined functions.

* To enforce a distinction that does not exist in Analytica, but is used in another platform or service that you are integrating with.

== Defining a Struct ==
To define a [[Struct]], you can first create a [[UDF|user function]] object by draggin the functio node from the [[Create and edit nodes|object Toolbar]]). Then change its class to <code>Struct</code> in its [[Object window]] or [[Attribute window]].

A Struct uses the [[Parameters]] attribute with the same [[Function Parameter Qualifiers]] as a [[User-Defined Function]] (UDF), for example:

:<code>Struct MyDtype( a : atom ; b : Text [I] ; c: Number[J] )</code>

This Struct has three members -- <code>a</code> with any atomic data type, <code>b</code>, which is text and may be an array of texts with index <code>I</code>, and <code>c</code>, which must be a numberand may have index <code>J</code>.

The default [[Definition]] of a Struct is <code>Self</code>. Sometimes you may specify a more specialized definition -- see [[#Constructor customization]] below.

== Instantiating a value ==

To create an instance of a Struct, you simply call the name of your struct as if it were a function from within an expression. In the previous example, that might be:

:<code>MyDtype( Category, Category_aliases, Category_IDs )</code>

If any value passed to a constructor parameter has extra indexes (dimensions), i.e. other than those specified in each paramter, [[Array Abstraction]] kicks in and creates an array of struct instances over those extra indexes.

== Accessing member values ==
Use the [[Arrow operator]] to access a member values of a Struct. E.g.,

:<code>inst -> b</code>

where <code>inst</code> was obtained by calling the Struct.

The left-hand side of the arrow can be a single instance, an array of instances, or even [[Null]]. The right-hand side of the arrow is the name of a member value.

== Member functions ==

You can introduce your own ''member functions'' that are called using the syntax:
:<code>inst -> F(x, y)</code>
The parameters are limited to be passed by values (e.g., no Index parameters). Keep in mind that the instance is immutable so these functions can't usually modify the internal state of the instance (see Section [[#Immutability]] for exceptions).

To create your own ''member function'', open up the [[Struct]]'s diagram (as you would open up the diagram of a Module node) and drag a Function object to the diagram. In its [[Object window]], set the parameters ensuring that the first parameter is declared as, e.g.,

:<code>Function F( Self : MyDtype atom ; param1 ; param2 )</code>

The first parameter should be named <code>Self</code> and should have the Struct name as its data type and the [[Objects and Values|atom]] qualifier. You can have zero or more additional parameters -- these are the ones passed to the function when it is called using the syntax <code>inst → F(x,y)</code>. These parameters can have any data type qualifier, dimensionality declaration; however, for now they cannot handle [[Function_parameter_qualifiers#Evaluation_Mode_Qualifiers|evaluation mode qualifiers]] or [[Function_parameter_qualifiers#Object_Class_Qualifiers|Object class qualifiers]].

You can also introduce global variables that are "private" to the Struct and its member functions by adding normal variable nodes to the diagram. Note that these are contained in the Struct definition, not in each instance (to have a value that varies with each instance, you must use a member value.

== Constructor customization ==
The member values of an instance are usually the parameter names that appear in the [[Parameter]] attribute of the struct (its Constructor's parameter names). However, in some use cases the constructor may change the member values, such as by adding new members, transforming the named members, or even removing members. These changes must be performed in the [[Definition]] of the constructor.

When you first view the [[Object window]] of a [[Struct]], the [[Definition]] might not be visible (because altering the member values is somewhat esoteric). If you don't see it, use the [[Object_Window#Selecting_Attributes_to_Display|Attribute visibility popup]] to make it visible.

Inside the constructor (and only in the constructor) the members can be assigned. For example:

[[Struct]] MyDType( a : atom ; b : Text [I] ; c : Number [J] )
'''Definition''':
Self -> creationTime := [[Today]](true);
Self -> c := c / [[Sum]](C, J);
Self

The final value is always <code>Self</code> whether or not your Definition actually returns <code>Self</code>, although it is clearer to do. Notice that in this example, it adds a new member value, <code>creationTime</code>, and changes the member value <code>c</code> to the normalized value.

When you change the member values in the constructor, you should consider whether you will ever assign values of your Struct to a definition or other expression attribute, or whether instances will even need to be saved directly in the model file. These cases require a text representation that is valid expression and which results in an equivalent instance. In the event that you alter the members, you may need to add a custom [[#ExpressionText]] member function that prints out a constructor call expression.

== Using an excess parameter in the constructor ==

An ''excess parameter'' is a catch-all parameter that allows the caller to include named parameters that aren't listed in the parameters. It can be either named or unnamed.

The constructor has an unnamed excess parameter when the last parameter is named <code>"..."</code>. For example,

[[Struct]] MyDType2( a : atom ; b : Text[I] ; ... )

When declared in this fashion, a caller can specify parameters other than <code>a</code> and <code>b</code>, for example:

MyDType2( a:5, b:f"I={I}", c:14, d:=J^2 )

When an unnamed excess parameter is used in this way, the additional parameters are automatically added as members. Hence, in this example, <code>MyDType2</code> has members <code>['a', 'b', 'c', 'd']</code>. Because the excess parameter is unnamed, there is no way to refer to it in the constructor's definition.

To specify that the excess parameters not be added to the struct instance, you can use
[[Struct]] MyDType3( a : atom ; b : Text[I] ; ... : nonMember )

A ''named excess parameter'' is declared using a named that starts with <code>"..."</code>, which again must be the last parameter in the declaration. For example,

[[Struct]] MyDType3( a : atom ; b : Text[I] ; ...kw )

Inside the constructor's definition, it can now refer to the local variable <code>kw</code>. The value of <code>kw</code> is itself a struct instance where each argument is a member. For example, when called as
MyDType3( a:5, b:f"{I}", y:43, z:'hello' )
The Definition of MyDType3 could reference <code>kw->y</code> or <code>kw->z</code> when called in this example; however, those would fail with an error when <code>y</code> or <code>z</code> is not specified.

== Equality and comparison ==

Two struct instances are equal (i.e., <code>s1=s2</code> is true) only when they are of the same Struct, have the same member names and have the same member values. In other words, <code>s1=s2</code> is based on "deep equality".

Shallow equality tests whether two instances are the exact same instance (as opposed to whether the two instances are equal). The following can be used to test whether two instances are the exact same instance:
:<code>s1->_addr = s2->_addr</code>
The special <code>_addr</code> member value returns an integer that is unique to each instance.

Inequality comparisons are also based on the "deep" member values, based on the internal member value ordering.

== Basic properties about an instance ==

You can get a list of the member value names using:
:<code>inst -> _members</code>

You can test whether it has a given member using:
:<code>inst -> Has('name')</code>

If you have the name of a member value as text in a variable memberName, you can access its value using:
:<code>`->`( inst, memberName )</code>

With this syntax, you can also specify a default value to use when the instance does not have the specified name by specifying the optional «defVal» parameter:
:<code>`->`( inst, memberName, defVal: Null )</code>

Note that it wouldn't work to write <code>inst -> memberName</code> because that would look for a member value named "memberName".

You can get a handle to the instance's Struct object using
:<code>inst -> _type</code>
You can get the name of the Struct (without a [[Namespaces|namespace]] prefix) from <code>[[TypeOf]](inst)</code>. You can detect that an atom is a struct instance using
:<code>[[TypeOf]]( inst, shallow:true ) = "Struct"</code>

== Special member functions ==

You can customize the behavior of your struct instances by adding special member functions (with reserved member function names). You add these as you would your own member functions to your Struct's diagram using the reserved name. Your implementation must match the required parameters for the special function.

=== Customizing how a value is printed ===
My default, an instance of your Struct will display in a result table cell or in the [[Typescript window|Typescript console]] as, e.g., <code>«YourStructName»</code>. You can customize this by adding a member function named <code>DisplayName</code>. E.g.,

Function DisplayName( Self : MyDtype atom )
'''Definition''': f"«{[[TypeOf]](Self)} a={Self->a}»"

Because <code>DisplayName</code> occurs while individual cells are drawing on the screen, errors that occur while it is evaluating are not displayed. If an error occurs, it will silently fall back to the default display name.

When your instance is "printed" to an expression (e.g., as a result of an assignment), you need to ensure that the text is a valid expression that creates a logically equivalent instance. This happens by default unless you alter the members in your constructor (see [[#Constructor customization]] above). To control this, add a member function name <code>ExpressionText(Self)</code>.

=== Value expansion (in a result table) ===
When a struct instance appears in the cell of a result table, it appears as a hyperlink. Double clicking on it expands the value. By default, it expands into the member values. You can change this by adding a member function named <code>Expand(Self)</code>.

Your expansion code cannot simply create an array of your member values (assuming they have different dimensionalities) since this would combine their dimensions. Instead, you should wrap each non-atomic value in <code>_HyperlinkedCellvalue</code>. For example:

Function Expand( Self )
'''Definition''': [ 'a' : Self->a,
'b' : _HyperlinkedCellValue( Self->b ),
'c' : _HyperlinkedCellValue( Self->c ) ]

You can also introduce a local index for the expansion.

After it expands, the result table displays a title showing the current "path" to the result view. Ideally this title is also a valid expression that produces the same result. When you customize the expansion, you may also need to customize the expansion title. You can do this by adding a member function

:<code>Function TitleForExpand(Self : Tuple atom ; subTitle : text atom ; memberNum : optional positive atom )</code>

The «subTitle» is the title up to the point of this expansion, and «memberNum» exposes which cell number was expanded from the previous level.

=== Finalizers ===

A finalizer is a member function that is called when the struct instance value is released for last time.

You can add a customized finalizer, for example, to ensure that a resource gets cleaned up. An example use case would be when your [[Struct]] is a temporary file, with the finalizer ensuring that the temporary file is deleted when the instance is released. This is an example where the constructor would pick a unique file name that doesn't already exist, and the finalizer calls [[FileSystemDelete]].

To add a finalizer, add a member function named <code>Finalizer(Self)</code>.

Finalizers should have a low probability of an error occurring while the finalizer is evaluating. In the event that an error occurs, it is not possible for Analytica to report the error, so the error will occur silently. If you do not catch it (in a [[Try]]), your full finalizer code might not run.

=== Callable values ===

You can make an instance of your Struct "''callable''", such that you can call the instance using e.g.,

:<code>inst -> ( x, y )</code>

To make it callable, create a member function named <code>`()`</code> -- make sure to include the backtics as part of the name, and no spaces between the parens. For example:

Function `()`( alpha, pwr )
'''Definition''': (1-alpha) * Self->a + alpha * [[Sum]]( b^pwr, I )

If you do this, you can also use a [[Callable]] object class to hold your instance (or an array of instances) and then call it using the name of your callable as if it were a normal function (even though the logical function itself is computed), e.g.,

:[[Callable]] F1 := MyDType( x,y,z )</code>

And call it:
:<code>F1(0.3, 2) </code>

=== Custom atomic subscripting ===
Your data type can support the syntax
:<code>inst -> [n]</code>
by adding a member function named <code>`[]`</code>. It can have either one or two parameters (after <code>Self</code>). With one parameter, only <code>inst -> [n]</code> is supported (so that <code>inst -> [m..n]</code> would array abstract returning a list). With two parameters, where the second parameter is optional, it can include special handling of <code>inst -> [m..n]</code>, for example by returning a new collection instance of the same type.

Function `[]`( Self : Tuple atom ; m,n : optional number atom )

In this example, if <code>inst -> [m]</code> is called, then the «n» parameter is omitted. If <code>inst -> [m..n]</code> is called, both parameters are provided. If <code>inst -> [m..]</code> is called, then «n» is [[INF]]. And if <code>inst->[..n]</code> is called, then «m» is omitted.

=== Operator overloading ===

At present, only these operators can be overloaded by adding a member function with the given name.

* Function `#`( Self )

=== Overloading the <code>`->`</code> operator ===

It is possible to overload the right-arrow operator for a Struct, intercepting attempts to read a member value or to set a member value.

If you only want to intercept attempts to read member values, add the following member function in your struct:
Function `->`( Self : '''''YourStruct''''' atom ; member : Text atom ; defVal : optional named )
By sure to change '''''YourStruct''''' to the actual name of your struct. This will be called when code evaluates
:<code>inst -> member</code>
on an instance <code>inst</code> of your struct. Your function can return values for members that don't actually exist, or deny members that might exist, or just intercept the read and then forward it in the usual way.

Exceptions: Member functions with names beginning with an underscore are never intercepted (such as the special <code>inst->_members</code>, <code>inst->_type</code> and <code>inst->_addr</code> virtual members). Also, calls to member local functions or member functions are never intercepted -- this intercepts member value access only.

Your implementation of the overload will often want to access the actual members of the class. It must not use the usual arrow operator for this because that would result in an infinite recursion. Instead, you can use the raw member access function, <code>`->!`</code>, which behaves the same same as <code>`->`</code> except that it cannot be overridden. This function can only be called using a function call syntax, it cannot be used as an infix operator.

Here is a contrived example that makes is look like the file contents is a member value. (It would be better to just add a member function for this, but it makes for an easy example).

Struct TextFile( filename : Text atom )

Function TextFile::`->`( Self : TextFile atom ; member : Text atom ; defVal : optional named )
'''Definition''':
[[If]] TextLowerCase(member) = "contents" Then
[[ReadTextFile]](filename)
[[Else]]
`->!`( Self, member, defVal:defVal )

You can also use an override of <code>`->`</code> to intercept attempts to assign to a member, such as an assignment like
inst -> val := newVal

A struct instance is itself immutable, so such assignments are not generally valid, but using an override you can make it appear that a member is mutable. This could be useful, for example, when using a struct to wrap an object from a different programming language, or in a web service, where members can be assigned. The overload could send the change through an API, keeping a familiar assignment syntax.

To add an overload that can also intercept member assignments (as well as reading member values), the member function should have this signature:

Function `->`( Self : '''''YourStruct''''' atom ; member : Text atom ; defVal : optional named ; rhs : optional named )

Inside the definition, use <code>IsNotSpecified(rhs)</code> to determine whether it is a read or an assignment.

== Assignment ==
Sometimes a button's [[OnClick]] expression assigns a result value to a global variable. When you do so, it sets the definition of the global variable to an expression that results in the same value when evaluated. It is also an expression that can be saved with a model file.

In the case of a Struct, this means that the expression must be a call to the Struct's constructor with parameter values that result in a logically equivalent instance.

In the cases where you have customized constructor logic that alters what member values are actually stored, if you want assignment (and saving to a model file) to work successfully, you need to include the custom member function:

Function ToExpression( Self : MyStruct atom )

This can return the textual expression that results in an equivalent value, but in general, it can be difficult to get the textual expression correct. Hence, the recommended way to implement the function is to return an instance of the generic built-in <code>_Struct</code> with member names that correspond to your constructor parameter names.

=== Example ===

This example uses the [[Mutables library]].

Struct S( x : nonMember )
'''Definition: ''' Self->mutable_val := Mutable(x)
 
Function ToExpression( Self : S atom )
'''Definition:''' _Struct( x: Self->mutable_val->val )

The <code>_Struct</code> returned has the parameter name </code>x, which matches the parameter name in <code>S</code>'s constructor with the value that should appear in the call to the constructor.

When you assign a value containing an instance of <code>S</code> to a global, the definition contains something like <code>S( 'Foo' )</code> -- a valid call to the constructor.

=== Repeated parameters ===
When your constructor has a repeated parameter, you need to set the <code>_Struct</code> element to a list, where each item in the list corresponds to one argument passed to the parameter. If all of the items that should be passed to the repeated parameter have the same dimensionality and none are a scalar reference, then a list is fine.

Struct S2( people : ... Text atom nonMember )
'''Definition:''' Self->people_ids := PersonToId( people )
 
Function ToExpression( Self : S2 atom )
'''Definition:'''
Local people := IdToPerson( Self->people_ids ); { This is a list of text }
_Struct( people : people )

A more nuanced case occurs when the items to the repeated parameter may have different dimensionalities. In this case, you need to take the [[reference]] of each item in the list so that its dimensions don't combine with the indexes of its sibling elements.

Struct S3( items : ... nonMember )
'''Definition:'''
Self->first := items[@=1];
[[Local]] refd := ([[For]] xi := repeated items Do \xi); {refs to keep dims separate}
Self->rest := refd[@=2..[[Size]](items,listLen:true)]
 
Function ToExpression( Self : S3 atom )
'''Definition:''' _Struct( items : [\Self->first, ...Self->rest ] )

To keep the dimensionalities separate for each item is <code>Self->Rest</code>, the constructor takes the reference of each repeated item. In <code>ToExpression</code>, these are already references so it simply forwards them into the list for «items».

== Immutability ==
The <code>Self</code> members can be altered from within the [[Struct]] constructor, but cannot be altered once the fully-constructed instance has been returned by the constructor. From that point on, the members of a struct instance are never changed.

However, a struct can hold a [[Mutable]] or a [[Local_functions_and_local_value_captures#Local_value_capture|captured local]] which actually makes it possible for the internal state of an instance to be changed. The mutable or the local's identity never changes, and changes to this type of internal state does not result in any downstream invalidation.

== Generic Struct ==
A built-in struct named <code>_Struct</code> (with an underscore) can be used as a generic Struct that you can instantiate on arbitrary members without having to define your own Struct object. To instantiate, every parameter must be named, but can be whatever name you want, e.g.,

_Struct( date:Today(), name: 'Donald', address: '1600 Pennsylvania Avenue' )

== Examples ==

Examples in this section demonstrate various aspects of a Struct and member functions.

=== Tuple ===
A Tuple is a ordered list of items, each item having a different dimensionality. It can be implemented as a Struct.

To create a tuple (after the Tuple Struct is defined), use:
Tuple( x, y, z )
with any number of values. The values passed can have different dimensionalities. The collection is held in a single cell (if you have an array of Tuples), and the dimensionalities of the items are kept separate.

Struct Tuple( items : ... ;
direct : hidden optional named boolean atom )
'''Definition''':
[[If]] direct [[Then]] (
[[For]] xi:= repeated items Do
[[If]] [[Not]] [[IsReference]](xi) then
Error("When using direct:True to Tuple, all «items» must be references");
Self->items := items
) [[Else]] (
Self->items := ([[For]] xi := repeated items Do \xi)
)

Function Tuple::Length( Self : Tuple atom )
'''Definition''':
[[Size]]( Self->items, True )

Function Tuple::Expand ( Self : Tuple atom )
'''Definition''':
[[Local]] i:=f"[{1..[[size]](Self->items)}]";
[[For]] ii:=@i do (
[[Local]] xi := #(Self->items[@=ii]);
[[If]] [[Size]]([[IndexesOf]](xi))>0 then
_HyperlinkedCellValue(xi)
[[Else]]
xi
)

Function Tuple::`[]`(Self : Tuple atom ; m,n : optional number atom )
'''Definition''':
[[If]] [[IsNotSpecified]](n) Then
#(Self->items[@=m,defVal:Null])
[[Else]] (
[[If]] [[IsNotSpecified]](m) [[Then]] m := 1;
[[If]] n>[[Size]](Self->items) [[Then]] n := [[Size]](Self->items);
Tuple( ...Self->items[@=m..n], direct:True )
)

Function Tuple::TitleForExpand(Self : Tuple atom ; subTitle : text atom ; memberNum : optional positive atom )
'''Definition''':
[[If]] [[IsNotSpecified]](memberNum) [[Then]]
f"{subTitle}->"
[[Else]]
f"{subTitle}->[{memberNum:I}]"

Function Tuple::ToExpression( Self : Tuple atom )
'''Definition''': _Struct( items: Self->items )

=== Reference ===
This example demonstrates how a [[reference]] could be implemented using Struct if it weren't already built into the Analytica language. Note that the keywords Ref and Reference are already in use, so we need to pick a different name.

Struct _Ref( r : [I] ; I : optional ... index = common )

Function _Ref::`#`( Self : _Ref atom )
'''Definition''': Self->r

Function _Ref::Expand( Self : _Ref atom )
'''Definition''': `#`(Self)

Function _Ref::TitleForExpand(Self : _Ref atom ; subTitle : text atom ; memberNum : optional positive atom )
'''Definition''':
f"#{subTitle}"

== See also ==
* [[Arrow operator]]
* [[Callable]]
* [[User-Defined Functions]]
* [[Function Parameter Qualifiers]]

Struct

2025-12-14T20:55:49Z

Mhenrion: /* Defining a Struct */

[[category:Objects]]
[[category:Variables]]
''new to [[Analytica 7.0]]''

Most programming languages have a way to bundle a set of disparate data into a packet, often called Records, Classes, or Structs. In Analytica, you can do this using an array with an [[Index]], but this doesn't work so well if the values in the array are disparate, for example, if they include numbers, text, references to other data, or array values with different dimensions. For example, if you want to create lists or hierarchies, represent JSON data or html. Thta's why Analytica has introduced Structs to represent these kinds of data structures.

A struct instance can have multiple member fields, which can be of varioust data types and dimensionality. For example, a struct could have a scalar member, a 1-D member and a 2-D member, where the dimensions of the members are unrelated. Each struct value is treated as an atomic element, and it does not apply Array abstraction within the Struct.

== Struct class ==

A [[Struct]] object defines a new atomic data type. It appears on a diagram with a shape that resembles a function, but with flat midsections on both the left and right.

<center>[[image:MyDtype_Struct.png]]</center>

After you define a [[Struct]], you can create instances of it. Instances are ''atomic'' and ''immutable'': ''Atomic''meaning that [[Array Abstraction]] treats it as a single cell -- even though it may have multiple elements.''Immutable'' meaning that, it cannot be destructively altered after it's been created.

A [[Struct]] is an [[Objects and Values|Object]]. An instance of a struct is a [[Objects and Values|Value]].

== When to use a Struct ==

These are examples of when a Struct may be convenient:
* To represent hierarchical data, such as from html or JSON.

* If you want your data type to be an opaque atomic unit with multiple internal items.

* To [[Returning multiple values|return multiple return values]] with varying dimensions as an alternative to capturing multiple return values.

* To pass complex data structures among user-defined functions.

* To enforce a distinction that does not exist in Analytica, but is used in another platform or service that you are integrating with.

== Defining a Struct ==
To define a [[Struct]], you can first create a [[UDF|user function]] object by draggin the functio node from the [[Create and edit nodes|object Toolbar]]). Then change its class to <code>Struct</code> in its [[Object window]] or [[Attribute window]].

A Struct uses the [[Parameters]] attribute with the same [[Function Parameter Qualifiers]] as a [[User-Defined Function]] (UDF), for example:

:<code>Struct MyDtype( a : atom ; b : Text [I] ; c: Number[J] )</code>

This Struct has three members -- <code>a</code> with any atomic data type, <code>b</code>, which is text and may be an array of texts with index <code>I</code>, and <code>c</code>, which must be a numberand may have index <code>J</code>.

The default [[Definition]] of a Struct is <code>Self</code>. Sometimes you may specify a more specialized definition -- see [[#Constructor customization]] below.

== Instantiating a value ==

To create an instance of a Struct, you simply call the name of your struct as if it were a function from within an expression. In the previous example, that might be:

:<code>MyDtype( Category, Category_aliases, Category_IDs )</code>

If any of the values passed to the constructor parameters have extra indexes (dimensions), [[Array Abstraction]] kicks in and creates an array of struct instances over those extra indexes.

== Accessing member values ==
Use the [[Arrow operator]] to access a member values of a Struct. E.g.,

:<code>inst -> b</code>

where <code>inst</code> was obtained by calling the Struct.

The left-hand side of the arrow can be a single instance, an array of instances, or even [[Null]]. The right-hand side of the arrow is the name of a member value.

== Member functions ==

You can introduce your own ''member functions'' that are called using the syntax:
:<code>inst -> F(x, y)</code>
The parameters are limited to be passed by values (e.g., no Index parameters). Keep in mind that the instance is immutable so these functions can't usually modify the internal state of the instance (see Section [[#Immutability]] for exceptions).

To create your own ''member function'', open up the [[Struct]]'s diagram (as you would open up the diagram of a Module node) and drag a Function object to the diagram. In its [[Object window]], set the parameters ensuring that the first parameter is declared as, e.g.,

:<code>Function F( Self : MyDtype atom ; param1 ; param2 )</code>

The first parameter should be named <code>Self</code> and should have the Struct name as its data type and the [[Objects and Values|atom]] qualifier. You can have zero or more additional parameters -- these are the ones passed to the function when it is called using the syntax <code>inst → F(x,y)</code>. These parameters can have any data type qualifier, dimensionality declaration; however, for now they cannot handle [[Function_parameter_qualifiers#Evaluation_Mode_Qualifiers|evaluation mode qualifiers]] or [[Function_parameter_qualifiers#Object_Class_Qualifiers|Object class qualifiers]].

You can also introduce global variables that are "private" to the Struct and its member functions by adding normal variable nodes to the diagram. Note that these are contained in the Struct definition, not in each instance (to have a value that varies with each instance, you must use a member value.

== Constructor customization ==
The member values of an instance are usually the parameter names that appear in the [[Parameter]] attribute of the struct (its Constructor's parameter names). However, in some use cases the constructor may change the member values, such as by adding new members, transforming the named members, or even removing members. These changes must be performed in the [[Definition]] of the constructor.

When you first view the [[Object window]] of a [[Struct]], the [[Definition]] might not be visible (because altering the member values is somewhat esoteric). If you don't see it, use the [[Object_Window#Selecting_Attributes_to_Display|Attribute visibility popup]] to make it visible.

Inside the constructor (and only in the constructor) the members can be assigned. For example:

[[Struct]] MyDType( a : atom ; b : Text [I] ; c : Number [J] )
'''Definition''':
Self -> creationTime := [[Today]](true);
Self -> c := c / [[Sum]](C, J);
Self

The final value is always <code>Self</code> whether or not your Definition actually returns <code>Self</code>, although it is clearer to do. Notice that in this example, it adds a new member value, <code>creationTime</code>, and changes the member value <code>c</code> to the normalized value.

When you change the member values in the constructor, you should consider whether you will ever assign values of your Struct to a definition or other expression attribute, or whether instances will even need to be saved directly in the model file. These cases require a text representation that is valid expression and which results in an equivalent instance. In the event that you alter the members, you may need to add a custom [[#ExpressionText]] member function that prints out a constructor call expression.

== Using an excess parameter in the constructor ==

An ''excess parameter'' is a catch-all parameter that allows the caller to include named parameters that aren't listed in the parameters. It can be either named or unnamed.

The constructor has an unnamed excess parameter when the last parameter is named <code>"..."</code>. For example,

[[Struct]] MyDType2( a : atom ; b : Text[I] ; ... )

When declared in this fashion, a caller can specify parameters other than <code>a</code> and <code>b</code>, for example:

MyDType2( a:5, b:f"I={I}", c:14, d:=J^2 )

When an unnamed excess parameter is used in this way, the additional parameters are automatically added as members. Hence, in this example, <code>MyDType2</code> has members <code>['a', 'b', 'c', 'd']</code>. Because the excess parameter is unnamed, there is no way to refer to it in the constructor's definition.

To specify that the excess parameters not be added to the struct instance, you can use
[[Struct]] MyDType3( a : atom ; b : Text[I] ; ... : nonMember )

A ''named excess parameter'' is declared using a named that starts with <code>"..."</code>, which again must be the last parameter in the declaration. For example,

[[Struct]] MyDType3( a : atom ; b : Text[I] ; ...kw )

Inside the constructor's definition, it can now refer to the local variable <code>kw</code>. The value of <code>kw</code> is itself a struct instance where each argument is a member. For example, when called as
MyDType3( a:5, b:f"{I}", y:43, z:'hello' )
The Definition of MyDType3 could reference <code>kw->y</code> or <code>kw->z</code> when called in this example; however, those would fail with an error when <code>y</code> or <code>z</code> is not specified.

== Equality and comparison ==

Two struct instances are equal (i.e., <code>s1=s2</code> is true) only when they are of the same Struct, have the same member names and have the same member values. In other words, <code>s1=s2</code> is based on "deep equality".

Shallow equality tests whether two instances are the exact same instance (as opposed to whether the two instances are equal). The following can be used to test whether two instances are the exact same instance:
:<code>s1->_addr = s2->_addr</code>
The special <code>_addr</code> member value returns an integer that is unique to each instance.

Inequality comparisons are also based on the "deep" member values, based on the internal member value ordering.

== Basic properties about an instance ==

You can get a list of the member value names using:
:<code>inst -> _members</code>

You can test whether it has a given member using:
:<code>inst -> Has('name')</code>

If you have the name of a member value as text in a variable memberName, you can access its value using:
:<code>`->`( inst, memberName )</code>

With this syntax, you can also specify a default value to use when the instance does not have the specified name by specifying the optional «defVal» parameter:
:<code>`->`( inst, memberName, defVal: Null )</code>

Note that it wouldn't work to write <code>inst -> memberName</code> because that would look for a member value named "memberName".

You can get a handle to the instance's Struct object using
:<code>inst -> _type</code>
You can get the name of the Struct (without a [[Namespaces|namespace]] prefix) from <code>[[TypeOf]](inst)</code>. You can detect that an atom is a struct instance using
:<code>[[TypeOf]]( inst, shallow:true ) = "Struct"</code>

== Special member functions ==

You can customize the behavior of your struct instances by adding special member functions (with reserved member function names). You add these as you would your own member functions to your Struct's diagram using the reserved name. Your implementation must match the required parameters for the special function.

=== Customizing how a value is printed ===
My default, an instance of your Struct will display in a result table cell or in the [[Typescript window|Typescript console]] as, e.g., <code>«YourStructName»</code>. You can customize this by adding a member function named <code>DisplayName</code>. E.g.,

Function DisplayName( Self : MyDtype atom )
'''Definition''': f"«{[[TypeOf]](Self)} a={Self->a}»"

Because <code>DisplayName</code> occurs while individual cells are drawing on the screen, errors that occur while it is evaluating are not displayed. If an error occurs, it will silently fall back to the default display name.

When your instance is "printed" to an expression (e.g., as a result of an assignment), you need to ensure that the text is a valid expression that creates a logically equivalent instance. This happens by default unless you alter the members in your constructor (see [[#Constructor customization]] above). To control this, add a member function name <code>ExpressionText(Self)</code>.

=== Value expansion (in a result table) ===
When a struct instance appears in the cell of a result table, it appears as a hyperlink. Double clicking on it expands the value. By default, it expands into the member values. You can change this by adding a member function named <code>Expand(Self)</code>.

Your expansion code cannot simply create an array of your member values (assuming they have different dimensionalities) since this would combine their dimensions. Instead, you should wrap each non-atomic value in <code>_HyperlinkedCellvalue</code>. For example:

Function Expand( Self )
'''Definition''': [ 'a' : Self->a,
'b' : _HyperlinkedCellValue( Self->b ),
'c' : _HyperlinkedCellValue( Self->c ) ]

You can also introduce a local index for the expansion.

After it expands, the result table displays a title showing the current "path" to the result view. Ideally this title is also a valid expression that produces the same result. When you customize the expansion, you may also need to customize the expansion title. You can do this by adding a member function

:<code>Function TitleForExpand(Self : Tuple atom ; subTitle : text atom ; memberNum : optional positive atom )</code>

The «subTitle» is the title up to the point of this expansion, and «memberNum» exposes which cell number was expanded from the previous level.

=== Finalizers ===

A finalizer is a member function that is called when the struct instance value is released for last time.

You can add a customized finalizer, for example, to ensure that a resource gets cleaned up. An example use case would be when your [[Struct]] is a temporary file, with the finalizer ensuring that the temporary file is deleted when the instance is released. This is an example where the constructor would pick a unique file name that doesn't already exist, and the finalizer calls [[FileSystemDelete]].

To add a finalizer, add a member function named <code>Finalizer(Self)</code>.

Finalizers should have a low probability of an error occurring while the finalizer is evaluating. In the event that an error occurs, it is not possible for Analytica to report the error, so the error will occur silently. If you do not catch it (in a [[Try]]), your full finalizer code might not run.

=== Callable values ===

You can make an instance of your Struct "''callable''", such that you can call the instance using e.g.,

:<code>inst -> ( x, y )</code>

To make it callable, create a member function named <code>`()`</code> -- make sure to include the backtics as part of the name, and no spaces between the parens. For example:

Function `()`( alpha, pwr )
'''Definition''': (1-alpha) * Self->a + alpha * [[Sum]]( b^pwr, I )

If you do this, you can also use a [[Callable]] object class to hold your instance (or an array of instances) and then call it using the name of your callable as if it were a normal function (even though the logical function itself is computed), e.g.,

:[[Callable]] F1 := MyDType( x,y,z )</code>

And call it:
:<code>F1(0.3, 2) </code>

=== Custom atomic subscripting ===
Your data type can support the syntax
:<code>inst -> [n]</code>
by adding a member function named <code>`[]`</code>. It can have either one or two parameters (after <code>Self</code>). With one parameter, only <code>inst -> [n]</code> is supported (so that <code>inst -> [m..n]</code> would array abstract returning a list). With two parameters, where the second parameter is optional, it can include special handling of <code>inst -> [m..n]</code>, for example by returning a new collection instance of the same type.

Function `[]`( Self : Tuple atom ; m,n : optional number atom )

In this example, if <code>inst -> [m]</code> is called, then the «n» parameter is omitted. If <code>inst -> [m..n]</code> is called, both parameters are provided. If <code>inst -> [m..]</code> is called, then «n» is [[INF]]. And if <code>inst->[..n]</code> is called, then «m» is omitted.

=== Operator overloading ===

At present, only these operators can be overloaded by adding a member function with the given name.

* Function `#`( Self )

=== Overloading the <code>`->`</code> operator ===

It is possible to overload the right-arrow operator for a Struct, intercepting attempts to read a member value or to set a member value.

If you only want to intercept attempts to read member values, add the following member function in your struct:
Function `->`( Self : '''''YourStruct''''' atom ; member : Text atom ; defVal : optional named )
By sure to change '''''YourStruct''''' to the actual name of your struct. This will be called when code evaluates
:<code>inst -> member</code>
on an instance <code>inst</code> of your struct. Your function can return values for members that don't actually exist, or deny members that might exist, or just intercept the read and then forward it in the usual way.

Exceptions: Member functions with names beginning with an underscore are never intercepted (such as the special <code>inst->_members</code>, <code>inst->_type</code> and <code>inst->_addr</code> virtual members). Also, calls to member local functions or member functions are never intercepted -- this intercepts member value access only.

Your implementation of the overload will often want to access the actual members of the class. It must not use the usual arrow operator for this because that would result in an infinite recursion. Instead, you can use the raw member access function, <code>`->!`</code>, which behaves the same same as <code>`->`</code> except that it cannot be overridden. This function can only be called using a function call syntax, it cannot be used as an infix operator.

Here is a contrived example that makes is look like the file contents is a member value. (It would be better to just add a member function for this, but it makes for an easy example).

Struct TextFile( filename : Text atom )

Function TextFile::`->`( Self : TextFile atom ; member : Text atom ; defVal : optional named )
'''Definition''':
[[If]] TextLowerCase(member) = "contents" Then
[[ReadTextFile]](filename)
[[Else]]
`->!`( Self, member, defVal:defVal )

You can also use an override of <code>`->`</code> to intercept attempts to assign to a member, such as an assignment like
inst -> val := newVal

A struct instance is itself immutable, so such assignments are not generally valid, but using an override you can make it appear that a member is mutable. This could be useful, for example, when using a struct to wrap an object from a different programming language, or in a web service, where members can be assigned. The overload could send the change through an API, keeping a familiar assignment syntax.

To add an overload that can also intercept member assignments (as well as reading member values), the member function should have this signature:

Function `->`( Self : '''''YourStruct''''' atom ; member : Text atom ; defVal : optional named ; rhs : optional named )

Inside the definition, use <code>IsNotSpecified(rhs)</code> to determine whether it is a read or an assignment.

== Assignment ==
Sometimes a button's [[OnClick]] expression assigns a result value to a global variable. When you do so, it sets the definition of the global variable to an expression that results in the same value when evaluated. It is also an expression that can be saved with a model file.

In the case of a Struct, this means that the expression must be a call to the Struct's constructor with parameter values that result in a logically equivalent instance.

In the cases where you have customized constructor logic that alters what member values are actually stored, if you want assignment (and saving to a model file) to work successfully, you need to include the custom member function:

Function ToExpression( Self : MyStruct atom )

This can return the textual expression that results in an equivalent value, but in general, it can be difficult to get the textual expression correct. Hence, the recommended way to implement the function is to return an instance of the generic built-in <code>_Struct</code> with member names that correspond to your constructor parameter names.

=== Example ===

This example uses the [[Mutables library]].

Struct S( x : nonMember )
'''Definition: ''' Self->mutable_val := Mutable(x)
 
Function ToExpression( Self : S atom )
'''Definition:''' _Struct( x: Self->mutable_val->val )

The <code>_Struct</code> returned has the parameter name </code>x, which matches the parameter name in <code>S</code>'s constructor with the value that should appear in the call to the constructor.

When you assign a value containing an instance of <code>S</code> to a global, the definition contains something like <code>S( 'Foo' )</code> -- a valid call to the constructor.

=== Repeated parameters ===
When your constructor has a repeated parameter, you need to set the <code>_Struct</code> element to a list, where each item in the list corresponds to one argument passed to the parameter. If all of the items that should be passed to the repeated parameter have the same dimensionality and none are a scalar reference, then a list is fine.

Struct S2( people : ... Text atom nonMember )
'''Definition:''' Self->people_ids := PersonToId( people )
 
Function ToExpression( Self : S2 atom )
'''Definition:'''
Local people := IdToPerson( Self->people_ids ); { This is a list of text }
_Struct( people : people )

A more nuanced case occurs when the items to the repeated parameter may have different dimensionalities. In this case, you need to take the [[reference]] of each item in the list so that its dimensions don't combine with the indexes of its sibling elements.

Struct S3( items : ... nonMember )
'''Definition:'''
Self->first := items[@=1];
[[Local]] refd := ([[For]] xi := repeated items Do \xi); {refs to keep dims separate}
Self->rest := refd[@=2..[[Size]](items,listLen:true)]
 
Function ToExpression( Self : S3 atom )
'''Definition:''' _Struct( items : [\Self->first, ...Self->rest ] )

To keep the dimensionalities separate for each item is <code>Self->Rest</code>, the constructor takes the reference of each repeated item. In <code>ToExpression</code>, these are already references so it simply forwards them into the list for «items».

== Immutability ==
The <code>Self</code> members can be altered from within the [[Struct]] constructor, but cannot be altered once the fully-constructed instance has been returned by the constructor. From that point on, the members of a struct instance are never changed.

However, a struct can hold a [[Mutable]] or a [[Local_functions_and_local_value_captures#Local_value_capture|captured local]] which actually makes it possible for the internal state of an instance to be changed. The mutable or the local's identity never changes, and changes to this type of internal state does not result in any downstream invalidation.

== Generic Struct ==
A built-in struct named <code>_Struct</code> (with an underscore) can be used as a generic Struct that you can instantiate on arbitrary members without having to define your own Struct object. To instantiate, every parameter must be named, but can be whatever name you want, e.g.,

_Struct( date:Today(), name: 'Donald', address: '1600 Pennsylvania Avenue' )

== Examples ==

Examples in this section demonstrate various aspects of a Struct and member functions.

=== Tuple ===
A Tuple is a ordered list of items, each item having a different dimensionality. It can be implemented as a Struct.

To create a tuple (after the Tuple Struct is defined), use:
Tuple( x, y, z )
with any number of values. The values passed can have different dimensionalities. The collection is held in a single cell (if you have an array of Tuples), and the dimensionalities of the items are kept separate.

Struct Tuple( items : ... ;
direct : hidden optional named boolean atom )
'''Definition''':
[[If]] direct [[Then]] (
[[For]] xi:= repeated items Do
[[If]] [[Not]] [[IsReference]](xi) then
Error("When using direct:True to Tuple, all «items» must be references");
Self->items := items
) [[Else]] (
Self->items := ([[For]] xi := repeated items Do \xi)
)

Function Tuple::Length( Self : Tuple atom )
'''Definition''':
[[Size]]( Self->items, True )

Function Tuple::Expand ( Self : Tuple atom )
'''Definition''':
[[Local]] i:=f"[{1..[[size]](Self->items)}]";
[[For]] ii:=@i do (
[[Local]] xi := #(Self->items[@=ii]);
[[If]] [[Size]]([[IndexesOf]](xi))>0 then
_HyperlinkedCellValue(xi)
[[Else]]
xi
)

Function Tuple::`[]`(Self : Tuple atom ; m,n : optional number atom )
'''Definition''':
[[If]] [[IsNotSpecified]](n) Then
#(Self->items[@=m,defVal:Null])
[[Else]] (
[[If]] [[IsNotSpecified]](m) [[Then]] m := 1;
[[If]] n>[[Size]](Self->items) [[Then]] n := [[Size]](Self->items);
Tuple( ...Self->items[@=m..n], direct:True )
)

Function Tuple::TitleForExpand(Self : Tuple atom ; subTitle : text atom ; memberNum : optional positive atom )
'''Definition''':
[[If]] [[IsNotSpecified]](memberNum) [[Then]]
f"{subTitle}->"
[[Else]]
f"{subTitle}->[{memberNum:I}]"

Function Tuple::ToExpression( Self : Tuple atom )
'''Definition''': _Struct( items: Self->items )

=== Reference ===
This example demonstrates how a [[reference]] could be implemented using Struct if it weren't already built into the Analytica language. Note that the keywords Ref and Reference are already in use, so we need to pick a different name.

Struct _Ref( r : [I] ; I : optional ... index = common )

Function _Ref::`#`( Self : _Ref atom )
'''Definition''': Self->r

Function _Ref::Expand( Self : _Ref atom )
'''Definition''': `#`(Self)

Function _Ref::TitleForExpand(Self : _Ref atom ; subTitle : text atom ; memberNum : optional positive atom )
'''Definition''':
f"#{subTitle}"

== See also ==
* [[Arrow operator]]
* [[Callable]]
* [[User-Defined Functions]]
* [[Function Parameter Qualifiers]]

Struct

2025-12-14T20:50:14Z

Mhenrion: /* When to use a Struct */

[[category:Objects]]
[[category:Variables]]
''new to [[Analytica 7.0]]''

Most programming languages have a way to bundle a set of disparate data into a packet, often called Records, Classes, or Structs. In Analytica, you can do this using an array with an [[Index]], but this doesn't work so well if the values in the array are disparate, for example, if they include numbers, text, references to other data, or array values with different dimensions. For example, if you want to create lists or hierarchies, represent JSON data or html. Thta's why Analytica has introduced Structs to represent these kinds of data structures.

A struct instance can have multiple member fields, which can be of varioust data types and dimensionality. For example, a struct could have a scalar member, a 1-D member and a 2-D member, where the dimensions of the members are unrelated. Each struct value is treated as an atomic element, and it does not apply Array abstraction within the Struct.

== Struct class ==

A [[Struct]] object defines a new atomic data type. It appears on a diagram with a shape that resembles a function, but with flat midsections on both the left and right.

<center>[[image:MyDtype_Struct.png]]</center>

After you define a [[Struct]], you can create instances of it. Instances are ''atomic'' and ''immutable'': ''Atomic''meaning that [[Array Abstraction]] treats it as a single cell -- even though it may have multiple elements.''Immutable'' meaning that, it cannot be destructively altered after it's been created.

A [[Struct]] is an [[Objects and Values|Object]]. An instance of a struct is a [[Objects and Values|Value]].

== When to use a Struct ==

These are examples of when a Struct may be convenient:
* To represent hierarchical data, such as from html or JSON.

* If you want your data type to be an opaque atomic unit with multiple internal items.

* To [[Returning multiple values|return multiple return values]] with varying dimensions as an alternative to capturing multiple return values.

* To pass complex data structures among user-defined functions.

* To enforce a distinction that does not exist in Analytica, but is used in another platform or service that you are integrating with.

== Defining a Struct ==
To create an object whose class is [[Struct]], you can first create a [[UDF|user function]] object, and then change its class to <code>Struct</code> in its [[Object window]] or [[Attribute window]].

A Struct uses the [[Parameters]] attribute with just the same [[Function Parameter Qualifiers]] as a [[User-Defined Function]] (UDF)., for example:

:<code>Struct MyDtype( a : atom ; b : Text [I] ; c: Number[J] )</code>

This data type has three members -- <code>a</code>, <code>b</code>, and <code>c</code>. The <code>a</code> field can have any atomic data type, the <code>b</code> member must be text and may have the index <code>I</code>, and the <code>c</code> member must be a numeric and may have index <code>J</code>.

The default [[Definition]] of a Struct is <code>Self</code>. Sometimes it makes sense to include a more specialized definition -- see [[#Constructor customization]] below.

== Instantiating a value ==

To create an instance of a Struct, you simply call the name of your struct as if it were a function from within an expression. In the previous example, that might be:

:<code>MyDtype( Category, Category_aliases, Category_IDs )</code>

If any of the values passed to the constructor parameters have extra indexes (dimensions), [[Array Abstraction]] kicks in and creates an array of struct instances over those extra indexes.

== Accessing member values ==
Use the [[Arrow operator]] to access a member values of a Struct. E.g.,

:<code>inst -> b</code>

where <code>inst</code> was obtained by calling the Struct.

The left-hand side of the arrow can be a single instance, an array of instances, or even [[Null]]. The right-hand side of the arrow is the name of a member value.

== Member functions ==

You can introduce your own ''member functions'' that are called using the syntax:
:<code>inst -> F(x, y)</code>
The parameters are limited to be passed by values (e.g., no Index parameters). Keep in mind that the instance is immutable so these functions can't usually modify the internal state of the instance (see Section [[#Immutability]] for exceptions).

To create your own ''member function'', open up the [[Struct]]'s diagram (as you would open up the diagram of a Module node) and drag a Function object to the diagram. In its [[Object window]], set the parameters ensuring that the first parameter is declared as, e.g.,

:<code>Function F( Self : MyDtype atom ; param1 ; param2 )</code>

The first parameter should be named <code>Self</code> and should have the Struct name as its data type and the [[Objects and Values|atom]] qualifier. You can have zero or more additional parameters -- these are the ones passed to the function when it is called using the syntax <code>inst → F(x,y)</code>. These parameters can have any data type qualifier, dimensionality declaration; however, for now they cannot handle [[Function_parameter_qualifiers#Evaluation_Mode_Qualifiers|evaluation mode qualifiers]] or [[Function_parameter_qualifiers#Object_Class_Qualifiers|Object class qualifiers]].

You can also introduce global variables that are "private" to the Struct and its member functions by adding normal variable nodes to the diagram. Note that these are contained in the Struct definition, not in each instance (to have a value that varies with each instance, you must use a member value.

== Constructor customization ==
The member values of an instance are usually the parameter names that appear in the [[Parameter]] attribute of the struct (its Constructor's parameter names). However, in some use cases the constructor may change the member values, such as by adding new members, transforming the named members, or even removing members. These changes must be performed in the [[Definition]] of the constructor.

When you first view the [[Object window]] of a [[Struct]], the [[Definition]] might not be visible (because altering the member values is somewhat esoteric). If you don't see it, use the [[Object_Window#Selecting_Attributes_to_Display|Attribute visibility popup]] to make it visible.

Inside the constructor (and only in the constructor) the members can be assigned. For example:

[[Struct]] MyDType( a : atom ; b : Text [I] ; c : Number [J] )
'''Definition''':
Self -> creationTime := [[Today]](true);
Self -> c := c / [[Sum]](C, J);
Self

The final value is always <code>Self</code> whether or not your Definition actually returns <code>Self</code>, although it is clearer to do. Notice that in this example, it adds a new member value, <code>creationTime</code>, and changes the member value <code>c</code> to the normalized value.

When you change the member values in the constructor, you should consider whether you will ever assign values of your Struct to a definition or other expression attribute, or whether instances will even need to be saved directly in the model file. These cases require a text representation that is valid expression and which results in an equivalent instance. In the event that you alter the members, you may need to add a custom [[#ExpressionText]] member function that prints out a constructor call expression.

== Using an excess parameter in the constructor ==

An ''excess parameter'' is a catch-all parameter that allows the caller to include named parameters that aren't listed in the parameters. It can be either named or unnamed.

The constructor has an unnamed excess parameter when the last parameter is named <code>"..."</code>. For example,

[[Struct]] MyDType2( a : atom ; b : Text[I] ; ... )

When declared in this fashion, a caller can specify parameters other than <code>a</code> and <code>b</code>, for example:

MyDType2( a:5, b:f"I={I}", c:14, d:=J^2 )

When an unnamed excess parameter is used in this way, the additional parameters are automatically added as members. Hence, in this example, <code>MyDType2</code> has members <code>['a', 'b', 'c', 'd']</code>. Because the excess parameter is unnamed, there is no way to refer to it in the constructor's definition.

To specify that the excess parameters not be added to the struct instance, you can use
[[Struct]] MyDType3( a : atom ; b : Text[I] ; ... : nonMember )

A ''named excess parameter'' is declared using a named that starts with <code>"..."</code>, which again must be the last parameter in the declaration. For example,

[[Struct]] MyDType3( a : atom ; b : Text[I] ; ...kw )

Inside the constructor's definition, it can now refer to the local variable <code>kw</code>. The value of <code>kw</code> is itself a struct instance where each argument is a member. For example, when called as
MyDType3( a:5, b:f"{I}", y:43, z:'hello' )
The Definition of MyDType3 could reference <code>kw->y</code> or <code>kw->z</code> when called in this example; however, those would fail with an error when <code>y</code> or <code>z</code> is not specified.

== Equality and comparison ==

Two struct instances are equal (i.e., <code>s1=s2</code> is true) only when they are of the same Struct, have the same member names and have the same member values. In other words, <code>s1=s2</code> is based on "deep equality".

Shallow equality tests whether two instances are the exact same instance (as opposed to whether the two instances are equal). The following can be used to test whether two instances are the exact same instance:
:<code>s1->_addr = s2->_addr</code>
The special <code>_addr</code> member value returns an integer that is unique to each instance.

Inequality comparisons are also based on the "deep" member values, based on the internal member value ordering.

== Basic properties about an instance ==

You can get a list of the member value names using:
:<code>inst -> _members</code>

You can test whether it has a given member using:
:<code>inst -> Has('name')</code>

If you have the name of a member value as text in a variable memberName, you can access its value using:
:<code>`->`( inst, memberName )</code>

With this syntax, you can also specify a default value to use when the instance does not have the specified name by specifying the optional «defVal» parameter:
:<code>`->`( inst, memberName, defVal: Null )</code>

Note that it wouldn't work to write <code>inst -> memberName</code> because that would look for a member value named "memberName".

You can get a handle to the instance's Struct object using
:<code>inst -> _type</code>
You can get the name of the Struct (without a [[Namespaces|namespace]] prefix) from <code>[[TypeOf]](inst)</code>. You can detect that an atom is a struct instance using
:<code>[[TypeOf]]( inst, shallow:true ) = "Struct"</code>

== Special member functions ==

You can customize the behavior of your struct instances by adding special member functions (with reserved member function names). You add these as you would your own member functions to your Struct's diagram using the reserved name. Your implementation must match the required parameters for the special function.

=== Customizing how a value is printed ===
My default, an instance of your Struct will display in a result table cell or in the [[Typescript window|Typescript console]] as, e.g., <code>«YourStructName»</code>. You can customize this by adding a member function named <code>DisplayName</code>. E.g.,

Function DisplayName( Self : MyDtype atom )
'''Definition''': f"«{[[TypeOf]](Self)} a={Self->a}»"

Because <code>DisplayName</code> occurs while individual cells are drawing on the screen, errors that occur while it is evaluating are not displayed. If an error occurs, it will silently fall back to the default display name.

When your instance is "printed" to an expression (e.g., as a result of an assignment), you need to ensure that the text is a valid expression that creates a logically equivalent instance. This happens by default unless you alter the members in your constructor (see [[#Constructor customization]] above). To control this, add a member function name <code>ExpressionText(Self)</code>.

=== Value expansion (in a result table) ===
When a struct instance appears in the cell of a result table, it appears as a hyperlink. Double clicking on it expands the value. By default, it expands into the member values. You can change this by adding a member function named <code>Expand(Self)</code>.

Your expansion code cannot simply create an array of your member values (assuming they have different dimensionalities) since this would combine their dimensions. Instead, you should wrap each non-atomic value in <code>_HyperlinkedCellvalue</code>. For example:

Function Expand( Self )
'''Definition''': [ 'a' : Self->a,
'b' : _HyperlinkedCellValue( Self->b ),
'c' : _HyperlinkedCellValue( Self->c ) ]

You can also introduce a local index for the expansion.

After it expands, the result table displays a title showing the current "path" to the result view. Ideally this title is also a valid expression that produces the same result. When you customize the expansion, you may also need to customize the expansion title. You can do this by adding a member function

:<code>Function TitleForExpand(Self : Tuple atom ; subTitle : text atom ; memberNum : optional positive atom )</code>

The «subTitle» is the title up to the point of this expansion, and «memberNum» exposes which cell number was expanded from the previous level.

=== Finalizers ===

A finalizer is a member function that is called when the struct instance value is released for last time.

You can add a customized finalizer, for example, to ensure that a resource gets cleaned up. An example use case would be when your [[Struct]] is a temporary file, with the finalizer ensuring that the temporary file is deleted when the instance is released. This is an example where the constructor would pick a unique file name that doesn't already exist, and the finalizer calls [[FileSystemDelete]].

To add a finalizer, add a member function named <code>Finalizer(Self)</code>.

Finalizers should have a low probability of an error occurring while the finalizer is evaluating. In the event that an error occurs, it is not possible for Analytica to report the error, so the error will occur silently. If you do not catch it (in a [[Try]]), your full finalizer code might not run.

=== Callable values ===

You can make an instance of your Struct "''callable''", such that you can call the instance using e.g.,

:<code>inst -> ( x, y )</code>

To make it callable, create a member function named <code>`()`</code> -- make sure to include the backtics as part of the name, and no spaces between the parens. For example:

Function `()`( alpha, pwr )
'''Definition''': (1-alpha) * Self->a + alpha * [[Sum]]( b^pwr, I )

If you do this, you can also use a [[Callable]] object class to hold your instance (or an array of instances) and then call it using the name of your callable as if it were a normal function (even though the logical function itself is computed), e.g.,

:[[Callable]] F1 := MyDType( x,y,z )</code>

And call it:
:<code>F1(0.3, 2) </code>

=== Custom atomic subscripting ===
Your data type can support the syntax
:<code>inst -> [n]</code>
by adding a member function named <code>`[]`</code>. It can have either one or two parameters (after <code>Self</code>). With one parameter, only <code>inst -> [n]</code> is supported (so that <code>inst -> [m..n]</code> would array abstract returning a list). With two parameters, where the second parameter is optional, it can include special handling of <code>inst -> [m..n]</code>, for example by returning a new collection instance of the same type.

Function `[]`( Self : Tuple atom ; m,n : optional number atom )

In this example, if <code>inst -> [m]</code> is called, then the «n» parameter is omitted. If <code>inst -> [m..n]</code> is called, both parameters are provided. If <code>inst -> [m..]</code> is called, then «n» is [[INF]]. And if <code>inst->[..n]</code> is called, then «m» is omitted.

=== Operator overloading ===

At present, only these operators can be overloaded by adding a member function with the given name.

* Function `#`( Self )

=== Overloading the <code>`->`</code> operator ===

It is possible to overload the right-arrow operator for a Struct, intercepting attempts to read a member value or to set a member value.

If you only want to intercept attempts to read member values, add the following member function in your struct:
Function `->`( Self : '''''YourStruct''''' atom ; member : Text atom ; defVal : optional named )
By sure to change '''''YourStruct''''' to the actual name of your struct. This will be called when code evaluates
:<code>inst -> member</code>
on an instance <code>inst</code> of your struct. Your function can return values for members that don't actually exist, or deny members that might exist, or just intercept the read and then forward it in the usual way.

Exceptions: Member functions with names beginning with an underscore are never intercepted (such as the special <code>inst->_members</code>, <code>inst->_type</code> and <code>inst->_addr</code> virtual members). Also, calls to member local functions or member functions are never intercepted -- this intercepts member value access only.

Your implementation of the overload will often want to access the actual members of the class. It must not use the usual arrow operator for this because that would result in an infinite recursion. Instead, you can use the raw member access function, <code>`->!`</code>, which behaves the same same as <code>`->`</code> except that it cannot be overridden. This function can only be called using a function call syntax, it cannot be used as an infix operator.

Here is a contrived example that makes is look like the file contents is a member value. (It would be better to just add a member function for this, but it makes for an easy example).

Struct TextFile( filename : Text atom )

Function TextFile::`->`( Self : TextFile atom ; member : Text atom ; defVal : optional named )
'''Definition''':
[[If]] TextLowerCase(member) = "contents" Then
[[ReadTextFile]](filename)
[[Else]]
`->!`( Self, member, defVal:defVal )

You can also use an override of <code>`->`</code> to intercept attempts to assign to a member, such as an assignment like
inst -> val := newVal

A struct instance is itself immutable, so such assignments are not generally valid, but using an override you can make it appear that a member is mutable. This could be useful, for example, when using a struct to wrap an object from a different programming language, or in a web service, where members can be assigned. The overload could send the change through an API, keeping a familiar assignment syntax.

To add an overload that can also intercept member assignments (as well as reading member values), the member function should have this signature:

Function `->`( Self : '''''YourStruct''''' atom ; member : Text atom ; defVal : optional named ; rhs : optional named )

Inside the definition, use <code>IsNotSpecified(rhs)</code> to determine whether it is a read or an assignment.

== Assignment ==
Sometimes a button's [[OnClick]] expression assigns a result value to a global variable. When you do so, it sets the definition of the global variable to an expression that results in the same value when evaluated. It is also an expression that can be saved with a model file.

In the case of a Struct, this means that the expression must be a call to the Struct's constructor with parameter values that result in a logically equivalent instance.

In the cases where you have customized constructor logic that alters what member values are actually stored, if you want assignment (and saving to a model file) to work successfully, you need to include the custom member function:

Function ToExpression( Self : MyStruct atom )

This can return the textual expression that results in an equivalent value, but in general, it can be difficult to get the textual expression correct. Hence, the recommended way to implement the function is to return an instance of the generic built-in <code>_Struct</code> with member names that correspond to your constructor parameter names.

=== Example ===

This example uses the [[Mutables library]].

Struct S( x : nonMember )
'''Definition: ''' Self->mutable_val := Mutable(x)
 
Function ToExpression( Self : S atom )
'''Definition:''' _Struct( x: Self->mutable_val->val )

The <code>_Struct</code> returned has the parameter name </code>x, which matches the parameter name in <code>S</code>'s constructor with the value that should appear in the call to the constructor.

When you assign a value containing an instance of <code>S</code> to a global, the definition contains something like <code>S( 'Foo' )</code> -- a valid call to the constructor.

=== Repeated parameters ===
When your constructor has a repeated parameter, you need to set the <code>_Struct</code> element to a list, where each item in the list corresponds to one argument passed to the parameter. If all of the items that should be passed to the repeated parameter have the same dimensionality and none are a scalar reference, then a list is fine.

Struct S2( people : ... Text atom nonMember )
'''Definition:''' Self->people_ids := PersonToId( people )
 
Function ToExpression( Self : S2 atom )
'''Definition:'''
Local people := IdToPerson( Self->people_ids ); { This is a list of text }
_Struct( people : people )

A more nuanced case occurs when the items to the repeated parameter may have different dimensionalities. In this case, you need to take the [[reference]] of each item in the list so that its dimensions don't combine with the indexes of its sibling elements.

Struct S3( items : ... nonMember )
'''Definition:'''
Self->first := items[@=1];
[[Local]] refd := ([[For]] xi := repeated items Do \xi); {refs to keep dims separate}
Self->rest := refd[@=2..[[Size]](items,listLen:true)]
 
Function ToExpression( Self : S3 atom )
'''Definition:''' _Struct( items : [\Self->first, ...Self->rest ] )

To keep the dimensionalities separate for each item is <code>Self->Rest</code>, the constructor takes the reference of each repeated item. In <code>ToExpression</code>, these are already references so it simply forwards them into the list for «items».

== Immutability ==
The <code>Self</code> members can be altered from within the [[Struct]] constructor, but cannot be altered once the fully-constructed instance has been returned by the constructor. From that point on, the members of a struct instance are never changed.

However, a struct can hold a [[Mutable]] or a [[Local_functions_and_local_value_captures#Local_value_capture|captured local]] which actually makes it possible for the internal state of an instance to be changed. The mutable or the local's identity never changes, and changes to this type of internal state does not result in any downstream invalidation.

== Generic Struct ==
A built-in struct named <code>_Struct</code> (with an underscore) can be used as a generic Struct that you can instantiate on arbitrary members without having to define your own Struct object. To instantiate, every parameter must be named, but can be whatever name you want, e.g.,

_Struct( date:Today(), name: 'Donald', address: '1600 Pennsylvania Avenue' )

== Examples ==

Examples in this section demonstrate various aspects of a Struct and member functions.

=== Tuple ===
A Tuple is a ordered list of items, each item having a different dimensionality. It can be implemented as a Struct.

To create a tuple (after the Tuple Struct is defined), use:
Tuple( x, y, z )
with any number of values. The values passed can have different dimensionalities. The collection is held in a single cell (if you have an array of Tuples), and the dimensionalities of the items are kept separate.

Struct Tuple( items : ... ;
direct : hidden optional named boolean atom )
'''Definition''':
[[If]] direct [[Then]] (
[[For]] xi:= repeated items Do
[[If]] [[Not]] [[IsReference]](xi) then
Error("When using direct:True to Tuple, all «items» must be references");
Self->items := items
) [[Else]] (
Self->items := ([[For]] xi := repeated items Do \xi)
)

Function Tuple::Length( Self : Tuple atom )
'''Definition''':
[[Size]]( Self->items, True )

Function Tuple::Expand ( Self : Tuple atom )
'''Definition''':
[[Local]] i:=f"[{1..[[size]](Self->items)}]";
[[For]] ii:=@i do (
[[Local]] xi := #(Self->items[@=ii]);
[[If]] [[Size]]([[IndexesOf]](xi))>0 then
_HyperlinkedCellValue(xi)
[[Else]]
xi
)

Function Tuple::`[]`(Self : Tuple atom ; m,n : optional number atom )
'''Definition''':
[[If]] [[IsNotSpecified]](n) Then
#(Self->items[@=m,defVal:Null])
[[Else]] (
[[If]] [[IsNotSpecified]](m) [[Then]] m := 1;
[[If]] n>[[Size]](Self->items) [[Then]] n := [[Size]](Self->items);
Tuple( ...Self->items[@=m..n], direct:True )
)

Function Tuple::TitleForExpand(Self : Tuple atom ; subTitle : text atom ; memberNum : optional positive atom )
'''Definition''':
[[If]] [[IsNotSpecified]](memberNum) [[Then]]
f"{subTitle}->"
[[Else]]
f"{subTitle}->[{memberNum:I}]"

Function Tuple::ToExpression( Self : Tuple atom )
'''Definition''': _Struct( items: Self->items )

=== Reference ===
This example demonstrates how a [[reference]] could be implemented using Struct if it weren't already built into the Analytica language. Note that the keywords Ref and Reference are already in use, so we need to pick a different name.

Struct _Ref( r : [I] ; I : optional ... index = common )

Function _Ref::`#`( Self : _Ref atom )
'''Definition''': Self->r

Function _Ref::Expand( Self : _Ref atom )
'''Definition''': `#`(Self)

Function _Ref::TitleForExpand(Self : _Ref atom ; subTitle : text atom ; memberNum : optional positive atom )
'''Definition''':
f"#{subTitle}"

== See also ==
* [[Arrow operator]]
* [[Callable]]
* [[User-Defined Functions]]
* [[Function Parameter Qualifiers]]

Struct

2025-12-13T21:32:20Z

Mhenrion: /* Defining a Struct */

[[category:Objects]]
[[category:Variables]]
''new to [[Analytica 7.0]]''

Most programming languages have a way to bundle a set of disparate data into a packet, often called Records, Classes, or Structs. In Analytica, you can do this using an array with an [[Index]], but this doesn't work so well if the values in the array are disparate, for example, if they include numbers, text, references to other data, or array values with different dimensions. For example, if you want to create lists or hierarchies, represent JSON data or html. Thta's why Analytica has introduced Structs to represent these kinds of data structures.

A struct instance can have multiple member fields, which can be of varioust data types and dimensionality. For example, a struct could have a scalar member, a 1-D member and a 2-D member, where the dimensions of the members are unrelated. Each struct value is treated as an atomic element, and it does not apply Array abstraction within the Struct.

== Struct class ==

A [[Struct]] object defines a new atomic data type. It appears on a diagram with a shape that resembles a function, but with flat midsections on both the left and right.

<center>[[image:MyDtype_Struct.png]]</center>

After you define a [[Struct]], you can create instances of it. Instances are ''atomic'' and ''immutable'': ''Atomic''meaning that [[Array Abstraction]] treats it as a single cell -- even though it may have multiple elements.''Immutable'' meaning that, it cannot be destructively altered after it's been created.

A [[Struct]] is an [[Objects and Values|Object]]. An instance of a struct is a [[Objects and Values|Value]].

== When to use a Struct ==

These are examples of when a Struct may be convenient:
* Representing hierarchical data, such as from html or JSON.

* If your data type should act as if it is an opaque atomic unit, and especially if there are multiple internal items, then a [[Struct]] is a good candidate. A struct can also provide one way to [[Returning multiple values|return multiple return values]] with differing dimensionalities as an alternative to capturing multiple return values.

* Passing complex data structures between many user-defined functions.

* When you want to enforce a distinction that does not exist in Analytica, but might exist in another platform or service that you are integrating with.

== Defining a Struct ==
To create an object whose class is [[Struct]], you can first create a [[UDF|user function]] object, and then change its class to <code>Struct</code> in its [[Object window]] or [[Attribute window]].

A Struct uses the [[Parameters]] attribute with just the same [[Function Parameter Qualifiers]] as a [[User-Defined Function]] (UDF)., for example:

:<code>Struct MyDtype( a : atom ; b : Text [I] ; c: Number[J] )</code>

This data type has three members -- <code>a</code>, <code>b</code>, and <code>c</code>. The <code>a</code> field can have any atomic data type, the <code>b</code> member must be text and may have the index <code>I</code>, and the <code>c</code> member must be a numeric and may have index <code>J</code>.

The default [[Definition]] of a Struct is <code>Self</code>. Sometimes it makes sense to include a more specialized definition -- see [[#Constructor customization]] below.

== Instantiating a value ==

To create an instance of a Struct, you simply call the name of your struct as if it were a function from within an expression. In the previous example, that might be:

:<code>MyDtype( Category, Category_aliases, Category_IDs )</code>

If any of the values passed to the constructor parameters have extra indexes (dimensions), [[Array Abstraction]] kicks in and creates an array of struct instances over those extra indexes.

== Accessing member values ==
Use the [[Arrow operator]] to access a member values of a Struct. E.g.,

:<code>inst -> b</code>

where <code>inst</code> was obtained by calling the Struct.

The left-hand side of the arrow can be a single instance, an array of instances, or even [[Null]]. The right-hand side of the arrow is the name of a member value.

== Member functions ==

You can introduce your own ''member functions'' that are called using the syntax:
:<code>inst -> F(x, y)</code>
The parameters are limited to be passed by values (e.g., no Index parameters). Keep in mind that the instance is immutable so these functions can't usually modify the internal state of the instance (see Section [[#Immutability]] for exceptions).

To create your own ''member function'', open up the [[Struct]]'s diagram (as you would open up the diagram of a Module node) and drag a Function object to the diagram. In its [[Object window]], set the parameters ensuring that the first parameter is declared as, e.g.,

:<code>Function F( Self : MyDtype atom ; param1 ; param2 )</code>

The first parameter should be named <code>Self</code> and should have the Struct name as its data type and the [[Objects and Values|atom]] qualifier. You can have zero or more additional parameters -- these are the ones passed to the function when it is called using the syntax <code>inst → F(x,y)</code>. These parameters can have any data type qualifier, dimensionality declaration; however, for now they cannot handle [[Function_parameter_qualifiers#Evaluation_Mode_Qualifiers|evaluation mode qualifiers]] or [[Function_parameter_qualifiers#Object_Class_Qualifiers|Object class qualifiers]].

You can also introduce global variables that are "private" to the Struct and its member functions by adding normal variable nodes to the diagram. Note that these are contained in the Struct definition, not in each instance (to have a value that varies with each instance, you must use a member value.

== Constructor customization ==
The member values of an instance are usually the parameter names that appear in the [[Parameter]] attribute of the struct (its Constructor's parameter names). However, in some use cases the constructor may change the member values, such as by adding new members, transforming the named members, or even removing members. These changes must be performed in the [[Definition]] of the constructor.

When you first view the [[Object window]] of a [[Struct]], the [[Definition]] might not be visible (because altering the member values is somewhat esoteric). If you don't see it, use the [[Object_Window#Selecting_Attributes_to_Display|Attribute visibility popup]] to make it visible.

Inside the constructor (and only in the constructor) the members can be assigned. For example:

[[Struct]] MyDType( a : atom ; b : Text [I] ; c : Number [J] )
'''Definition''':
Self -> creationTime := [[Today]](true);
Self -> c := c / [[Sum]](C, J);
Self

The final value is always <code>Self</code> whether or not your Definition actually returns <code>Self</code>, although it is clearer to do. Notice that in this example, it adds a new member value, <code>creationTime</code>, and changes the member value <code>c</code> to the normalized value.

When you change the member values in the constructor, you should consider whether you will ever assign values of your Struct to a definition or other expression attribute, or whether instances will even need to be saved directly in the model file. These cases require a text representation that is valid expression and which results in an equivalent instance. In the event that you alter the members, you may need to add a custom [[#ExpressionText]] member function that prints out a constructor call expression.

== Using an excess parameter in the constructor ==

An ''excess parameter'' is a catch-all parameter that allows the caller to include named parameters that aren't listed in the parameters. It can be either named or unnamed.

The constructor has an unnamed excess parameter when the last parameter is named <code>"..."</code>. For example,

[[Struct]] MyDType2( a : atom ; b : Text[I] ; ... )

When declared in this fashion, a caller can specify parameters other than <code>a</code> and <code>b</code>, for example:

MyDType2( a:5, b:f"I={I}", c:14, d:=J^2 )

When an unnamed excess parameter is used in this way, the additional parameters are automatically added as members. Hence, in this example, <code>MyDType2</code> has members <code>['a', 'b', 'c', 'd']</code>. Because the excess parameter is unnamed, there is no way to refer to it in the constructor's definition.

To specify that the excess parameters not be added to the struct instance, you can use
[[Struct]] MyDType3( a : atom ; b : Text[I] ; ... : nonMember )

A ''named excess parameter'' is declared using a named that starts with <code>"..."</code>, which again must be the last parameter in the declaration. For example,

[[Struct]] MyDType3( a : atom ; b : Text[I] ; ...kw )

Inside the constructor's definition, it can now refer to the local variable <code>kw</code>. The value of <code>kw</code> is itself a struct instance where each argument is a member. For example, when called as
MyDType3( a:5, b:f"{I}", y:43, z:'hello' )
The Definition of MyDType3 could reference <code>kw->y</code> or <code>kw->z</code> when called in this example; however, those would fail with an error when <code>y</code> or <code>z</code> is not specified.

== Equality and comparison ==

Two struct instances are equal (i.e., <code>s1=s2</code> is true) only when they are of the same Struct, have the same member names and have the same member values. In other words, <code>s1=s2</code> is based on "deep equality".

Shallow equality tests whether two instances are the exact same instance (as opposed to whether the two instances are equal). The following can be used to test whether two instances are the exact same instance:
:<code>s1->_addr = s2->_addr</code>
The special <code>_addr</code> member value returns an integer that is unique to each instance.

Inequality comparisons are also based on the "deep" member values, based on the internal member value ordering.

== Basic properties about an instance ==

You can get a list of the member value names using:
:<code>inst -> _members</code>

You can test whether it has a given member using:
:<code>inst -> Has('name')</code>

If you have the name of a member value as text in a variable memberName, you can access its value using:
:<code>`->`( inst, memberName )</code>

With this syntax, you can also specify a default value to use when the instance does not have the specified name by specifying the optional «defVal» parameter:
:<code>`->`( inst, memberName, defVal: Null )</code>

Note that it wouldn't work to write <code>inst -> memberName</code> because that would look for a member value named "memberName".

You can get a handle to the instance's Struct object using
:<code>inst -> _type</code>
You can get the name of the Struct (without a [[Namespaces|namespace]] prefix) from <code>[[TypeOf]](inst)</code>. You can detect that an atom is a struct instance using
:<code>[[TypeOf]]( inst, shallow:true ) = "Struct"</code>

== Special member functions ==

You can customize the behavior of your struct instances by adding special member functions (with reserved member function names). You add these as you would your own member functions to your Struct's diagram using the reserved name. Your implementation must match the required parameters for the special function.

=== Customizing how a value is printed ===
My default, an instance of your Struct will display in a result table cell or in the [[Typescript window|Typescript console]] as, e.g., <code>«YourStructName»</code>. You can customize this by adding a member function named <code>DisplayName</code>. E.g.,

Function DisplayName( Self : MyDtype atom )
'''Definition''': f"«{[[TypeOf]](Self)} a={Self->a}»"

Because <code>DisplayName</code> occurs while individual cells are drawing on the screen, errors that occur while it is evaluating are not displayed. If an error occurs, it will silently fall back to the default display name.

When your instance is "printed" to an expression (e.g., as a result of an assignment), you need to ensure that the text is a valid expression that creates a logically equivalent instance. This happens by default unless you alter the members in your constructor (see [[#Constructor customization]] above). To control this, add a member function name <code>ExpressionText(Self)</code>.

=== Value expansion (in a result table) ===
When a struct instance appears in the cell of a result table, it appears as a hyperlink. Double clicking on it expands the value. By default, it expands into the member values. You can change this by adding a member function named <code>Expand(Self)</code>.

Your expansion code cannot simply create an array of your member values (assuming they have different dimensionalities) since this would combine their dimensions. Instead, you should wrap each non-atomic value in <code>_HyperlinkedCellvalue</code>. For example:

Function Expand( Self )
'''Definition''': [ 'a' : Self->a,
'b' : _HyperlinkedCellValue( Self->b ),
'c' : _HyperlinkedCellValue( Self->c ) ]

You can also introduce a local index for the expansion.

After it expands, the result table displays a title showing the current "path" to the result view. Ideally this title is also a valid expression that produces the same result. When you customize the expansion, you may also need to customize the expansion title. You can do this by adding a member function

:<code>Function TitleForExpand(Self : Tuple atom ; subTitle : text atom ; memberNum : optional positive atom )</code>

The «subTitle» is the title up to the point of this expansion, and «memberNum» exposes which cell number was expanded from the previous level.

=== Finalizers ===

A finalizer is a member function that is called when the struct instance value is released for last time.

You can add a customized finalizer, for example, to ensure that a resource gets cleaned up. An example use case would be when your [[Struct]] is a temporary file, with the finalizer ensuring that the temporary file is deleted when the instance is released. This is an example where the constructor would pick a unique file name that doesn't already exist, and the finalizer calls [[FileSystemDelete]].

To add a finalizer, add a member function named <code>Finalizer(Self)</code>.

Finalizers should have a low probability of an error occurring while the finalizer is evaluating. In the event that an error occurs, it is not possible for Analytica to report the error, so the error will occur silently. If you do not catch it (in a [[Try]]), your full finalizer code might not run.

=== Callable values ===

You can make an instance of your Struct "''callable''", such that you can call the instance using e.g.,

:<code>inst -> ( x, y )</code>

To make it callable, create a member function named <code>`()`</code> -- make sure to include the backtics as part of the name, and no spaces between the parens. For example:

Function `()`( alpha, pwr )
'''Definition''': (1-alpha) * Self->a + alpha * [[Sum]]( b^pwr, I )

If you do this, you can also use a [[Callable]] object class to hold your instance (or an array of instances) and then call it using the name of your callable as if it were a normal function (even though the logical function itself is computed), e.g.,

:[[Callable]] F1 := MyDType( x,y,z )</code>

And call it:
:<code>F1(0.3, 2) </code>

=== Custom atomic subscripting ===
Your data type can support the syntax
:<code>inst -> [n]</code>
by adding a member function named <code>`[]`</code>. It can have either one or two parameters (after <code>Self</code>). With one parameter, only <code>inst -> [n]</code> is supported (so that <code>inst -> [m..n]</code> would array abstract returning a list). With two parameters, where the second parameter is optional, it can include special handling of <code>inst -> [m..n]</code>, for example by returning a new collection instance of the same type.

Function `[]`( Self : Tuple atom ; m,n : optional number atom )

In this example, if <code>inst -> [m]</code> is called, then the «n» parameter is omitted. If <code>inst -> [m..n]</code> is called, both parameters are provided. If <code>inst -> [m..]</code> is called, then «n» is [[INF]]. And if <code>inst->[..n]</code> is called, then «m» is omitted.

=== Operator overloading ===

At present, only these operators can be overloaded by adding a member function with the given name.

* Function `#`( Self )

=== Overloading the <code>`->`</code> operator ===

It is possible to overload the right-arrow operator for a Struct, intercepting attempts to read a member value or to set a member value.

If you only want to intercept attempts to read member values, add the following member function in your struct:
Function `->`( Self : '''''YourStruct''''' atom ; member : Text atom ; defVal : optional named )
By sure to change '''''YourStruct''''' to the actual name of your struct. This will be called when code evaluates
:<code>inst -> member</code>
on an instance <code>inst</code> of your struct. Your function can return values for members that don't actually exist, or deny members that might exist, or just intercept the read and then forward it in the usual way.

Exceptions: Member functions with names beginning with an underscore are never intercepted (such as the special <code>inst->_members</code>, <code>inst->_type</code> and <code>inst->_addr</code> virtual members). Also, calls to member local functions or member functions are never intercepted -- this intercepts member value access only.

Your implementation of the overload will often want to access the actual members of the class. It must not use the usual arrow operator for this because that would result in an infinite recursion. Instead, you can use the raw member access function, <code>`->!`</code>, which behaves the same same as <code>`->`</code> except that it cannot be overridden. This function can only be called using a function call syntax, it cannot be used as an infix operator.

Here is a contrived example that makes is look like the file contents is a member value. (It would be better to just add a member function for this, but it makes for an easy example).

Struct TextFile( filename : Text atom )

Function TextFile::`->`( Self : TextFile atom ; member : Text atom ; defVal : optional named )
'''Definition''':
[[If]] TextLowerCase(member) = "contents" Then
[[ReadTextFile]](filename)
[[Else]]
`->!`( Self, member, defVal:defVal )

You can also use an override of <code>`->`</code> to intercept attempts to assign to a member, such as an assignment like
inst -> val := newVal

A struct instance is itself immutable, so such assignments are not generally valid, but using an override you can make it appear that a member is mutable. This could be useful, for example, when using a struct to wrap an object from a different programming language, or in a web service, where members can be assigned. The overload could send the change through an API, keeping a familiar assignment syntax.

To add an overload that can also intercept member assignments (as well as reading member values), the member function should have this signature:

Function `->`( Self : '''''YourStruct''''' atom ; member : Text atom ; defVal : optional named ; rhs : optional named )

Inside the definition, use <code>IsNotSpecified(rhs)</code> to determine whether it is a read or an assignment.

== Assignment ==
Sometimes a button's [[OnClick]] expression assigns a result value to a global variable. When you do so, it sets the definition of the global variable to an expression that results in the same value when evaluated. It is also an expression that can be saved with a model file.

In the case of a Struct, this means that the expression must be a call to the Struct's constructor with parameter values that result in a logically equivalent instance.

In the cases where you have customized constructor logic that alters what member values are actually stored, if you want assignment (and saving to a model file) to work successfully, you need to include the custom member function:

Function ToExpression( Self : MyStruct atom )

This can return the textual expression that results in an equivalent value, but in general, it can be difficult to get the textual expression correct. Hence, the recommended way to implement the function is to return an instance of the generic built-in <code>_Struct</code> with member names that correspond to your constructor parameter names.

=== Example ===

This example uses the [[Mutables library]].

Struct S( x : nonMember )
'''Definition: ''' Self->mutable_val := Mutable(x)
 
Function ToExpression( Self : S atom )
'''Definition:''' _Struct( x: Self->mutable_val->val )

The <code>_Struct</code> returned has the parameter name </code>x, which matches the parameter name in <code>S</code>'s constructor with the value that should appear in the call to the constructor.

When you assign a value containing an instance of <code>S</code> to a global, the definition contains something like <code>S( 'Foo' )</code> -- a valid call to the constructor.

=== Repeated parameters ===
When your constructor has a repeated parameter, you need to set the <code>_Struct</code> element to a list, where each item in the list corresponds to one argument passed to the parameter. If all of the items that should be passed to the repeated parameter have the same dimensionality and none are a scalar reference, then a list is fine.

Struct S2( people : ... Text atom nonMember )
'''Definition:''' Self->people_ids := PersonToId( people )
 
Function ToExpression( Self : S2 atom )
'''Definition:'''
Local people := IdToPerson( Self->people_ids ); { This is a list of text }
_Struct( people : people )

A more nuanced case occurs when the items to the repeated parameter may have different dimensionalities. In this case, you need to take the [[reference]] of each item in the list so that its dimensions don't combine with the indexes of its sibling elements.

Struct S3( items : ... nonMember )
'''Definition:'''
Self->first := items[@=1];
[[Local]] refd := ([[For]] xi := repeated items Do \xi); {refs to keep dims separate}
Self->rest := refd[@=2..[[Size]](items,listLen:true)]
 
Function ToExpression( Self : S3 atom )
'''Definition:''' _Struct( items : [\Self->first, ...Self->rest ] )

To keep the dimensionalities separate for each item is <code>Self->Rest</code>, the constructor takes the reference of each repeated item. In <code>ToExpression</code>, these are already references so it simply forwards them into the list for «items».

== Immutability ==
The <code>Self</code> members can be altered from within the [[Struct]] constructor, but cannot be altered once the fully-constructed instance has been returned by the constructor. From that point on, the members of a struct instance are never changed.

However, a struct can hold a [[Mutable]] or a [[Local_functions_and_local_value_captures#Local_value_capture|captured local]] which actually makes it possible for the internal state of an instance to be changed. The mutable or the local's identity never changes, and changes to this type of internal state does not result in any downstream invalidation.

== Generic Struct ==
A built-in struct named <code>_Struct</code> (with an underscore) can be used as a generic Struct that you can instantiate on arbitrary members without having to define your own Struct object. To instantiate, every parameter must be named, but can be whatever name you want, e.g.,

_Struct( date:Today(), name: 'Donald', address: '1600 Pennsylvania Avenue' )

== Examples ==

Examples in this section demonstrate various aspects of a Struct and member functions.

=== Tuple ===
A Tuple is a ordered list of items, each item having a different dimensionality. It can be implemented as a Struct.

To create a tuple (after the Tuple Struct is defined), use:
Tuple( x, y, z )
with any number of values. The values passed can have different dimensionalities. The collection is held in a single cell (if you have an array of Tuples), and the dimensionalities of the items are kept separate.

Struct Tuple( items : ... ;
direct : hidden optional named boolean atom )
'''Definition''':
[[If]] direct [[Then]] (
[[For]] xi:= repeated items Do
[[If]] [[Not]] [[IsReference]](xi) then
Error("When using direct:True to Tuple, all «items» must be references");
Self->items := items
) [[Else]] (
Self->items := ([[For]] xi := repeated items Do \xi)
)

Function Tuple::Length( Self : Tuple atom )
'''Definition''':
[[Size]]( Self->items, True )

Function Tuple::Expand ( Self : Tuple atom )
'''Definition''':
[[Local]] i:=f"[{1..[[size]](Self->items)}]";
[[For]] ii:=@i do (
[[Local]] xi := #(Self->items[@=ii]);
[[If]] [[Size]]([[IndexesOf]](xi))>0 then
_HyperlinkedCellValue(xi)
[[Else]]
xi
)

Function Tuple::`[]`(Self : Tuple atom ; m,n : optional number atom )
'''Definition''':
[[If]] [[IsNotSpecified]](n) Then
#(Self->items[@=m,defVal:Null])
[[Else]] (
[[If]] [[IsNotSpecified]](m) [[Then]] m := 1;
[[If]] n>[[Size]](Self->items) [[Then]] n := [[Size]](Self->items);
Tuple( ...Self->items[@=m..n], direct:True )
)

Function Tuple::TitleForExpand(Self : Tuple atom ; subTitle : text atom ; memberNum : optional positive atom )
'''Definition''':
[[If]] [[IsNotSpecified]](memberNum) [[Then]]
f"{subTitle}->"
[[Else]]
f"{subTitle}->[{memberNum:I}]"

Function Tuple::ToExpression( Self : Tuple atom )
'''Definition''': _Struct( items: Self->items )

=== Reference ===
This example demonstrates how a [[reference]] could be implemented using Struct if it weren't already built into the Analytica language. Note that the keywords Ref and Reference are already in use, so we need to pick a different name.

Struct _Ref( r : [I] ; I : optional ... index = common )

Function _Ref::`#`( Self : _Ref atom )
'''Definition''': Self->r

Function _Ref::Expand( Self : _Ref atom )
'''Definition''': `#`(Self)

Function _Ref::TitleForExpand(Self : _Ref atom ; subTitle : text atom ; memberNum : optional positive atom )
'''Definition''':
f"#{subTitle}"

== See also ==
* [[Arrow operator]]
* [[Callable]]
* [[User-Defined Functions]]
* [[Function Parameter Qualifiers]]