Embed table or graph with ACP



Release:

4.6  •  5.0  •  5.1  •  5.2  •  5.3  •  5.4  •  6.0


You can create user interfaces for Analytica Cloud Platform (ACP) that embed tables and graphs inside a Diagram window. This works better for web applications than the separate windows to show tables and graphs used in Analytica on the desktop. There are two ways to do this:

  • #Tall input and output nodes: You just resize a user input or output node to be tall enough so that it has space to show a table or graph. ACP will then automatically know to display the table or graph inside it.
  • #Frame nodes: You create a text nodes that you specify as a Frame for that Diagram (module) using the ACP Style Library. When the end user clicks a user input or output, or actually, any node in a Diagram, it shows the value of the node as a table or graph inside the Frame.


This lets users view and input tables and result tables and graphs all in a single user interface window -- unlike Analytica on the desktop in which each input table and result table or graph must be in its own window.

See ACP Style Library for guidance on how to set up your model to, for example, auto calculate the results when the user views a model in ACP (note: auto calculate is required for tall nodes).

There are two ways to render a table or graph on the diagram.

The second way to render a table or graph is to create a Frame, which serves as a the location where a User input node or User output node will render the table or graph for the user.

Tall nodes

The simplest way to embed a user input or output in a diagram in ACP is to make it a Tall node -- i.e. to resize the node in Analytica so that its tall enough to show the table or graph (at least 4 times taller than the default size). The default height of a user input or output node is 26 pixels -- if it uses the default 11-point font size. So, "tall" means more than 104 pixels -- more for a larger font. It may look a little odd in desktop Analytica, which just shows the Edit table, Calc, or Result button in the tall node. But, when you load the model into ACP, it automatically shows the edit table for an input node. For an output node, it displays the result as a table or graph (usually in whatever form it was last saved in Analytica).

ACP sizes a graph automatically to fit the frame (node size) you have specified. For a table larger than the node size, scroll bars let you see all parts of the table.

ACP uses the table or graph format last used in the version of the model you saved in Desktop Analytica. So, if you want ACP to show a graph (not a table), you should view it that way -- and set any other table or graph options you want -- before you save the model. Similarly, for an Edit table, choose the pivot (which index is rows and which columns) before you save the model. ACP also uses the uncertainty view -- mid, mean, statistics, pdf, cdf, or sample -- that you last viewed in DTA. (For experts, you can find this information in the ValueState attribute for the original node.)

Examples

In the Car cost.ana model from the Analytica Tutorial Example Models and Libraries, define a User output node from the Total cost Objective.


ACP Create User Output node.png


1. Right click the Total cost Objective.


2. Select Make User Output node from the options.

Re-position and resize the resulting User output node to a size corresponding to how large the graph will be when rendered in ACP.


ACP make tall node.png


3. Resize the node by clicking and dragging the bottom right handle.

Once you publish to cloud and play the model, here's the result displayed on the diagram ACP:

Embedded result graph in awp.png

Tall nodes for Web application

Here's a second example, with two different User output nodes and three User input nodes.

User Output nodes for ACP.png

In the ACP Style Library, the settings for Web application are as follows:

ACP Web application style.png

Here's the result displayed in a ACP model designed for Web application:

User Output nodes for ACP web.png

AcpStyles flags in tall output nodes

In the previous screenshots, the graph on the left does not have any Index selection options, while the one on the right does. For the graph on the left, the AcpStyles attribute for that Variable includes the flag Show_index_menus:no.

ACP Cloud Player Style no index.png

Frame nodes

The main wiki article on Frame nodes

A second way to embed tables and graphs in a diagram uses Frames. This is very convenient, since you need make only one Frame node, usually to the right of the user interface or diagram, and it will show a table or graph for any node you click. A Frame is a rectangular area defined by a that will display the edit table for any input node you click, or a result table or graph for any output node you click. In fact, it also shows a result table or graph for any variable node that you click in an influence diagram. (If the variable has a single atomic value, it will show it in the user input or output node, not in the Frame node.)

Note that in Desktop Analytica 6.0 the Frame node object was introduced, which simplifies the process for creating framenodes. You simply drag a text node of the desired size on to the diagram and set its object class to framenode. ACP will detect this automatically.

In previous builds (and optionally in 6.0) , you add a Text node to the diagram and set the acpstyle as described here to include this text node as a module text node.


What is displayed?

ACP resizes a result graph fit into the frame. You may need make sure that the frame node is large enough to display the entire graph in a legible way, depending font size, and its complexity. If an edit table or result table is too large to fit, ACP will show scroll bars to let you scroll around the table.

Title, Units and description: Normally ACP shows the node's title and units (If any) in bold at the top of the frame, followed by its description (if any). But, if the Description contains more text than will fit in the top third of the frame, it shows only what will fit in the top third, with a scrollbar to see more.

When a Diagram first opens in ACP (and no node has been selected), each frame node shows its own title, and description (if any). This is a useful place to put an introductory explanation of this diagram and how to use it.

Font size: It uses the font style and size specified for the frame node with the title in bold -- initially the title and description specified for the frame, and then the title and description for the selected variable.

It should allow web links (as in other descriptions) to appear in the description text.

ACP styles for Embedded Tall nodes or Frame nodes

The following ACP styles can be used in tall output nodes and in frame nodes.

  • Show_title: Set Show_title: yes to show or Show_title: no tostop showing the Title and units of a selected variable.
  • Show_description: nn: Where nn is a number between 0 and 100, where it uses up to nn% of the vertical space available to show the description, showing vertical scroller if that isn't enough to show the entire description. Set nn = 0, if you don't want to show the description at all (and no scroller). Default if not mentioned, is one third, i.e. Show_description: 33
  • Show_graph_table_icon: No/ yes
  • Show_uncertainty_view: no/yes
  • Show_Index_menus:
    • By default (no show_index_menu: setting) the index menus for are not shown in 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.
    • show_index_menus:yes 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.
    • show_index_menus:no 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.
    • show_index_menus:Not_even_slicersIf you don't want to show any pivoters or slicers, you can set show_index_menus:Not_even_slicers.


Examples

Single Frame node

To create a Frame_node, drag a text node to the diagram and make it large enough to hold graphs and tables.

Analytica initializes the node with a long cryptic identifier starting with 'Te' and end with a string of numbers. You can rename the text node Identifiers to make it easier to review your Frames. For example, this changes 'Te1510871050' to a more meaningful 'FrameNode1':


ACP change textnode identifier.png


1. Type FrameNode1 to rename.

Next, you need to specify which text nodes are Frame nodes by naming them in the AcpStyles attribute of the parent model or module, i.e. not of the text node itself. In this example, we specify FrameNode1 as a Framenode in our Module.


ACP define framenode.png


2. Click somewhere in the grey diagram background.


3. Select Acp Styles from the Attributed drop down.


4. Type Framenode: FrameNode1.

Publish the model to cloud to (follow the tutorial for instructions on how to do this) to test the Edit table and Graph functionality in the model.


ACP Frame edit table.png


5. Click Table to display the Edit table in the Frame.


Editable table


ACP Frame results.png


6. Click Result to display the graph in the Frame.


Result graph

Multiple Frames

If a Diagram has more than one Frame node, when you click a user input or output, it reuses the Frame with the oldest previous table or graph that was displayed and replaces it with the new result. To specify multiple Frames in a Diagram, you list all Text nodes that will serve as Frames in AC, seperated by &. Here is how you specify two Frames in a Diagram in a generic Module M:

AcpStyles: Framenode:FrameNode1 & FrameNode2

In this case, the first User input or output node clicked will fill FrameNode1 and the next one will fill FrameNode2 because that's the order in which they were specified. Each time you click on a User input or output node, the corresponding table or graph will display in the Frame whose contents was displayed the longest ago. Thus, as you click on different nodes, it cycles through the Frames. In this way, you can see and compare edit tables or results from multiple nodes all in the same diagram window.

*Once you evaluate a variable, if that result is present in a frame node, if you evaluate the same variable again the result will stay in the same frame node.


See Also

Comments


You are not allowed to post comments.