MotiveWave SDK

https://www.motivewave.com/sdk/javadoc/
Admin
MotiveWave SDK provides a set of APIs and tools for developers to extend and integrate with the...
Tokens:111,632
Snippets:1,843
Trust Score:9.8
Update:2 months ago
Show doc for...
Tokens:
Raw
### Guide Visual Configuration Methods

Source: https://www.motivewave.com/sdk/javadoc/com/motivewave/platform/sdk/common/desc/GuideDescriptor.html

Methods to configure the visual appearance of the guide, such as line color, width, and dash patterns.

```APIDOC
## Visual Configuration Methods

### Methods
- **setLineColor(Color c)** - Sets the default line color.
- **setWidth(float w)** - Sets the default line width.
- **setDash(float[] d)** - Sets the default dash settings (null for solid).
- **setLabelColor(Color c)** - Sets the default label color.
- **setTextColor(Color c)** - Sets the default text color.
```

--------------------------------

### getStartTime

Source: https://www.motivewave.com/sdk/javadoc/com/motivewave/platform/sdk/common/desc/TimeFrameDescriptor.html

Retrieves the start time.

```APIDOC
## Method: getStartTime()

### Description
Gets the start time value.

### Returns
- **int** - The start time.
```

--------------------------------

### getStartTime()

Source: https://www.motivewave.com/sdk/javadoc/com/motivewave/platform/sdk/draw/Line.html

Retrieves the start time of the line.

```APIDOC
## Method: getStartTime()

### Description
Returns the time of the starting location of the line.

### Returns
- **long** - The start time in milliseconds since 1970.
```

--------------------------------

### GuideDescriptor Methods

Source: https://www.motivewave.com/sdk/javadoc/com/motivewave/platform/sdk/common/desc/GuideDescriptor.html

Methods for retrieving and configuring guide properties such as colors, line width, and dash patterns.

```APIDOC
## Method Summary

- **getMinValue()** (double) - Gets the minimum value for the guide.
- **getMaxValue()** (double) - Gets the maximum value for the guide.
- **getStep()** (double) - Gets the step increment.
- **getLineColor() / setLineColor(Color c)** - Gets or sets the default line color.
- **getLabelColor() / setLabelColor(Color c)** - Gets or sets the default label color.
- **getTextColor() / setTextColor(Color c)** - Gets or sets the default text color.
- **getWidth() / setWidth(float w)** - Gets or sets the default line width.
- **getDash() / setDash(float[] d)** - Gets or sets the dash settings (null for solid).
```

--------------------------------

### setStart(long time, double value)

Source: https://www.motivewave.com/sdk/javadoc/com/motivewave/platform/sdk/draw/Line.html

Sets the starting point of the line using time and value.

```APIDOC
## Method: setStart(long time, double value)

### Description
Updates the starting location of the line.

### Parameters
- **time** (long) - Time as milliseconds since 1970.
- **value** (double) - The y-coordinate value.
```

--------------------------------

### getState()

Source: https://www.motivewave.com/sdk/javadoc/com/motivewave/platform/sdk/study/Study.html

Gets the current state of the strategy.

```APIDOC
### public final Enums.StrategyState getState()

Gets the current state of this strategy.

#### Returns
- **Enums.StrategyState** - Current state of this strategy
```

--------------------------------

### GuideInfo(double value, Color lineColor, Color labelColor, Color textColor, float width, float[] dash, boolean showLine, boolean showIndicator, boolean enabled)

Source: https://www.motivewave.com/sdk/javadoc/com/motivewave/platform/sdk/common/GuideInfo.html

Constructs a new GuideInfo object with specified line and label properties.

```APIDOC
## Constructor: GuideInfo

### Description
Initializes a new guide line configuration with specific visual attributes.

### Parameters
- **value** (double) - The price or study value for the guide.
- **lineColor** (Color) - The color of the guide line.
- **labelColor** (Color) - The background color for the label.
- **textColor** (Color) - The text color for the label.
- **width** (float) - The width of the guide line.
- **dash** (float[]) - The dash pattern for the line (null if solid).
- **showLine** (boolean) - Whether to display the line.
- **showIndicator** (boolean) - Whether to display the indicator label.
- **enabled** (boolean) - Whether the guide is enabled.
```

--------------------------------

### getStartOfWeek

Source: https://www.motivewave.com/sdk/javadoc/com/motivewave/platform/sdk/common/Instrument.html

Gets the start of the week (in millis since 1970) for the given time.

```java
long getStartOfWeek(long time, boolean rth)
```

--------------------------------

### Path Configuration Methods

Source: https://www.motivewave.com/sdk/javadoc/com/motivewave/platform/sdk/common/desc/PathDescriptor.html

Methods to get and set various attributes of the path, such as color, width, dash patterns, and point display settings.

```APIDOC
## Method: getColor() / setColor(Color c)
Gets or sets the default color of the path line and points.

## Method: getWidth() / setWidth(float w)
Gets or sets the default width of the path line.

## Method: getDash() / setDash(float[] dash)
Gets or sets the default dash pattern for the path line (null for solid).

## Method: isShowPoints() / setShowPoints(boolean b)
Indicates or sets whether the points of the path should be shown by default.

## Method: isShowPath() / setShowPath(boolean b)
Indicates or sets whether the path line should be shown by default.

## Method: getPointSize() / setPointSize(Enums.Size size)
Gets or sets the default size of the path points.

## Method: getPointType() / setPointType(Enums.PointType type)
Gets or sets the default type of point displayed for each value in the path.
```

--------------------------------

### Define replacement patterns and values

Source: https://www.motivewave.com/sdk/javadoc/com/motivewave/platform/sdk/common/Util.html

Example arrays for mapping search patterns to their corresponding replacement strings.

```java
String[] patterns = {"&", "\"", "<", ">"}; String[] replacements = {"&", "\"", "<", ">"};
```

--------------------------------

### getStartOfDay

Source: https://www.motivewave.com/sdk/javadoc/com/motivewave/platform/sdk/common/Instrument.html

Gets the start of the day (in millis since 1970) for the given day.

```java
long getStartOfDay(long time, boolean rth)
```

--------------------------------

### Box Configuration Methods

Source: https://www.motivewave.com/sdk/javadoc/com/motivewave/platform/sdk/draw/Box.html

Methods to get and set the properties of the box, including coordinates, colors, and stroke styles.

```APIDOC
## setStart(long time, double value)
## setEnd(long time, double value)
## getStartTime()
## getStartValue()
## getEndTime()
## getEndValue()
## setLineColor(Color color)
## getLineColor()
## setFillColor(Color color)
## getFillColor()
## setStroke(Stroke stroke)
## getStroke()

### Description
These methods allow for the dynamic configuration of the box's position and visual appearance. You can update the start and end points, as well as define the line color, fill color, and stroke style for the box.
```

--------------------------------

### getStartOfEveningSession

Source: https://www.motivewave.com/sdk/javadoc/com/motivewave/platform/sdk/common/Instrument.html

Gets the start of the evening session (in millis since 1970) for the given time.

```java
long getStartOfEveningSession(long time)
```

--------------------------------

### addQuickSettings(String... ids)

Source: https://www.motivewave.com/sdk/javadoc/com/motivewave/platform/sdk/common/desc/SettingsDescriptor.html

Adds settings to the Quick Settings list by their IDs.

```APIDOC
## void addQuickSettings(String... ids)

### Description
Retrieves the setting (if it exists) and adds it as a quick setting.
```

--------------------------------

### fromJson(String str, GuideInfo def)

Source: https://www.motivewave.com/sdk/javadoc/com/motivewave/platform/sdk/common/GuideInfo.html

Creates a GuideInfo object from a JSON string.

```APIDOC
## Method: fromJson

### Description
Static factory method to instantiate a GuideInfo object from a JSON representation.

### Parameters
- **str** (String) - The JSON string.
- **def** (GuideInfo) - Default GuideInfo object to use for missing values.

### Returns
- **GuideInfo** - The parsed GuideInfo instance.
```

--------------------------------

### getStartOfYear

Source: https://www.motivewave.com/sdk/javadoc/com/motivewave/platform/sdk/common/Instrument.html

Gets the start of the year (in millis since 1970) for the given time, with an option to specify regular or extended trading hours.

```Java
long getStartOfYear(long time, boolean rth)
```

--------------------------------

### getStartOfMonth

Source: https://www.motivewave.com/sdk/javadoc/com/motivewave/platform/sdk/common/Instrument.html

Gets the start of the month (in millis since 1970) for the given time, with an option to specify regular or extended trading hours.

```Java
long getStartOfMonth(long time, boolean rth)
```

--------------------------------

### getGuide

Source: https://www.motivewave.com/sdk/javadoc/com/motivewave/platform/sdk/common/SettingsBase.html

Retrieves the GuideInfo object associated with the specified ID.

```APIDOC
### public GuideInfo getGuide(String id)

Gets the GuideInfo object associated with the given id.

#### Parameters
- **id** (String) - The id of the guide.

#### Returns
- **GuideInfo** - The GuideInfo associated with the given id.
```

--------------------------------

### Line(Coordinate start, Coordinate end)

Source: https://www.motivewave.com/sdk/javadoc/com/motivewave/platform/sdk/draw/Line.html

Constructs a new Line object using start and end coordinates.

```APIDOC
## Constructor: Line(Coordinate start, Coordinate end)

### Description
Constructs a new line figure between two specified coordinates.

### Parameters
- **start** (Coordinate) - The starting location of the line.
- **end** (Coordinate) - The ending location of the line.
```

--------------------------------

### PriceBarInfo Constructors

Source: https://www.motivewave.com/sdk/javadoc/com/motivewave/platform/sdk/common/PriceBarInfo.html

Constructors for initializing a new PriceBarInfo instance with specific bar types, inputs, and display properties.

```APIDOC
## Constructor: PriceBarInfo(Enums.PriceBarType type, Enums.BarInput input, boolean enabled)

### Description
Initializes a new PriceBarInfo instance.

### Parameters
- **type** (Enums.PriceBarType) - The type of price bar.
- **input** (Enums.BarInput) - The bar input for displaying a bar or line chart.
- **enabled** (boolean) - True if this path should be displayed.

## Constructor: PriceBarInfo(Enums.PriceBarType type, Enums.BarInput input, Integer fixedWidth, boolean enabled)

### Description
Initializes a new PriceBarInfo instance with a fixed width.

### Parameters
- **type** (Enums.PriceBarType) - The type of price bar.
- **input** (Enums.BarInput) - The bar input for displaying a bar or line chart.
- **fixedWidth** (Integer) - Fixed width of the bar (null for auto width).
- **enabled** (boolean) - True if this path should be displayed.
```

--------------------------------

### GuideDescriptor Constructor

Source: https://www.motivewave.com/sdk/javadoc/com/motivewave/platform/sdk/common/desc/GuideDescriptor.html

Initializes a new instance of the GuideDescriptor class with specified configuration parameters.

```APIDOC
## GuideDescriptor(String name, String label, double value, double minValue, double maxValue, double step, boolean supportsDisable)

### Description
Constructs a new GuideDescriptor with the specified settings for a guide.

### Parameters
- **name** (String) - The name (key) of the setting.
- **label** (String) - The label displayed to the user.
- **value** (double) - The default y-value for the guide.
- **minValue** (double) - The minimum y-value for the guide.
- **maxValue** (double) - The maximum y-value for the guide.
- **step** (double) - The incremental step value.
- **supportsDisable** (boolean) - Indicates if the user can disable this setting.
```

--------------------------------

### getValue()

Source: https://www.motivewave.com/sdk/javadoc/com/motivewave/platform/sdk/common/GuideInfo.html

Retrieves the y-value where the guide is displayed.

```APIDOC
## Method: getValue

### Description
Returns the y-axis value (price or study value) where the guide line is positioned.

### Returns
- **double** - The y-value.
```

--------------------------------

### Settings Class Constructors

Source: https://www.motivewave.com/sdk/javadoc/com/motivewave/platform/sdk/common/Settings.html

Constructors for initializing a new Settings instance.

```APIDOC
### Constructor: Settings()
Creates a new instance of Settings.

### Constructor: Settings(SettingsDescriptor desc)
Creates a new instance of Settings using the provided SettingsDescriptor.
```

--------------------------------

### Marker Configuration Methods

Source: https://www.motivewave.com/sdk/javadoc/com/motivewave/platform/sdk/draw/Marker.html

Methods to get and set properties of the Marker, including colors, size, type, and text labels.

```APIDOC
## Marker Configuration Methods

### Methods
- **getType()** (Enums.MarkerType) - Gets the type of marker.
- **setType(Enums.MarkerType type)** (void) - Sets the type of marker.
- **getOutlineColor()** (Color) - Gets the outline color.
- **setOutlineColor(Color color)** (void) - Sets the outline color.
- **getFillColor()** (Color) - Gets the fill color.
- **setFillColor(Color color)** (void) - Sets the fill color.
- **getSize()** (Enums.Size) - Gets the marker size.
- **setSize(Enums.Size size)** (void) - Sets the marker size.
- **setPosition(Enums.Position position)** (void) - Sets the relative position of the marker.
- **setTextValue(String text)** (void) - Sets the text label value.
- **getText()** (Text) - Gets the text label.
- **getTextPosition()** (Enums.Position) - Gets the text label position.
- **setTextPosition(Enums.Position position)** (void) - Sets the text label position.
```

--------------------------------

### getSettings()

Source: https://www.motivewave.com/sdk/javadoc/com/motivewave/platform/sdk/common/desc/SettingsDescriptor.html

Retrieves all SettingDescriptor instances declared for the study.

```APIDOC
## List<SettingDescriptor> getSettings()

### Description
Gets all of the SettingDescriptor instances declared for this study.
```

--------------------------------

### getStartOfPrevWeek

Source: https://www.motivewave.com/sdk/javadoc/com/motivewave/platform/sdk/common/Util.html

Calculates the start time of the previous trading week based on the provided time, instrument, and trading hours setting.

```APIDOC
## public static long getStartOfPrevWeek(long time, Instrument instr, boolean rth)

### Description
Gets the start of the previous trading week.

### Parameters
- **time** (long) - time in milliseconds since 1970
- **instr** (Instrument) - instrument
- **rth** (boolean) - regular trading hours vs extended trading hours
```

--------------------------------

### getRuntimeDescriptor

Source: https://www.motivewave.com/sdk/javadoc/com/motivewave/platform/sdk/study/Study.html

Gets the runtime descriptor for the study.

```APIDOC
## RuntimeDescriptor getRuntimeDescriptor()

### Description
Gets the 'runtime' descriptor. This object describes the runtime characteristics of the study.

### Returns
- **RuntimeDescriptor** - The runtime descriptor.
```

--------------------------------

### isShowIndicator()

Source: https://www.motivewave.com/sdk/javadoc/com/motivewave/platform/sdk/common/GuideInfo.html

Checks if the indicator label is enabled for the guide.

```APIDOC
## Method: isShowIndicator

### Description
Determines if the indicator label should be rendered for this guide.

### Returns
- **boolean** - True if the indicator is shown, false otherwise.
```

--------------------------------

### PriceBarInfo Constructors

Source: https://www.motivewave.com/sdk/javadoc/com/motivewave/platform/sdk/common/PriceBarInfo.html

Constructors for initializing PriceBarInfo with various display settings such as bar type, colors, line styles, and tag configurations.

```APIDOC
## PriceBarInfo Constructors

### Description
Initializes a new instance of PriceBarInfo to configure the visual representation of price data.

### Signatures
- `public PriceBarInfo(Enums.PriceBarType type, Enums.BarInput input, Integer fixedWidth, Color lineColor, Color lineColor2, Enums.ColorPolicy colorPolicy, Double gradientCenter, float lineWidth, float[] lineDash, boolean enabled)`
- `public PriceBarInfo(Enums.PriceBarType type, Enums.BarInput input, Integer fixedWidth, Color lineColor, Color lineColor2, Enums.ColorPolicy colorPolicy, Double gradientCenter, float lineWidth, float[] lineDash, boolean enabled, boolean showTag, boolean showTagValue, String tag, Font font, Color tagTextColor, Color tagBgColor)`
- `public PriceBarInfo(Enums.PriceBarType type, Enums.BarInput input, Color c, Color c2, Color c3, Color c4, Enums.ColorPolicy colorPolicy, double gradientCenter, float strokeWidth, float[] dash, int maxPoints, boolean continuous, int barCenter, double fixedWidth, boolean showTag, boolean showTagValue, String tag, TextStyle tagStyle, boolean enabled)`
```

--------------------------------

### getLabel()

Source: https://www.motivewave.com/sdk/javadoc/com/motivewave/platform/sdk/study/Study.html

Gets the display label for the study plot.

```APIDOC
## getLabel(String plotName)

### Description
Gets the display label for the given plot including setting values.

### Parameters
- **plotName** (String) - Optional - Name of the study plot.

### Returns
- **String** - The display label.
```

--------------------------------

### getBaseCurrency

Source: https://www.motivewave.com/sdk/javadoc/com/motivewave/platform/sdk/order_mgmt/OrderContext.html

Gets the symbol for the base currency.

```Java
String getBaseCurrency()
Gets the symbol for the base currency. 

Returns:
    base currency
```

--------------------------------

### Study.initialize

Source: https://www.motivewave.com/sdk/javadoc/index-all.html

Initializes the design and runtime settings for a study.

```APIDOC
## void initialize(Defaults defaults)

### Description
This method is called by the platform to initialize the design and runtime settings for the study.

### Parameters
- **defaults** (Defaults) - The default configuration settings for the study.
```

--------------------------------

### Place Buy Orders - Multiple Overloads

Source: https://www.motivewave.com/sdk/javadoc/com/motivewave/platform/sdk/order_mgmt/OrderContext.html

Demonstrates various overloads for placing BUY orders at market price, specifying instrument and quantity, or just quantity for the current instrument.

```java
void buy(Instrument instr, int qty)
Convenience Method: Places a BUY order for the given instrument at market price. 

Parameters:
    `instr` - instrument     `qty` - number of shares/units to buy
```

```java
void buy(int qty)
Convenience Method: Places a BUY order for the current instrument at market price. 

Parameters:
    `qty` - number of shares/units to buy
```

```java
void buy(Instrument instr, float qty)
Convenience Method: Places a BUY order for the given instrument at market price. 

Parameters:
    `instr` - instrument     `qty` - number of shares/units to buy
```

```java
void buy(float qty)
Convenience Method: Places a BUY order for the current instrument at market price. 

Parameters:
    `qty` - number of shares/units to buy
```

--------------------------------

### getTime()

Source: https://www.motivewave.com/sdk/javadoc/com/motivewave/platform/sdk/draw/ColorRange.html

Gets the time associated with this color range.

```APIDOC
## Method: getTime()

### Description
Gets the time (in milliseconds since 1970) where this bar is displayed.

### Returns
- **long** - The time where this bar is displayed.
```

--------------------------------

### isEnterOnSessionStart() / setEnterOnSessionStart(boolean b)

Source: https://www.motivewave.com/sdk/javadoc/com/motivewave/platform/sdk/common/Settings.html

Manages whether the strategy should enter automatically when a trading session opens.

```APIDOC
## boolean isEnterOnSessionStart()

### Description
Determines if this strategy should enter automatically when a trading session opens.

### Returns
- **boolean** - true if this strategy should enter automatically when a trading session opens.

## void setEnterOnSessionStart(boolean b)

### Description
Sets the enter on session start attribute.

### Parameters
- **b** (boolean) - Required - true if enter on session start is enabled
```

--------------------------------

### getBackgroundColor()

Source: https://www.motivewave.com/sdk/javadoc/com/motivewave/platform/sdk/draw/ColorRange.html

Gets the background color for the color range.

```APIDOC
## Method: getBackgroundColor()

### Description
Gets the background color for the color range.

### Returns
- **Color** - The background color for the color range.
```

--------------------------------

### getSettings()

Source: https://www.motivewave.com/sdk/javadoc/com/motivewave/platform/sdk/study/Study.html

Retrieves the user-defined settings for the study.

```APIDOC
## getSettings()

### Description
Gets the user defined settings.

### Returns
- **Settings** - The user defined settings.
```

--------------------------------

### getValues()

Source: https://www.motivewave.com/sdk/javadoc/com/motivewave/platform/sdk/common/Settings.html

Gets the set of value keys in the settings.

```APIDOC
## getValues()

### Description
Retrieves the set of all value keys currently in the settings.

### Returns
- **Set<String>** - A set of value keys.
```

--------------------------------

### PathInfo Constructors

Source: https://www.motivewave.com/sdk/javadoc/com/motivewave/platform/sdk/common/PathInfo.html

The PathInfo class offers several constructors to initialize path display properties such as colors, shading, point styles, and bar rendering configurations.

```APIDOC
## PathInfo Constructors

### Description
Initializes a new instance of the PathInfo class with various configuration parameters for path rendering.

### Constructors

- **PathInfo(Color c, Color c2, Color c3, Color c4, Enums.ColorPolicy colorPolicy, Double gradientCenter, Enums.ShadeType shadeType, float width, float[] dash, int maxPoints, boolean allPoints, boolean enabled, boolean continuous, boolean showBars, int barCenter, Integer fixedWidth)**
- **PathInfo(Color c, Color c2, Enums.PointType pointType, Enums.Size pointSize, int maxPoints, boolean allPoints, boolean enabled, boolean continuous, boolean showBars, int barCenter, Integer fixedWidth)**
- **PathInfo(Color c, Color c2, Enums.ColorPolicy colorPolicy, Double gradientCenter, Enums.ShadeType shadeType, Enums.PointType pointType, Enums.Size pointSize, int maxPoints, boolean allPoints, boolean enabled, boolean continuous, boolean showBars, int barCenter, Integer fixedWidth)**
- **PathInfo(Color c, Color c2, Color c3, Color c4, Enums.ColorPolicy colorPolicy, Double gradientCenter, Enums.ShadeType shadeType, Enums.PointType pointType, Enums.Size pointSize, int maxPoints, boolean allPoints, boolean enabled, boolean continuous, boolean showBars, int barCenter, Integer fixedWidth)**

### Parameters
- **c** (Color) - Primary path color or upward trend color
- **c2** (Color) - Secondary path color or downward trend color
- **c3** (Color) - Tertiary path color
- **c4** (Color) - Quaternary path color
- **colorPolicy** (Enums.ColorPolicy) - Policy for applying colors
- **gradientCenter** (Double) - Center point for gradient
- **shadeType** (Enums.ShadeType) - Type of shading
- **width** (float) - Line width
- **dash** (float[]) - Dash style
- **pointType** (Enums.PointType) - Type of point to display
- **pointSize** (Enums.Size) - Size of points
- **maxPoints** (int) - Max points to display
- **allPoints** (boolean) - Whether to display all points
- **enabled** (boolean) - Whether path is enabled
- **continuous** (boolean) - Whether path is continuous
- **showBars** (boolean) - Whether to show as bars
- **barCenter** (int) - Center point for bars
- **fixedWidth** (Integer) - Fixed width for bars
```

--------------------------------

### getInstruments()

Source: https://www.motivewave.com/sdk/javadoc/com/motivewave/platform/sdk/common/Settings.html

Gets the set of all registered instrument ids.

```APIDOC
## getInstruments()

### Description
Retrieves the set of all registered instrument ids.

### Returns
- **Set<String>** - A set of all registered Instrument ids.
```

--------------------------------

### getOpen

Source: https://www.motivewave.com/sdk/javadoc/com/motivewave/platform/sdk/common/Instrument.html

Gets the daily open price.

```java
float getOpen()
```

--------------------------------

### createControl(SettingsBase settings, boolean readOnly)

Source: https://www.motivewave.com/sdk/javadoc/com/motivewave/platform/sdk/common/desc/SoundFileDesc.html

Creates the UI component that allows the user to select a sound file.

```APIDOC
## Method: createControl

### Description
Creates the JavaFX component that accepts user input for the sound file setting.

### Parameters
- **settings** (SettingsBase) - The settings object for the study.
- **readOnly** (boolean) - If true, the component will not accept user input.

### Returns
- **javafx.scene.Node** - The UI component for the setting.
```

--------------------------------

### ResizePoint Constructors

Source: https://www.motivewave.com/sdk/javadoc/com/motivewave/platform/sdk/draw/ResizePoint.html

Constructors for initializing a new ResizePoint instance.

```APIDOC
## ResizePoint(Enums.ResizeType type)

### Description
Constructs a new ResizePoint with the specified type.

## ResizePoint(Enums.ResizeType type, boolean absolute)

### Description
Constructs a new ResizePoint with the specified type and absolute positioning flag.
```

--------------------------------

### getLow

Source: https://www.motivewave.com/sdk/javadoc/com/motivewave/platform/sdk/common/Instrument.html

Gets the daily low price.

```java
float getLow()
```

--------------------------------

### getHigh

Source: https://www.motivewave.com/sdk/javadoc/com/motivewave/platform/sdk/common/Instrument.html

Gets the daily high price.

```java
float getHigh()
```

--------------------------------

### PathInfo(Enums.PathType, Color, Color, Color, Color, Enums.ColorPolicy, double, Enums.ShadeType, float, float[], Enums.PointType, Enums.Size, int, boolean, int, double, boolean, boolean, String, TextStyle, boolean)

Source: https://www.motivewave.com/sdk/javadoc/com/motivewave/platform/sdk/common/PathInfo.html

Constructor to create a new PathInfo instance for configuring path display properties.

```APIDOC
## PathInfo Constructor

### Description
Creates a new PathInfo object to define how lines and points are rendered for a path.

### Signature
`public PathInfo(Enums.PathType type, Color c, Color c2, Color c3, Color c4, Enums.ColorPolicy colorPolicy, double gradientCenter, Enums.ShadeType shadeType, float strokeWidth, float[] dash, Enums.PointType pointType, Enums.Size pointSize, int maxPoints, boolean continuous, int barCenter, double fixedWidth, boolean showTag, boolean showTagValue, String tag, TextStyle tagStyle, boolean enabled)`
```

--------------------------------

### onBeginDrag

Source: https://www.motivewave.com/sdk/javadoc/com/motivewave/platform/sdk/study/Study.html

Called when a user starts a drag operation on the study.

```APIDOC
## void onBeginDrag(Point2D p, int flags, DrawContext ctx)

### Description
This method is called when a user starts a drag operation on the study.

### Parameters
- **p** (Point2D) - Point where the drag operation started.
- **flags** (int) - Indicators of modifier keys pressed.
- **ctx** (DrawContext) - The draw context for the chart that is affected.
```

--------------------------------

### OrderContext.buy(Instrument, int)

Source: https://www.motivewave.com/sdk/javadoc/index-all.html

Places a BUY order for a specific instrument at market price using an integer quantity.

```APIDOC
## buy(Instrument, int)

### Description
Places a BUY order for the given instrument at market price.

### Parameters
- **instrument** (Instrument) - Required - The instrument to trade.
- **quantity** (int) - Required - The quantity to buy.
```

--------------------------------

### getGraphLocation/setGraphLocation

Source: https://www.motivewave.com/sdk/javadoc/com/motivewave/platform/sdk/draw/SinglePointFigure.html

Gets or sets the translated drawing location on the graph.

```APIDOC
## getGraphLocation()
### Returns
- **Point2D** - The graph location.

## setGraphLocation(Point2D location)
### Parameters
- **location** (Point2D) - The location to set.
```

--------------------------------

### PathInfo Constructors

Source: https://www.motivewave.com/sdk/javadoc/com/motivewave/platform/sdk/common/PathInfo.html

Constructors for initializing a PathInfo object with various display settings such as color, line width, dash style, and bar configuration.

```APIDOC
## PathInfo(Color color, boolean enabled)

### Description
Creates a new PathInfo instance with a specified color and enabled state.

## PathInfo()

### Description
Creates a default PathInfo instance.

## PathInfo(Color c, float width, float[] dash, boolean enabled, boolean continuous, boolean showBars, int barCenter, Integer fixedWidth)

### Description
Creates a path info for displaying a series of points connected by lines with specific styling and bar configuration.

### Parameters
- **c** (Color) - color of the path
- **width** (float) - width of line used to connect the path points
- **dash** (float[]) - dash style (null if solid line)
- **enabled** (boolean) - true if this path should be displayed
- **continuous** (boolean) - true if this path is continuous even with missing values
- **showBars** (boolean) - true if the path should be shown as bars
- **barCenter** (int) - center point for drawing bars
- **fixedWidth** (Integer) - fixed width of the bars
```

--------------------------------

### getLocation/setLocation

Source: https://www.motivewave.com/sdk/javadoc/com/motivewave/platform/sdk/draw/SinglePointFigure.html

Methods for getting and setting the coordinate location of the figure.

```APIDOC
## getLocation()
### Returns
- **Coordinate** - The location of the marker.

## setLocation(Coordinate coord)
### Parameters
- **coord** (Coordinate) - The coordinate for the location.

## setLocation(long time, double value)
### Parameters
- **time** (long) - Time in milliseconds.
- **value** (double) - Y axis value.
```

--------------------------------

### GuideDescriptor Constructor

Source: https://www.motivewave.com/sdk/javadoc/com/motivewave/platform/sdk/common/desc/GuideDescriptor.html

Initializes a new GuideDescriptor with specified parameters for name, label, value ranges, and support for disabling.

```APIDOC
## GuideDescriptor(String name, String label, double value, double minValue, double maxValue, double step, boolean supportsDisable)

### Description
Constructs a new guide descriptor for a study graph.

### Parameters
- **name** (String) - The internal name of the guide.
- **label** (String) - The display label for the guide.
- **value** (double) - The default value.
- **minValue** (double) - The minimum allowed value.
- **maxValue** (double) - The maximum allowed value.
- **step** (double) - The increment step.
- **supportsDisable** (boolean) - Whether the guide can be disabled by the user.
```

--------------------------------

### onBeginResize

Source: https://www.motivewave.com/sdk/javadoc/com/motivewave/platform/sdk/study/Study.html

Called when a user begins to move a resize point.

```APIDOC
## void onBeginResize(ResizePoint rp, DrawContext ctx)

### Description
This method is called when a user begins to move a resize point.

### Parameters
- **rp** (ResizePoint) - The resize point that is about to be moved.
- **ctx** (DrawContext) - The draw context for the chart that is affected.
```

--------------------------------

### getCashBalance

Source: https://www.motivewave.com/sdk/javadoc/com/motivewave/platform/sdk/order_mgmt/OrderContext.html

Gets the current cash balance for the account.

```Java
double getCashBalance()
Gets the current cash balance for the account. 

Returns:
    current cash balance for the account
```

--------------------------------

### getGradientCenter / setGradientCenter

Source: https://www.motivewave.com/sdk/javadoc/com/motivewave/platform/sdk/common/desc/PathDescriptor.html

Gets or sets the center point for the gradient.

```APIDOC
## Double getGradientCenter()

### Description
Gets the center point for the gradient (null if automatic).

### Returns
- **Double** - the center point for the gradient

## void setGradientCenter(Double center)

### Description
Sets the center point for the gradient (null if automatic).

### Parameters
- **center** (Double) - center point for the gradient
```

--------------------------------

### MAMethodInfo Constructors

Source: https://www.motivewave.com/sdk/javadoc/com/motivewave/platform/sdk/common/MAMethodInfo.html

Constructors for initializing a new MAMethodInfo instance.

```APIDOC
## MAMethodInfo(Enums.MAMethod value)
## MAMethodInfo(Enums.MAMethod value, boolean enabled)

### Description
Creates a new instance of MAMethodInfo with the specified method type and optional enabled state.
```

--------------------------------

### PathInfo(Color, Color, Color, Color, Enums.ColorPolicy, Double, Enums.ShadeType, float, float[], Enums.PointType, Enums.Size, int, boolean, boolean, boolean, boolean, int, Integer)

Source: https://www.motivewave.com/sdk/javadoc/com/motivewave/platform/sdk/common/PathInfo.html

Constructor to create a path info object for displaying lines and points with four-color support.

```APIDOC
## PathInfo(Color c, Color c2, Color c3, Color c4, Enums.ColorPolicy colorPolicy, Double gradientCenter, Enums.ShadeType shadeType, float width, float[] dash, Enums.PointType pointType, Enums.Size pointSize, int maxPoints, boolean allPoints, boolean enabled, boolean continuous, boolean showBars, int barCenter, Integer fixedWidth)

### Description
Creates a path info object for displaying the lines and points of a path with primary, secondary, tertiary, and quaternary color support.

### Parameters
- **c** (Color) - Primary color
- **c2** (Color) - Secondary color
- **c3** (Color) - Tertiary color
- **c4** (Color) - Quaternary color
- **colorPolicy** (Enums.ColorPolicy) - Policy for applying colors to the path
- **gradientCenter** (Double) - Center point for the gradient, null if automatic
- **shadeType** (Enums.ShadeType) - Type of shading for path
- **width** (float) - Width of the lines connecting the path points
- **dash** (float[]) - Dash style (null for solid line)
- **pointType** (Enums.PointType) - Type of point to display
- **pointSize** (Enums.Size) - Size of the points
- **maxPoints** (int) - Max points to display
- **allPoints** (boolean) - True if all points should be displayed
- **enabled** (boolean) - True if this path should be displayed
- **continuous** (boolean) - True if this path is continuous even with missing values
- **showBars** (boolean) - True if this path should be shown as bars
- **barCenter** (int) - Center point for drawing bars
- **fixedWidth** (Integer) - Fixed width for the bars
```

--------------------------------

### getPriority / setPriority

Source: https://www.motivewave.com/sdk/javadoc/com/motivewave/platform/sdk/common/desc/SignalDescriptor.html

Methods to get or set the priority of the signal.

```APIDOC
## Enums.Priority getPriority()
## void setPriority(Enums.Priority p)

### Description
Gets or sets the priority level for the signal.
```

--------------------------------

### OrderContext.buy(Instrument, float)

Source: https://www.motivewave.com/sdk/javadoc/index-all.html

Places a BUY order for a specific instrument at market price using a float quantity.

```APIDOC
## buy(Instrument, float)

### Description
Places a BUY order for the given instrument at market price.

### Parameters
- **instrument** (Instrument) - Required - The instrument to trade.
- **quantity** (float) - Required - The quantity to buy.
```

--------------------------------

### getTimeFrames()

Source: https://www.motivewave.com/sdk/javadoc/com/motivewave/platform/sdk/common/Settings.html

Gets the set of all registered time frame ids.

```APIDOC
## getTimeFrames()

### Description
Retrieves the set of all registered time frame ids.

### Returns
- **Set<String>** - A set of all registered TimeFrame ids.
```

--------------------------------

### FileInfo Constructors

Source: https://www.motivewave.com/sdk/javadoc/com/motivewave/platform/sdk/common/FileInfo.html

Constructors for initializing a new FileInfo object.

```APIDOC
## Constructors

### FileInfo()
Creates a new FileInfo instance.

### FileInfo(File value)
Creates a new FileInfo instance with the specified file.

### FileInfo(File value, boolean enabled)
Creates a new FileInfo instance with the specified file and enabled status.
```

--------------------------------

### getExitPoints()

Source: https://www.motivewave.com/sdk/javadoc/com/motivewave/platform/sdk/common/Settings.html

Gets the set of all registered Exit Point ids.

```APIDOC
## getExitPoints()

### Description
Retrieves the set of all registered Exit Point ids.

### Returns
- **Set<String>** - A set of all registered ExitPoint ids.
```

--------------------------------

### Configuration Methods

Source: https://www.motivewave.com/sdk/javadoc/com/motivewave/platform/sdk/common/desc/QuantityDescriptor.html

Methods to configure the constraints of the numeric input, including range and step increments.

```APIDOC
## Configuration Methods

### Methods
- **setMinValue(double min)**: Sets the minimum allowable value.
- **setMaxValue(double max)**: Sets the maximum allowable value.
- **setStep(double step)**: Sets the incremental step for the value.
- **getMinValue()**: Returns the current minimum value.
- **getMaxValue()**: Returns the current maximum value.
- **getStep()**: Returns the current step increment.
```

--------------------------------

### getBarSizes()

Source: https://www.motivewave.com/sdk/javadoc/com/motivewave/platform/sdk/common/Settings.html

Gets the set of all registered bar size ids.

```APIDOC
## getBarSizes()

### Description
Retrieves the set of all registered bar size ids.

### Returns
- **Set<String>** - A set of all registered BarSize ids.
```

--------------------------------

### getPreviousClose

Source: https://www.motivewave.com/sdk/javadoc/com/motivewave/platform/sdk/common/Instrument.html

Gets the closing price for the previous day.

```java
float getPreviousClose()
```

--------------------------------

### Utility Methods

Source: https://www.motivewave.com/sdk/javadoc/com/motivewave/platform/sdk/common/Settings.html

General utility methods for exporting or updating settings.

```APIDOC
## Map<String,Object> toJson()
Returns a map representation of the settings.

## void update(Settings settings)
Updates the information from the given object.
```

--------------------------------

### SettingsDescriptor()

Source: https://www.motivewave.com/sdk/javadoc/com/motivewave/platform/sdk/common/desc/SettingsDescriptor.html

Constructs a new SettingsDescriptor instance.

```APIDOC
## SettingsDescriptor()

### Description
Constructs a new SettingsDescriptor instance.
```

--------------------------------

### getBidSize

Source: https://www.motivewave.com/sdk/javadoc/com/motivewave/platform/sdk/common/Instrument.html

Gets the current bid size for this instrument.

```java
int getBidSize()
```

--------------------------------

### getAskSize

Source: https://www.motivewave.com/sdk/javadoc/com/motivewave/platform/sdk/common/Instrument.html

Gets the current ask size for this instrument.

```java
int getAskSize()
```

--------------------------------

### getLastSize

Source: https://www.motivewave.com/sdk/javadoc/com/motivewave/platform/sdk/common/Instrument.html

Gets the last traded size for this instrument.

```java
int getLastSize()
```

--------------------------------

### SettingDescriptor Methods

Source: https://www.motivewave.com/sdk/javadoc/com/motivewave/platform/sdk/common/desc/SettingDescriptor.html

Methods for managing setting metadata, default values, and UI display properties.

```APIDOC
## getLabel()
Gets the label for this setting (displayed to the user).

## getId()
Gets the id of this setting. This is used as the key to retrieve the setting from the settings.

## getDefaultValue()
Gets the default value for this setting.

## setDefaultValue(T value)
Sets the default value for this setting.

## isShowLabel()
Returns true if the label for this setting will be displayed to the user.

## setShowLabel(boolean b)
Sets the show label attribute for the setting.

## isSupportsDisable()
Returns true if this setting can be disabled by the user.

## setSupportsDisable(boolean b)
Sets whether this descriptor supports being disabled by the user.

## isEnabled()
Indicates if the setting is enabled.

## getGridWidth()
Gets the number of columns occupied by the input component.

## setGridWidth(int width)
Sets the number of columns occupied by the input component.
```

--------------------------------

### Place Sell Orders - Multiple Overloads

Source: https://www.motivewave.com/sdk/javadoc/com/motivewave/platform/sdk/order_mgmt/OrderContext.html

Demonstrates various overloads for placing SELL orders at market price, specifying instrument and quantity, or just quantity for the current instrument.

```java
void sell(Instrument instr, int qty)
Convenience Method: Places a SELL order for the given instrument at market price. 

Parameters:
    `instr` - instrument     `qty` - number of shares/units to sell
```

```java
void sell(int qty)
Convenience Method: Places a SELL order for the current instrument at market price. 

Parameters:
    `qty` - number of shares/units to sell
```

```java
void sell(Instrument instr, float qty)
Convenience Method: Places a SELL order for the given instrument at market price. 

Parameters:
    `instr` - instrument     `qty` - number of shares/units to sell
```

```java
void sell(float qty)
Convenience Method: Places a SELL order for the current instrument at market price. 

Parameters:
    `qty` - number of shares/units to sell
```

--------------------------------

### getSellPrice

Source: https://www.motivewave.com/sdk/javadoc/com/motivewave/platform/sdk/common/Instrument.html

Gets the current price to sell this instrument.

```java
float getSellPrice()
```

--------------------------------

### Menu(String text)

Source: https://www.motivewave.com/sdk/javadoc/com/motivewave/platform/sdk/common/menu/Menu.html

Constructor to create a sub-menu with a specific text label.

```APIDOC
## Menu(String text)

### Description
Creates a new sub-menu instance with the specified display text.

### Parameters
- **text** (String) - The label to display for the menu.
```

--------------------------------

### getBuyPrice

Source: https://www.motivewave.com/sdk/javadoc/com/motivewave/platform/sdk/common/Instrument.html

Gets the current price to buy this instrument.

```java
float getBuyPrice()
```

--------------------------------

### getAskPrice

Source: https://www.motivewave.com/sdk/javadoc/com/motivewave/platform/sdk/common/Instrument.html

Gets the current ask price for this instrument.

```java
float getAskPrice()
```

--------------------------------

### createTBInput(SettingsBase settings)

Source: https://www.motivewave.com/sdk/javadoc/com/motivewave/platform/sdk/common/desc/SettingDescriptor.html

Creates a JavaFX Node component that can be displayed in a tool bar for user input.

```APIDOC
### createTBInput

**Signature:** public javafx.scene.Node createTBInput(SettingsBase settings)

**Description:** Creates a version of the input that can be displayed in a tool bar.

**Parameters:**
- **settings** (SettingsBase) - Settings for the study.

**Returns:**
- (javafx.scene.Node) - Component that will accept user input.
```

--------------------------------

### SettingsBase Methods

Source: https://www.motivewave.com/sdk/javadoc/index-all.html

Methods for retrieving color settings from the SettingsBase class.

```APIDOC
## SettingsBase.getColor(String id)
### Description
Gets the color associated to the given id.

## SettingsBase.getColor(String id, Color defaultColor)
### Description
Gets the color associated to the given id.

## SettingsBase.getColorInfo(String id)
### Description
Gets the color info object associated to the given id.
```

--------------------------------

### getBidPrice

Source: https://www.motivewave.com/sdk/javadoc/com/motivewave/platform/sdk/common/Instrument.html

Gets the current bid price for this instrument.

```java
float getBidPrice()
```

--------------------------------

### LineInfo Constructors

Source: https://www.motivewave.com/sdk/javadoc/com/motivewave/platform/sdk/common/LineInfo.html

Constructors for initializing a LineInfo object with various configurations for color, width, dash style, and enabled status.

```APIDOC
## Constructors

- LineInfo()
- LineInfo(boolean enabled)
- LineInfo(float[] dash)
- LineInfo(Color lineColor)
- LineInfo(Color lineColor, boolean enabled)
- LineInfo(Color lineColor, float width, boolean enabled)
- LineInfo(double value, Color lineColor, float width, float[] dash)
- LineInfo(double value, Color lineColor, float width, float[] dash, boolean enabled)
- LineInfo(Color lineColor, float width, float[] dash, boolean enabled)
```

--------------------------------

### getLastPrice

Source: https://www.motivewave.com/sdk/javadoc/com/motivewave/platform/sdk/common/Instrument.html

Gets the last traded price for this instrument.

```java
float getLastPrice()
```

--------------------------------

### getTimeZone

Source: https://www.motivewave.com/sdk/javadoc/com/motivewave/platform/sdk/common/DataContext.html

Gets the time zone for the underlying chart.

```Java
TimeZone getTimeZone()
```

--------------------------------

### createLimitOrder (action, tif, qty, limitPrice)

Source: https://www.motivewave.com/sdk/javadoc/com/motivewave/platform/sdk/order_mgmt/OrderContext.html

Creates a new 'Limit' order.

```Java
Order createLimitOrder(Enums.OrderAction action, Enums.TIF tif, int qty, float limitPrice)
```

--------------------------------

### getTimeFrame(String id)

Source: https://www.motivewave.com/sdk/javadoc/com/motivewave/platform/sdk/common/Settings.html

Gets the timeframe associated with the given id.

```APIDOC
## getTimeFrame(String id)

### Description
Retrieves the TimeFrame associated with the given id.

### Parameters
- **id** (String) - The id of the timeframe.

### Returns
- **TimeFrame** - The TimeFrame associated with the given id.
```

--------------------------------

### createTBInput

Source: https://www.motivewave.com/sdk/javadoc/com/motivewave/platform/sdk/common/desc/PercentSliderDescriptor.html

Creates a compact version of the input for use in a toolbar.

```APIDOC
## javafx.scene.Node createTBInput(SettingsBase settings)

### Description
Generates a toolbar-compatible version of the input component.

### Parameters
- **settings** (SettingsBase) - The study settings object.
```

--------------------------------

### isSupportsBoth / setSupportsBoth

Source: https://www.motivewave.com/sdk/javadoc/com/motivewave/platform/sdk/common/desc/PathDescriptor.html

Indicates or sets if both path line and path points are supported at the same time.

```APIDOC
## boolean isSupportsBoth()

### Description
Indicates if both path line and path points are supported at the same time.

### Returns
- **boolean** - true if both the path line and path points are supported at the same time.

## void setSupportsBoth(boolean b)

### Description
Indicates if both the path line and path points are supported at the same time.

### Parameters
- **b** (boolean) - true if both the path line and path points are supported at the same time.
```

--------------------------------

### getMAMethods()

Source: https://www.motivewave.com/sdk/javadoc/com/motivewave/platform/sdk/common/Settings.html

Gets the set of all registered Moving Average Method ids.

```APIDOC
## getMAMethods()

### Description
Retrieves the set of all registered Moving Average Method ids.

### Returns
- **Set<String>** - A set of all registered MAMethod ids.
```

--------------------------------

### PathInfo(Color, Color, Enums.ColorPolicy, Double, Enums.ShadeType, float, float[], Enums.PointType, Enums.Size, int, boolean, boolean, boolean, boolean, int, Integer)

Source: https://www.motivewave.com/sdk/javadoc/com/motivewave/platform/sdk/common/PathInfo.html

Constructor to create a path info object for displaying lines and points with two-color support.

```APIDOC
## PathInfo(Color c, Color c2, Enums.ColorPolicy colorPolicy, Double gradientCenter, Enums.ShadeType shadeType, float width, float[] dash, Enums.PointType pointType, Enums.Size pointSize, int maxPoints, boolean allPoints, boolean enabled, boolean continuous, boolean showBars, int barCenter, Integer fixedWidth)

### Description
Creates a path info object for displaying the lines and points of a path with upward and downward trending colors.

### Parameters
- **c** (Color) - Color for lines trending upward
- **c2** (Color) - Color for lines trending downward
- **colorPolicy** (Enums.ColorPolicy) - Policy for applying colors to the path
- **gradientCenter** (Double) - Center point for the gradient, null if automatic
- **shadeType** (Enums.ShadeType) - Type of shading for path
- **width** (float) - Width of the lines connecting the path points
- **dash** (float[]) - Dash style (null for solid line)
- **pointType** (Enums.PointType) - Type of point to display
- **pointSize** (Enums.Size) - Size of the points
- **maxPoints** (int) - Max points to display
- **allPoints** (boolean) - True if all points should be displayed
- **enabled** (boolean) - True if this path should be displayed
- **continuous** (boolean) - True if this path is continuous even with missing values
- **showBars** (boolean) - True if this path should be shown as bars
- **barCenter** (int) - Center point for drawing bars
- **fixedWidth** (Integer) - Fixed width for the bars
```

--------------------------------

### getSpread

Source: https://www.motivewave.com/sdk/javadoc/com/motivewave/platform/sdk/common/Instrument.html

Gets the difference between the bid and ask price for this instrument.

```java
float getSpread()
```

--------------------------------

### getSetting(String id)

Source: https://www.motivewave.com/sdk/javadoc/com/motivewave/platform/sdk/common/Settings.html

Retrieves the setting object associated with the specified ID.

```APIDOC
### Object getSetting(String id)

Gets the setting associated with the given id.

#### Parameters
- **id** (String) - The identifier of the setting.

#### Returns
- **Object** - The setting associated with the specified id.
```

--------------------------------

### getRealizedPnL

Source: https://www.motivewave.com/sdk/javadoc/com/motivewave/platform/sdk/order_mgmt/OrderContext.html

Gets the realized PnL (profit/loss) for the current 'leg' of the strategy.

```Java
double getRealizedPnL()
Gets the realized PnL (profit/loss) for the current 'leg' of the strategy. 

Returns:
    realized profit/loss
```

--------------------------------

### createControl

Source: https://www.motivewave.com/sdk/javadoc/com/motivewave/platform/sdk/common/desc/FileDesc.html

Creates the UI component for the file selection setting.

```APIDOC
## Method: createControl(SettingsBase settings, boolean readOnly)

### Description
Creates the JavaFX component that accepts user input for this setting.

### Parameters
- **settings** (SettingsBase) - The settings for the study.
- **readOnly** (boolean) - True if the component should be read-only.

### Returns
- javafx.scene.Node - The UI component.
```

--------------------------------

### getAvgEntryPrice

Source: https://www.motivewave.com/sdk/javadoc/com/motivewave/platform/sdk/order_mgmt/OrderContext.html

Gets the average entry price for the current position and instrument.

```Java
float getAvgEntryPrice(Instrument instr)
Gets the average entry price for the current position and instrument. 

Returns:
    average entry price for the current position
```

--------------------------------

### getBoolean(String id)

Source: https://www.motivewave.com/sdk/javadoc/com/motivewave/platform/sdk/common/Settings.html

Gets the boolean value associated with the given id.

```APIDOC
## getBoolean(String id)

### Description
Retrieves the boolean value associated with the given id.

### Parameters
- **id** (String) - The id of the value.

### Returns
- **Boolean** - The boolean value associated with the given id.
```

--------------------------------

### ShadeInfo Constructors

Source: https://www.motivewave.com/sdk/javadoc/com/motivewave/platform/sdk/common/ShadeInfo.html

Constructors for creating a new ShadeInfo instance with various configurations for line keys, values, and shade types.

```APIDOC
## ShadeInfo(String lineKey1, double value, Enums.ShadeType type, Color color, boolean enabled)
## ShadeInfo(String lineKey1, String lineKey2, Enums.ShadeType type, Color color, boolean enabled)
## ShadeInfo(String[][] linePairs, Color color, boolean enabled)
## ShadeInfo(String lineKey1, String lineKey2, double value, Enums.ShadeType type, Color color, boolean enabled)

### Description
Creates a new instance of ShadeInfo to define how shading is applied to chart lines.

### Parameters
- **lineKey1** (String) - Identifier for the first line.
- **lineKey2** (String) - Identifier for the second line.
- **value** (double) - The shade value.
- **linePairs** (String[][]) - Set of line pairs for shading.
- **type** (Enums.ShadeType) - Type of shade (above, below, both).
- **color** (Color) - The color of the shade.
- **enabled** (boolean) - True if the shade is enabled.
```

--------------------------------

### getOrderType(String id)

Source: https://www.motivewave.com/sdk/javadoc/com/motivewave/platform/sdk/common/Settings.html

Gets the order type associated with the given id.

```APIDOC
## getOrderType(String id)

### Description
Retrieves the OrderType associated with the given id.

### Parameters
- **id** (String) - The id of the order type.

### Returns
- **Enums.OrderType** - The OrderType associated with the given id.
```

--------------------------------

### getExitPoint(String id)

Source: https://www.motivewave.com/sdk/javadoc/com/motivewave/platform/sdk/common/Settings.html

Gets the exit point associated with the given id.

```APIDOC
## getExitPoint(String id)

### Description
Retrieves the ExitPoint associated with the given id.

### Parameters
- **id** (String) - The id of the exit point.

### Returns
- **ExitPoint** - The ExitPoint associated with the given id.
```

--------------------------------

### Menu(String text, List<MenuItem> items)

Source: https://www.motivewave.com/sdk/javadoc/com/motivewave/platform/sdk/common/menu/Menu.html

Constructor to create a sub-menu with a specific text label and an initial list of items.

```APIDOC
## Menu(String text, List<MenuItem> items)

### Description
Creates a new sub-menu instance with the specified display text and a pre-defined list of menu items.

### Parameters
- **text** (String) - The label to display for the menu.
- **items** (List<MenuItem>) - The initial list of items to include in the sub-menu.
```

--------------------------------

### getTicks (default)

Source: https://www.motivewave.com/sdk/javadoc/com/motivewave/platform/sdk/common/Instrument.html

Gets the ticks that occurred between the given startTime and endTime.

```Java
default List<Tick> getTicks(long startTime, long endTime)
```

--------------------------------

### IntegerDescriptor Methods

Source: https://www.motivewave.com/sdk/javadoc/com/motivewave/platform/sdk/common/desc/IntegerDescriptor.html

Methods available for retrieving configuration details from an IntegerDescriptor instance.

```APIDOC
## Methods

### getDefaultValue()
Returns the default Integer value.

### getMinValue()
Returns the configured minimum integer value.

### getMaxValue()
Returns the configured maximum integer value.

### getStep()
Returns the step increment value for the setting.
```
Tokens:
Raw