Class D3RaphaelAxis
A Raphael axis renderer function, intended to be used like d3.svg.axis
.
caveates and differences documented below.
If you don't see a method documented, it probably doesn't exist yet.
NOTE: The object is actually a function with signature function(selection)
, to be called with a selection to which it renders it's axis,
Defined in: _documentation.js.
Constructor Attributes | Constructor Name and Description |
---|---|
Method Attributes | Method Name and Description |
---|---|
classPrefix(val)
Get or set the class name prefix appended to the class names used to differentiate parts of the rendered axis.
|
|
left(val)
Get or set the left offset for the axis rendering.
|
|
orient(x)
Get or set the axis orientation.
|
|
scale(x)
Get or set the associated scale.
|
|
tickSize(x, y, z)
Get or set the size of major, minor and end ticks.
|
|
top(val)
Get or set the top offset for axis rendering.
|
Method Detail
{D3RaphaelAxis}
classPrefix(val)
Get or set the class name prefix appended to the class names used to differentiate parts of the rendered axis.
Class name suffixes used internally are:
Defined in: axis.js.
Class name suffixes used internally are:
- path
- axis ticks
- pathdomain
- axis domain line (and end-ticks)
xaxis_
, you would want to specify CSS selectors, .xaxis_path
and .xaxis_pathdomain
Defined in: axis.js.
- Parameters:
- {String} val
- Returns:
- {D3RaphaelAxis} this
{D3RaphaelAxis}
left(val)
Get or set the left offset for the axis rendering. This is a work-around for the fact Raphael doesn't have a group element.
Defined in: axis.js.
Defined in: axis.js.
- Parameters:
- {Number} val
- left offset, in pixels
- Returns:
- {D3RaphaelAxis} this
{D3RaphaelAxis}
orient(x)
Get or set the axis orientation. If orientation is not specified, returns the current orientation, which defaults to "bottom".
Defined in: axis.js.
Defined in: axis.js.
- Parameters:
- {String} x
- orientation, one of top, bottom, or left. NOTE: right currently unsupported. top/bottom for horizontal axis, and left for vertical.
- Returns:
- {D3RaphaelAxis} this
{D3RaphaelAxis}
scale(x)
Get or set the associated scale. If scale is specified, sets the scale and returns the axis. If scale is not specified, returns the current scale which defaults to a linear scale.
Defined in: axis.js.
Defined in: axis.js.
- Parameters:
- {d3.Scale} x
- scale
- Returns:
- {D3RaphaelAxis} this
{D3RaphaelAxis}
tickSize(x, y, z)
Get or set the size of major, minor and end ticks.
Defined in: axis.js.
Defined in: axis.js.
- Parameters:
- {Number} x
- major tick size
- {Number} y
- minor tick size (optional)
- {Number} z
- end tick size (optional)
- Returns:
- {D3RaphaelAxis} this
{D3RaphaelAxis}
top(val)
Get or set the top offset for axis rendering. This is a work-around for the fact Raphael doesn't have a group element.
Defined in: axis.js.
Defined in: axis.js.
- Parameters:
- {Number} val
- top offset, in pixels
- Returns:
- {D3RaphaelAxis} this