Difference between revisions of "ACP Style Library"

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

(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:

Answer:

Yes: To use the standard default settings-- outline style, tool tabs, no shadow on nodes
No: To use the recommended settings -- top tabs, shadowed nodes.

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.

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...

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:

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:

Make sure you are in edit mode.
Click File menu > Add Library...
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:

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:

From the File menu, select Publish to cloud...

Otherwise, you can upload your model from inside ACP"

Start up ACP from https://acp.analytica.com/.
Sign in (or [sign up if you don't yet have an ACP account). 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.

@@ Line 1: / Line 1: @@
-[[Category: Analytica Cloud Player]]
+[[Category: Analytica_Cloud_Platform]]
 {{ReleaseBar}}
-The [[Analytica Cloud Platform]] (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.  Using the '''ACP Style Library''' makes it much easier to select these styles than setting special flags and codes in the  [[AcpStyles]] attributes of the model.   {{Release||6.1|You should first import this library into desktop Analytica.  }}{{Release||5.4| You can then select options in the library in desktop Analytica which shows previews of their effects in ACP.
+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]. }}
-{{Release||6.0| After uploading the model into ACP, you can open the library and select styles. You will see their effects immediately in the ACP model. }}
+<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>
 ===To use the ACP Style library===
-The recommended way to use the ACP Style library is to add it from the Options menu in the ACP GUI.
-*Prepare your model in Desktop Analytica,  adding any Frame nodes or Tall nodes you want [[Embed_table_or_graph_with_ACP|embedded]]  on your diagrams. Once you have uploaded your model to ACP, launch the model by clicking on it's link in the model listing.
-*You can add the Acp Style library by clicking on the Options menu on the top teal bar (3 horizontal lines) and selecting Acp Style library.
-[[File:ACP Styles hamburger01.png]]
-=== How to install 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'''
-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.'''
+[[File:ACP Styles hamburger01.png|780px|border]]
-<!--The simplest way to add the ACP Style library is to load it from the standard Analytica libraries:
+(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.)
-# Make sure you are in edit mode.
-# Click [[File menu]] > '''Add Library...'''
+=== When loading the ACP Style library into your model ===
-# Select '''ACP Styles.ANA'''  and click '''Open''-->
+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.'''
-<!--Alternatively, you can download the latest version of the ACP style library from here: [[Media:ACP style library.ana]]. This version may include some more recent [[What's new in ACP?|enhancements to ACP]]. -->After downloading the library into a folder, you can read it into your model:
+After downloading the library into a folder, you can read it into your model:
 # Make sure you are in edit mode.
 # Click [[File menu]] > '''Add Library...'''
@@ Line 30: / Line 61: @@
 {{Release||5.4|:[[File:Add styles library01.PNG]]}}
-{{Release|6.0||:[[File:Reading ACP Style library into a model in desktop Analytica.png]]
+{{Release|6.0||:[[File:Reading ACP Style library into a model in desktop Analytica.png|780px|border]]
-===What the ACP Style library does on model load===
-''In ACP3, the styles library has had some major changes. This explains one of the new features.''
-*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).
-*If you add the ACP Style library to a model which has no [[AcpStyles#Model_level_styles|model level AcpStyle]] attribute flags set, you will be asked to choose [[AcpStyles#Navigation_style|default settings]] (outline style) or [[AcpStyles#Tabbed_Module_Navigation|Recommended settings]] (Top tabs). The library will apply the styles to the model to display using the settings you accept.<br />
-[[File:ACP Style library question01.png]]
-*In contrast, when adding the ACP Style library to a model which already contains one or more [[AcpStyles#Model_level_styles|model level AcpStyles]], 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]]
-**If you choose to keep the AcpStyles already present in the model, you will be asked to confirm...<br />
-[[File:ACP Style library question03.png]]<br />
-then the Acp style library will change to reflect these styles - eg if your model contains the AcpStyle <code>show_description:10</code>, the relevant choice menu in the Acp style library would be set to reflect this.
+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.
-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.
@@ Line 65: / Line 81: @@
 # Click the name of your uploaded model to start it up in ACP.
-=== How to set ACP styles  ===
-The easiest way to see what each option does is just to select from the menu or (uncheck) the checkbox. ACP will immediately show the effect of the changed style. The Default styles for tables and graphs show in the "Preview result" just to the right. A few, like the "Fly-in" option for Index menus show the Pivot icon only when you move your cursor over the "Preview result".
-[[File:ACP Style library w Preview result styles.png|border]]
-You can also move your cursor over each control to see its description in a balloon, in the usual way.
-===Make the Acp Style library ready for Import into another model===
-More details coming soon....
 }}
+<!--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).-->
 {{Release||5.4|
@@ Line 95: / 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.
-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==