Skip to content

Commit

Permalink
Update stale documentation for axis titles (#9683)
Browse files Browse the repository at this point in the history
* Update stale documentation for axis titles (#9682)

Updated the documentation for the types on axis labels.

In the corresponding `index.esm.d.ts` file, put JSDoc descriptions for
the properties to match the now-updated documentation.

* Clean up axis title labels documentation (#9682)

Inserted extra information in the documentation for the type of the
padding, inserted missing full stops.

In the type file, added JSDoc for undocumented properties.

* Update docs/axes/labelling.md

* Update types/index.esm.d.ts

Co-authored-by: Jukka Kurkela <jukka.kurkela@gmail.com>
  • Loading branch information
carsonalh and kurkle committed Nov 29, 2021
1 parent 67aa6eb commit 5e5339d
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 1 deletion.
2 changes: 1 addition & 1 deletion docs/axes/labelling.md
Expand Up @@ -13,7 +13,7 @@ Namespace: `options.scales[scaleId].title`, it defines options for the scale tit
| `text` | `string`\|`string[]` | `''` | The text for the title. (i.e. "# of People" or "Response Choices").
| `color` | [`Color`](../general/colors.md) | `Chart.defaults.color` | Color of label.
| `font` | `Font` | `Chart.defaults.font` | See [Fonts](../general/fonts.md)
| `padding` | [`Padding`](../general/padding.md) | `4` | Padding to apply around scale labels. Only `top` and `bottom` are implemented.
| `padding` | [`Padding`](../general/padding.md) | `4` | Padding to apply around scale labels. Only `top`, `bottom` and `y` are implemented.

## Creating Custom Tick Formats

Expand Down
11 changes: 11 additions & 0 deletions types/index.esm.d.ts
Expand Up @@ -2937,15 +2937,26 @@ export interface CartesianScaleOptions extends CoreScaleOptions {

grid: GridLineOptions;

/** Options for the scale title. */
title: {
/** If true, displays the axis title. */
display: boolean;
/** Alignment of the axis title. */
align: 'start' | 'center' | 'end';
/** The text for the title, e.g. "# of People" or "Response Choices". */
text: string | string[];
/** Color of the axis label. */
color: Color;
/** Information about the axis title font. */
font: FontSpec;
/** Padding to apply around scale labels. */
padding: number | {
/** Padding on the (relative) top side of this axis label. */
top: number;
/** Padding on the (relative) bottom side of this axis label. */
bottom: number;
/** This is a shorthand for defining top/bottom to the same values. */
y: number;
};
};

Expand Down

0 comments on commit 5e5339d

Please sign in to comment.