@mk7s/holochart-components

Interfaces

Interface	Description
ArrowGeometry	The drawn arrow: a line segment (if any length is left) and head polygons, container px.
ArrowOptions	Options of arrowGeometry.
ButtonClickedEvent	Payload of buttonclicked.
FullSlider	A defaulted slider.
FullSliderStep	A defaulted slider step.
FullUpdatemenu	A defaulted update menu.
FullUpdatemenuButton	A defaulted update-menu button.
Point	A point in container px.
RotatedBox	A rotated rectangle: center, half sizes, clockwise angle in degrees.
SliderChangeEvent	Payload of sliderchange: the active step changed.
SliderEndEvent	Payload of sliderend: the pointer was released.
SliderStartEvent	Payload of sliderstart: a pointer pressed on the slider.

Type Aliases

Type Alias	Description
ModebarIcon	An icon for a modebar button, in one of three forms:
ShapeOptions	Shape attributes accepted by the helpers (anything layout.shapes[i] takes).

Variables

Variable	Description
annotationsComponent	The annotations component (layout.annotations, E5.4).
ARROWHEADS	Plotly's arrowheads (annotations/arrow_paths.js) as polygons. 8, which Plotly's list does not define, is a bar across the arrow end.
axesComponent	The axes component: register it (the full bundle does) to draw every cartesian axis.
builtinComponents	Every component in this package, in registration order (the full bundle registers these).
colorbarComponent	The colorbar component (marker.colorbar, layout.coloraxisN.colorbar; E5.3).
imagesComponent	The layout images component (layout.images, E5.6).
legendComponent	The legend component (layout.legend, legend2, …, showlegend; E5.2).
modebarComponent	The modebar component (plan E5.8): layout.modebar attributes and the DOM toolbar. Buttons act through chart.relayout (drag mode, hover mode, zoom, autoscale, reset) or download a PNG; custom buttons come from config.modeBarButtonsToAdd.
modebarIcons	The built-in modebar glyphs, reusable as icon of custom buttons.
rangeselectorComponent	The range selector component (plan E5.9). Core owns xaxis.rangeselector's schema and defaults; this draws the buttons and pushes the margins they need.
rangesliderComponent	The range slider component (xaxis.rangeslider, plan E5.9). Its attributes are core's (the x axis schema); this draws the slider and pushes the bottom margin.
selectionsComponent	The selections component (layout.selections, plan E5.12): outlines and editing. The attributes are core's; the runtime selects the points.
shapesComponent	The shapes component (layout.shapes, E5.5).
slidersComponent	Sliders: step through restyle, relayout, update or animate calls; emit sliderchange, sliderstart and sliderend (plan E5.11).
titleComponent	The figure title component (layout.title, E5.1).
updatemenusComponent	Update menus: buttons and dropdowns that call restyle, relayout, update or animate and emit buttonclicked (plan E5.10).

Functions

Function	Description
addHline	Add a horizontal line at y across the subplot (plotly.py add_hline).
addHrect	Add a horizontal band from y0 to y1 across the subplot (plotly.py add_hrect).
addShape	Append shape to layout.shapes (one relayout).
addVline	Add a vertical line at x across the subplot (plotly.py add_vline).
addVrect	Add a vertical band from x0 to x1 across the subplot (plotly.py add_vrect).
arrowGeometry	The arrow from tail to head (container px): it starts where it leaves box (plus startstandoff), ends standoff before the head, and is shortened further by each drawn head's back-off, so the heads' tips land exactly on the (stood-off) ends.
componentsReady	Resolves once chart has drawn its first frame, every follow-up pass its components requested has run, and all text (tick labels, titles, legend) is typeset.