widget-component.models.ts
2.65 KB
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
///
/// Copyright © 2016-2019 The Thingsboard Authors
///
/// Licensed under the Apache License, Version 2.0 (the "License");
/// you may not use this file except in compliance with the License.
/// You may obtain a copy of the License at
///
/// http://www.apache.org/licenses/LICENSE-2.0
///
/// Unless required by applicable law or agreed to in writing, software
/// distributed under the License is distributed on an "AS IS" BASIS,
/// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
/// See the License for the specific language governing permissions and
/// limitations under the License.
///
import { ExceptionData } from '@shared/models/error.models';
import { IDashboardComponent } from '@home/models/dashboard-component.models';
import { WidgetActionDescriptor, WidgetConfig, WidgetConfigSettings, widgetType } from '@shared/models/widget.models';
import { Timewindow } from '@shared/models/time/time.models';
import {
EntityInfo,
IWidgetSubscription,
SubscriptionInfo,
WidgetSubscriptionOptions,
IStateController,
IAliasController,
TimewindowFunctions,
WidgetSubscriptionApi,
RpcApi,
WidgetActionsApi,
IWidgetUtils
} from '@core/api/widget-api.models';
import { Observable } from 'rxjs';
import { EntityId } from '@shared/models/id/entity-id';
export interface IWidgetAction {
name: string;
icon: string;
onAction: ($event: Event) => void;
}
export interface WidgetHeaderAction extends IWidgetAction {
displayName: string;
descriptor: WidgetActionDescriptor;
}
export interface WidgetAction extends IWidgetAction {
show: boolean;
}
export interface IDynamicWidgetComponent {
widgetContext: WidgetContext;
widgetErrorData: ExceptionData;
loadingData: boolean;
[key: string]: any;
}
export interface WidgetContext {
inited?: boolean;
$container?: any;
$containerParent?: any;
width?: number;
height?: number;
$scope?: IDynamicWidgetComponent;
hideTitlePanel?: boolean;
isEdit?: boolean;
isMobile?: boolean;
dashboard?: IDashboardComponent;
widgetConfig?: WidgetConfig;
settings?: WidgetConfigSettings;
units?: string;
decimals?: number;
subscriptions?: {[id: string]: IWidgetSubscription};
defaultSubscription?: IWidgetSubscription;
dashboardTimewindow?: Timewindow;
timewindowFunctions?: TimewindowFunctions;
subscriptionApi?: WidgetSubscriptionApi;
controlApi?: RpcApi;
utils?: IWidgetUtils;
actionsApi?: WidgetActionsApi;
stateController?: IStateController;
aliasController?: IAliasController;
activeEntityInfo?: EntityInfo;
widgetTitleTemplate?: string;
widgetTitle?: string;
customHeaderActions?: Array<WidgetHeaderAction>;
widgetActions?: Array<WidgetAction>;
}