All files / metadata/src/displayset BaseDisplaySet.ts

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
import type { IDisplaySet } from './IDisplaySet';
import type { NaturalizedInstance, ViewportTypeHint } from './types';
import { getPreferredViewportType } from './viewportTypes';
 
export type BaseDisplaySetOptions = {
  displaySetId: string;
  viewportTypes?: readonly ViewportTypeHint[];
  instances?: NaturalizedInstance[];
  imageIds?: Iterable<string>;
  underlyingImageIds?: Iterable<string>;
};
 
/**
 * Base display set metadata exposing the common {@link IDisplaySet} attributes.
 * Attributes are computed once at construction (see IDisplaySet for the
 * data-attribute rationale and the extension pattern for additional attributes).
 */
export class BaseDisplaySet implements IDisplaySet {
  displaySetId: string;
  viewportTypes: readonly ViewportTypeHint[];
  preferredViewportType: ViewportTypeHint;
  readonly instances: readonly NaturalizedInstance[];
  readonly imageIds: readonly string[];
  readonly underlyingImageIds: readonly string[];
 
  constructor(options: BaseDisplaySetOptions) {
    this.displaySetId = options.displaySetId;
    this.viewportTypes = options.viewportTypes?.length
      ? [...options.viewportTypes]
      : ['stack'];
    this.preferredViewportType = getPreferredViewportType(this.viewportTypes);
    this.instances = [...(options.instances ?? [])];
    // Preserve caller cardinality/order: IDisplaySet documents
    // underlyingImageIds as one entry per instance, so deduping could drop a
    // legitimate frame-to-instance mapping.
    this.imageIds = [...(options.imageIds ?? [])];
    this.underlyingImageIds = [...(options.underlyingImageIds ?? [])];
  }
}