Skip to content

Commit

Permalink
docs: added documentation regarding align prop
Browse files Browse the repository at this point in the history
  • Loading branch information
ColinEberhardt authored and chrisprice committed Apr 30, 2020
1 parent 90bdbfb commit fd30380
Showing 1 changed file with 38 additions and 1 deletion.
39 changes: 38 additions & 1 deletion packages/d3fc-series/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -593,6 +593,12 @@ The WebGL implementation does not support this property.

If *orientation* is specified, sets the orientation and returns this series. If *orientation* is not specified, returns the current orientation. The orientation value should be either `horizontal` (default) or `vertical`.

<a name="seriesBar_align" href="#seriesBar_align">#</a> *seriesBar*.**align**(*alignment*)

The WebGL implementation does not support this property.

If *alignment* is specified, sets the alignment and returns this series. If *alignment* is not specified, returns the current alignment. The alignment value should be `left`, `right` or `center` (default) and describes how the alignment of each bar with respect to the central value.

<a name="seriesBar_xScale" href="#seriesBar_xScale">#</a> *seriesBar*.**xScale**(*scale*)
<a name="seriesBar_yScale" href="#seriesBar_yScale">#</a> *seriesBar*.**yScale**(*scale*)

Expand Down Expand Up @@ -649,6 +655,12 @@ If *scale* is specified, sets the scale and returns this series. If *scale* is n

If *bandwidthFunc* is specified, sets the bandwidth function and returns this series. If *bandwidthFunc* is not specified, returns the current bandwidth function.

<a name="seriesCandlestick_align" href="#seriesCandlestick_align">#</a> *seriesCandlestick*.**align**(*alignment*)

The WebGL implementation does not support this property.

If *alignment* is specified, sets the alignment and returns this series. If *alignment* is not specified, returns the current alignment. The alignment value should be `left`, `right` or `center` (default) and describes how the alignment of each candlestick with respect to the central value.

<a name="seriesCandlestick_decorate" href="#seriesCandlestick_decorate">#</a> *seriesCandlestick*.**decorate**(*decorateFunc*)

If *decorateFunc* is specified, sets the decorator function to the specified function, and returns this series. If *decorateFunc* is not specified, returns the current decorator function.
Expand Down Expand Up @@ -704,10 +716,16 @@ If *accessorFunc* is specified, sets the accessor to the specified function and

If *scale* is specified, sets the scale and returns this series. If *scale* is not specified, returns the current scale.

<a name="seriesCandlestick_bandwidth" href="#seriesCandlestick_bandwidth">#</a> *seriesCandlestick*.**bandwidth**(*bandwidthFunc*)
<a name="seriesOhlc_bandwidth" href="#seriesOhlc_bandwidth">#</a> *seriesOhlc*.**bandwidth**(*bandwidthFunc*)

If *bandwidthFunc* is specified, sets the bandwidth function and returns this series. If *bandwidthFunc* is not specified, returns the current bandwidth function.

<a name="seriesOhlc_align" href="#seriesOhlc_align">#</a> *seriesOhlc*.**align**(*alignment*)

The WebGL implementation does not support this property.

If *alignment* is specified, sets the alignment and returns this series. If *alignment* is not specified, returns the current alignment. The alignment value should be `left`, `right` or `center` (default) and describes how the alignment of each OHLC with respect to the central value.

<a name="seriesOhlc_decorate" href="#seriesOhlc_decorate">#</a> *seriesOhlc*.**decorate**(*decorateFunc*)

If *decorateFunc* is specified, sets the decorator function to the specified function, and returns this series. If *decorateFunc* is not specified, returns the current decorator function.
Expand Down Expand Up @@ -774,6 +792,12 @@ If *scale* is specified, sets the scale and returns this series. If *scale* is n

If *bandwidthFunc* is specified, sets the bandwidth function and returns this series. If *bandwidthFunc* is not specified, returns the current bandwidth function.

<a name="seriesBoxPlot_align" href="#seriesBoxPlot_align">#</a> *seriesBoxPlot*.**align**(*alignment*)

The WebGL implementation does not support this property.

If *alignment* is specified, sets the alignment and returns this series. If *alignment* is not specified, returns the current alignment. The alignment value should be `left`, `right` or `center` (default) and describes how the alignment of each boxplot with respect to the central value.

<a name="seriesBoxPlot_cap" href="#seriesBoxPlot_cap">#</a> *seriesBoxPlot*.**cap**(*capFunc*)

If *capFunc* is specified, sets the cap function and returns this series. If *capFunc* is not specified, returns the current cap function. The `capFunc(item, index)` function is called on each item of the data, and returns the **proportion** of the box width that the caps width should be.
Expand Down Expand Up @@ -841,6 +865,12 @@ If *scale* is specified, sets the scale and returns this series. If *scale* is n

If *bandwidthFunc* is specified, sets the bandwidth function and returns this series. If *bandwidthFunc* is not specified, returns the current bandwidth function.

<a name="serieErrorsBar_align" href="#seriesErrorBar_align">#</a> *seriesErrorBar*.**align**(*alignment*)

The WebGL implementation does not support this property.

If *alignment* is specified, sets the alignment and returns this series. If *alignment* is not specified, returns the current alignment. The alignment value should be `left`, `right` or `center` (default) and describes how the alignment of each errorbar with respect to the central value.

<a name="seriesErrorBar_decorate" href="#seriesErrorBar_decorate">#</a> *seriesErrorBar*.**decorate**(*decorateFunc*)

If *decorateFunc* is specified, sets the decorator function to the specified function, and returns this series. If *decorateFunc* is not specified, returns the current decorator function.
Expand Down Expand Up @@ -902,6 +932,13 @@ If *colorInterpolate* is specified, sets the interpolator used to map color valu

If *bandwidthFunc* is specified, sets the bandwidth function and returns this series. If *bandwidthFunc* is not specified, returns the current bandwidth function.

<a name="seriesHeatmap_yAlign" href="#seriesHeatmap_yAlign">#</a> *seriesHeatmap*.**yAlign**(*alignment*)
<a name="seriesHeatmap_xAlign" href="#seriesHeatmap_xAlign">#</a> *seriesHeatmap*.**xAlign**(*alignment*)

The WebGL implementation does not support this property.

If *alignment* is specified, sets the alignment and returns this series. If *alignment* is not specified, returns the current alignment. The alignment value should be `left`, `right` or `center` (default) and describes how the alignment of each heatmap cell with respect to the central value.

<a name="seriesHeatmap_decorate" href="#seriesHeatmap_decorate">#</a> *seriesHeatmap*.**decorate**(*decorateFunc*)

If *decorateFunc* is specified, sets the decorator function to the specified function, and returns this series. If *decorateFunc* is not specified, returns the current decorator function.
Expand Down

0 comments on commit fd30380

Please sign in to comment.