Differences

This shows you the differences between two versions of the page.

--- desktop:desktop_chart_scripting_walkthrough [2022/01/07 13:25] – rob
+++ desktop:desktop_chart_scripting_walkthrough [2023/09/21 19:58] (current) – external edit 127.0.0.1
@@ Line 22: / Line 22: @@
 If you do not want to write your script from scratch, but rather start with a pre-defined template you may select a template from the list. Templates are fully functional scripts that you take and modify to suit your needs.
-Image
+{{:desktop:wlkthr_4.jpg|Image}}
 The fields on this window are described as follows:
-Create Study Window Fields
+----
-Field	Description
-Type	Select whether the script will be an overlay or an indicator study. This cannot be changed after the study is created.
-Name	A name for the study.
+<datatables>
-Short Name	A short name for the study (e.g. SMA, BB, VOL, etc)
+^ Create Study Window Fields ^^
-Category	Determines where this new study will appear in the list of studies in the Add Study window.
+^ Field ^ Description ^
-Description	A description of the study and what is does.
+| Type | Select whether the script will be an overlay or an indicator study. This cannot be changed after the study is created. |
-Template	Pre-defined full functional study templates that you can select from so that you don't have to start from scratch.
+| Name | A name for the study.|
-Preview	A preview of the selected study template.
+| Short Name | A short name for the study (e.g. SMA, BB, VOL, etc) |
+| Category | Determines where this new study will appear in the list of studies in the Add Study window. |
+| Description| A description of the study and what is does. |
+| Template | Pre-defined full functional study templates that you can select from so that you don't have to start from scratch. |
+| Preview  | A preview of the selected study template.|
+</datatables>
+----
 Once you have completed setting up your study, click the Create button to have the study created and added to the list of available studies.
@@ Line 40: / Line 48: @@
 The Add Study will change back to display the list a available studies. The new study you just created will be automatically selected.
-Image
+{{:desktop:wlkthr_5.jpg|Image}}
 Simply click the Add button to add the study to your chart.
@@ Line 48: / Line 56: @@
 Custom script-based studies appear in blue.
-Image
+{{:desktop:wlkthr_6.jpg|Image}}
 Right-clicking a custom study opens a context menu with additional actions you can take on these studies:
-Image
+{{:desktop:wlkthr_7.jpg|Image}}
-Custom Study Context Menu
-Menu Item	Description
-Edit Script	Open the script editor to allow you to immediately start editing the script. The study will be added to the chart if it is not already there.
-Export Script	Exports the script to a file. This allows you to share the script with someone else.
-Copy Script	Simply creates a copy of the study.
-Delete Script	Deletes the study permanently. The study will get removed from all charts that are using it.
-Additionally, the Add Study window has an import button. Use this feature to import scripts that you saved off, or sent to you by someone else. Important: in order to do this you need to be enabled for the Advanced Data Package
+----
+<datatables>
+^ Custom Study Context Menu^^
+^ Menu Item ^ Description^
+| Edit Script | Open the script editor to allow you to immediately start editing the script. The study will be added to the chart if it is not already there.|
+| Export Script| Exports the script to a file. This allows you to share the script with someone else. |
+| Copy Script | Simply creates a copy of the study.|
+| Delete Script | Deletes the study permanently. The study will get removed from all charts that are using it.|
+</datatables>
-Image
+----
+Additionally, the Add Study window has an import button. Use this feature to import scripts that you saved off, or sent to you by someone else. Important: in order to do this you need to be enabled for the Advanced Data Package
-	To install the script, save the .XML file you created to your computer (Desktop or some other temporary location).
+{{:desktop:wlkthr_8.jpg|Image}}
-	Next, open the Add Study window from any chart.
+  - To install the script, save the .XML file you created to your computer (Desktop or some other temporary location).
-	Click the Import Custom Study button and select the .XML file you saved to your computer.
+  - Next, open the Add Study window from any chart.
-	A new study called will appear at the bottom of the study list. Double-click it to add to your chart.
+  - Click the Import Custom Study button and select the .XML file you saved to your computer.
-	Once imported, this study will travel with your saved settings, so there is no need to hold onto the .XML file you saved to your computer… you can delete it.
+  - A new study called will appear at the bottom of the study list. Double-click it to add to your chart.
+  - Once imported, this study will travel with your saved settings, so there is no need to hold onto the .XML file you saved to your computer… you can delete it.