Function addOrdinalStringAxis

addOrdinalStringAxis(
    chartId: number,
    axisId: string,
    svg: SvgSelection,
    location: AxisLocation,
    categories: string[],
    axisLabel: string,
    axesLabelFont: AxesFont,
    axisTickStyle: AxisTickStyle,
    plotDimensions: Dimensions,
    margin: Margin,
    setAxisRangeFor: (axisId: string, range: AxisInterval) => void,
    setOriginalAxisRangeFor: (axisId: string, range: AxisInterval) => void,
): OrdinalStringAxis
Adds a category axis to the specified location. When the location is top or bottom, the category axis represents the x-axis. When the location is left or right, then the category axis represents the y-axis.
Parameters
- chartId: number
  The unique ID of the chart to which this axis belongs
- axisId: string
  A unique ID for the axis
- svg: SvgSelection
  The SVG selection (d3)
- location: AxisLocation
  The location of the axis
- categories: string[]
  An array holding the category names
- axisLabel: string
  The axis label
- axesLabelFont: AxesFont
  The font for the axis label
- axisTickStyle: AxisTickStyle
  Styling information for the ticks (e.g. font, rotation, etc)
- plotDimensions: Dimensions
  The dimensions of the plot
- margin: Margin
  The plot margin
- setAxisRangeFor: (axisId: string, range: AxisInterval) => void
  Lambda that sets the axis range for the specified axis
- setOriginalAxisRangeFor: (axisId: string, range: AxisInterval) => void
  Lambda that sets the original axis range for the specified axis
Returns OrdinalStringAxis
A category axis
- Defined in app/charts/axes/axes.ts:234

Function addOrdinalStringAxis

Parameters

Returns OrdinalStringAxis

Settings