Class DimensionsBuilder

Builder for dimension configuration

Index

Constructors

Properties

ndim displayed currentStep metadata

Methods

withNDimensions withDisplayed withDimension withSpatialDimensions withTimeDimension withChannelDimension withCurrentPosition build

Constructors

constructor

new DimensionsBuilder(): DimensionsBuilder

Returns DimensionsBuilder

Properties

`Private`ndim

ndim: number = 3

`Private`displayed

displayed: number[] = ...

`Private`currentStep

currentStep: number[] = []

`Private`metadata

metadata: DimensionMetadata[] = []

Methods

withNDimensions

withNDimensions(n: number): this
Set total number of dimensions
Parameters
- n: number
Returns this
- Defined in src/tests/builders/test-data-builders.ts:468

withDisplayed

withDisplayed(...indices: number[]): this
Set which dimensions are displayed. The Luxar scene contract caps displayed dimensions at 3 (the visual XYZ axes); a caller passing more than 3 indices is asserting a stronger contract than the viewer can satisfy. Silently slicing to 3 hid this misuse.

Now the builder throws on >3 indices so tests are forced to be explicit about which dims they want visible. Passing exactly 0–3 is unchanged.
Parameters
- ...indices: number[]
Returns this
- Defined in src/tests/builders/test-data-builders.ts:484

withDimension

withDimension(
    index: number,
    name: string,
    unit?: string,
    range?: [number, number],
    options?: { display?: boolean; discrete?: boolean; step?: number },
): this
Add a dimension with metadata
Parameters
- index: number
- name: string
- unit: string = ''
- range: [number, number] = ...
- options: { display?: boolean; discrete?: boolean; step?: number } = {}
Returns this
- Defined in src/tests/builders/test-data-builders.ts:498

withSpatialDimensions

withSpatialDimensions(unit?: string, range?: [number, number]): this
Add standard spatial dimensions
Parameters
- unit: string = 'μm'
- range: [number, number] = ...
Returns this
- Defined in src/tests/builders/test-data-builders.ts:535

withTimeDimension

withTimeDimension(range?: [number, number], step?: number): this
Add a time dimension
Parameters
- range: [number, number] = ...
- step: number = 0.1
Returns this
- Defined in src/tests/builders/test-data-builders.ts:545

withChannelDimension

withChannelDimension(numChannels?: number): this
Add a channel dimension
Parameters
- numChannels: number = 3
Returns this
- Defined in src/tests/builders/test-data-builders.ts:562

withCurrentPosition

withCurrentPosition(...values: number[]): this
Set current position in non-displayed dimensions
Parameters
- ...values: number[]
Returns this
- Defined in src/tests/builders/test-data-builders.ts:579

build

build(): SimpleDims
Build the dimensions configuration

Returns SimpleDims
- Defined in src/tests/builders/test-data-builders.ts:589