feat(vtkscalarbaractor): adds generateTicks field to vtkScalarBarActor

[NGimbal]

Context

I'd like to enable customizing ticks in vtkScalarBarActor to do things like the following:

Discussed approach with @martinken on Discourse thread here.

Results

The approach I took was to create a new generateTicks field that is implemented similarly to autoLayout.

I ended up adding ticks and tickstrings setters / getters to the vtkScalarBarActorHelper publicAPI where those values had been private to the vtkScalarBarActorHelper model previously. The generateTicks function then has to set those values. This is very similar to the current implementation of autoLayout, although probably could be improved.

Here are results from my client app:

Setting a new generateTicks function requires the user to update the vtkScalarBarActor annotations. This also seems to be true for other similar functions, setAxisLabel for example. This is how I'm doing that:

      const mapper = scalarBarActor.getMapper()
      if (mapper) {
        mapper.getLookupTable().resetAnnotations()
      }

Changes

• Adds new generateTicks field to vtkScalarBarActor
• Added test for new generateTicks initial value
• Documentation and TypeScript definitions were updated to match those changes

PR and Code Checklist

• semantic-release commit messages
• Run npm run reformat to have correctly formatted code

Testing

Adds new test testScalaBarSetGenerateTicks.js, tests against image testScalarBarSetGenerateTicks.png.

• This change adds or fixes unit tests
• Tested environment:
  • vtk.js: latest master
  • OS: macOS Monterey 12.3.1
  • Browser: Chrome Version 100.0.4896.127 (Official Build) (x86_64)

Funding

This contribution is funded by Pollination.

[martinken]

Very nice MR! I suspect the failing test is due to font differences. We need to add another valid image (see testScalarBar.js for how to have multiple baselines) To get the image that failed you can go to actions at the top of this page and then click on your failed workflow and then download the tests artifact (zip file) and open that in a browser, click on the hide/show browser tests and the results should show up. If you get stuck just holler or check this page https://docs.github.com/en/actions/managing-workflow-runs/downloading-workflow-artifacts

The only other minor thing I see is since we are making tickstrings public let's change the capitalization to be tickStrings and getTickStrings() (tickstrings was my mistake, but let's fix it now if that's OK)

[martinken]

artifacts will look like

[NGimbal]

@martinken Thanks - I'll add the images from the failing tests as you describe (I was wondering where the multiple baseline images came from!) then convert back to a reviewable PR.

[finetjul]

LGTM

[boucaud]

@finetjul @NGimbal what is the status on this ? This will affect a project I'm working on now and I would like to start the integration.

[NGimbal]

@boucaud - I think this is ready to merge pending @martinken's review.

[github-actions]

🎉 This PR is included in version 24.11.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀