feat(chart): added description

core-ds · Sep 17, 2021 · 8275346 · 8275346
1 parent 9a4c076
commit 8275346
Show file tree

Hide file tree

Showing 9 changed files with 690 additions and 24 deletions.
diff --git a/packages/chart/src/docs/description.mdx b/packages/chart/src/docs/description.mdx
diff --git a/packages/chart/src/types/brush.type.ts b/packages/chart/src/types/brush.type.ts
@@ -35,7 +35,7 @@ export interface BrushProps {
      */
     alwaysShowText?: boolean;
     /**
-     * Цвевт
+     * Цвет
      */
     stroke?: string;
 }
diff --git a/packages/chart/src/types/charts.type.ts b/packages/chart/src/types/charts.type.ts
@@ -15,25 +15,25 @@ export interface ChartsProps {
      */
     id: string;
     /**
-     * Компонент контейнера, позволяющий адаптировать диаграммы к размеру родительского контейнера.
+     * Компонент контейнера, позволяющий адаптировать диаграммы к размеру родительского контейнера
      */
     responsiveContainer?: ResponsiveContainerProps;
     /**
-     * Диаграмма, состоящая из линейных диаграмм, диаграмм с областями и гистограмм.
+     * Диаграмма, состоящая из bar, linear и area диаграмм
      */
     composeChart: ComposedChartProps;
     /**
-     * Компонент линий осей графика
+     * Отображение линий осей графика
      */
-    cartesianGrid: CartesianGridProps;
+    cartesianGrid?: CartesianGridProps;
     /**
-     * Ось Х графика
+     * Настройки оси Х
      */
-    xAxis?: XAxisProps;
+    xAxis: XAxisProps;
     /**
-     * Ось У графика
+     * Настройки оси У
      */
-    yAxis?: YAxisProps;
+    yAxis: YAxisProps;
     /**
      * Всплывающаяся подсказка
      */
@@ -47,11 +47,11 @@ export interface ChartsProps {
      */
     legend?: LegendProps;
     /**
-     * Массив графиков для отображения
+     * Mассив объектов с параметрами грaфиков с обязательным полем
      */
     series: SeriaProps[];
     /**
-     * "Положение" в поле просмотра декартовых координат
+     * Mассив меток
      */
     labels: Array<string | number>;
     children?: React.ReactNode;

diff --git a/packages/chart/src/types/composedChart.type.ts b/packages/chart/src/types/composedChart.type.ts
@@ -1,6 +1,6 @@
 export interface ComposedChartProps {
     /**
-     * Отступы внутри графика для иницилизации
+     * Отступы графика на момент инициализации компонента
      */
     initMargin?: {
         top?: number;
@@ -26,7 +26,7 @@ export interface ComposedChartProps {
      */
     barCategoryGap?: string | number;
     /**
-     * Ширина графиков типа bar
+     * Разрыв между двумя столбцами одной категории
      */
     barGap?: number;
 }
diff --git a/packages/chart/src/types/legend.type.ts b/packages/chart/src/types/legend.type.ts
@@ -16,7 +16,7 @@ export interface LegendProps {
      */
     align?: 'left' | 'center' | 'right';
     /**
-     * Вертикальный отстуа
+     * Вертикальный отступ
      */
     marginTop?: number;
     /**

diff --git a/packages/chart/src/types/seria.type.ts b/packages/chart/src/types/seria.type.ts
@@ -12,7 +12,7 @@ export interface SeriaProps {
      */
     hideLegend?: boolean;
     /**
-     * Скрыть график в тултипк
+     * Скрыть график в тултипe
      */
     hideTooltip?: boolean;
     /**
@@ -30,15 +30,15 @@ export interface SeriaProps {
     /**
      * Оффсет для градиента (только для типа area)
      */
-    offset?: number;
+    offset: number;
     /**
      * Заливка графика
      */
     fill?: string;
     /**
-     * Параметры градиента
+     * Прозрачность
      */
-    gradient?: {
+    gradient: {
         /**
          * Индефикатор градиента
          */

diff --git a/packages/chart/src/types/utils/axis.ts b/packages/chart/src/types/utils/axis.ts
@@ -6,7 +6,7 @@ export interface AxisProps {
      */
     hide?: boolean;
     /**
-     * Показывать линию оси.
+     * Отображение линии оси.
      */
     axisLine: boolean;
     /**

diff --git a/packages/chart/src/types/utils/data.type.ts b/packages/chart/src/types/utils/data.type.ts
@@ -1,6 +1,6 @@
 export interface DataProps {
     /**
-     * Подпись значения
+     * Метка
      */
     label: string | number;
     /**

diff --git a/packages/chart/src/types/utils/dot.type.ts b/packages/chart/src/types/utils/dot.type.ts
@@ -15,11 +15,11 @@ export interface DotSettingProps {
      */
     initScale: number;
     /**
-     * Ширина.
+     * Ширина точки.
      */
     width: number;
     /**
-     * Высота.
+     * Высота точки.
      */
     height: number;
 }