Multicategory axis type by etpinard · Pull Request #3300 · plotly/plotly.js

etpinard · 2018-11-30T17:36:25Z

(attempts to) resolves #2799 by adding a ✨ new ✨ axis type: 'multicategory' - which displays two (maybe more later) axis labels levels along with "dividers" in-between each category group.

N.B. This branch is up-to-date with the latest master that includes uirevision.

Things to TODO:

add support for type: 'multicategory' on y-axes
add support to heatmap and contours
add support in histogram* traces
~~[ ] add some way to configure ticks/dividers per category level~~ - leave for later
improve axis.automargin test coverage, partly done in: 80f4701, more to come in Allow replot during drag interactions #3305
test as many edge cases I can think of

Things skipped:

ticktext / tickvals are not coerced on type: 'multicategory' axes
support for transforms

cc @plotly/plotly_js @nicolaskruchten

- ax._mainLinePosition appears to be always defined for cartesian axes

- so that it can still be relevant for multi-category axes.

- no need to export it on Axes - return Lib.syncOrAsync result

- this will allow us to use ax._boundingBox for multicategory axes

... similar to ax._lw for ax.linewidth.

- compute and use tick-label height to position secondary labels - disallow 30deg tick label rotation when fixing overlaps - use ax._boundingBox to position axis title on multicategory axes.

test/image/mocks/multicategory.json

src/plots/cartesian/axis_autotype.js

- make it return z.length if z is 1D - make it return 0 when not an array

- mea culpa: no need to keep track of max-row-length for multicategory coordinate array, min-row-length suffices.

- make sure calc'ed arrays are sorted properly - handle null and undefined item correctly - handle non-2d-array input correctly - test 2d-array input on non-multicategory axes

- improve secondary-label to axis title padding - add horizontal violin mock

- lock down annotations in same mock.

this means Axes.getSubplots and Axes.findSubplotsWithAxis are essentially unused internally, but we have some outside callers using getSubplots

Clean up automargin pipeline a bit

alexcjohnson · 2018-12-11T22:21:44Z

💃 love it.

Braintelligence · 2018-12-20T05:52:47Z

Just to make 100% sure:
Is it somehow possible to combine this with xaxis.type = "date" or linear if you want your datapoint to be between two ticks (divider style) and still keep the advantages of these axis types? (scalability and so on)
As it stands now it seems that showdividers is not compatible with xaxis.type = "date" to me.

etpinard · 2018-12-20T14:04:38Z

As it stands now it seems that showdividers is not compatible with xaxis.type = "date" to me.

That's correct. Dividers are only available for type: 'multicategory' axes.

LJaschinski · 2019-03-08T09:00:11Z

Hello, do you know when 'multicategory' type will displays more than two axis ? Is there a work in progress about it ?

elmadj · 2020-01-18T02:14:59Z

Hi is there support for something similar to bargap and bargroupgap with multicategory axes? The goal would be to have a different gaps between bars of an outer category and bars of an inner category. Thanks ! Any other way to achieve this would be helpful :)

etpinard added 14 commits November 30, 2018 12:14

big lint commit in axes.js

e962fb4

first cut multicategory

d49b7b4

rm useless if(ax._mainLinePosition) condition

d28ed18

- ax._mainLinePosition appears to be always defined for cartesian axes

generalize tick labels selection stash

9ebbe7d

- so that it can still be relevant for multi-category axes.

small fixup in axis drawTitle()

6dbddc9

- no need to export it on Axes - return Lib.syncOrAsync result

mv ax drawTitles() to end of Axes.drawOne

5720802

- this will allow us to use ax._boundingBox for multicategory axes

stash crispRound ax.gridwidth value on ax._gw

0f0661e

... similar to ax._lw for ax.linewidth.

2nd look at mutlicategory positioning

86f710c

- compute and use tick-label height to position secondary labels - disallow 30deg tick label rotation when fixing overlaps - use ax._boundingBox to position axis title on multicategory axes.

adapt tickon:'boundaries' logic for multicategory axes

d986f94

don't coerce ticktext/tickvals on multicategory axes

c680558

mv maxRowLength to lib/array.js, use it it in xy defaults

2a9ef87

add support for multicategory for box and violin traces

f404d9f

add support for axis dividers

93323b8

3️⃣ multicategory mocks

73f0365

etpinard added feature something new status: in progress labels Nov 30, 2018

etpinard added this to the v1.43.0 milestone Nov 30, 2018

etpinard commented Nov 30, 2018

View reviewed changes

test/image/mocks/multicategory.json Show resolved Hide resolved

etpinard commented Nov 30, 2018

View reviewed changes

src/plots/cartesian/axis_autotype.js Outdated Show resolved Hide resolved

etpinard added 11 commits December 5, 2018 16:36

fix showdividers:false logic

660a546

generalize Lib.maxRowLength

1a4c95e

- make it return z.length if z is 1D - make it return 0 when not an array

add a some potential TODOs

48df699

add Lib.minRowLength and use it to find trace._length

701f793

- mea culpa: no need to keep track of max-row-length for multicategory coordinate array, min-row-length suffices.

improve multicategory ax.makeCalcdata

016846a

- make sure calc'ed arrays are sorted properly - handle null and undefined item correctly - handle non-2d-array input correctly - test 2d-array input on non-multicategory axes

initial support for multicategory on y-axes

3d097c2

- improve secondary-label to axis title padding - add horizontal violin mock

fix data-referenced shapes on multicategory axes

d5777e9

- lock down annotations in same mock.

add support for heatmap and contour traces on multicategoy axes

b792b8d

add support for histogram* traces on multicategory axes

bf52cd7

add support for finance traces on multicategory axes

c3a0f5a

test xaxis.automargin:true + long multicategory labels

80f4701

etpinard and others added 11 commits December 11, 2018 09:00

assert multicategory event data

e71b7df

fix multicategory ax.cleanPos

5c85981

simplify histogram2d x/y len logic

627f24b

aj-proof heatmap_multicategory mock

a25c5e3

fix #3255 - get automargin calls out of supplyDefaults

858f7c2

refactor rangeslider pipeline

bdabf48

fixed range_slider_rangemode baseline

b2a4b76

use _replotting in cartesian dragbox

177e6f0

remove setScale categories fallback and update heatmap test comment

da30f16

minor 🌴 for findMainSubplot

68993c3

pre-collate counteraxes and subplot ids for each axis

f55e769

this means Axes.getSubplots and Axes.findSubplotsWithAxis are essentially unused internally, but we have some outside callers using getSubplots

etpinard mentioned this pull request Dec 11, 2018

Clean up automargin pipeline a bit #3323

Merged

alexcjohnson and others added 4 commits December 11, 2018 17:14

Merge pull request #3323 from plotly/clean-defaults-mc

939df6e

Clean up automargin pipeline a bit

do not draw ticks above dividers

5da3851

add multicategory + mirror ax mock

204b2e8

do not accept number as box/violin x0 on multicategory axes

4b82426

etpinard merged commit 07d73df into master Dec 11, 2018

etpinard deleted the multicategory branch December 11, 2018 22:30

etpinard mentioned this pull request Dec 12, 2018

Multicategory inside ticks fixes #3326

Merged

nicolaskruchten mentioned this pull request Dec 13, 2018

Multi-category axes plotly/documentation#1206

Closed

etpinard mentioned this pull request Dec 21, 2018

Add support for transforms on multicategory axes #3363

Closed

mtwichan mentioned this pull request Mar 18, 2019

Feature Request: Add Multi-category Support for Gantt Chart plotly/plotly.py#1468

Closed

etpinard mentioned this pull request Mar 18, 2019

Extend multicategory axes to more than 2 levels #2175

Open

ThibTrip mentioned this pull request Apr 7, 2019

Multi-category sorting misbehaves with missing categories #3723

Open

Joe-Wasserman mentioned this pull request Aug 14, 2020

Support control over gaps between outer layers of multicategory axes #5080

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Multicategory axis type#3300

Multicategory axis type#3300
etpinard merged 55 commits intomasterfrom
multicategory

etpinard commented Nov 30, 2018 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

alexcjohnson commented Dec 11, 2018

Uh oh!

Braintelligence commented Dec 20, 2018

Uh oh!

etpinard commented Dec 20, 2018

Uh oh!

LJaschinski commented Mar 8, 2019

Uh oh!

elmadj commented Jan 18, 2020 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Uh oh!

Conversation

etpinard commented Nov 30, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

alexcjohnson commented Dec 11, 2018

Uh oh!

Braintelligence commented Dec 20, 2018

Uh oh!

etpinard commented Dec 20, 2018

Uh oh!

LJaschinski commented Mar 8, 2019

Uh oh!

elmadj commented Jan 18, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

etpinard commented Nov 30, 2018 •

edited

Loading

elmadj commented Jan 18, 2020 •

edited

Loading