-
Notifications
You must be signed in to change notification settings - Fork 8.2k
/
saved_dashboard.ts
124 lines (114 loc) · 4.1 KB
/
saved_dashboard.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
/*
* Licensed to Elasticsearch B.V. under one or more contributor
* license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright
* ownership. Elasticsearch B.V. licenses this file to you 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 {
createSavedObjectClass,
SavedObject,
SavedObjectKibanaServices,
} from '../../../../plugins/saved_objects/public';
import { extractReferences, injectReferences } from './saved_dashboard_references';
import { Filter, ISearchSource, Query, RefreshInterval } from '../../../../plugins/data/public';
import { createDashboardEditUrl } from '../dashboard_constants';
export interface SavedObjectDashboard extends SavedObject {
id?: string;
timeRestore: boolean;
timeTo?: string;
timeFrom?: string;
description?: string;
panelsJSON: string;
optionsJSON?: string;
// TODO: write a migration to rid of this, it's only around for bwc.
uiStateJSON?: string;
lastSavedTitle: string;
refreshInterval?: RefreshInterval;
searchSource: ISearchSource;
getQuery(): Query;
getFilters(): Filter[];
}
// Used only by the savedDashboards service, usually no reason to change this
export function createSavedDashboardClass(
services: SavedObjectKibanaServices
): new (id: string) => SavedObjectDashboard {
const SavedObjectClass = createSavedObjectClass(services);
class SavedDashboard extends SavedObjectClass {
// save these objects with the 'dashboard' type
public static type = 'dashboard';
// if type:dashboard has no mapping, we push this mapping into ES
public static mapping = {
title: 'text',
hits: 'integer',
description: 'text',
panelsJSON: 'text',
optionsJSON: 'text',
version: 'integer',
timeRestore: 'boolean',
timeTo: 'keyword',
timeFrom: 'keyword',
refreshInterval: {
type: 'object',
properties: {
display: { type: 'keyword' },
pause: { type: 'boolean' },
section: { type: 'integer' },
value: { type: 'integer' },
},
},
};
public static fieldOrder = ['title', 'description'];
public static searchSource = true;
public showInRecentlyAccessed = true;
constructor(id: string) {
super({
type: SavedDashboard.type,
mapping: SavedDashboard.mapping,
searchSource: SavedDashboard.searchSource,
extractReferences,
injectReferences,
// if this is null/undefined then the SavedObject will be assigned the defaults
id,
// default values that will get assigned if the doc is new
defaults: {
title: '',
hits: 0,
description: '',
panelsJSON: '[]',
optionsJSON: JSON.stringify({
// for BWC reasons we can't default dashboards that already exist without this setting to true.
useMargins: !id,
hidePanelTitles: false,
}),
version: 1,
timeRestore: false,
timeTo: undefined,
timeFrom: undefined,
refreshInterval: undefined,
},
});
this.getFullPath = () => `/app/dashboards#${createDashboardEditUrl(String(this.id))}`;
}
getQuery() {
return this.searchSource!.getOwnField('query') || { query: '', language: 'kuery' };
}
getFilters() {
return this.searchSource!.getOwnField('filter') || [];
}
}
// Unfortunately this throws a typescript error without the casting. I think it's due to the
// convoluted way SavedObjects are created.
return (SavedDashboard as unknown) as new (id: string) => SavedObjectDashboard;
}