Difference between revisions of "ACP Style Library"
 
(29 intermediate revisions by 4 users not shown)
Line 1: Line 1:
−
[[Category: Analytica Cloud Player]]
+
[[Category: Analytica_Cloud_Platform]]
 +
{{ReleaseBar}}
  
−
The [[Analytica Cloud Player]] (ACP) offers a variety of user-interface styles and features useful for web applications, and not available in desktop Analytica. These include navigation styles with tabs across the top or down the left side, node styles, and Frame nodes to show tables and graphs embedded in a Diagram. The '''ACP Style Library''' helps you select these user-interface styles and options in Analytica on the desktop. You could specify these styles by setting flags and codes in the  [[CloudPlayerStyles]] attributes of the model. But it's much easier just to use the ACP Style library. That way you don't have to learn these special codes.
+
The [[Analytica Cloud Platform]] (ACP) offers a variety of user-interface styles useful for web applications that aren't available in desktop Analytica. These include navigation styles with tabs across the top or down the left side, node styles, and Frame nodes and Tall nodes that embed tables and graphs in a Diagram. The '''ACP Style Library''' makes it much easier to select and explore these styles than setting special codes in the  [[AcpStyles]] attributes of the model.   {{Release||6.1|You use the library from inside ACP and see their effects.  }}{{Release||5.4| You can then select options in the library in desktop Analytica which shows previews of their effects in ACP.
  
 +
You can see a video of the ACP Style library in use in the [https://youtu.be/OH3mYa_m0xE Analytica Cloud Player (ACP) Webinar]. }} 
  
−
You can see a video of the ACP Style library in use in the [https://youtu.be/OH3mYa_m0xE Analytica Cloud Player (ACP) Webinar].
+
<iframe width="560" height="315" src="https://www.youtube.com/embed/uUAk4TwrOAw" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
  
−
=== How to install the ACP Style library ===
+
===To use the ACP Style library===
−
-
 
  
−
The simplest way to add the ACP Style library is to load it from the standard Analytica libraries:
+
The easiest way to use the ACP Style library is from inside ACP. Start the model in ACP and from the Hamburger menu on the top right, select '''ACP Style library'''
  
−
You can also download the latest version of the ACP style library from here: [[Media:ACP style library.ana]], which includes some more recent [[What's new in ACP?|enhancements to ACP]].
+
[[File:ACP Styles hamburger01.png|780px|border]]
  
 +
(You can also [[ACP Style Library#Install the ACP Style library in Desktop Analytica]] as described below, although it's rare you would need to do that.)
 +
 +
=== When loading the ACP Style library into your model ===
 +
 +
If the model contains no previous  [[AcpStyles#Model_level_styles|model level AcpStyle settings]], it shows this dialog:
 +
[[File:ACP Style library question01.png]]
 +
 +
Answer:
 +
* '''Yes''': To use the standard [[AcpStyles#Navigation_style|default settings]]-- outline style, tool tabs, no shadow on nodes
 +
* '''No''': To use the  [[AcpStyles#Tabbed_Module_Navigation|recommended settings]] -- top tabs, shadowed nodes.
 +
Either way, you can modify all the settings afterwards.
 +
 +
If your model already contains one or more [[AcpStyles#Model_level_styles|model level AcpStyles]], which is likely if you used the ACP Style library before, it shows a slightly different dialog.  You will be prompted to either change to the recommended defaults, or to keep the AcpStyles already present in the model.
 +
[[File:ACP Style library question02.png]]
 +
 +
Answer:
 +
* '''Yes''': To retain its existing settings
 +
* '''No''': To use the  [[AcpStyles#Tabbed_Module_Navigation|recommended settings]] -- top tabs, shadowed nodes.
 +
** Again, you can modify all the settings afterwards.
 +
** If you choose to retain existing settings, it will ask you to confirm...<br />
 +
[[File:ACP Style library question03.png]]<br />
 +
If you answer yes, the Acp style library will reflect the existing settings. styles -- e.g. if your model contains the AcpStyle <code>show_description:10</code>, the relevant choice menu in the Acp style library will reflect this.
 +
 +
=== How to set ACP styles  ===
 +
 +
After loading the ACP Style library, it will look like this:
 +
[[File:ACP Style library w Preview result styles.png|780px|border]]
 +
 +
You can see what each input does in the usual way: Move the mouse cursor over any input control to see a tooltip balloon explaining what it does.
 +
 +
Or, even simpler, you can just modify an input --(un)check a box or select from a menu-- to see its effect immediately.  The default styles for tables and graphs show in the "Preview result" just to the right. Some options and icons, like the "Fly-in" option for Index menus, only appear when you move your cursor over '''Preview styles for results'''.
 +
 +
===Make the ACP Style library ready for Import into another model===
 +
 +
More details coming soon....
 +
 +
=== Install the ACP Style library in Desktop Analytica ===
 +
 +
Instead of loading the ACP style library from inside ACP, you can add it to your model in Desktop Analytica before uploading to ACP. You may rarely find a reason to do that.  The ACP Style library is included as a standard Analytica library, but we recommend using '''the most recent ACP Style library version which you can download here: [[Media:ACP_style_library.ana|ACP style library.ana]],''' since there have been major enhancements recently.'''
 +
 +
After downloading the library into a folder, you can read it into your model:
 
# Make sure you are in edit mode.  
 
# Make sure you are in edit mode.  
 
# Click [[File menu]] > '''Add Library...'''
 
# Click [[File menu]] > '''Add Library...'''
−
# The file explorer lists the standard Libraries installed. Select '''ACP Style Library.ANA''' and click '''Open''':
+
# Select '''ACP Styles.ana''' from the folder into which you saved the file and click '''Open''
 +
The 'ACP Styles library' will appear in the diagram:
 +
 
 +
{{Release||5.4|:[[File:Add styles library01.PNG]]}}
 +
{{Release|6.0||:[[File:Reading ACP Style library into a model in desktop Analytica.png|780px|border]]
 +
 
 +
Once you've imported the ACP Styles library into your model, you can use it to set ACP styles in desktop Analytica.
 +
But, it's better to do in in ACP so you can immediately see the effects of each setting.
 +
}}
 +
{{Release|6.0||
 +
=== Upload your model into ACP ===
 +
If you have imported the ACP Styles library into your model in Desktop Analytica, you can use it to set ACP styles in desktop Analytica.
 +
But, it's better to do in in ACP so you can immediately see the effects of each setting.
 +
 
 +
If you have an ACP account, you can upload your model into ACP from inside Analytica on the desktop:
 +
* From the '''File''' menu, select '''[[Publish_To_Cloud_dialog|Publish to cloud..]]'''.
  
−
:[[File:Add library01.PNG]]
+
Otherwise, you can upload your model from inside ACP"
 +
# Start up ACP from [https://acp.analytica.com/ https://acp.analytica.com/].
 +
# Sign in (or [sign up if you don't yet have an ACP account). [[Analytica_Cloud_Platform#How_to_use_ACP|more..]].
 +
# When you see the '''Models''' tab, click the '''Upload''' button.
 +
# Follow the file browser prompts to upload your model into ACP
 +
# Click the name of your uploaded model to start it up in ACP.
  
−
It adds the 'ACP Style library' to the diagram:
+
}}
 +
<!--As distributed, the ACP style library has been [[ACP_Style_Library#Make_the_Acp_Style_library_ready_for_Import_into_another_model|made ready for import]] - it will set some Acp Styles automatically in your model (after prompting you to accept or decline) . This is to simplify the task of preparing the model.
 +
*Once the style library is imported into a model, it is no longer "''ready for import''" , and it will not automatically apply Acp styles (unless you [[ACP_Style_Library#Make_the_Acp_Style_library_ready_for_Import_into_another_model|make it ready]] and save it, or use a fresh copy).-->
  
−
:[[File:Add styles library01.PNG]]
+
{{Release||5.4|
  
 
=== How to use the ACP Style library ===
 
=== How to use the ACP Style library ===
Line 38: Line 102:
 
You use the '''ACP Style library''' to set styles in Analytica on the desktop, but you can only see their effect in ACP. (The ACP Style library does show some examples of what the styles look like.)  After setting some ACP styles, you can see their full effect by uploading your model into ACP. You can do this quickly by selecting '''Publish to cloud...''' from the '''File''' menu. It lets you upload and run the model in your free individual ACP account, or in an [[ACP Group Accounts|ACP Group account]] if you have one.   
 
You use the '''ACP Style library''' to set styles in Analytica on the desktop, but you can only see their effect in ACP. (The ACP Style library does show some examples of what the styles look like.)  After setting some ACP styles, you can see their full effect by uploading your model into ACP. You can do this quickly by selecting '''Publish to cloud...''' from the '''File''' menu. It lets you upload and run the model in your free individual ACP account, or in an [[ACP Group Accounts|ACP Group account]] if you have one.   
  
−
The library is invisible in ACP. Once you have selected the ACP styles you want, you can delete the ACP Styles Library from your model. Your selections  model will remain. Tthe library file size is over 1 MB, so removing it from your model saves a little time when uploading and running the model in ACP.
+
The library is invisible in ACP. Once you have selected the ACP styles you want, you can delete the ACP Styles Library from your model. Your selections  model will remain. The library file size is over 1 MB, so removing it from your model saves a little time when uploading and running the model in ACP.
  
 
==Navigation styles==
 
==Navigation styles==
Line 58: Line 122:
 
:[[File:Outline01.png]]
 
:[[File:Outline01.png]]
  
−
* '''Top diagram only''': Shows in ACP as a single diagram, with no Outline or hierarchy or tabs. This is useful when creating a simple Web application with a single UI, and no need for any navigation.  Prevents opening other diagrams with the '''[https://wiki.analytica.com/index.php?title=CloudPlayerStyles_Attribute_Values#Display_Only_a_Single_Diagram top_diagram_only:yes]'''. flag You need to arrange, and size the diagram to display what you want users to see in ACP.
+
* '''Top diagram only''': Shows in ACP as a single diagram, with no Outline or hierarchy or tabs. This is useful when creating a simple Web application with a single UI, and no need for any navigation.  Prevents opening other diagrams with the [[AcpStyles#Top Diagram Only]]. flag You need to arrange, and size the diagram to display what you want users to see in ACP.
  
 
'''Tabbed Navigation''' styles:  These show the main modules in your top model as tabs  (ordered left to right then top to bottom). It is most useful for creating a web application for  people  not familiar with Analytica. It works best when you create a few modules at the top level with user inputs and outputs, showing input tables and result tables and charts in [[#Frame nodes]]. The Navigation style menu offers these options:
 
'''Tabbed Navigation''' styles:  These show the main modules in your top model as tabs  (ordered left to right then top to bottom). It is most useful for creating a web application for  people  not familiar with Analytica. It works best when you create a few modules at the top level with user inputs and outputs, showing input tables and result tables and charts in [[#Frame nodes]]. The Navigation style menu offers these options:
Line 82: Line 146:
 
''These next two checkboxes are unusable - and so are hidden - when you have not selected a tabbed Navigation style.''
 
''These next two checkboxes are unusable - and so are hidden - when you have not selected a tabbed Navigation style.''
  
−
*'''Include top level diagram as tab:''' Can be used only with 'Side tabs' or 'Top tabs'. You may check this checkbox to include the top model diagram as the leftmost tab for "Side tabs", or top tab for "Top tabs". If you uncheck this checkbox, the top diagram will not display in ACP, so you include the key user interface pages as modules in the main model. Currently for 2 level tabs it is required to exclude the top diagram from the tabs, so this checkbox is hidden.  [[CloudPlayerStyles_Attribute_Values#Exclude_the_top_level_diagram_from_tabs| More...]]
+
*'''Include top level diagram as tab:''' Can be used only with 'Side tabs' or 'Top tabs'. You may check this checkbox to include the top model diagram as the leftmost tab for "Side tabs", or top tab for "Top tabs". If you uncheck this checkbox, the top diagram will not display in ACP, so you include the key user interface pages as modules in the main model. Currently for 2 level tabs it is required to exclude the top diagram from the tabs, so this checkbox is hidden.  [[AcpStyles#Exclude_the_top_level_diagram_from_tabs| More...]]
  
 
:[[File:Show as tab01.png]]
 
:[[File:Show as tab01.png]]
Line 107: Line 171:
  
 
====Parent button====
 
====Parent button====
−
Flag to control the display of the '''Go into Parent''' button. Currently the button is shown by default with Outline style. The checkbox is hidden in other styles. It is possible to display this button with top tabs, but not by using the styles library, since there are some model specific settings involved. [[CloudPlayerStyles_Attribute_Values#Go_into_Parent_Button Not compatible with Side tabs. | More...]]
+
Flag to control the display of the '''Go into Parent''' button. Currently the button is shown by default with Outline style. The checkbox is hidden in other styles. It is possible to display this button with top tabs, but not by using the styles library, since there are some model specific settings involved. [[AcpStyles#Go_into_Parent_Button Not compatible with Side tabs. | More...]]
  
 
:[[File:Styles library 17.png]]
 
:[[File:Styles library 17.png]]
Line 271: Line 335:
  
 
Click '''Done''' when your settings are complete.
 
Click '''Done''' when your settings are complete.
 +
}}
  
 
==See Also==
 
==See Also==
 
* [[Media:ACP style library.ana|ACP style library.ana]]
 
* [[Media:ACP style library.ana|ACP style library.ana]]
−
* [[CloudPlayerStyles Attribute Values|CloudPlayerStyles attribute]]
+
* [[AcpStyles]]
−
* [https://youtu.be/OH3mYa_m0xE Analytica Cloud Player (ACP) Webinar]
+
{{Release||5.4| * [https://youtu.be/OH3mYa_m0xE Analytica Cloud Player (ACP) Webinar] }}
−
* [[Analytica Cloud Player]]
+
* [[Analytica Cloud Platform]]

Latest revision as of 10:40, 4 December 2024



Release:

4.6  •  5.0  •  5.1  •  5.2  •  5.3  •  5.4  •  6.0  •  6.1  •  6.2  •  6.3  •  6.4  •  6.5


The Analytica Cloud Platform (ACP) offers a variety of user-interface styles useful for web applications that aren't available in desktop Analytica. These include navigation styles with tabs across the top or down the left side, node styles, and Frame nodes and Tall nodes that embed tables and graphs in a Diagram. The ACP Style Library makes it much easier to select and explore these styles than setting special codes in the AcpStyles attributes of the model.

To use the ACP Style library

The easiest way to use the ACP Style library is from inside ACP. Start the model in ACP and from the Hamburger menu on the top right, select ACP Style library

ACP Styles hamburger01.png

(You can also ACP Style Library#Install the ACP Style library in Desktop Analytica as described below, although it's rare you would need to do that.)

When loading the ACP Style library into your model

If the model contains no previous model level AcpStyle settings, it shows this dialog: ACP Style library question01.png

Answer:

Either way, you can modify all the settings afterwards.

If your model already contains one or more model level AcpStyles, which is likely if you used the ACP Style library before, it shows a slightly different dialog. You will be prompted to either change to the recommended defaults, or to keep the AcpStyles already present in the model. ACP Style library question02.png

Answer:

  • Yes: To retain its existing settings
  • No: To use the recommended settings -- top tabs, shadowed nodes.
    • Again, you can modify all the settings afterwards.
    • If you choose to retain existing settings, it will ask you to confirm...

ACP Style library question03.png
If you answer yes, the Acp style library will reflect the existing settings. styles -- e.g. if your model contains the AcpStyle show_description:10, the relevant choice menu in the Acp style library will reflect this.

How to set ACP styles

After loading the ACP Style library, it will look like this: ACP Style library w Preview result styles.png

You can see what each input does in the usual way: Move the mouse cursor over any input control to see a tooltip balloon explaining what it does.

Or, even simpler, you can just modify an input --(un)check a box or select from a menu-- to see its effect immediately. The default styles for tables and graphs show in the "Preview result" just to the right. Some options and icons, like the "Fly-in" option for Index menus, only appear when you move your cursor over Preview styles for results.

Make the ACP Style library ready for Import into another model

More details coming soon....

Install the ACP Style library in Desktop Analytica

Instead of loading the ACP style library from inside ACP, you can add it to your model in Desktop Analytica before uploading to ACP. You may rarely find a reason to do that. The ACP Style library is included as a standard Analytica library, but we recommend using the most recent ACP Style library version which you can download here: ACP style library.ana, since there have been major enhancements recently.

After downloading the library into a folder, you can read it into your model:

  1. Make sure you are in edit mode.
  2. Click File menu > Add Library...
  3. Select ACP Styles.ana' from the folder into which you saved the file and click Open

The 'ACP Styles library' will appear in the diagram:


Reading ACP Style library into a model in desktop Analytica.png

Once you've imported the ACP Styles library into your model, you can use it to set ACP styles in desktop Analytica. But, it's better to do in in ACP so you can immediately see the effects of each setting.

Upload your model into ACP

If you have imported the ACP Styles library into your model in Desktop Analytica, you can use it to set ACP styles in desktop Analytica. But, it's better to do in in ACP so you can immediately see the effects of each setting.

If you have an ACP account, you can upload your model into ACP from inside Analytica on the desktop:

Otherwise, you can upload your model from inside ACP"

  1. Start up ACP from https://acp.analytica.com/.
  2. Sign in (or [sign up if you don't yet have an ACP account). more...
  3. When you see the Models tab, click the Upload button.
  4. Follow the file browser prompts to upload your model into ACP
  5. Click the name of your uploaded model to start it up in ACP.


See Also

Comments


You are not allowed to post comments.