@vizzly/dashboard 0.14.4-dev-141913bcc9dced2a3f4a2c5c2d40ac36ba1bb900 → 0.14.4-dev-6c156e11d67aa5e19cb11392e1ce7bd8d55de310

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,3 +1,3 @@
1
1
  import { Component } from '../Component/types';
2
- export declare function validateLabelFormat(labelFormatFunc?: (options?: Component.LabelFormatOptions) => string | undefined): (options?: Component.LabelFormatOptions | undefined) => string | undefined;
2
+ export declare function validateLabelFormat(labelFormatFunc?: (options: Component.LabelFormatOptions) => string | undefined): (options: Component.LabelFormatOptions) => string | undefined;
3
3
  export declare const prepareLabelFormatValues: (dimensionKeys?: string[] | undefined, dimensionValues?: (string | number | string[] | null)[] | undefined) => Component.LabelFormatOptionsValues;
@@ -5,6 +5,7 @@ import { Result } from '../Result/types';
5
5
  import { PivotConfig } from '../PivotConfig/types';
6
6
  import { QueryAttributes } from '../QueryAttributes/types';
7
7
  import { Component, FormatType } from '../Component/types';
8
+ import { seriesLabelFormatter } from '../Result/formattedResultToSeries';
8
9
  interface buildLineChartRepresentationArgs {
9
10
  axisTitles?: Component.AxisTitles;
10
11
  colors?: CSSProperties['color'][];
@@ -32,6 +33,7 @@ interface buildLineChartRepresentationArgs {
32
33
  yAxisPostfix: string;
33
34
  yAxisPrefix: string;
34
35
  approxYAxisLabelCount: number;
36
+ seriesLabelFormatter: seriesLabelFormatter;
35
37
  }
36
- export declare const buildLineChartRepresentation: ({ axisTitles, colors, conditionalFormattingAttributes, dateTimeFormatOptions, defaultFormats, goalLineAttributes, nullValue, numberFormatOptions, order, pivotConfig, result, trendsAndForecasts, xAxisFormat, xAxisPostfix, xAxisPrefix, yAxisFormat, yAxisPostfix, yAxisPrefix, approxYAxisLabelCount, }: buildLineChartRepresentationArgs) => LineChartRepresentation;
38
+ export declare const buildLineChartRepresentation: ({ axisTitles, colors, conditionalFormattingAttributes, dateTimeFormatOptions, defaultFormats, goalLineAttributes, nullValue, numberFormatOptions, order, pivotConfig, result, trendsAndForecasts, xAxisFormat, xAxisPostfix, xAxisPrefix, yAxisFormat, yAxisPostfix, yAxisPrefix, approxYAxisLabelCount, seriesLabelFormatter, }: buildLineChartRepresentationArgs) => LineChartRepresentation;
37
39
  export {};
@@ -15,5 +15,10 @@ declare type Returns = {
15
15
  };
16
16
  seriesData: FormattedResult['contentMapped'];
17
17
  };
18
- export declare const formattedResultToSeries: (formattedResult: FormattedResult, pivotConfig: PivotConfig) => Returns;
18
+ export declare type seriesLabelFormatter = (params: {
19
+ yResultField: FormattedResult['fields'][number];
20
+ yPivotFields: FormattedResult['fields'];
21
+ row: FormattedResult['contentMapped'][number];
22
+ }) => string;
23
+ export declare const formattedResultToSeries: (formattedResult: FormattedResult, pivotConfig: PivotConfig, seriesLabelFormatter: seriesLabelFormatter) => Returns;
19
24
  export {};
@@ -134,7 +134,7 @@ export declare type DashboardBehaviour = {
134
134
  };
135
135
  export declare type TextOverride = (key: string, defaultValue: string, options?: TranslationOptions) => string;
136
136
  export declare type FilterLibrary = (data: Component[]) => Component[];
137
- export declare type LabelFormat = (options?: Component.LabelFormatOptions) => string | undefined;
137
+ export declare type LabelFormat = (options: Component.LabelFormatOptions) => string | undefined;
138
138
  export declare type TranslationOptions = {
139
139
  [key: string]: string | number | Pluralised;
140
140
  };
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@vizzly/dashboard",
3
3
  "author": "james@vizzly.co",
4
- "version": "0.14.4-dev-141913bcc9dced2a3f4a2c5c2d40ac36ba1bb900",
4
+ "version": "0.14.4-dev-6c156e11d67aa5e19cb11392e1ce7bd8d55de310",
5
5
  "source": "src/index.tsx",
6
6
  "types": "./dist/dashboard/src/index.d.ts",
7
7
  "main": "dist/index.js",