Maximum allowable number of wrapped lines for tick labels.
Maximum allowable px width of tick labels.
A Wrapper configured according to the other properties on this axis.
A Writer attached to this measurer and wrapper.
The css class applied to each annotation circle, which denotes which tick is being annotated.
The css class applied to each annotation label, which shows the formatted annotation text.
The css class applied to each annotation line, which extends from the axis to the rect.
The css class applied to each annotation rect, which surrounds the annotation label.
The css class applied to each end tick mark (the line on the end tick).
The css class applied to each tick label (the text associated with the tick).
The css class applied to each tick mark (the line on the tick).
How many pixels to give labels at minimum before downsampling takes effect.
Write ticks to the DOM.
The tick elements to write.
Responsible for hiding any tick labels that break out of the bounding container.
Hides the Tick Marks which have no corresponding Tick Labels
Gets the maximum pixel length over all ticks on this axis.
Measures the size of the tick labels without making any (permanent) DOM changes.
Width available for this axis.
Height available for this axis.
Return the space required by the ticks, padding included.
Adds a given CSS class to the Component.
The CSS class to add.
Attaches the Component as a child of a given d3 Selection.
Gets the annotated ticks.
Sets the annotated ticks.
Gets the count of annotation tiers to render.
Sets the count of annotation tiers to render.
Gets if annotations are enabled.
Sets if annotations are enabled.
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 a Selection containing a
Will return undefined if the Component has not been anchored.
content selection for the Component
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 end tick mark length in pixels.
Sets the end tick mark length in pixels.
Gets the Selection containing the
Will return undefined if the Component has not been anchored.
Take the scale and drop ticks at regular intervals such that the resultant ticks are all a reasonable minimum distance apart. Return the resultant ticks to render, as well as the new stepWidth between them.
The scale being downsampled. Defaults to this Axis' scale.
an object holding the resultant domain and new stepWidth.
Checks if the Component has a given CSS class.
The CSS class to check for.
Gets the height of the Component in pixels.
Gets the tick mark length in pixels.
Sets the tick mark length in pixels.
Gets the margin in pixels. The margin is the amount of space between the tick labels and the outer edge of the Axis. The margin also determines the space that annotations will reside in if annotations are enabled.
Sets the margin in pixels. The margin is the amount of space between the tick labels and the outer edge of the Axis. The margin also determines the space that annotations will reside in if annotations 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 Axis.
Sets the orientation of the Axis.
The orientation to apply to this axis.
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.
Queues the Component for rendering.
Renders the Component to a given
A selector-string for the
Compute space requirements for this Category Axis. Category Axes have two primary space requirements:
1) width/height needed by the tick lines (including annotations, padding, and margins). 2) width/height needed by the tick text.
We requested space is the sum of the lines and text.
Gets whether the Axis shows the end tick labels.
Sets whether the Axis shows the end tick labels.
Gets the tick label angle in degrees.
Sets the tick label angle in degrees. Right now only -90/0/90 are supported. 0 is horizontal.
Gets the padding between each tick mark and its associated label in pixels.
Sets the padding between each tick mark and its associated label in pixels.
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
Constructs a Category Axis.
A Category Axis is a visual representation of a Category Scale.