AllenCell / AllenCell/vole-core

internals: setState api and efficient render updates

Open
#90 3 comments 0 reactions 1 assignee Claimed by @frasercl View on GitHub
Tech Debt
Dominant language
TypeScript
Stars
106
Forks
11
Avg merge
3d 51m
Merged PRs (30d)
12

Description

## Use Case

As a developer, the public api is too spread out over many functions that have partial side effects.
We would like to be able to update large chunks of state with only one function call.

## Solution

Copy the data structure from https://github.com/allen-cell-animated/website-3d-cell-viewer/issues/110 down into volume-viewer and export it.
Partially implement the react-like state update mechanism as discussed in Teams call in volume-viewer, starting only with VolumeOptions (our temporary name for the appearance and channel editing information).
We believe this can be implemented at low technical risk as an alternate code path that doesn't modify any of the other public api or internal Drawable classes.
After some nontrivial tbd amount of functionality is in, we can assess the impact on performance and code maintainability/readability.

The end goal which may require followup issues is to have all settings updated via this mechanism and remove the individual setters in the api. A requirement for the final goal will be to have good documentation of the whole data structure and a clear path forward for future modifications.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.