| Instance of ChartDesign | Represents an instance of a chart design. | |
| Instance of ChartDesign | Returns one instance of the chart design class. | |
| Secure | Whether the URL of the chart should be HTTPS or HTTP | |
| TextTitle |
The title of the chart. Leave blank to use the Ticker symbol as a title. You can use the following placeholders in the title when applicable:
- $symbol$ for the security symbol.
- $name$ for the security name.
- $startdate$ for the chart start date.
- $enddate$ for the chart end date.
- $today$ for today's date.
- $cr$ for a carriage return.
| Yes |
| TextHeader | The text of the header displayed under the title. You can use the same placeholders as TextTitle. | Yes |
| TextFooter | The text of the footer displayed on the bottom right corner. | Yes |
| TextPriceLine |
The text for the price data series. You can use the following placeholders:
- $symbol$ for the security symbol.
| Yes |
| TextVolumeBar |
The text for the volume data series. You can use the following placeholders:
- $symbol$ for the security symbol.
| Yes |
| TextHighest | The text for the high price line, if ShowHigh is set to true. | Yes |
| TextLowest | The text for the low price line, if ShowLow is set to true. | Yes |
| TextOpen | The text for the open price line, if ShowOpen is set to true. | Yes |
| TextClose | The text for the closed price line, if ShowClose is set to true. | Yes |
| TextUp |
The text for the up variations if ShowVariations is set to true.
- $year$ the number of years for the variation.
| Yes |
| TextDown |
The text for the down variations if ShowVariations is set to true.
- $year$ the number of years for the variation.
| Yes |
| ColorBackground | The background color. This color is used to build background gradients for the wall and background. | Yes |
| ColorBackWall | The backwall color. This color is used to build background gradients for the wall and background. | Yes |
| ColorVolumeBackWall | The background color. This color is used to build background gradients for the wall and background. | Yes |
| ShowVolumeBackWall | Enable or disable the backwall of the volume chart. | Yes |
| ColorHighlight | The hightlight color used for the footer. | Yes |
| ColorPriceLine | The color of the price line. | Yes |
| ColorVolumeBar | The color of the volume bar. | Yes |
| ColorVolumeBarFill | The fill color of the volume bar. | Yes |
| ColorHigh | The color of the high price line and label. Use the #RRGGBB format where RR, GG, and BB are the red, blue, and green values in HEX format. | Yes |
| ColorStickUp | The color of the up sticks in Candlestick charts. Use the #RRGGBB format where RR, GG, and BB are the red, blue, and green values in HEX format. | Yes |
| ColorStickLow | The color of the down sticks in Candlestick charts. Use the #RRGGBB format where RR, GG, and BB are the red, blue, and green values in HEX format. | Yes |
| ColorConstant | The color of constant lines. Use the #RRGGBB format where RR, GG, and BB are the red, blue, and green values in HEX format. | Yes |
| ColorLow | The color of the low price line and label. Use the #RRGGBB format where RR, GG, and BB are the red, blue, and green values in HEX format. | Yes |
| ColorPoint | The color for displayed points, such as . | Yes |
| ColorTitle | The title color. | Yes |
| ColorFooter | The footer color. | Yes |
| ColorHeader | The header color. | Yes |
| ColorAxis | The axis color. | Yes |
| ColorGrid | The outer grid color. | Yes |
| ColorFonts | The right axis, bottom axis, and legend font colors. | Yes |
| ColorStripe | The color of the back wall strip indicating the market opening period, when applicable. | Yes |
| ColorOpen | The color of the open price line and label. Use the #RRGGBB format where RR, GG, and BB are the red, blue, and green values in HEX format. | Yes |
| ColorClose | The color of the close price line and label. Use the #RRGGBB format where RR, GG, and BB are the red, blue, and green values in HEX format. | Yes |
| ColorVerticalGrid | The vertical grid color. | Yes |
| ColorHorizontalGrid | The horizontal grid color. | Yes |
| ColorUp | The color up color for candlesticks charts. | Yes |
| ColorDown | The color down color for candlesticks charts. | Yes |
| ColorHighLowLine | The high-low line color for candlesticks charts. | Yes |
| ColorCollection | The list of colors to apply when more than one symbol is displayed. | Yes |
| GridHorizontalStyle | The pattern for the horizontal grid. | Yes |
| GridVerticalStyle | The pattern for the vertical grid. | Yes |
| GridHorizontalWidth | The width for the horizontal grid lines. | Yes |
| GridVerticalWidth | The width for the vertical grid lines. | Yes |
| ColorFrame | The outer frame color. | Yes |
| FormatPriceLine | The format for prices. Example: #,##0.000 for 3 decimals. | Yes |
| FormatVolume | The format for volumes. Example: use #,###0.0 to show one decimal. | Yes |
| FormatDate | The format for dates. | Yes |
| GradeBackground | If set to true, the color of chart background is set as a diagonal right-to-left gradient from ColorDarkTone to ColorLightTone. Use the #RRGGBB format where RR, GG, and BB are the red, blue, and green values in HEX format. | Yes |
| GradeBackwall | If set to true, the color of wall background is set as a diagonal left-to-right gradient from ColorDarkTone to ColorLightTone. Use the #RRGGBB format where RR, GG, and BB are the red, blue, and green values in HEX format. | Yes |
| WaterMark | The address of the watermark file. Please contact us to set this parameter. | Yes |
| WaterMarkTopMargin | The top position of the watermark, in percentage (0=Top, 100=Bottom) | Yes |
| WaterMarkLeftMargin | The left position of the watermark, in percentage (0=Left, 100=Right). | Yes |
| WaterMarkTransparency | The watermark transparency (in percentage). | Yes |
| PointSize | The point size for point charts (i.e. SEC filings on market capitalization charts). | Yes |
| LineWidth | The width of the line series (in pixels). | Yes |
| SplitPercent | The percentage of the chart aera allocated to displaying trade volumes. | Yes |
| ShowHigh | Show the high price line. | Yes |
| ShowLow | Show the low price line. | Yes |
| ShowOpen | Show the open price line. | Yes |
| ShowClose | Show the close price line. | Yes |
| ShowVolume | Show the volume data at the bottom of the chart. | Yes |
| ShowUpVariation | Show the down variations (largest declines) for the stock. | Yes |
| ShowDownVariation | Show the up variations for the stock. Not Supported. | Yes |
| ShowLegend | Show the legend of the chart. | Yes |
| VariationYear | The variation year for the chart. | Yes |
| VolumeDivider | A divider to apply to volume numbers. | Yes |
| VolumeTextOff | The text off for the volume numbers. | Yes |
| PriceTextOff | The text off for the price numbers. | Yes |
| FrameType | The type of frame to display around the chart. | Yes |
| LightScheme | The lighting scheme to apply to the chart 3D projection. | Yes |
| Projection | The 3D projection for the chart. | Yes |
| MarginTop | The top margin expressed as a percentage of the chart area. | Yes |
| MarginBottom | The bottom margin expressed as a percentage of the chart area. | Yes |
| MarginLeft | The left margin expressed as a percentage of the chart area. | Yes |
| MarginRight | The right margin expressed as a percentage of the chart area. | Yes |
| FontFamily | The font family to apply to all texts. | Yes |
| FontSizeLegend | The size of the legend fonts. | Yes |
| FontSizeAxes | The size of the axes fonts. | Yes |
| FontSizeTitle | The size of the title fonts. | Yes |
| FontSizeHeader | The size of the header fonts. | Yes |
| FontSizeFooter | The size of the footer fonts. | Yes |
| Height | The height of the chart within the frame. | Yes |
| Width | The width of the chart within the frame. | Yes |
| ZoomPercent | The percent to zoom for the chart. | Yes |
| Reload | If the chart will reload. | Yes |
| ShowPriceChartLabels | Show the price chart labels for the legend. | Yes |
| LegendBox | Show the background for the legend. | Yes |
| ColorLegendBackground | The color of the background of the legend. | Yes |
| ColorLegendBorder | The color of the border of the legend. | Yes |
| LegendVerticalPosition | The top position of the legend (0=Top, 100=Bottom). | Yes |
| LegendHorizontalPosition | The left position of the legend (0=Left, 100=Right). | Yes |
| TickPrecision | The precision unit to apply to the ticks of the chart. Choose: - Tick to draw one point per trade (could be thousands for highly traded securities). TickPeriods does not apply in this case.
- Milliseconds to summarize trades by the number of milliseconds specified by TickPeriods.
- Second to summarize trades by the number of seconds specified by TickPeriods.
- Minute to summarize trades by the number of minutes specified by TickPeriods.
For instance TickPeriod=2 and TickPrecision=Minute will plot one value of the chart for trades executed every two minutes. | Yes |
| TickPeriods | Used in combination with TickPrecision to define the number of points displayed on the chart. For instance TickPeriods=5 with TickPrecision=Minute will display one data point every 5 minutes with the point being the average price for that period. | Yes |