Skip to content

Commit

Permalink
Update Legend docs (#290)
Browse files Browse the repository at this point in the history
  • Loading branch information
PavelVanecek committed Feb 2, 2024
1 parent 8abc6c6 commit a0215b3
Showing 1 changed file with 13 additions and 3 deletions.
16 changes: 13 additions & 3 deletions src/docs/api/Legend.js
Original file line number Diff line number Diff line change
Expand Up @@ -44,17 +44,27 @@ export default {
defaultVal: "'center'",
isOptional: false,
desc: {
'en-US': "The alignment of legend items in 'horizontal' direction, which can be 'left', 'center', 'right'.",
'en-US': `
'left' shows the Legend to the left of the chart, and chart width reduces automatically to make space for it.
'right' shows the Legend to the right of the chart, and chart width reduces automatically.
'center' shows the Legend in the middle of chart, and chart width remains unchanged.
The exact behavior changes depending on 'verticalAlign' prop.
`,
'zh-CN': '水平方向的对齐方式。',
},
},
{
name: 'verticalAlign',
type: "'top', 'middle', 'bottom'",
defaultVal: "'middle'",
defaultVal: "'bottom'",
isOptional: false,
desc: {
'en-US': "The alignment of legend items in 'vertical' direction, which can be 'top', 'middle', 'bottom'.",
'en-US': `
'bottom' shows the Legend below chart, and chart height reduces automatically to make space for it.
'top' shows the Legend above chart, and chart height reduces automatically.
'middle' shows the Legend in the middle of chart, covering other content, and chart height remains unchanged.
The exact behavior changes depending on 'align' prop.
`,
'zh-CN': '垂直方向的对齐方式。',
},
},
Expand Down

0 comments on commit a0215b3

Please sign in to comment.