Skip to content

Commit 27f5971

Browse files
committed
docs: update description for rectStyle
1 parent a0106fe commit 27f5971

2 files changed

Lines changed: 6 additions & 4 deletions

File tree

src/utils/themes/theme.ts

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -399,9 +399,11 @@ export interface RectStyle {
399399
fill?: Color | ColorVariant;
400400
/** the opacity of each rect on the theme/series */
401401
opacity: number;
402-
/** The width of the rect in pixel */
402+
/** The width of the rect in pixel. If expressed together with `widthRatio` then the `widthRatio`
403+
* will express the max available size, where the `widthPixel` express the derived/min width. */
403404
widthPixel?: Pixels;
404-
/** The ratio of the width limited to [0,1] */
405+
/** The ratio of the width limited to [0,1]. If expressed together with `widthPixel` then the `widthRatio`
406+
* will express the max available size, where the `widthPixel` express the derived/min width. */
405407
widthRatio?: Ratio;
406408
}
407409

stories/stylings/10_custom_bars.tsx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
import { boolean, color, number } from '@storybook/addon-knobs';
2121
import React from 'react';
2222

23-
import { Axis, BarSeries, Chart, Position, ScaleType, Settings, RecursivePartial, Theme } from '../../src';
23+
import { Axis, BarSeries, Chart, Position, ScaleType, Settings, PartialTheme } from '../../src';
2424
import * as TestDatasets from '../../src/utils/data_samples/test_dataset';
2525

2626
function range(title: string, min: number, max: number, value: number, groupId?: string, step = 1) {
@@ -55,7 +55,7 @@ export const Example = () => {
5555
},
5656
};
5757

58-
const theme: RecursivePartial<Theme> = {
58+
const theme: PartialTheme = {
5959
barSeriesStyle: {
6060
rectBorder: {
6161
stroke: color('theme border stroke', 'red', 'Chart Global Theme'),

0 commit comments

Comments
 (0)