-
Notifications
You must be signed in to change notification settings - Fork 9
/
interfaces.ts
206 lines (172 loc) · 4.82 KB
/
interfaces.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
/*
* MIT License
*
* Copyright (c) 2016 Microsoft
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
import "powerbi-visuals/lib/powerbi-visuals";
import { IPersistObjectBuilder } from "../utils/interfaces";
/**
* Represents a setting
*/
export interface ISetting {
/**
* The property name within the class that this setting is for
*/
propertyName: string;
/**
* The setting descriptor
*/
descriptor: ISettingDescriptor<any>;
/**
* The owner of this setting
*/
classType: ISettingsClass<any>;
/**
* The parent setting
*/
parentSetting?: ISetting;
/**
* Is a child settings object
*/
isChildSettings?: boolean;
/**
* The child settings constructor
*/
childClassType?: ISettingsClass<any>;
}
/**
* Represents a setting descriptor that has a numerical value
*/
export interface INumericalSettingDescriptor {
/**
* The minimum value for this setting
*/
min?: number;
/**
* The maximum value for this setting
*/
max?: number;
}
/**
* The setting descriptor
*/
export interface ISettingDescriptor<T> extends INumericalSettingDescriptor {
/**
* The display name of the setting
*/
displayName?: string;
/**
* The settings description
*/
description?: string;
/**
* The category of the setting
* @default "General"
*/
category?: string;
/**
* The default value for this setting
*/
defaultValue?: any;
/**
* If hidden, the setting will not show up in powerbi's formatting pane
* @default false
* @deprecated
*/
hidden?: boolean | IHiddenFn<T>;
/**
* If enumerable is false, then it will not show up in the formatting pane
* @default true
*/
enumerable?: boolean | IHiddenFn<T>;
/**
* Whether or not this setting should be persisted to powerbi
* @default true
*/
persist?: boolean;
/**
* Additional configuration options
*/
config?: powerbi.data.DataViewObjectPropertyDescriptor;
/**
* The name of the setting
*/
name?: string;
/**
* A helper to parse the powerbi value into a setting value
*/
parse?: ISettingsParser<T, any>; // Controls how the value is parsed from pbi
/**
* A helper to convert the setting value into a powerbi value
*/
compose?: ISettingsComposer<any>;
}
/**
* Represents a settings parser
*/
export type ISettingsParser<T, J> = (
/**
* The PowerBI version of the value
*/
pbiValue: any,
/**
* The descriptor that is requesting the value
*/
descriptor?: ISettingDescriptor<T>,
/**
* The options used for parsing
*/
dataView?: powerbi.DataView,
/**
* The setting for this parser
*/
setting?: ISetting) => J;
/**
* Represents a settings composer
*/
export type ISettingsComposer<T> = (
value: T,
descriptor?: ISettingDescriptor<T>,
dataView?: powerbi.DataView,
setting?: ISetting,
builder?: IPersistObjectBuilder,
enumerate?: boolean) => IComposeResult;
/**
* Represents a compose call result
*/
export type IComposeResult = powerbi.VisualObjectInstance|powerbi.VisualObjectInstance[]|any;
/**
* Represents a hidden function
*/
export interface IHiddenFn<T> {
(settingObj: T, dataView?: powerbi.DataView): boolean;
}
/**
* Represents a class that is a settings class
*/
export interface ISettingsClass<T> {
new (): T;
constructor: Function;
}
export type IDefaultValue<T> = T|(() => T);
export type IDefaultInstanceValue<T> = ((idx: number, dataView?: powerbi.DataView, identity?: powerbi.DataViewScopeIdentity) => T);
export type IDefaultInstanceColor = string|IDefaultInstanceValue<string>;
export type IDefaultColor = string|IDefaultValue<string>;