API Reference

Wiki ▸ API Reference

This is WIP: Comment and vote for this on issue #1, otherwise I'll be focusing on new features and enhancements.

Everything in TechanJS is scoped under the techan namespace.

TechanJS uses semantic versioning. You can find the current version of TechanJS as techan.version.

See one of:

• Data Structures - required data structures for plots
• Plots - plots render and visualise the supplied data
• Scales - convert between data and visual encodings
• Algorithms - calculate indicators and other technical analysis algorithms

Data Structures

• OHLC & Volume
• Moving Averages
• MACD
• RSI
• Axis Annotations
• Support & Resistance
• Trendline

techan.plot (Plots)

Data Plots

• techan.plot.candlestick - construct a candlestick.
• techan.plot.ohlc - construct a ohlc.
• techan.plot.volume - construct a volume.
• techan.plot.ema - construct a Exponential Moving Average.
• techan.plot.sma - construct a Simple Moving Average.
• techan.plot.macd - construct a MACD.
• techan.plot.rsi - construct a RSI.

Annotations

• techan.plot.axisannotation - construct a axisannotation.

Interactive

• techan.plot.crosshair - construct a crosshair plot.
• techan.plot.supstance - construct a support/resistance line plot.
• techan.plot.trendline - construct a trendline plot.

techan.scale (Scales)

Finance Time Scales

• techan.scale.financetime - construct a finance time scale.

Plot Scale Factories

• techan.scale.plot.time - construct and initialise a techan.scale.financetime scale.

Algorithms

Indicators

• techan.indicator.ema - construct a exponential moving average algorithm.
• techan.indicator.macd - construct a MACD algorithm.
• techan.indicator.rsi - construct a RSI algorithm.
• techan.indicator.sma - construct a simple moving average algorithm.