@vizzly/services 0.12.11 → 0.12.12
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.
- package/dist/index.js +1 -1
- package/dist/results-driver/src/driver/VizzlyQuery/AreaChart/toQueries.d.ts +1 -1
- package/dist/results-driver/src/driver/VizzlyQuery/BarChart/toQueries.d.ts +1 -1
- package/dist/results-driver/src/driver/VizzlyQuery/BasicTable/toQueries.d.ts +1 -1
- package/dist/results-driver/src/driver/VizzlyQuery/FunnelChart/toQueries.d.ts +4 -0
- package/dist/results-driver/src/driver/VizzlyQuery/HorizontalBarChart/toQueries.d.ts +1 -1
- package/dist/results-driver/src/driver/VizzlyQuery/LineChart/toQueries.d.ts +1 -1
- package/dist/results-driver/src/driver/VizzlyQuery/PieChart/toQueries.d.ts +1 -1
- package/dist/results-driver/src/driver/VizzlyQuery/PivotTable/toQueries.d.ts +1 -1
- package/dist/results-driver/src/driver/VizzlyQuery/RichText/toQueries.d.ts +4 -0
- package/dist/results-driver/src/driver/VizzlyQuery/commonToQueries.d.ts +1 -1
- package/dist/results-driver/src/types.d.ts +11 -10
- package/dist/services/src/Services/View.d.ts +5 -1
- package/dist/shared-logic/src/AdditionalFilter/AdditionalFilter.d.ts +1 -0
- package/dist/shared-logic/src/Component/types.d.ts +24 -2
- package/dist/shared-logic/src/ComponentInterface/types/namespaces.types.d.ts +2 -1
- package/dist/shared-logic/src/DatumKey/DatumKey.d.ts +1 -0
- package/dist/shared-logic/src/Field/Field.d.ts +10 -3
- package/dist/shared-logic/src/FormatPanelConfig/types.d.ts +2 -1
- package/dist/shared-logic/src/FunnelChart/constants.d.ts +3 -0
- package/dist/shared-logic/src/FunnelChart/index.d.ts +4 -0
- package/dist/shared-logic/src/FunnelChart/setAttributes.d.ts +4 -0
- package/dist/shared-logic/src/JSQueryEngine/fetchData.d.ts +2 -1
- package/dist/shared-logic/src/Query/types.d.ts +2 -0
- package/dist/shared-logic/src/RichText/attributesSchema.d.ts +3 -0
- package/dist/shared-logic/src/RichText/constants.d.ts +3 -0
- package/dist/shared-logic/src/RichText/index.d.ts +4 -0
- package/dist/shared-logic/src/RichText/initialRichTextContent.d.ts +38 -0
- package/dist/shared-logic/src/RichText/setAttributes.d.ts +4 -0
- package/dist/shared-logic/src/api/queryEngine/getRunQueriesCallback.d.ts +1 -1
- package/dist/shared-logic/src/getComponentInterface.d.ts +1 -0
- package/package.json +1 -1
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
export declare const toQueries: (attributes: import("../../../../../shared-logic/src/Component/types").Component.BarChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.
|
|
1
|
+
export declare const toQueries: (attributes: import("../../../../../shared-logic/src/Component/types").Component.AreaChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.BarChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.BasicTableAttributes | import("../../../../../shared-logic/src/Component/types").Component.DataTableAttributes | import("../../../../../shared-logic/src/Component/types").Component.FunnelChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.RichTextAttributes | import("../../../../../shared-logic/src/Component/types").Component.HorizontalBarChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.LineChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.PieChartAttributes, dataSet: import("../../../../../shared-logic/src/DataSet/types").DataSet<import("../../../../../shared-logic/src/DataSet/types").DataSet.Field>, additionalFilters: import("../../../../../shared-logic/src/QueryAttributes/types").QueryAttributes.Filter[], queryEngineConfig: import("@vizzly/semantic-layer-public/dist/types").QueryEngineConfig) => {
|
|
2
2
|
queries: import("../../../../../shared-logic/src/Query/types").Query<string, string, string>[];
|
|
3
3
|
resultFields: import("../../../../../shared-logic/src/Result/types").Result.Field[][];
|
|
4
4
|
};
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
export declare const toQueries: (attributes: import("../../../../../shared-logic/src/Component/types").Component.BarChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.
|
|
1
|
+
export declare const toQueries: (attributes: import("../../../../../shared-logic/src/Component/types").Component.AreaChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.BarChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.BasicTableAttributes | import("../../../../../shared-logic/src/Component/types").Component.DataTableAttributes | import("../../../../../shared-logic/src/Component/types").Component.FunnelChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.RichTextAttributes | import("../../../../../shared-logic/src/Component/types").Component.HorizontalBarChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.LineChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.PieChartAttributes, dataSet: import("../../../../../shared-logic/src/DataSet/types").DataSet<import("../../../../../shared-logic/src/DataSet/types").DataSet.Field>, additionalFilters: import("../../../../../shared-logic/src/QueryAttributes/types").QueryAttributes.Filter[], queryEngineConfig: import("@vizzly/semantic-layer-public/dist/types").QueryEngineConfig) => {
|
|
2
2
|
queries: import("../../../../../shared-logic/src/Query/types").Query<string, string, string>[];
|
|
3
3
|
resultFields: import("../../../../../shared-logic/src/Result/types").Result.Field[][];
|
|
4
4
|
};
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
export declare const toQueries: (attributes: import("../../../../../shared-logic/src/Component/types").Component.BarChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.
|
|
1
|
+
export declare const toQueries: (attributes: import("../../../../../shared-logic/src/Component/types").Component.AreaChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.BarChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.BasicTableAttributes | import("../../../../../shared-logic/src/Component/types").Component.DataTableAttributes | import("../../../../../shared-logic/src/Component/types").Component.FunnelChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.RichTextAttributes | import("../../../../../shared-logic/src/Component/types").Component.HorizontalBarChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.LineChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.PieChartAttributes, dataSet: import("../../../../../shared-logic/src/DataSet/types").DataSet<import("../../../../../shared-logic/src/DataSet/types").DataSet.Field>, additionalFilters: import("../../../../../shared-logic/src/QueryAttributes/types").QueryAttributes.Filter[], queryEngineConfig: import("@vizzly/semantic-layer-public/dist/types").QueryEngineConfig) => {
|
|
2
2
|
queries: import("../../../../../shared-logic/src/Query/types").Query<string, string, string>[];
|
|
3
3
|
resultFields: import("../../../../../shared-logic/src/Result/types").Result.Field[][];
|
|
4
4
|
};
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
export declare const toQueries: (attributes: import("../../../../../shared-logic/src/Component/types").Component.AreaChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.BarChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.BasicTableAttributes | import("../../../../../shared-logic/src/Component/types").Component.DataTableAttributes | import("../../../../../shared-logic/src/Component/types").Component.FunnelChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.RichTextAttributes | import("../../../../../shared-logic/src/Component/types").Component.HorizontalBarChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.LineChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.PieChartAttributes, dataSet: import("../../../../../shared-logic/src/DataSet/types").DataSet<import("../../../../../shared-logic/src/DataSet/types").DataSet.Field>, additionalFilters: import("../../../../../shared-logic/src/QueryAttributes/types").QueryAttributes.Filter[], queryEngineConfig: import("@vizzly/semantic-layer-public/dist/types").QueryEngineConfig) => {
|
|
2
|
+
queries: import("../../../../../shared-logic/src/Query/types").Query<string, string, string>[];
|
|
3
|
+
resultFields: import("../../../../../shared-logic/src/Result/types").Result.Field[][];
|
|
4
|
+
};
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
export declare const toQueries: (attributes: import("../../../../../shared-logic/src/Component/types").Component.BarChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.
|
|
1
|
+
export declare const toQueries: (attributes: import("../../../../../shared-logic/src/Component/types").Component.AreaChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.BarChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.BasicTableAttributes | import("../../../../../shared-logic/src/Component/types").Component.DataTableAttributes | import("../../../../../shared-logic/src/Component/types").Component.FunnelChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.RichTextAttributes | import("../../../../../shared-logic/src/Component/types").Component.HorizontalBarChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.LineChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.PieChartAttributes, dataSet: import("../../../../../shared-logic/src/DataSet/types").DataSet<import("../../../../../shared-logic/src/DataSet/types").DataSet.Field>, additionalFilters: import("../../../../../shared-logic/src/QueryAttributes/types").QueryAttributes.Filter[], queryEngineConfig: import("@vizzly/semantic-layer-public/dist/types").QueryEngineConfig) => {
|
|
2
2
|
queries: import("../../../../../shared-logic/src/Query/types").Query<string, string, string>[];
|
|
3
3
|
resultFields: import("../../../../../shared-logic/src/Result/types").Result.Field[][];
|
|
4
4
|
};
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
export declare const toQueries: (attributes: import("../../../../../shared-logic/src/Component/types").Component.BarChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.
|
|
1
|
+
export declare const toQueries: (attributes: import("../../../../../shared-logic/src/Component/types").Component.AreaChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.BarChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.BasicTableAttributes | import("../../../../../shared-logic/src/Component/types").Component.DataTableAttributes | import("../../../../../shared-logic/src/Component/types").Component.FunnelChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.RichTextAttributes | import("../../../../../shared-logic/src/Component/types").Component.HorizontalBarChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.LineChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.PieChartAttributes, dataSet: import("../../../../../shared-logic/src/DataSet/types").DataSet<import("../../../../../shared-logic/src/DataSet/types").DataSet.Field>, additionalFilters: import("../../../../../shared-logic/src/QueryAttributes/types").QueryAttributes.Filter[], queryEngineConfig: import("@vizzly/semantic-layer-public/dist/types").QueryEngineConfig) => {
|
|
2
2
|
queries: import("../../../../../shared-logic/src/Query/types").Query<string, string, string>[];
|
|
3
3
|
resultFields: import("../../../../../shared-logic/src/Result/types").Result.Field[][];
|
|
4
4
|
};
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
export declare const toQueries: (attributes: import("../../../../../shared-logic/src/Component/types").Component.BarChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.
|
|
1
|
+
export declare const toQueries: (attributes: import("../../../../../shared-logic/src/Component/types").Component.AreaChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.BarChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.BasicTableAttributes | import("../../../../../shared-logic/src/Component/types").Component.DataTableAttributes | import("../../../../../shared-logic/src/Component/types").Component.FunnelChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.RichTextAttributes | import("../../../../../shared-logic/src/Component/types").Component.HorizontalBarChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.LineChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.PieChartAttributes, dataSet: import("../../../../../shared-logic/src/DataSet/types").DataSet<import("../../../../../shared-logic/src/DataSet/types").DataSet.Field>, additionalFilters: import("../../../../../shared-logic/src/QueryAttributes/types").QueryAttributes.Filter[], queryEngineConfig: import("@vizzly/semantic-layer-public/dist/types").QueryEngineConfig) => {
|
|
2
2
|
queries: import("../../../../../shared-logic/src/Query/types").Query<string, string, string>[];
|
|
3
3
|
resultFields: import("../../../../../shared-logic/src/Result/types").Result.Field[][];
|
|
4
4
|
};
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
export declare const toQueries: (attributes: import("../../../../../shared-logic/src/Component/types").Component.BarChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.
|
|
1
|
+
export declare const toQueries: (attributes: import("../../../../../shared-logic/src/Component/types").Component.AreaChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.BarChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.BasicTableAttributes | import("../../../../../shared-logic/src/Component/types").Component.DataTableAttributes | import("../../../../../shared-logic/src/Component/types").Component.FunnelChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.RichTextAttributes | import("../../../../../shared-logic/src/Component/types").Component.HorizontalBarChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.LineChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.PieChartAttributes, dataSet: import("../../../../../shared-logic/src/DataSet/types").DataSet<import("../../../../../shared-logic/src/DataSet/types").DataSet.Field>, additionalFilters: import("../../../../../shared-logic/src/QueryAttributes/types").QueryAttributes.Filter[], queryEngineConfig: import("@vizzly/semantic-layer-public/dist/types").QueryEngineConfig) => {
|
|
2
2
|
queries: import("../../../../../shared-logic/src/Query/types").Query<string, string, string>[];
|
|
3
3
|
resultFields: import("../../../../../shared-logic/src/Result/types").Result.Field[][];
|
|
4
4
|
};
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
export declare const toQueries: (attributes: import("../../../../../shared-logic/src/Component/types").Component.AreaChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.BarChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.BasicTableAttributes | import("../../../../../shared-logic/src/Component/types").Component.DataTableAttributes | import("../../../../../shared-logic/src/Component/types").Component.FunnelChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.RichTextAttributes | import("../../../../../shared-logic/src/Component/types").Component.HorizontalBarChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.LineChartAttributes | import("../../../../../shared-logic/src/Component/types").Component.PieChartAttributes, dataSet: import("../../../../../shared-logic/src/DataSet/types").DataSet<import("../../../../../shared-logic/src/DataSet/types").DataSet.Field>, additionalFilters: import("../../../../../shared-logic/src/QueryAttributes/types").QueryAttributes.Filter[], queryEngineConfig: import("@vizzly/semantic-layer-public/dist/types").QueryEngineConfig) => {
|
|
2
|
+
queries: import("../../../../../shared-logic/src/Query/types").Query<string, string, string>[];
|
|
3
|
+
resultFields: import("../../../../../shared-logic/src/Result/types").Result.Field[][];
|
|
4
|
+
};
|
|
@@ -5,7 +5,7 @@ import { Query as QueryType } from '../../../../shared-logic/src/Query/types';
|
|
|
5
5
|
import { QueryAttributes } from '../../../../shared-logic/src/QueryAttributes/types';
|
|
6
6
|
import { QueryEngineConfig } from '../../../../shared-logic/src/QueryEngineConfig/types';
|
|
7
7
|
import { Result } from '../../../../shared-logic/src/Result/types';
|
|
8
|
-
export declare const commonToQueries: (attributes: Component.AreaChartAttributes | Component.BarChartAttributes | Component.DataTableAttributes | Component.BasicTableAttributes | Component.HorizontalBarChartAttributes | Component.LineChartAttributes | Component.PieChartAttributes, dataSet: DataSet, additionalFilters: QueryAttributes.Filter[], queryEngineConfig: QueryEngineConfig) => {
|
|
8
|
+
export declare const commonToQueries: (attributes: Component.AreaChartAttributes | Component.BarChartAttributes | Component.DataTableAttributes | Component.BasicTableAttributes | Component.HorizontalBarChartAttributes | Component.LineChartAttributes | Component.PieChartAttributes | Component.FunnelChartAttributes | Component.RichTextAttributes, dataSet: DataSet, additionalFilters: QueryAttributes.Filter[], queryEngineConfig: QueryEngineConfig) => {
|
|
9
9
|
queries: QueryType[];
|
|
10
10
|
resultFields: Result.Field[][];
|
|
11
11
|
};
|
|
@@ -1,18 +1,18 @@
|
|
|
1
|
-
import { QueryEngineConfig, QueryEngineEndpoint } from
|
|
2
|
-
import { DataSet, DataSet as DataSetType } from
|
|
3
|
-
import { TimeRangeOptions, FilterConfig } from
|
|
4
|
-
import { loadDataCallback } from
|
|
5
|
-
import { Query } from
|
|
6
|
-
import { Result } from
|
|
1
|
+
import { QueryEngineConfig, QueryEngineEndpoint } from '../../shared-logic/src/QueryEngineConfig/types';
|
|
2
|
+
import { DataSet, DataSet as DataSetType } from '../../shared-logic/src/DataSet/types';
|
|
3
|
+
import { TimeRangeOptions, FilterConfig } from '../../shared-logic/src/AdditionalFilter/types';
|
|
4
|
+
import { loadDataCallback } from '../../shared-logic/src/Callbacks/types';
|
|
5
|
+
import { Query } from '../../shared-logic/src/Query/types';
|
|
6
|
+
import { Result } from '../../shared-logic/src/Result/types';
|
|
7
7
|
export declare type VizzlyQueryEngineDriver = {
|
|
8
|
-
type:
|
|
8
|
+
type: 'vizzlyQueryEngine';
|
|
9
9
|
queryEngineConfig: QueryEngineConfig;
|
|
10
10
|
queryEngineEndpoint: QueryEngineEndpoint;
|
|
11
11
|
dataAccessToken: string;
|
|
12
12
|
cacheKeyNamespace: string;
|
|
13
13
|
};
|
|
14
14
|
export declare type CustomDriver = {
|
|
15
|
-
type:
|
|
15
|
+
type: 'custom';
|
|
16
16
|
queryEngineConfig: QueryEngineConfig;
|
|
17
17
|
dataAccessToken?: string;
|
|
18
18
|
cacheKeyNamespace: string;
|
|
@@ -21,10 +21,10 @@ export declare type CustomDriver = {
|
|
|
21
21
|
abortSignal?: AbortSignal;
|
|
22
22
|
dataAccessToken?: string;
|
|
23
23
|
filterConfig?: FilterConfig;
|
|
24
|
-
}) => Promise<Array<Result | Result[
|
|
24
|
+
}) => Promise<Array<Result | Result['content'] | null> | null>;
|
|
25
25
|
};
|
|
26
26
|
export declare type VizzlyJsQueryEngineDriver = {
|
|
27
|
-
type:
|
|
27
|
+
type: 'vizzlyJsQueryEngine';
|
|
28
28
|
loadData: loadDataCallback;
|
|
29
29
|
cacheKeyNamespace: string;
|
|
30
30
|
};
|
|
@@ -34,4 +34,5 @@ export declare type Params = {
|
|
|
34
34
|
filterConfig: FilterConfig;
|
|
35
35
|
abortSignal?: AbortSignal;
|
|
36
36
|
timeRangeOptions: TimeRangeOptions;
|
|
37
|
+
timeZone?: string;
|
|
37
38
|
};
|
|
@@ -13,7 +13,7 @@ export declare class View<T extends Component.Attributes> {
|
|
|
13
13
|
} & RequiredAttributes<T>);
|
|
14
14
|
updateAttributes(newAttributes: Partial<T>): void;
|
|
15
15
|
}
|
|
16
|
-
export declare type AnyView = AreaChart | LineChart | BarChart | PieChart | ScatterChart | ComboChart | PivotTable | BasicTable | HorizontalBarChart | MercatorMap | SingleStat | Progress;
|
|
16
|
+
export declare type AnyView = AreaChart | LineChart | BarChart | PieChart | ScatterChart | ComboChart | PivotTable | BasicTable | HorizontalBarChart | MercatorMap | SingleStat | Progress | RichText;
|
|
17
17
|
export declare class AreaChart extends View<Component.AreaChartAttributes> {
|
|
18
18
|
constructor(attributes: Partial<Component.AreaChartAttributes> & RequiredAttributes<Component.AreaChartAttributes>);
|
|
19
19
|
static type(): Component.AreaChartAttributes['type'];
|
|
@@ -62,4 +62,8 @@ export declare class Progress extends View<Component.ProgressAttributes> {
|
|
|
62
62
|
constructor(attributes: Partial<Component.ProgressAttributes> & RequiredAttributes<Component.ProgressAttributes>);
|
|
63
63
|
static type(): Component.ProgressAttributes['type'];
|
|
64
64
|
}
|
|
65
|
+
export declare class RichText extends View<Component.RichTextAttributes> {
|
|
66
|
+
constructor(attributes: Partial<Component.RichTextAttributes> & RequiredAttributes<Component.RichTextAttributes>);
|
|
67
|
+
static type(): Component.RichTextAttributes['type'];
|
|
68
|
+
}
|
|
65
69
|
export {};
|
|
@@ -6,6 +6,7 @@ import { DateTimeFilterOptions } from '../DateTime/types';
|
|
|
6
6
|
import { TextOverride } from '../Translations/types';
|
|
7
7
|
import { QueryAttributes } from '../QueryAttributes/types';
|
|
8
8
|
export declare const typeToString: (type: AdditionalFilter['type'], textOverride: TextOverride) => string;
|
|
9
|
+
export declare const NULL_VALUE_OPT = "__vizzly_null_value_option";
|
|
9
10
|
export declare const allowedDataTypesForFilter: (type: AdditionalFilter['type']) => Array<DataType>;
|
|
10
11
|
export declare const dump: (hydrated: AdditionalFilter) => AdditionalFilter;
|
|
11
12
|
export declare const load: (dumped: AdditionalFilter, componentInterfaceConfig?: import("../ComponentInterface/types").ComponentInterfaceConfig | undefined) => AdditionalFilter;
|
|
@@ -10,7 +10,7 @@ import { Dictionary } from 'lodash';
|
|
|
10
10
|
export declare type getNumberFormatter = (formatterId: string | undefined | null) => (number: number) => string;
|
|
11
11
|
export declare type FormatType = string | null;
|
|
12
12
|
export declare type ApproxAxisLabelCount = 'auto' | number;
|
|
13
|
-
export declare type ComponentType = 'barChart' | '
|
|
13
|
+
export declare type ComponentType = 'areaChart' | 'barChart' | 'basicTable' | 'comboChart' | 'custom' | 'dataTable' | 'funnelChart' | 'horizontalBarChart' | 'lineChart' | 'mercatorMap' | 'pieChart' | 'progress' | 'richText' | 'scatterChart' | 'singleStat';
|
|
14
14
|
export declare const componentTypes: string[];
|
|
15
15
|
export declare namespace Component {
|
|
16
16
|
export type LineCurve = 'natural' | 'straight' | 'step' | 'stepBefore' | 'stepAfter';
|
|
@@ -31,6 +31,10 @@ export declare namespace Component {
|
|
|
31
31
|
type BaseQueryAttributes = QueryAttributes & {
|
|
32
32
|
dataSetId: string;
|
|
33
33
|
};
|
|
34
|
+
export type RichTextAttributes = BaseAttributes & BaseQueryAttributes & {
|
|
35
|
+
type: 'richText';
|
|
36
|
+
content: object;
|
|
37
|
+
};
|
|
34
38
|
export type MercatorMapAttributes = BaseAttributes & {
|
|
35
39
|
type: 'mercatorMap';
|
|
36
40
|
measure: BaseQueryAttributes['measure'];
|
|
@@ -69,6 +73,24 @@ export declare namespace Component {
|
|
|
69
73
|
headline?: Headline;
|
|
70
74
|
drilldownOptions: Array<DrilldownOptions> | undefined;
|
|
71
75
|
};
|
|
76
|
+
export type FunnelChartAttributes = BaseAttributes & BaseQueryAttributes & {
|
|
77
|
+
type: 'funnelChart';
|
|
78
|
+
conditionalFormattingRules: Array<ConditionalFormatting.Rule>;
|
|
79
|
+
xAxisPrefix: string;
|
|
80
|
+
yAxisPrefix: string;
|
|
81
|
+
xAxisPostfix: string;
|
|
82
|
+
yAxisPostfix: string;
|
|
83
|
+
xAxisFormat: FormatType;
|
|
84
|
+
yAxisFormat: FormatType;
|
|
85
|
+
approxXAxisLabelCount: ApproxAxisLabelCount;
|
|
86
|
+
approxYAxisLabelCount: ApproxAxisLabelCount;
|
|
87
|
+
legend: boolean;
|
|
88
|
+
protectedFields?: ProtectedFields;
|
|
89
|
+
parameters?: Parameters;
|
|
90
|
+
goalLines?: Array<Component.GoalLine.Rule>;
|
|
91
|
+
axisTitles?: AxisTitles;
|
|
92
|
+
headline?: Headline;
|
|
93
|
+
};
|
|
72
94
|
export type CustomViewAttributes = BaseAttributes & {
|
|
73
95
|
type: 'custom';
|
|
74
96
|
viewId: string;
|
|
@@ -267,7 +289,7 @@ export declare namespace Component {
|
|
|
267
289
|
goalLines?: Array<Component.GoalLine.Rule>;
|
|
268
290
|
axisTitles?: AxisTitles;
|
|
269
291
|
};
|
|
270
|
-
export type Attributes =
|
|
292
|
+
export type Attributes = AreaChartAttributes | BarChartAttributes | BasicTableAttributes | ComboChartAttributes | CustomViewAttributes | DataTableAttributes | FunnelChartAttributes | HorizontalBarChartAttributes | LineChartAttributes | MercatorMapAttributes | PieChartAttributes | ProgressAttributes | RichTextAttributes | ScatterChartAttributes | SingleStatAttributes;
|
|
271
293
|
export interface RenderTableCell {
|
|
272
294
|
viewId: string;
|
|
273
295
|
type: 'basicTable' | 'dataTable';
|
|
@@ -73,6 +73,7 @@ export interface FormatPanelNamespaces {
|
|
|
73
73
|
count: SubSection<'statsLabels'>;
|
|
74
74
|
};
|
|
75
75
|
};
|
|
76
|
+
rich_text?: Section<'richText'> & {};
|
|
76
77
|
heading: Section<'heading'> & {
|
|
77
78
|
subSectionDefinition: {
|
|
78
79
|
title: SubSection<'title'>;
|
|
@@ -105,5 +106,5 @@ export interface FormatPanelNamespaces {
|
|
|
105
106
|
};
|
|
106
107
|
};
|
|
107
108
|
}
|
|
108
|
-
export declare type ComponentNamespace = '
|
|
109
|
+
export declare type ComponentNamespace = 'area_chart' | 'bar_chart' | 'basic_table' | 'combo_chart' | 'custom' | 'fields' | 'funnel_chart' | 'headline' | 'horizontal_bar_chart' | 'line_chart' | 'mercator_map' | 'pie_chart' | 'pivot_table' | 'progress' | 'rich_text' | 'scatter_chart' | 'single_stat';
|
|
109
110
|
export {};
|
|
@@ -7,6 +7,7 @@ export declare type ParsedDatumKey = {
|
|
|
7
7
|
dimensionValues: Array<string | number | null | string[]>;
|
|
8
8
|
fieldId: string;
|
|
9
9
|
function: string;
|
|
10
|
+
modifier?: string;
|
|
10
11
|
};
|
|
11
12
|
export declare const key: (dimensionKeys: ParsedDatumKey['dimensionKeys'], dimensionValues: ParsedDatumKey['dimensionValues'], fieldId: ParsedDatumKey['fieldId'], func: ParsedDatumKey['function']) => string;
|
|
12
13
|
export declare const isDatumKey: (key: string | undefined) => boolean;
|
|
@@ -7,8 +7,8 @@ import { SupportedAggregates } from '../Aggregate';
|
|
|
7
7
|
import { SupportedTimeTruncFunctions } from '../TimeDimension/types';
|
|
8
8
|
import { QueryEngineConfig } from '../QueryEngineConfig/types';
|
|
9
9
|
import { SupportedTransformationFunctions } from '../Functions/types';
|
|
10
|
-
import * as Measure from '../Measure';
|
|
11
10
|
import { TextOverride } from '../Translations/types';
|
|
11
|
+
export declare const NULL_REPLACEMENT = "No value";
|
|
12
12
|
export declare const ALL_AGGREGATES: Array<QueryAttributes.Aggregate>;
|
|
13
13
|
export declare type OldField = {
|
|
14
14
|
id: string;
|
|
@@ -34,7 +34,7 @@ export declare const VALID_DATA_TYPES: DataType[];
|
|
|
34
34
|
export declare const isValidDataType: (type: string) => boolean;
|
|
35
35
|
export declare const toHumanReadable: (fieldTitle: string) => string;
|
|
36
36
|
export declare const dataTypeToHumanReadable: (dataType: DataType) => string;
|
|
37
|
-
export declare const toString: (value: null | string | number | Date | boolean | string[], formatDate
|
|
37
|
+
export declare const toString: (value: null | string | number | Date | boolean | string[], formatDate?: ((date: Date) => string) | undefined, nullReplacement?: string) => string | null;
|
|
38
38
|
export declare const toStringShort: (value: null | string | number | Date, nullReplacement?: string) => string | number;
|
|
39
39
|
export declare const removeFields: <T extends {
|
|
40
40
|
id: string;
|
|
@@ -102,5 +102,12 @@ declare type NullValueAlias = (params: {
|
|
|
102
102
|
dataSetId: string;
|
|
103
103
|
fieldId: string;
|
|
104
104
|
}) => string | null | undefined;
|
|
105
|
-
export declare const nullValue: (dataSetId: string, dimensions: QueryAttributes.Dimension[] | null, timeDimension: QueryAttributes.TimeDimension | null, nullValueAlias?: NullValueAlias, textOverride?: TextOverride) => string | undefined;
|
|
105
|
+
export declare const nullValue: (dataSetId: string, dimensions: QueryAttributes.Dimension[] | null, timeDimension: QueryAttributes.TimeDimension | null, nullValueAlias?: NullValueAlias, textOverride?: TextOverride, textOverrideKey?: string) => string | undefined;
|
|
106
|
+
export declare const nullValueWithFieldId: ({ dataSetId, fieldId, nullValueAlias, textOverride, textOverrideKey, }: {
|
|
107
|
+
dataSetId: string;
|
|
108
|
+
fieldId: string;
|
|
109
|
+
nullValueAlias?: NullValueAlias | undefined;
|
|
110
|
+
textOverride?: TextOverride | undefined;
|
|
111
|
+
textOverrideKey?: string | undefined;
|
|
112
|
+
}) => string | undefined;
|
|
106
113
|
export {};
|
|
@@ -27,6 +27,7 @@ export declare type LabelsSection = Section<'statsLabels'> & LabelSection<'stats
|
|
|
27
27
|
export declare type PrefixSection = Section<'prefixes'>;
|
|
28
28
|
export declare type MapColorsSection = Section<'mapColors'>;
|
|
29
29
|
export declare type HeadlineSection = Section<'headline'>;
|
|
30
|
+
export declare type RichTextFormatSection = Section<'richText'>;
|
|
30
31
|
export interface ConditionalFormattingSection extends Section<'conditionalFormatting'> {
|
|
31
32
|
ruleType: FormattingRuleType;
|
|
32
33
|
subSection?: {
|
|
@@ -40,5 +41,5 @@ export interface ProgressTypeSection<T> extends Omit<Section<T>, 'type'> {
|
|
|
40
41
|
progressType?: Omit<Section<T>, 'type'>;
|
|
41
42
|
}
|
|
42
43
|
export declare type ProgressTypesSection = Section<'progressType'> & ProgressTypeSection<'progressType'>;
|
|
43
|
-
export declare type FormatPanelSection = HeadingSection | FormatSection | ChartStylesSection | PrefixSection | AxisLabelsSection | LabelsSection | MapColorsSection | ConditionalFormattingSection | GoalLineSection | ProgressTypesSection | HeadlineSection;
|
|
44
|
+
export declare type FormatPanelSection = HeadingSection | FormatSection | ChartStylesSection | PrefixSection | AxisLabelsSection | LabelsSection | MapColorsSection | ConditionalFormattingSection | GoalLineSection | ProgressTypesSection | HeadlineSection | RichTextFormatSection;
|
|
44
45
|
export declare type FormatPanelConfig = Array<FormatPanelSection>;
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
import { Component } from '../Component/types';
|
|
2
|
+
import { ComponentInterfaceConfig } from '../ComponentInterface/types';
|
|
3
|
+
declare const _default: (config: ComponentInterfaceConfig) => (lineChart: Component.FunnelChartAttributes, partial: Partial<Component.FunnelChartAttributes>) => Component.FunnelChartAttributes;
|
|
4
|
+
export default _default;
|
|
@@ -1,8 +1,9 @@
|
|
|
1
1
|
import { DataSet } from '../../../shared-logic/src/DataSet/types';
|
|
2
2
|
import { loadDataCallback } from '../Callbacks/types';
|
|
3
3
|
import { DataMap } from './types';
|
|
4
|
-
export declare
|
|
4
|
+
export declare let cachedData: {
|
|
5
5
|
[cacheKey: string]: DataMap[] | null;
|
|
6
6
|
};
|
|
7
|
+
export declare const clearCachedData: () => void;
|
|
7
8
|
export declare const _clearAllDataDownloadThrottles: () => void;
|
|
8
9
|
export declare const fetchData: (dataSet: DataSet, doFetch: loadDataCallback, cacheKey: string) => Promise<DataMap[] | null>;
|
|
@@ -105,6 +105,7 @@ export declare type SubQuery<SupportedFunction = string, ComparisonOperator = st
|
|
|
105
105
|
/** For when a query cannot be generalised into the TraditionalQuery format. We can provide a very specific query for a specific purpose. */
|
|
106
106
|
declare type BasePreparedQuery<PreparedQueryType> = {
|
|
107
107
|
type: 'preparedQuery';
|
|
108
|
+
timeZone?: string;
|
|
108
109
|
preparedQueryType: PreparedQueryType;
|
|
109
110
|
};
|
|
110
111
|
/** A prepared query that returns unique values for a single array field */
|
|
@@ -123,6 +124,7 @@ export declare type PreparedQuery = UniqueArrayValuesQuery | PreAggregatedQuery;
|
|
|
123
124
|
/** Most commonly used query format. */
|
|
124
125
|
export declare type Query<SupportedFunction = string, ComparisonOperator = string, MathsOp = string> = {
|
|
125
126
|
type: 'query';
|
|
127
|
+
timeZone?: string;
|
|
126
128
|
dataSetId: string;
|
|
127
129
|
measure: Array<QueryNameSpace.FieldDefinition<SupportedFunction, ComparisonOperator, MathsOp>>;
|
|
128
130
|
filter: QueryNameSpace.Filter<QueryNameSpace.FieldDefinition<SupportedFunction, ComparisonOperator, MathsOp>, ComparisonOperator>[][];
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
export declare const INITIAL_RICH_TEXT_CONTENT: {
|
|
2
|
+
type: string;
|
|
3
|
+
content: ({
|
|
4
|
+
type: string;
|
|
5
|
+
attrs: {
|
|
6
|
+
level: number;
|
|
7
|
+
language?: undefined;
|
|
8
|
+
};
|
|
9
|
+
content: {
|
|
10
|
+
type: string;
|
|
11
|
+
text: string;
|
|
12
|
+
}[];
|
|
13
|
+
} | {
|
|
14
|
+
type: string;
|
|
15
|
+
content: ({
|
|
16
|
+
type: string;
|
|
17
|
+
text: string;
|
|
18
|
+
marks?: undefined;
|
|
19
|
+
} | {
|
|
20
|
+
type: string;
|
|
21
|
+
marks: {
|
|
22
|
+
type: string;
|
|
23
|
+
}[];
|
|
24
|
+
text: string;
|
|
25
|
+
})[];
|
|
26
|
+
attrs?: undefined;
|
|
27
|
+
} | {
|
|
28
|
+
type: string;
|
|
29
|
+
attrs: {
|
|
30
|
+
language: null;
|
|
31
|
+
level?: undefined;
|
|
32
|
+
};
|
|
33
|
+
content: {
|
|
34
|
+
type: string;
|
|
35
|
+
text: string;
|
|
36
|
+
}[];
|
|
37
|
+
})[];
|
|
38
|
+
};
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
import { Component } from '../Component/types';
|
|
2
|
+
import { ComponentInterfaceConfig } from '../ComponentInterface/types';
|
|
3
|
+
declare const _default: (config: ComponentInterfaceConfig) => (areaChart: Component.RichTextAttributes, partial: Partial<Component.RichTextAttributes>) => Component.RichTextAttributes;
|
|
4
|
+
export default _default;
|
|
@@ -15,5 +15,5 @@ export declare type runQueriesCallback = (queries: Component.Attributes | Additi
|
|
|
15
15
|
dataAccessToken?: string;
|
|
16
16
|
filterConfig?: FilterConfig;
|
|
17
17
|
}) => Promise<(Result | null)[] | Array<Result['content'] | null> | CallbackError>;
|
|
18
|
-
declare const getRunQueriesCallback: (identityConfig: IdentityConfigType, queryEngineConfig: QueryEngineConfigType, timeRangeOptions: TimeRangeOptions, runQueries?: CustomDriver['runQueries'], data?: loadDataCallback, queryEngineEndpoint?: QueryEngineEndpoint) => runQueriesCallback;
|
|
18
|
+
declare const getRunQueriesCallback: (identityConfig: IdentityConfigType, queryEngineConfig: QueryEngineConfigType, timeRangeOptions: TimeRangeOptions, runQueries?: CustomDriver['runQueries'], data?: loadDataCallback, queryEngineEndpoint?: QueryEngineEndpoint, timeZone?: string) => runQueriesCallback;
|
|
19
19
|
export default getRunQueriesCallback;
|
|
@@ -14,5 +14,6 @@ declare function getComponentInterface(type: 'horizontalBarChart', config?: Comp
|
|
|
14
14
|
declare function getComponentInterface(type: 'areaChart', config?: ComponentInterfaceConfig): ComponentInterface<Component.AreaChartAttributes>;
|
|
15
15
|
declare function getComponentInterface(type: 'lineChart', config?: ComponentInterfaceConfig): ComponentInterface<Component.LineChartAttributes>;
|
|
16
16
|
declare function getComponentInterface(type: 'barChart', config?: ComponentInterfaceConfig): ComponentInterface<Component.BarChartAttributes>;
|
|
17
|
+
declare function getComponentInterface(type: 'funnelChart', config?: ComponentInterfaceConfig): ComponentInterface<Component.FunnelChartAttributes>;
|
|
17
18
|
declare function getComponentInterface(type: ComponentType, config?: ComponentInterfaceConfig): ComponentInterface<Component.Attributes>;
|
|
18
19
|
export default getComponentInterface;
|