fix: outside rect annotation placement and group relations #2471
Conversation
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
nickofthyme
added
:annotation
nickofthyme
commented
Jun 23, 2024
| @@ -40,7 +43,7 @@ export function computeRectAnnotationDimensions( | |||
| isHistogram: boolean = false, | |||
| ): AnnotationRectProps[] | null { | |||
| const { dataValues, groupId, outside, id: annotationSpecId } = annotationSpec; | |||
| const { xAxis, yAxis } = getAxesSpecForSpecId(axesSpecs, groupId); | |||
| const { xAxis, yAxis } = getAxesSpecForSpecId(axesSpecs, groupId, chartRotation); | |||
There was a problem hiding this comment.
Needed to match to correct axis
Comment on lines
+104
to
+108
| if (outside) { | ||
| if (hasXValues && hasYValues) { | ||
| Logger.warn( | ||
| `The RectAnnotation (${annotationSpecId}) was defined as outside but has both x and y values defined.`, | ||
| ); |
There was a problem hiding this comment.
Warns when attempting to render annotation as outside but both x and y coordinates are defined. The outside annotation should be limited to a single axis. Renders inside as fallback to avoid not rendering at all.
|
buildkite update screenshots |
|
buildkite update screenshots |
nickofthyme
changed the title
nickofthyme
pushed a commit
that referenced
this pull request
Jun 24, 2024
## [66.0.4](v66.0.3...v66.0.4) (2024-06-24) ### Bug Fixes * **deps:** update dependency @elastic/eui to v95 ([#2462](#2462)) ([040c354](040c354)) * option to disable the isolated point styles on line and area charts ([#2472](#2472)) ([ae16815](ae16815)) * outside rect annotation placement and group relations ([#2471](#2471)) ([d46fb41](d46fb41))
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR fixes an issue with
RectAnnotationwhen defined asoutside. Now alloutsideRectAnnotations render correctly within their respectiveAxis.Details
This prop is meant to render the annotation outside of the chart in the axis area, however this only works when there is an arbitrary
groupIdapplied, because this would cause theyScaleto be undefined as if it's the same case as fixed in #842.This was due to a combination of errors in the logic. First was the missing rotation when looking up the axis specs here...
elastic-charts/packages/charts/src/chart_types/xy_chart/annotations/rect/dimensions.ts
Line 43 in ae2af1c
This would provide wrong axis for the given annotation. I have now made the
rotationargument required to avoid this error in the future.Secondly, the logic to determine the placement dimensions of the
outsideannotation was extremely limiting for all cases particularly related to chart rotations.elastic-charts/packages/charts/src/chart_types/xy_chart/annotations/rect/dimensions.ts
Lines 77 to 81 in ae2af1c
This was fixed by factoring in each case for rotation and domain, as is done for the
LineAnnotationmarkers.Issues
fixes #2470
Checklist
:xy,:partition):interactions,:axis)closes #123,fixes #123)packages/charts/src/index.ts