Creates additional elements as necessary for the Component to function. Called during anchor() if the Component's element has not been created yet. Override in subclasses to provide additional functionality.
Adds a Component in the specified row and column position.
For example, instead of calling new Table([[a, b], [null, c]]), you
could call
var table = new Plottable.Components.Table();
table.add(a, 0, 0);
table.add(b, 0, 1);
table.add(c, 1, 1);
The Component to be added.
Adds a given CSS class to the Component.
The CSS class to add.
Gets the Selection containing the
Will return undefined if the Component has not been anchored.
background selection for the Component
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 the padding to the left and right of each column in pixels.
Sets the padding to the left and right of each column in pixels.
Gets the weight of the specified column.
Sets the weight of the specified column. Space is allocated to columns based on their weight. Columns with higher weights receive proportionally more space.
Please see rowWeight docs for an example.
Returns the Component at the specified row and column index.
The Component at the specified position, or null if no Component is there.
Gets a Selection containing a
Will return undefined if the Component has not been anchored.
content selection for the Component
Destroys the ComponentContainer and all Components within it.
Detaches a Component from the DOM. The Component can be reused.
This should only be used if you plan on reusing the calling Component. Otherwise, use destroy().
Gets the Selection containing the
Will return undefined if the Component has not been anchored.
Checks whether the specified Component is in the Table.
Checks if the Component has a given CSS class.
The CSS class to check for.
Gets the height of the Component in pixels.
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 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 the specified Component from the ComponentContainer.
Removes a given CSS class from the Component.
The CSS class to remove.
Renders the Component without waiting for the next frame.
Renders the Component to a given
A selector-string for the
Gets the padding above and below each row in pixels.
Sets the padding above and below each row in pixels.
Gets the weight of the specified row.
Sets the weight of the specified row. Space is allocated to rows based on their weight. Rows with higher weights receive proportionally more space.
A common case would be to have one row take up 2/3rds of the space, and the other row take up 1/3rd.
Example:
plot = new Plottable.Component.Table([
[row1],
[row2]
]);
// assign twice as much space to the first row
plot
.rowWeight(0, 2)
.rowWeight(1, 1)
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 Table combines Components in the form of a grid. A common case is combining a y-axis, x-axis, and the plotted data via
new Table([[yAxis, plot], [null, xAxis]]);