victory-candlestick
Advanced tools
victory-candlestick@^30.0.0 exports VictoryCandlestick and Candle components
View these docs at https://formidable.com/open-source/victory/docs/victory-candlestick to see live examples.
VictoryCandlestick renders a dataset as a series of candlesticks. VictoryCandlestick can be composed with VictoryChart to create candlestick charts.
<VictoryChart
theme={VictoryTheme.material}
domainPadding={{ x: 25 }}
scale={{ x: "time" }}
>
<VictoryAxis tickFormat={(t) => `${t.getDate()}/${t.getMonth()}`}/>
<VictoryAxis dependentAxis/>
<VictoryCandlestick
candleColors={{ positive: "#5f5c5b", negative: "#c43a31" }}
data={sampleDataDates}
/>
</VictoryChart>
type: boolean || object
VictoryCandlestick uses the standard animate prop. Read about it https://formidable.com/open-source/victoryhere
See the Animations Guide for more detail on animations and transitions
animate={{
duration: 2000,
onLoad: { duration: 1000 }
}}
type: { positive: string, negative: string }
Candle colors are significant in candlestick charts, with colors indicating whether a market closed higher than it opened (positive), or closed lower than it opened (negative). The candleColors prop should be given as an object with color strings specified for positive and negative.
default (provided by default theme): candleColors={{positive: "white", negative: "black"}}
<VictoryCandlestick
candleColors={{ positive: "#5f5c5b", negative: "#c43a31" }}
data={sampleDataDates}
/>
type: array[string] || { x: array[string], y: array[string] }
VictoryCandlestick uses the standard categories prop. Read about it here
categories={{ x: ["dogs", "cats", "mice"] }}
type: string || integer || array[string] || function
Use close data accessor prop to define the close value of a candle.
string: specify which property in an array of data objects should be used as the close value
examples: close="closing_value"
function: use a function to translate each element in a data array into a close value
examples: close={() => 10}
array index: specify which index of an array should be used as a close value when data is given as an array of arrays
examples: close={1}
path string or path array: specify which property in an array of nested data objects should be used as a close value
examples: close="bonds.close", close={["bonds", "close"]}
type: element
VictoryCandlestick uses the standard containerComponent prop. Read about it here
containerComponent={<VictoryVoronoiContainer/>}
type: array[object]
Specify data via the data prop. By default, VictoryCandlestick expects data as an array of objects with x, open, close, high, and low keys. Use the x, open, close, high, and low data accessor props to specify custom data formats. Refer to the Data Accessors Guide for more detail.
<VictoryCandlestick
data={[
{x: new Date(2016, 6, 1), open: 5, close: 10, high: 15, low: 0},
{x: new Date(2016, 6, 2), open: 10, close: 15, high: 20, low: 5},
{x: new Date(2016, 6, 3), open: 15, close: 20, high: 22, low: 10},
{x: new Date(2016, 6, 4), open: 20, close: 10, high: 25, low: 7},
{x: new Date(2016, 6, 5), open: 10, close: 8, high: 15, low: 5}
]}
/>
type: element
VictoryCandlestick uses the standard dataComponent prop. Read about it here
VictoryCandlestick supplies the following props to its dataComponent: data, datum, index, padding, polar, origin, scale, style, candleHeight, x1, y1, y2, x2
See the Custom Components Guide for more detail on creating your own dataComponents
default: <Candle/>
dataComponent={<Candle events={{ onClick: handleClick }}/>}
type: array[low, high] || { x: [low, high], y: [low, high] }
VictoryCandlestick uses the standard domain prop. Read about it here
domain={{x: [0, 100], y: [0, 1]}}
type: number || array[left, right] || { x: [left, right], y: [bottom, top] }
VictoryCandlestick uses the standard domainPadding prop. Read about it here
domainPadding={{x: [10, -10], y: 5}}
type: string || integer || array[string] || function
VictoryCandlestick uses the standard eventKey prop to specify how event targets are addressed. This prop is not commonly used. Read about the eventKey prop in more detail here
eventKey = "x";
type: array[object]
VictoryCandlestick uses the standard events prop. Read about it here
See the Events Guide for more information on defining events.
<div>
<h3>Click Me</h3>
<VictoryCandlestick
events={[{
target: "data",
eventHandlers: {
onClick: () => {
return [
{
target: "data",
mutation: (props) => {
const fill = props.style && props.style.fill;
return fill === "#c43a31" ? null : { style: { fill: "#c43a31" } };
}
}
];
}
}
}]}
data={sampleDataDates}
/>
</div>
type: element
VictoryCandlestick uses the standard groupComponent prop. Read about it here
default: <g/>
groupComponent={<g transform="translate(10, 10)" />}
type: number
VictoryCandlestick uses the standard height prop. Read about it here
default (provided by default theme): height={300}
height={400}
type: string || integer || array[string] || function
Use high data accessor prop to define the high value of a candle.
string: specify which property in an array of data objects should be used as the high value
examples: high="highest_value"
function: use a function to translate each element in a data array into a high value
examples: high={() => 10}
array index: specify which index of an array should be used as a high value when data is given as an array of arrays
examples: high={1}
path string or path array: specify which property in an array of nested data objects should be used as a high value
examples: high="bonds.high", high={["bonds", "high"]}
type: element
VictoryCandlestick uses the standard labelComponent prop. Read about it here
default: <VictoryLabel/>
<VictoryCandlestick
data={sampleDataDates}
labels={(d) => d.open}
labelComponent={<VictoryLabel dx={-10} dy={22}/>}
/>
type: array || function
VictoryCandlestick uses the standard labels prop. Read about it here
<VictoryCandlestick
data={sampleDataDates}
labels={(d) => `open: ${d.open}`}
/>
type: string || integer || array[string] || function
Use low data accessor prop to define the low value of a candle.
string: specify which property in an array of data objects should be used as the low value
examples: low="lowest_value"
function: use a function to translate each element in a data array into a low value
examples: low={() => 10}
array index: specify which index of an array should be used as a low value when data is given as an array of arrays
examples: low={1}
path string or path array: specify which property in an array of nested data objects should be used as a low value
examples: low="bonds.low", low={["bonds", "low"]}
type: number || { x: number, y: number }
VictoryCandlestick uses the standard maxDomain prop. Read about it in detail
<VictoryChart
maxDomain={{ y: 30 }}
scale={{ x: "time" }}
>
<VictoryCandlestick
data={sampleDataDates}
/>
</VictoryChart>
type: number || { x: number, y: number }
VictoryCandlestick uses the standard minDomain prop. Read about it in detail
<VictoryChart
minDomain={{ y: 0 }}
scale={{ x: "time" }}
>
<VictoryCandlestick
data={sampleDataDates}
/>
</VictoryChart>
type: string
The name prop is used to reference a component instance when defining shared events.
name = "series-1";
type: string || integer || array[string] || function
Use open data accessor prop to define the open value of a candle.
string: specify which property in an array of data objects should be used as the open value
examples: open="opening_value"
function: use a function to translate each element in a data array into a open value
examples: open={() => 10}
array index: specify which index of an array should be used as a open value when data is given as an array of arrays
examples: open={1}
path string or path array: specify which property in an array of nested data objects should be used as a open value
examples: open="bonds.open", open={["bonds", "open"]}
type: { x: number, y: number }
The origin prop is only used by polar charts, and is usually controlled by VictoryChart. It will not typically be necessary to set an origin prop manually
Read about the origin prop in detailhttps://formidable.com/open-source/victory
type: number || { top: number, bottom: number, left: number, right: number }
VictoryCandlestick uses the standard padding prop. Read about it here
default (provided by default theme): padding={50}
padding={{ top: 20, bottom: 60 }}
type: boolean
VictoryCandlestick uses the standard polar prop. Read about it here
Note: Polar Charts are not yet supported for VictoryCandlestick
type: array[low, high] || { x: [low, high], y: [low, high] }
The range prop is usually controlled by VictoryChart. It will not typically be necessary to set a range prop manually
Read about the range prop in detailhttps://formidable.com/open-source/victory
type: number
VictoryCandlestick uses the standard samples prop. Read about it here
default: samples={50}
samples={100}
type: scale || { x: scale, y: scale }
VictoryCandlestick uses the standard scale prop. Read about it here
Options for scale include "linear", "time", "log", "sqrt" and the d3-scale functions that correspond to these options.
default: scale="linear"
scale={{x: "linear", y: "log"}}
The sharedEvents prop is used internally to coordinate events between components. It should not be set manually.
type: boolean || { x: boolean, y: boolean }
VictoryCandlestick uses the standard singleQuadrantDomainPadding prop. Read about it here
type: string || integer || array[string] || function
VictoryCandlestick uses the standard sortKey prop. Read about it here
See the Data Accessors Guide for more detail on formatting and processing data.
sortKey = "x";
type: "ascending" || "descending"
The sortOrder prop specifies whether sorted data should be returned in ascending or descending order.
default: sortOrder="ascending"
type: boolean
VictoryCandlestick uses the standard standalone prop. Read about it here
note: When VictoryCandlestick is nested within a component like VictoryChart, this prop will be set to false
default: standalone={true}
<svg width={300} height={300}>
<circle cx={150} cy={150} r={150} fill="#c43a31"/>
<VictoryCandlestick
standalone={false}
width={300} height={300}
data={sampleDataDates}
/>
</svg>
type: { parent: object, data: object, labels: object }
VictoryCandlestick uses the standard style prop. Read about it here
default (provided by default theme): See grayscale theme for more detail
<VictoryCandlestick
style={{
data: {
fill: "#c43a31", fillOpacity: 0.7, stroke: "#c43a31", strokeWidth: 3
},
labels: {
fontSize: 15, fill: "#c43a31"
}
}}
data={sampleDataDates}
labels={(d) => d.open}
/>
type: object
VictoryCandlestick uses the standard theme prop. Read about it here
See the Themes Guide for information about creating custom themes.
default: theme={VictoryTheme.grayscale}
theme={VictoryTheme.material}
type: number
When the wickStrokeWidth prop is set, this value will be used to determine the stroke width for the candle wick. When this prop is not set, the strokeWidth set by the style prop will apply to both the candle and the wick.
type: number
VictoryCandlestick uses the standard width prop. Read about it here
default (provided by default theme): width={450}
width={400}
type: string || integer || array[string] || function
VictoryCandlestick uses the standard x data accessor prop. Read about it here
See the Data Accessors Guide for more detail on formatting and processing data.
x={(datum) => new Date(datum.day)}
FAQs
Candlestick Component for Victory
The npm package victory-candlestick receives a total of 200,380 weekly downloads. As such, victory-candlestick popularity was classified as popular.
We found that victory-candlestick demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 16 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Socket researchers uncover a malicious npm package posing as a tool for detecting vulnerabilities in Etherium smart contracts.
Security News
Research
A supply chain attack on Rspack's npm packages injected cryptomining malware, potentially impacting thousands of developers.
Research
Security News
Socket researchers discovered a malware campaign on npm delivering the Skuld infostealer via typosquatted packages, exposing sensitive data.