-
Notifications
You must be signed in to change notification settings - Fork 8.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[discover] use elastic-charts for histogram
- Loading branch information
Emma Cunningham
committed
Jul 16, 2019
1 parent
ea2cb5d
commit 055340f
Showing
7 changed files
with
346 additions
and
0 deletions.
There are no files selected for viewing
3 changes: 3 additions & 0 deletions
3
src/legacy/core_plugins/kibana/public/discover/components/histogram/_index.scss
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
.dscHistogram__header--partial { | ||
font-weight: $euiFontWeightRegular; | ||
} |
28 changes: 28 additions & 0 deletions
28
src/legacy/core_plugins/kibana/public/discover/components/histogram/directive.js
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
/* | ||
* 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 'ngreact'; | ||
import { uiModules } from 'ui/modules'; | ||
import { DiscoverHistogram } from './histogram'; | ||
|
||
import { wrapInI18nContext } from 'ui/i18n'; | ||
|
||
const app = uiModules.get('apps/discover', ['react']); | ||
|
||
app.directive('discoverHistogram', reactDirective => reactDirective(wrapInI18nContext(DiscoverHistogram))); |
259 changes: 259 additions & 0 deletions
259
src/legacy/core_plugins/kibana/public/discover/components/histogram/histogram.tsx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,259 @@ | ||
/* | ||
* 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 { EuiFlexGroup, EuiFlexItem, EuiIcon, EuiSpacer } from '@elastic/eui'; | ||
import moment from 'moment-timezone'; | ||
import React, { Component } from 'react'; | ||
import PropTypes from 'prop-types'; | ||
|
||
import { | ||
AnnotationDomainTypes, | ||
Axis, | ||
Chart, | ||
HistogramBarSeries, | ||
getAnnotationId, | ||
getAxisId, | ||
getSpecId, | ||
LineAnnotation, | ||
Position, | ||
ScaleType, | ||
Settings, | ||
RectAnnotation, | ||
TooltipValue, | ||
} from '@elastic/charts'; | ||
|
||
import { i18n } from '@kbn/i18n'; | ||
|
||
import { getChartTheme } from 'ui/elastic_charts'; | ||
import chrome from 'ui/chrome'; | ||
|
||
export interface DiscoverHistogramProps { | ||
chartData: any; | ||
visLib: any; | ||
} | ||
|
||
const getTimezone = () => { | ||
const config = chrome.getUiSettingsClient(); | ||
const DATE_FORMAT_CONFIG_KEY = 'dateFormat:tz'; | ||
const isCustomTimezone = !config.isDefault(DATE_FORMAT_CONFIG_KEY); | ||
if (isCustomTimezone) { | ||
return config.get(DATE_FORMAT_CONFIG_KEY); | ||
} | ||
|
||
const detectedTimezone = moment.tz.guess(); | ||
if (detectedTimezone) { | ||
return detectedTimezone; | ||
} | ||
// default to UTC if we can't figure out the timezone | ||
const tzOffset = moment().format('Z'); | ||
return tzOffset; | ||
}; | ||
|
||
export class DiscoverHistogram extends Component<DiscoverHistogramProps> { | ||
static propTypes = { | ||
chartData: PropTypes.object, | ||
visLib: PropTypes.object, | ||
}; | ||
|
||
render() { | ||
const { visLib, chartData } = this.props; | ||
|
||
if (!this.props.chartData || !this.props.chartData.series[0]) { | ||
return null; | ||
} | ||
|
||
const appState = visLib.API.getAppState(); | ||
|
||
const data = chartData.series[0].values; | ||
const format = chartData.xAxisFormat.params.pattern; | ||
|
||
/** | ||
* Deprecation: [interval] on [date_histogram] is deprecated, use [fixed_interval] or [calendar_interval]. | ||
* see https://github.com/elastic/kibana/issues/27410 | ||
*/ | ||
const xInterval = chartData.ordered.interval; // We can remove this line only for versions > 8.x | ||
|
||
const xValues = chartData.xAxisOrderedValues; | ||
const lastXValue = xValues[xValues.length - 1]; | ||
|
||
const formatter = (val: string) => { | ||
return moment(val).format(format); | ||
}; | ||
|
||
const domain = chartData.ordered; | ||
const domainStart = domain.min.valueOf(); | ||
const domainEnd = domain.max.valueOf(); | ||
|
||
const domainMin = data[0].x > domainStart ? domainStart : data[0].x; | ||
const domainMax = domainEnd - xInterval > lastXValue ? domainEnd - xInterval : lastXValue; | ||
|
||
const xDomain = { | ||
min: domainMin, | ||
max: domainMax, | ||
minInterval: xInterval, | ||
}; | ||
|
||
// Duplicated from point_series.js | ||
// Domain end of 'now' will be milliseconds behind current time | ||
// Extend toTime by 1 minute to ensure those cases have a TimeMarker | ||
const now = moment(); | ||
const isAnnotationAtEdge = domainEnd + 60000 > now && now > domainEnd; | ||
const lineAnnotationValue = isAnnotationAtEdge ? domainEnd : now; | ||
|
||
const currentTime = { | ||
dataValue: lineAnnotationValue, | ||
}; | ||
|
||
const lineAnnotationStyle = { | ||
line: { | ||
strokeWidth: 2, | ||
stroke: '#c80000', | ||
opacity: 0.3, | ||
}, | ||
}; | ||
|
||
const partialAnnotationText = i18n.translate( | ||
'kbn.discover.histogram.partialData.annotationText', | ||
{ | ||
defaultMessage: | ||
'This area may contain partial data. The selected time range does not fully cover it.', | ||
} | ||
); | ||
|
||
const rectAnnotations = [ | ||
{ | ||
coordinates: { | ||
x0: domainStart, | ||
}, | ||
details: partialAnnotationText, | ||
}, | ||
{ | ||
coordinates: { | ||
x1: domainEnd, | ||
}, | ||
details: partialAnnotationText, | ||
}, | ||
]; | ||
|
||
const rectAnnotationStyle = { | ||
stroke: 'rgba(0, 0, 0, 0)', | ||
strokeWidth: 1, | ||
opacity: 1, | ||
fill: 'rgba(0, 0, 0, 0.1)', | ||
}; | ||
|
||
const customTooltip = (details?: string) => ( | ||
<div style={{ minWidth: 200 }}> | ||
<EuiFlexGroup alignItems="center"> | ||
<EuiFlexItem grow={false}> | ||
<EuiIcon type="alert" /> | ||
</EuiFlexItem> | ||
<EuiFlexItem>{details}</EuiFlexItem> | ||
</EuiFlexGroup> | ||
</div> | ||
); | ||
|
||
const onBrushEnd = (min: number, max: number) => { | ||
const brushData = { | ||
aggConfigs: visLib.aggs, | ||
data: chartData, | ||
range: [min, max], | ||
}; | ||
|
||
visLib.API.events.brush(brushData, appState); | ||
}; | ||
|
||
const partialDataText = i18n.translate('kbn.discover.histogram.partialData.bucketTooltipText', { | ||
defaultMessage: | ||
'Part of this bucket may contain partial data. The selected time range does not fully cover it.', | ||
}); | ||
|
||
const tooltipHeaderFormater = (headerData: TooltipValue): JSX.Element | string => { | ||
const headerDataValue = headerData.value; | ||
const formattedValue = formatter(headerDataValue); | ||
|
||
if (headerDataValue < domainStart || headerDataValue + xInterval > domainEnd) { | ||
return ( | ||
<React.Fragment> | ||
<EuiFlexGroup alignItems="center" className="dscHistogram__header--partial"> | ||
<EuiFlexItem grow={false}> | ||
<EuiIcon type="iInCircle" /> | ||
</EuiFlexItem> | ||
<EuiFlexItem>{partialDataText}</EuiFlexItem> | ||
</EuiFlexGroup> | ||
<EuiSpacer size="m" /> | ||
<p>{formattedValue}</p> | ||
</React.Fragment> | ||
); | ||
} | ||
|
||
return formattedValue; | ||
}; | ||
|
||
const tooltipProps = { | ||
headerFormatter: tooltipHeaderFormater, | ||
}; | ||
|
||
return ( | ||
<Chart> | ||
<Settings | ||
xDomain={xDomain} | ||
onBrushEnd={onBrushEnd} | ||
tooltip={tooltipProps} | ||
theme={getChartTheme()} | ||
/> | ||
<Axis | ||
id={getAxisId('discover-histogram-left-axis')} | ||
position={Position.Left} | ||
title={chartData.yAxisLabel} | ||
/> | ||
<Axis | ||
id={getAxisId('discover-histogram-bottom-axis')} | ||
position={Position.Bottom} | ||
title={chartData.xAxisLabel} | ||
tickFormat={formatter} | ||
/> | ||
<LineAnnotation | ||
annotationId={getAnnotationId('line-annotation')} | ||
domainType={AnnotationDomainTypes.XDomain} | ||
dataValues={[currentTime]} | ||
hideTooltips={true} | ||
style={lineAnnotationStyle} | ||
/> | ||
<RectAnnotation | ||
dataValues={rectAnnotations} | ||
annotationId={getAnnotationId('rect-annotation')} | ||
zIndex={2} | ||
style={rectAnnotationStyle} | ||
renderTooltip={customTooltip} | ||
/> | ||
<HistogramBarSeries | ||
id={getSpecId('discover-histogram')} | ||
xScaleType={ScaleType.Time} | ||
yScaleType={ScaleType.Linear} | ||
xAccessor="x" | ||
yAccessors={['y']} | ||
data={data} | ||
timeZone={getTimezone()} // match kibana timezone | ||
name={chartData.yAxisLabel} | ||
/> | ||
</Chart> | ||
); | ||
} | ||
} |
20 changes: 20 additions & 0 deletions
20
src/legacy/core_plugins/kibana/public/discover/components/histogram/index.js
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
/* | ||
* 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 './directive'; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
/* | ||
* 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 chrome from 'ui/chrome'; | ||
import { Theme, LIGHT_THEME, DARK_THEME } from '@elastic/charts'; | ||
|
||
export function getChartTheme(): Theme { | ||
const isDarkMode = chrome.getUiSettingsClient().get('theme:darkMode'); | ||
return isDarkMode ? DARK_THEME : LIGHT_THEME; | ||
} |