It should be possible to render a chart with axis labels
Closed, ResolvedPublic1 Estimated Story Points
Actions

Assigned To

Authored By

	Jdlrobson
	Sep 24 2024, 10:57 PM

Description

Background

It is currently not possible to render a chart with a title as in this example:
https://echarts.apache.org/examples/en/editor.html?c=data-transform-filter

User story

As an editor I want to create a line chart which is clearly labelled axis labels.

Requirements

The axis labels should be localizable
The axis labels live inside the chart definition
The labels are enabled by default.

BDD

For QA engineer to fill out

Test Steps

For QA engineer to fill out

Design

Add mockups and design requirements

Acceptance criteria

Add acceptance criteria

Communication criteria - does this need an announcement or discussion?

Add communication criteria

Rollback plan

What is the rollback plan in production for this task if something goes wrong?

This task was created by Version 1.2.0 of the Web team task template using phabulous

Details

Related Changes in GitLab:

	Title	Reference	Author	Source Branch	Dest Branch
	Render x-axis name and increase margin for y-axis name	repos/mediawiki/services/chart-renderer!25	aude	T375576	main

Customize query in GitLab

Related Objects

Mentioned Here: T375585: x-axis label text is cut off on the right side when labels are rotated
T373349: Add support for chart titles

Event Timeline

Jdlrobson created this task.Sep 24 2024, 10:57 PM

Restricted Application added a subscriber: Aklapper. · View Herald TranscriptSep 24 2024, 10:57 PM

Should the chart definition have a title property? The chart definition is more of a "template" that can be combined with various sets of tabular data so the title could be more specific to the invocation of the parser function, thus a parser function option.

And we does it make sense to require a title? If the chart is in context of a template, the title might be a separate part of the template.

e.g. https://en.wikipedia.org/wiki/Template:Climate_chart (in this case, the legend is also separate)

In T375576#10175261, @aude wrote:

Should the chart definition have a title property? The chart definition is more of a "template" that can be combined with various sets of tabular data so the title could be more specific to the invocation of the parser function, thus a parser function option.

And we does it make sense to require a title? If the chart is in context of a template, the title might be a separate part of the template.

e.g. https://en.wikipedia.org/wiki/Template:Climate_chart (in this case, the legend is also separate)

Descoped titles - https://phabricator.wikimedia.org/T373349

Axis should be defined in the chart definition to avoid data being misrepresented e.g. with different units

Reedy renamed this task from It should be possible to render a chart with axis labels. to It should be possible to render a chart with axis labels.Sep 25 2024, 3:36 PM

Reedy added a project: I18n.

Just a technicality, the labels are for the grid values along the axis (e.g. 1950, 1953 ...)

The "name" is the label for the axis (as a whole), such as "Income".

The y-axis name is there but there is not enough margin and it is cut off, making it not visible. This would have the same fix as T375585.

Rendering the x-axis name is an easy fix.

aude claimed this task.Sep 25 2024, 8:25 PM

aude opened https://gitlab.wikimedia.org/repos/mediawiki/services/chart-renderer/-/merge_requests/25

Render x-axis name and increase margin for y-axis name

jdlrobson merged https://gitlab.wikimedia.org/repos/mediawiki/services/chart-renderer/-/merge_requests/25

Render x-axis name and increase margin for y-axis name

Maintenance_bot removed a project: Patch-For-Review.Oct 7 2024, 8:30 PM

@CCiufo-WMF this wasn't planned work, but was done. How do we handle unplanned work in the sprint? Should we retroactively estimate this?

Jdlrobson moved this task from Incoming to Ready for Signoff on the Charts (Sprint 8) board.Oct 8 2024, 4:26 PM

Jdlrobson moved this task from Ready for Signoff to Testing on the Charts (Sprint 8) board.

In T375576#10208798, @Jdlrobson wrote:

@CCiufo-WMF this wasn't planned work, but was done. How do we handle unplanned work in the sprint? Should we retroactively estimate this?

Retroactive estimation (which would really be actual points spent) is fine with me.

(Note there's also a tag Unplanned-Sprint-Work, just saying)

Jdlrobson triaged this task as Medium priority.Oct 9 2024, 11:35 PM

Jdlrobson set the point value for this task to 1.

Jdlrobson reassigned this task from aude to CCiufo-WMF.Oct 10 2024, 7:57 PM

Jdlrobson moved this task from Testing to Ready for Signoff on the Charts (Sprint 8) board.

CCiufo-WMF closed this task as Resolved.Oct 16 2024, 4:53 PM

It should be possible to render a chart with axis labelsClosed, ResolvedPublic1 Estimated Story PointsActions