+1 888 340 6572

Working with Studies: Difference between revisions

From MultiCharts
No edit summary
(6 intermediate revisions by the same user not shown)
Line 1: Line 1:
<br>
Studies can be added, formatted, removed, and customized.  
Studies can be added, formatted, removed, and customized.  


Line 9: Line 8:
Audio, visual and E-mail alerts can be enabled.  
Audio, visual and E-mail alerts can be enabled.  


<br>
== Adding Studies ==  
== Adding Studies ==  
 
To add a study to the Scanner window:
# Open the Insert Study window.
# Open the '''Insert Study''' window.
#* Press the '''F7''' button, or
#* Press the '''F7''' button.
#* Select '''Insert''' in the main menu and select '''Study''', or
#* Select '''Insert''' in the main menu and select '''Study'''.
#* Right-click on any cell in the Scanner window and select '''Insert Study'''.
#* Right-click on any cell in the Scanner window and select '''Insert Study'''.
# Select either an individual study or multiple studies.  To select multiple studies, hold down the CTRL button and select each study.
# Select either an individual study or multiple studies.  To select multiple studies, hold down the '''Ctrl''' button and select each study.


A study's color is defined in its PowerLanguage Script.  
<br>A study's color is defined in its PowerLanguage Script.  


To edit the colors, use the reserved words [[SetPlotColor]] and [[SetPlotBGColor]].
To edit the colors, use the reserved words [[SetPlotColor]] and [[SetPlotBGColor]].
<br>


== Formatting Studies ==  
== Formatting Studies ==  
Line 28: Line 24:
To format a study:  
To format a study:  


* Double-click on the symbol's cell in the study's column, or
* Double-click on the symbol's cell in the study's column.
* Right-click on the symbol's cell in the study's column.  Select '''Format Study'''.
* Right-click on the symbol's cell in the study's column.  Select '''Format Study'''.


<br>
<br>The Format Study dialog window will appear.  If a study has two or more plots, then formatting will be applied to all the plots for that particular study.
The Format Study dialog window will appear.  If a study has two or more plots, then formatting will be applied  
to all the plots for that particular study.


<br>
=== Setting Inputs Values ===
=== Setting Inputs Values ===


An Input is a constant used in the study's calculations.  Studies can have one or more inputs, or none at all.  Each input is assigned a name.
An Input is a constant used in the study's calculations.  Studies can have one or more inputs, or none at all.  Each input is assigned a name.


There are three types of inputs: Numeric, True/False, and String.  Studies can be modified by changing the input Values. Most, but not all, studies use input values.  
There are three types of inputs: '''Numeric''', '''True/False''', and '''String'''.  Studies can be modified by changing the input Values. Most, but not all, studies use input values.  


Learn more about [[Default_Study_Properties|Default Studies Inputs]].  
<div class="tip-no-title">Find more info about studies inputs on [[Default_Study_Properties|this page]].</div>


One of the main advantages of using inputs is that the study's logic can be changed by simply changing the input values.  Editing the study's code is not required. The inputs can be modified before and after the study has been inserted.  
One of the main advantages of using inputs is that the study's logic can be changed by simply changing the input values.  Editing the study's code is not required. The inputs can be modified before and after the study has been inserted.  
<br>


=== Setting the Symbol Properties ===
=== Setting the Symbol Properties ===
Line 52: Line 43:
Study properties can be different for all symbols in the Scanner window.  
Study properties can be different for all symbols in the Scanner window.  
Study properties include '''Number Format''' and '''Update On Every Tick''' sections.  
Study properties include '''Number Format''' and '''Update On Every Tick''' sections.  
To define the number of decimals to display for all the study plots of the specified symbol,


* Select '''Same as Symbol''' radio button to use the same number of decimals as the symbol, or
To define the number of decimals to display for all the study plots of the specified symbol:
 
* Select '''Same as Symbol''' radio button to use the same number of decimals as the symbol.
* Select '''Show''' radio button and enter the number of decimals.  
* Select '''Show''' radio button and enter the number of decimals.  


To recalculate study on every tick, select the '''Update On Every Tick''' check box.   
To recalculate study on every tick, select the '''Update On Every Tick''' check box.   


<div style="background-color: #E3FBE5;">Note: Even with this check box checked, updates are still limited to two updates in one second.</div>
<div class="note">Even with this check box checked, updates are still limited to two updates in one second.</div>
 
<div class="tip">To use these '''Properties''' settings for all new symbols, check '''Use as Default''' check box.</div>
<br><div style="background-color: #E3FBE5;">Note: If the '''Use as Default''' check box is selected, then the current''' Properties''' settings will be used for every newly added symbol.</div>


=== Enabling the Alerts ===
=== Enabling the Alerts ===
Line 67: Line 59:
Visual, audio, or e-mail alerts can be sent when market conditions meet the criteria specified in the study.  
Visual, audio, or e-mail alerts can be sent when market conditions meet the criteria specified in the study.  


To enable alerts,
To enable alerts:


# Select the '''Enable Alerts''' check box under the '''Alerts'''.
# Select the '''Enable Alerts''' check box under the '''Alerts'''.
# In the '''Alert Conditions Check''' section, select whether the alerts will be triggered '''On Bar Close''', '''Every Tick''' or '''Once per bar'''.
# In the '''Alert Conditions Check''' section, select whether the alerts will be triggered '''On Bar Close''', '''Every Tick''' or '''Once per bar'''.


<br>
==== Audio Alert ====
==== Audio Alert ====


To enable Audio alerts,
To enable Audio alerts:


# Select the '''Audio Alert''' check box.  
# Select the '''Audio Alert''' check box.  
# Select the '''Beep''' radio button for a standard beep sound, or select the '''Sound''' radio button to play a custom sound. If Sound is selected, select the .wav sound file.
# Select the .wav sound file in the '''File''' field. Ding.wav is selected by default.
# Press the '''Test''' button to test the sound.
# Press the '''Play''' button to test the sound.
# Select '''Play Once''' to play selected sound once or '''Repeat''' to play it continuously.  


<div style="background-color: #E3FBE5;">Note: The computer must be equipped with a Sound Card to support the '''Audio Alert''' function.</div>
<div class="note">Make sure that the sound is enabled on your PC so that the '''Audio Alert''' function works properly.</div>


==== Visual Alert ====
==== Visual Alert ====
Line 91: Line 81:
# In the '''Display Notify Window for''' drop-down list, select the period of time for the alert message to be displayed.
# In the '''Display Notify Window for''' drop-down list, select the period of time for the alert message to be displayed.


==== E-mail Alert ====
==== External Alerts ====


To enable E-mail alert:
To enable External Alerts click the '''Add''' button and select one of the external alert configurations.


# In the '''E-mail Alert''' section, select the '''E-mail Alert''' check box.
To add a new external alert configuration:
# Press the '''Settings''' button to access to the '''E-mail Alert''' settings window.
# Click the gear icon next to the '''Add''' button.
# Enter the email addresses of the sender.
# In the opened window configure the desired external alerts:
# Enter the email address of the recipient.  To send the email to multiple recipients, separate each email address with a semi-colon.
#* [[Using_Alerts#E-mail_Alert|E-mail]]
# Enter the '''SMTP Server Name or IP address''', and '''Port''' number into the textboxes.  Please get this information from your email provider.
#* [[Slack WebHooks|Slack]]
# Check the SMTP Server authentication data checkbox if your SMTP server requires authentication to send emails.  (Usually, if your email account requires a login and password, you need to check this box.)
#* [[Telegram]]
# Enter the '''User name''' and '''Password'''.  (This is usually your email login and password.)
# Press '''OK'''.
# Press the '''Test''' button to send a test email.<br>If the sending process has been successful a message will appear in the pop-up window: <br> [[File:err1.gif]] <br>If the sending process has been unsuccessful a message will appear in the pop-up window: <br>[[File:err2.gif]]
# Click the '''Add''' button and select the newly added alert configurations.
# Press '''OK''' to close the '''E-mail Alert''' window.
<br><div style="background-color: #E3FBE5;">'''Example of Email Alert Message'''<br>01.10.2008 17:48:50 (alert time and date) <br>Source: Bollinger Bands (study that triggered alert) <br>Symbol: ESZ8 (traded symbol name) <br>Resolution: 1 Tick Bar (resolution used) <br>Price: 1157.5000 (price value at the moment when defined conditions has been met) <br>Message: Price crossing over lower price band (Message carrying information about the study condition that has been met)</div>
<br><div style="background-color: #E3FBE5;">Note: To use these alert settings as the default for all new indicators, select '''Use as Default''' check box.</div>


<br>
<div class="tip">To use these alert settings as the default for all new indicators, select '''Use as Default''' check box.</div>


== Displaying Studies with Two or More Plots ==  
== Displaying Studies with Two or More Plots ==  


It is possible to hide/display plots of studies, in case a study has more than one plot.  To hide/display plots of a study,
It is possible to hide/display plots of studies, in case a study has more than one plot.  To hide/display plots of a study:


# Right-click on a cell in the study's column or on the study title.  
# Right-click on a cell in the study's column or on the study title.  
# Select '''Show Plots'''.  
# Select '''Show Plots'''.  
# Select or deselect the plots to be displayed/hidden.  
# Select or deselect the plots to be displayed/hidden.


<br>
== Formatting a Study for All Symbols ==  
== Formatting a Study for All Symbols ==  


Line 127: Line 113:
# Select '''Format 'Study Title' Study for All Symbols'''. The Format Study window will appear.
# Select '''Format 'Study Title' Study for All Symbols'''. The Format Study window will appear.


The settings for all existing studies will be changed.  However newly added symbols will not inherit these settings.
<br>The settings for all existing studies will be changed.  However newly added symbols will not inherit these settings.
 
Learn more about [[#Formatting Studies|Formatting Studies]].


<br>
<div class="tip-no-title">Find more info about Formatting Studies on [[#Formatting Studies|this page]].</div>


== Settings a Study Style in the Real-Time Market Scanner ==
== Settings a Study Style in the Real-Time Market Scanner ==
Line 139: Line 123:
To change the style of the plots:
To change the style of the plots:


# Right-click anywhere within the '''Study's''' column, excluding the header,
# Right-click anywhere within the '''Study's''' column, excluding the header.
# Select '''Format Study'''. The Format Study window will appear,
# Select '''Format Study'''. The Format Study window will appear.
# Turn to the '''Style Tab'''.  
# Turn to the '''Style Tab'''.  


Alignment types available:  
<br>Alignment types available:  
# Right,
* Right
# Center,
* Center
# Left.
* Left
 
Format types available:
# Same as instrument,
# Number,
# Currency,
# Percentage,
# Date,
# Time,
# Text.


<br>
<br>Format types available:
* Same as instrument
* Number
* Currency
* Percentage
* Date
* Time
* Text


== Removing Studies ==  
== Removing Studies ==  
Line 166: Line 148:
# Select '''Remove 'Study Title' Study'''.
# Select '''Remove 'Study Title' Study'''.


<br>
== Accessing Scripts ==  
== Accessing Scripts ==  



Revision as of 15:32, 3 July 2024

Studies can be added, formatted, removed, and customized.

A study script can be accessed directly from the Scanner.

It is possible to change settings for multiple studies at once.

Indicated plots of a study can be hidden or displayed when necessary. Audio, visual and E-mail alerts can be enabled.

Adding Studies

To add a study to the Scanner window:

  1. Open the Insert Study window.
    • Press the F7 button.
    • Select Insert in the main menu and select Study.
    • Right-click on any cell in the Scanner window and select Insert Study.
  2. Select either an individual study or multiple studies. To select multiple studies, hold down the Ctrl button and select each study.


A study's color is defined in its PowerLanguage Script.

To edit the colors, use the reserved words SetPlotColor and SetPlotBGColor.

Formatting Studies

To format a study:

  • Double-click on the symbol's cell in the study's column.
  • Right-click on the symbol's cell in the study's column. Select Format Study.


The Format Study dialog window will appear. If a study has two or more plots, then formatting will be applied to all the plots for that particular study.

Setting Inputs Values

An Input is a constant used in the study's calculations. Studies can have one or more inputs, or none at all. Each input is assigned a name.

There are three types of inputs: Numeric, True/False, and String. Studies can be modified by changing the input Values. Most, but not all, studies use input values.

Find more info about studies inputs on this page.

One of the main advantages of using inputs is that the study's logic can be changed by simply changing the input values. Editing the study's code is not required. The inputs can be modified before and after the study has been inserted.

Setting the Symbol Properties

Study properties can be different for all symbols in the Scanner window. Study properties include Number Format and Update On Every Tick sections.

To define the number of decimals to display for all the study plots of the specified symbol:

  • Select Same as Symbol radio button to use the same number of decimals as the symbol.
  • Select Show radio button and enter the number of decimals.


To recalculate study on every tick, select the Update On Every Tick check box.

Even with this check box checked, updates are still limited to two updates in one second.
To use these Properties settings for all new symbols, check Use as Default check box.

Enabling the Alerts

Visual, audio, or e-mail alerts can be sent when market conditions meet the criteria specified in the study.

To enable alerts:

  1. Select the Enable Alerts check box under the Alerts.
  2. In the Alert Conditions Check section, select whether the alerts will be triggered On Bar Close, Every Tick or Once per bar.

Audio Alert

To enable Audio alerts:

  1. Select the Audio Alert check box.
  2. Select the .wav sound file in the File field. Ding.wav is selected by default.
  3. Press the Play button to test the sound.
Make sure that the sound is enabled on your PC so that the Audio Alert function works properly.

Visual Alert

To enable Visual alert:

  1. Select the Visual Alert check box.
  2. In the Display Notify Window for drop-down list, select the period of time for the alert message to be displayed.

External Alerts

To enable External Alerts click the Add button and select one of the external alert configurations.

To add a new external alert configuration:

  1. Click the gear icon next to the Add button.
  2. In the opened window configure the desired external alerts:
  3. Press OK.
  4. Click the Add button and select the newly added alert configurations.
To use these alert settings as the default for all new indicators, select Use as Default check box.

Displaying Studies with Two or More Plots

It is possible to hide/display plots of studies, in case a study has more than one plot. To hide/display plots of a study:

  1. Right-click on a cell in the study's column or on the study title.
  2. Select Show Plots.
  3. Select or deselect the plots to be displayed/hidden.

Formatting a Study for All Symbols

Formatting a Study for All Symbols makes it possible to modify settings for all symbols at the same time.

To format a Study for all symbols:

  1. Right-click anywhere within the Study's column, excluding the header.
  2. Select Format 'Study Title' Study for All Symbols. The Format Study window will appear.


The settings for all existing studies will be changed. However newly added symbols will not inherit these settings.

Find more info about Formatting Studies on this page.

Settings a Study Style in the Real-Time Market Scanner

It is possible to change the style of the studies applied to the Real-Time Market Scanner. Color, Alignment, plot format and number of decimals can be changed.

To change the style of the plots:

  1. Right-click anywhere within the Study's column, excluding the header.
  2. Select Format Study. The Format Study window will appear.
  3. Turn to the Style Tab.


Alignment types available:

  • Right
  • Center
  • Left


Format types available:

  • Same as instrument
  • Number
  • Currency
  • Percentage
  • Date
  • Time
  • Text

Removing Studies

To remove a study:

  1. Right-click on any cell within the Study's column, excluding the header.
  2. Select Remove 'Study Title' Study.

Accessing Scripts

To access a script from a Scanner window:

  1. Right-click on any cell within the Study's column, excluding the header.
  2. Select Open 'Study Title' Script. A PowerLanguage Editor window will appear.
  3. Customize the study script in the PowerLanguage Editor.

Learn more about Working with Studies in PowerLanguage Editor.