API

Public API

These functions rarely change. And if they do, it's mostly backwards compatible.

def create_plot(title='Finance Plot', rows=1, init_zoom_periods=1e10, maximize=True, yscale='linear')
def create_plot_widget(master, rows=1, init_zoom_periods=1e10, yscale='linear')
def close()
def price_colorfilter(item, datasrc, df)
def volume_colorfilter(item, datasrc, df)
def strength_colorfilter(item, datasrc, df)
def volume_colorfilter_section(sections=[])
def horizvol_colorfilter(sections=[])
def candlestick_ochl(datasrc, draw_body=True, draw_shadow=True, candle_width=0.6, ax=None, colorfunc=price_colorfilter)
def renko(x, y=None, bins=None, step=None, ax=None, colorfunc=price_colorfilter)
def volume_ocv(datasrc, candle_width=0.8, ax=None, colorfunc=volume_colorfilter)
def horiz_time_volume(datasrc, ax=None, **kwargs)
def heatmap(datasrc, ax=None, **kwargs)
def bar(x, y=None, width=0.8, ax=None, colorfunc=strength_colorfilter, **kwargs)
def hist(x, bins, ax=None, **kwargs)
def plot(x, y=None, color=None, width=1, ax=None, style=None, legend=None, zoomscale=True, **kwargs)
def labels(x, y=None, labels=None, color=None, ax=None, anchor=(0.5,1))
def add_legend(text, ax=None)
def fill_between(plot0, plot1, color=None)
def set_x_pos(xmin, xmax, ax=None)
def set_y_range(ymin, ymax, ax=None)
def set_y_scale(yscale='linear', ax=None)
def add_band(y0, y1, color=band_color, ax=None)
def add_rect(p0, p1, color=band_color, interactive=False, ax=None)
def add_line(p0, p1, color=draw_line_color, width=1, style=None, interactive=False, ax=None)
def add_text(pos, s, color=draw_line_color, anchor=(0,0), ax=None)
def remove_primitive(primitive)
def set_time_inspector(inspector, ax=None, when='click')
def add_crosshair_info(infofunc, ax=None)
def timer_callback(update_func, seconds, single_shot=False)
def autoviewrestore(enable=True)
def refresh()
def show(qt_exec=True)
def play_sound(filename)
def screenshot(file, fmt='png')

See Settings if you need to dig deeper.