bqplot.marks.OHLC¶

class bqplot.marks.OHLC(**kwargs)[source]¶

Open/High/Low/Close marks.

icon¶

font-awesome icon for that mark

Type:	string (class-level attribute)

name¶

user-friendly name of the mark

Type:	string (class-level attribute)

marker¶

marker type

Type:	{‘candle’, ‘bar’}

stroke¶

stroke color of the marker

Type:	color (default: None)

stroke_width¶

stroke width of the marker

Type:	float (default: 1.0)

colors¶

fill colors for the markers (up/down)

Type:	List of colors (default: [‘limegreen’, ‘red’])

opacities¶

Opacities for the markers of the OHLC mark. Defaults to 1 when the list is too short, or the element of the list is set to None.

Type:	list of floats (default: [])

format¶

description of y data being passed supports all permutations of the strings ‘ohlc’, ‘oc’, and ‘hl’

Type:	string (default: ‘ohlc’)

Data Attributes

x¶

abscissas of the data points (1d array)

Type:	numpy.ndarray

y¶

Open/High/Low/Close ordinates of the data points (2d array)

Type:	numpy.ndarrays

Notes

The fields which can be passed to the default tooltip are:: x: the x value associated with the bar/candle open: open value for the bar/candle high: high value for the bar/candle low: low value for the bar/candle close: close value for the bar/candle index: index of the bar/candle being hovered on

__init__(**kwargs)¶: Public constructor

Methods

`__init__`(**kwargs)	Public constructor
`add_traits`(**traits)	Dynamically add trait attributes to the Widget.
`class_own_trait_events`(name)	Get a dict of all event handlers defined on this class, not a parent.
`class_own_traits`(**metadata)	Get a dict of all the traitlets defined on this class, not a parent.
`class_trait_names`(**metadata)	Get a list of all the names of this class’ traits.
`class_traits`(**metadata)	Get a `dict` of all the traits of this class.
`close`()	Close method.
`close_all`()
`get_manager_state`([drop_defaults, widgets])	Returns the full state for a widget manager for embedding
`get_state`([key, drop_defaults])	Gets the widget state, or a piece of it.
`get_view_spec`()
`handle_comm_opened`(comm, msg)	Static method, called when a widget is constructed.
`has_trait`(name)	Returns True if the object has a trait with the specified name.
`hold_sync`()	Hold syncing any state until the outermost context manager exits
`hold_trait_notifications`()	Context manager for bundling trait change notifications and cross validation.
`notify_change`(change)	Called when a property has changed.
`observe`(handler[, names, type])	Setup a handler to be called when a trait changes.
`on_background_click`(callback[, remove])
`on_click`(callback[, remove])
`on_displayed`(callback[, remove])	(Un)Register a widget displayed callback.
`on_element_click`(callback[, remove])
`on_hover`(callback[, remove])
`on_legend_click`(callback[, remove])
`on_legend_hover`(callback[, remove])
`on_msg`(callback[, remove])	(Un)Register a custom msg receive callback.
`on_trait_change`([handler, name, remove])	DEPRECATED: Setup a handler to be called when a trait changes.
`on_widget_constructed`(callback)	Registers a callback to be called when a widget is constructed.
`open`()	Open a comm to the frontend if one isn’t already open.
`send`(content[, buffers])	Sends a custom msg to the widget model in the front-end.
`send_state`([key])	Sends the widget state, or a piece of it, to the front-end, if it exists.
`set_state`(sync_data)	Called when a state is received from the front-end.
`set_trait`(name, value)	Forcibly sets trait attribute, including read-only attributes.
`setup_instance`(args, *kwargs)	This is called before self.__init__ is called.
`trait_events`([name])	Get a `dict` of all the event handlers of this class.
`trait_metadata`(traitname, key[, default])	Get metadata values for trait by key.
`trait_names`(**metadata)	Get a list of all the names of this class’ traits.
`traits`(**metadata)	Get a `dict` of all the traits of this class.
`unobserve`(handler[, names, type])	Remove a trait change handler.
`unobserve_all`([name])	Remove trait change handlers of any type for the specified name.

Attributes

`apply_clip`	A boolean (True, False) trait.
`colors`	An instance of a Python list.
`comm`	A trait whose value must be an instance of a specified class.
`cross_validation_lock`	A contextmanager for running a block with our cross validation lock set to True.
`display_legend`	A boolean (True, False) trait.
`enable_hover`	A boolean (True, False) trait.
`format`	A trait for unicode strings.
`icon`
`interactions`	An instance of a Python dict.
`keys`	An instance of a Python list.
`labels`	An instance of a Python list.
`log`	A trait whose value must be an instance of a specified class.
`mark_types`
`marker`	An enum whose value must be in a given sequence.
`model_id`	Gets the model id of this widget.
`name`
`opacities`	An instance of a Python list.
`preserve_domain`	An instance of a Python dict.
`scales`	An instance of a Python dict.
`scales_metadata`	An instance of a Python dict.
`selected`	An instance of a Python list.
`selected_style`	An instance of a Python dict.
`stroke`	A string holding a valid HTML color such as ‘blue’, ‘#060482’, ‘#A80’
`stroke_width`	A float trait.
`tooltip`	A trait whose value must be an instance of a specified class.
`tooltip_location`	An enum whose value must be in a given sequence.
`tooltip_style`	An instance of a Python dict.
`unselected_style`	An instance of a Python dict.
`visible`	A boolean (True, False) trait.
`widget_types`
`widgets`
`x`	A numpy array trait type.
`y`	A numpy array trait type.