Computes the barPixelWidth of all the bars in the plot.
If the position scale of the plot is a CategoryScale and in bands mode, then the rangeBands function will be used. If the position scale of the plot is a QuantitativeScale, then the bar width is equal to the smallest distance between two adjacent data points, padded for visualisation.
Updates the extents associated with each attribute, then autodomains all scales the Plot uses.
Adds a given CSS class to the Component.
The CSS class to add.
Returns whether the plot will be animated.
Enables or disables animation.
Gets the AccessorScaleBinding for a particular attribute.
Sets a particular attribute to a constant value or the result of an Accessor.
Sets a particular attribute to a scaled constant value or scaled result of an Accessor. The provided Scale will account for the attribute values when autoDomain()-ing.
Gets the automatic domain adjustment mode for visible points.
Sets the automatic domain adjustment mode for visible points to operate against the X Scale, Y Scale, or neither. If "x" or "y" is specified the adjustment is immediately performed.
One of "x"/"y"/"none". "x" will adjust the x Scale in relation to changes in the y domain. "y" will adjust the y Scale in relation to changes in the x domain. "none" means neither Scale will change automatically.
Gets the Selection containing the
Will return undefined if the Component has not been anchored.
background selection for the Component
Gets the baseline value. The baseline is the line that the bars are drawn from.
Sets the baseline value. The baseline is the line that the bars are drawn from.
for the component in pixel space, where the topLeft represents the component's minimum x and y values and the bottomRight represents the component's maximum x and y values.
Gets a Selection containing a
Will return undefined if the Component has not been anchored.
content selection for the Component
Returns the whether or not the rendering is deferred for performance boost.
The deferred rendering option
Sets / unsets the deferred rendering option Activating this option improves the performance of plot interaction (pan / zoom) by performing lazy renders, only after the interaction has stopped. Because re-rendering is no longer performed during the interaction, the zooming might experience a small resolution degradation, before the lazy re-render is performed.
This option is intended for cases where performance is an issue.
Gets the Entities at a particular Point.
Gets the Entities that intersect the Bounds.
Gets the Entities that intersect the area defined by the ranges.
Returns the PlotEntity nearest to the query point according to the following algorithm:
The nearest PlotEntity, or undefined if no PlotEntity can be found.
Checks if the Component has a fixed height or if it grows to fill available space. Returns false by default on the base Component class.
Checks if the Component has a fixed width or if it grows to fill available space. Returns false by default on the base Component class.
Gets the Selection containing the
Will return undefined if the Component has not been anchored.
Checks if the Component has a given CSS class.
The CSS class to check for.
Gets the height of the Component in pixels.
Get whether bar labels are enabled.
Whether bars should display labels or not.
Sets whether labels are enabled.
Removes a callback that would be called on anchoring the Component to the DOM. The callback is identified by reference equality.
Removes a callback to be called when the Component is detach()-ed. The callback is identified by reference equality.
Adds a callback to be called on anchoring the Component to the DOM. If the Component is already anchored, the callback is called immediately.
Adds a callback to be called when the Component is detach()-ed.
Sets a callback that gets called when the component resizes. The size change is not guaranteed to be reflected by the DOM at the time the callback is fired.
Gets the orientation of the plot
"vertical" | "horizontal"
Gets the origin of the Component relative to its parent.
Gets the origin of the Component relative to the root
Gets the parent ComponentContainer for this Component.
Sets the parent ComponentContainer for this Component. An error will be thrown if the parent does not contain this Component. Adding a Component to a ComponentContainer should be done using the appropriate method on the ComponentContainer.
Causes the Component to re-layout and render.
This function should be called when a CSS change has occured that could influence the layout of the Component, such as changing the font size.
Removes a given CSS class from the Component.
The CSS class to remove.
Renders the Component to a given
A selector-string for the
Given available space in pixels, returns the minimum width and height this Component will need.
Adjusts the domains of both X and Y scales to show all data. This call does not override the autorange() behavior.
Gets the width of the Component in pixels.
Gets the x alignment of the Component.
Sets the x alignment of the Component.
The x alignment of the Component ("left"/"center"/"right").
Gets the y alignment of the Component.
Sets the y alignment of the Component.
The y alignment of the Component ("top"/"center"/"bottom").
Generated using TypeDoc
A StackedBar Plot stacks bars across Datasets based on the primary value of the bars. On a vertical StackedBar Plot, the bars with the same X value are stacked. On a horizontal StackedBar Plot, the bars with the same Y value are stacked.