@vizzly/dashboard 0.14.4-dev-6c156e11d67aa5e19cb11392e1ce7bd8d55de310 → 0.14.4-dev-cf1ef4725808a85153bb29a9fe9ca63060a721d0

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.
@@ -35,5 +35,5 @@ interface buildLineChartRepresentationArgs {
35
35
  approxYAxisLabelCount: number;
36
36
  seriesLabelFormatter: seriesLabelFormatter;
37
37
  }
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;
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, valueAlias, }: buildLineChartRepresentationArgs) => LineChartRepresentation;
39
39
  export {};
@@ -3,8 +3,6 @@ import { Component } from '../Component/types';
3
3
  interface getGoalLinesArgs {
4
4
  goalLineAttributes: Component.GoalLine.Rule[];
5
5
  formattingFunctionY: (value: any) => string;
6
- yAxisPostfix: string | undefined;
7
- yAxisPrefix: string | undefined;
8
6
  }
9
- export declare const getGoalLines: ({ goalLineAttributes, formattingFunctionY, yAxisPostfix, yAxisPrefix, }: getGoalLinesArgs) => GoalLine[];
7
+ export declare const getGoalLines: ({ goalLineAttributes, formattingFunctionY }: getGoalLinesArgs) => GoalLine[];
10
8
  export {};
@@ -1,9 +1,11 @@
1
1
  import { DataType } from '../Field/types';
2
2
  import { FormattedResult } from '../Result/types';
3
- export declare const getMinAndMax: ({ data, key, dataType, }: {
3
+ import { GoalLine } from './types';
4
+ export declare const getMinAndMax: ({ data, keys, dataType, goalLines, }: {
4
5
  data: FormattedResult['contentMapped'];
5
- key: string | null;
6
+ keys: Array<string>;
6
7
  dataType: DataType;
8
+ goalLines?: GoalLine[] | undefined;
7
9
  }) => {
8
10
  max: null;
9
11
  min: null;
@@ -1,7 +1,7 @@
1
1
  import { ValueAliasFunctionV2 } from '../ValueAlias/types';
2
2
  import { FormattedResult, Result } from './types';
3
3
  import { DateTimeFormatter, NumberFormatter } from '../LineChartV2/types';
4
- export declare type _params = {
4
+ export declare type formatResultArgs = {
5
5
  defaultFormats: () => {
6
6
  [functionId: string]: string;
7
7
  };
@@ -33,4 +33,4 @@ export declare type _params = {
33
33
  * When provided with a result, and formatting parameters, it returns a
34
34
  * populated result including the formatted value to show.
35
35
  */
36
- export declare const formatResult: (result: Result, params: _params) => FormattedResult;
36
+ export declare const formatResult: (result: Result, params: formatResultArgs) => FormattedResult;
@@ -22,8 +22,11 @@ declare type Datum = {
22
22
  export declare const getExplanationsOfConditionFormattingRulesThatApplyToSeries: (dimensions: QueryAttributesType.Dimension[], conditionalFormattingRules: ActualComponent.ConditionalFormatting.Rule[], seriesKey: string, supportedAggregates: DashboardBehaviour['queryEngineConfig']['supportedAggregates'], dataSet: DataSetType) => Array<ConditionalFormattingOption>;
23
23
  export declare const applyConditionFormattingRules: (dimensions: QueryAttributesType.Dimension[], conditionalFormattingRules: ConditionalFormattingBoundary[], datum: Datum | undefined, key: string, dataSet: DataSetType) => ActualComponent.ConditionalFormatting.DisplayRule | undefined;
24
24
  export declare function formattedFallbackDateTime(value: string | number | Date): string;
25
+ /** @deprecated - for new charts, formatting is done in the `formatResult` function. */
25
26
  export declare const formatXAxisLabel: (timeDimension: QueryAttributesType.TimeDimension | null, axisLabelConfig: AxisLabelConfig, valueAlias?: DashboardBehaviour['valueAlias']) => (value: any, fieldId?: string | null | undefined) => string;
27
+ /** @deprecated - for new charts, formatting is done in the `formatResult` function. */
26
28
  export declare const formatYAxisLabel: (textOverride: TextOverride, axisLabelConfig?: AxisLabelConfig | undefined) => (value: any) => string;
29
+ /** @deprecated - for new charts, build series using formattedResultToSeries. */
27
30
  export declare const formatSeriesName: (result: ResultType | null | undefined, textOverride: TextOverride, type: ComponentType, id: string, labelFormat: LabelFormat) => (key: string) => string | undefined;
28
31
  export declare const convertValueToFormat: (value: any, numberFormatOptions?: {
29
32
  [id: string]: import("../contexts/DashboardBehaviour/types").NumberFormatter;
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-6c156e11d67aa5e19cb11392e1ce7bd8d55de310",
4
+ "version": "0.14.4-dev-cf1ef4725808a85153bb29a9fe9ca63060a721d0",
5
5
  "source": "src/index.tsx",
6
6
  "types": "./dist/dashboard/src/index.d.ts",
7
7
  "main": "dist/index.js",