Candlestick & OHLC
Basic Options
Name
Type: string
Documentation: Sets the trace name. The trace name appears as the legend item and on hover.
Path: data.index.name
Opacity
Default Value: 1
Type: number
Min: 0
Max: 1
Documentation: Sets the opacity of the trace.
Path: data.index.opacity
Data Source
Text
Default Value:
Type: string
Accept List: true
Documentation: Sets hover text elements associated with each sample point. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to this trace's sample points.
Path: data.index.text
X
Type: any
Accept List: true
Documentation: Sets the x coordinates. If absent, linear coordinate will be generated.
Path: data.index.x
Decreasing Items Styling
Line Color
Default Value: #FF4136
Type: color
Documentation: Sets the color of line bounding the box(es).
Path: data.index.decreasing.line.color
Line Width
Default Value: 2
Type: number
Min: 0
Documentation: Sets the width (in px) of line bounding the box(es).
Path: data.index.decreasing.line.width
Increasing Items Styling
Line Color
Default Value: #3D9970
Type: color
Documentation: Sets the color of line bounding the box(es).
Path: data.index.increasing.line.color
Line Width
Default Value: 2
Type: number
Min: 0
Documentation: Sets the width (in px) of line bounding the box(es).
Path: data.index.increasing.line.width
Lines Styling
Width
Default Value: 2
Type: number
Min: 0
Documentation: Sets the width (in px) of line bounding the box(es). Note that this style setting can also be set per direction via increasing.line.width and decreasing.line.width.
Path: data.index.line.width
Exclusive Options
Whisker Width
Default Value: 0
Type: number
Min: 0
Max: 1
Documentation: Sets the width of the whiskers relative to the box' width. For example, with 1, the whiskers are as wide as the box(es).
Path: data.index.whiskerwidth
Calendar Options
X Calendar
Default Value: gregorian
Type: enumerated
Enum Options: chinese,coptic,discworld,ethiopian,gregorian,hebrew,islamic,jalali,julian,mayan,nanakshahi,nepali,persian,taiwan,thai,ummalqura
Documentation: Sets the calendar system to use with x date data.
Path: data.index.xcalendar
X Period
Default Value: 0
Type: any
Documentation: Only relevant when the axis type is date. Sets the period positioning in milliseconds or M on the x axis. Special values in the form of M could be used to declare the number of months. In this case n must be a positive integer.
Path: data.index.xperiod
X Period Alignment
Default Value: middle
Type: enumerated
Enum Options: start,middle,end
Documentation: Only relevant when the axis type is date. Sets the alignment of data points on the x axis.
Path: data.index.xperiodalignment
Hover Formatting
Hover Info
Default Value: all
Type: flaglist
Accept List: true
Flag Options: x,y,z,text,name
Flag Single: all,none,skip
Documentation: Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.
Path: data.index.hoverinfo
Last updated