bdsa-react-components 0.1.0

package/dist/components/SlideViewer/SlideViewer.d.ts

@@ -0,0 +1,132 @@
+import { default as React } from 'react';
+import { FeatureCollection } from 'geojson';
+import { Viewer as OpenSeadragonViewer, Options as OpenSeadragonOptions } from 'openseadragon';
+
+export interface SlideImageInfo {
+    /** Image ID from DSA (used if dziUrl is not provided) */
+    imageId?: string | number;
+    /** Image width in pixels (used if dziUrl is not provided) */
+    width?: number;
+    /** Image height in pixels (used if dziUrl is not provided) */
+    height?: number;
+    /** Tile width (used if dziUrl is not provided) */
+    tileWidth?: number;
+    /** Number of zoom levels (used if dziUrl is not provided) */
+    levels?: number;
+    /** Base URL for DSA tile server (used if dziUrl is not provided) */
+    baseUrl?: string;
+    /** DZI descriptor URL (e.g., 'http://bdsa.pathology.emory.edu:8080/api/v1/item/{itemId}/tiles/dzi.dzi')
+     *  If provided, this will be used instead of manually constructing tile URLs */
+    dziUrl?: string;
+}
+export interface AnnotationFeature {
+    /** Unique identifier for the annotation */
+    id?: string | number;
+    /** Left coordinate in pixels */
+    left: number;
+    /** Top coordinate in pixels */
+    top: number;
+    /** Width in pixels */
+    width: number;
+    /** Height in pixels */
+    height: number;
+    /** Optional color for the annotation stroke */
+    color?: string;
+    /** Optional group identifier */
+    group?: string | number;
+    /** Optional label */
+    label?: string;
+    /** Type of annotation (rectangle, polyline, etc.) */
+    annotationType?: 'rectangle' | 'polyline';
+    /** Points array for polyline annotations */
+    points?: Array<[number, number]>;
+    /** Whether polyline is closed */
+    closed?: boolean;
+    /** Fill color for polyline */
+    fillColor?: string;
+    /** Store full element for rendering */
+    element?: unknown;
+    /** Optional additional properties */
+    [key: string]: unknown;
+}
+export interface AnnotationInfoProperty {
+    /** Key to access the property value from the annotation document */
+    key: string;
+    /** Display label for this property */
+    label: string;
+    /** Optional formatter function to transform the value before display */
+    formatter?: (value: unknown, doc: {
+        id: string | number;
+        elementCount: number;
+        totalPoints: number;
+        types: string[];
+        filteredCount?: number;
+        filteredPoints?: number;
+    }) => string | React.ReactNode;
+    /** Whether to display this property (default: true) */
+    show?: boolean;
+}
+export interface AnnotationInfoConfig {
+    /** Properties to display for each fetched annotation document */
+    documentProperties?: AnnotationInfoProperty[];
+    /** Whether to show the "Fetched from DSA API" section */
+    showFetchedSection?: boolean;
+    /** Whether to show the "Provided Annotations" section */
+    showProvidedSection?: boolean;
+    /** Whether to show the "Total Rendered" section */
+    showTotalSection?: boolean;
+    /** Custom header text */
+    headerText?: string;
+}
+export interface SlideViewerProps {
+    /** Image information for the slide to display */
+    imageInfo: SlideImageInfo;
+    /** Annotations to render on the slide (array of rectangles or GeoJSON) */
+    annotations?: AnnotationFeature[] | FeatureCollection;
+    /** Annotation IDs to fetch from DSA API (baseUrl/annotation/{id}) */
+    annotationIds?: (string | number)[];
+    /** Base URL for DSA API (e.g., 'http://bdsa.pathology.emory.edu:8080/api/v1') */
+    apiBaseUrl?: string;
+    /** Callback when viewer is ready */
+    onViewerReady?: (viewer: OpenSeadragonViewer) => void;
+    /** Callback when annotation is clicked */
+    onAnnotationClick?: (annotation: AnnotationFeature) => void;
+    /** Default stroke color for annotations */
+    defaultAnnotationColor?: string;
+    /** Stroke width for annotations */
+    strokeWidth?: number;
+    /** Additional OpenSeadragon configuration options */
+    osdOptions?: OpenSeadragonOptions;
+    /** Custom CSS class name */
+    className?: string;
+    /** Height for the viewer container (e.g., '600px', '100vh', '100%').
+     *  Required: OpenSeadragon needs an explicit height to initialize properly. */
+    height?: string | number;
+    /** Width for the viewer container (defaults to '100%') */
+    width?: string | number;
+    /** Display information about loaded annotation documents */
+    showAnnotationInfo?: boolean;
+    /** Configuration for customizing the annotation info panel display */
+    annotationInfoConfig?: AnnotationInfoConfig;
+    /** Maximum number of points allowed per annotation element (default: 10000).
+     *  Annotations exceeding this limit will be skipped with a warning. */
+    maxPointsPerAnnotation?: number;
+    /** Maximum total number of points allowed across all annotations (default: 100000).
+     *  If exceeded, annotations will be filtered starting from the largest ones. */
+    maxTotalPoints?: number;
+    /** Custom fetch function for API requests. Useful for adding authentication headers.
+     *  If not provided, uses the default `fetch`. The function should match the Fetch API signature. */
+    fetchFn?: (url: string, options?: RequestInit) => Promise<Response>;
+    /** Custom headers to add to all API requests. Merged with fetchFn headers if both are provided. */
+    apiHeaders?: HeadersInit;
+    /** Show annotation controls panel in the sidebar (default: false) */
+    showAnnotationControls?: boolean;
+    /** Default opacity for all annotations (0-1, default: 1) */
+    defaultAnnotationOpacity?: number;
+}
+/**
+ * A slide viewer component that integrates OpenSeadragon with Paper.js annotations
+ * for viewing Digital Slide Archive images with annotation overlays.
+ */
+export declare const SlideViewer: React.ForwardRefExoticComponent<SlideViewerProps & React.RefAttributes<HTMLDivElement>>;
+//# sourceMappingURL=SlideViewer.d.ts.map

package/dist/components/SlideViewer/SlideViewer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SlideViewer.d.ts","sourceRoot":"","sources":["../../../src/components/SlideViewer/SlideViewer.tsx"],"names":[],"mappings":"AAAA,OAAO,KAA+C,MAAM,OAAO,CAAA;AAGnE,OAAO,KAAK,EAAE,iBAAiB,EAAW,MAAM,SAAS,CAAA;AACzD,OAAO,KAAK,EAAE,MAAM,IAAI,mBAAmB,EAAE,OAAO,IAAI,oBAAoB,EAAE,MAAM,eAAe,CAAA;AACnG,OAAO,mBAAmB,CAAA;AAE1B,MAAM,WAAW,cAAc;IAC3B,yDAAyD;IACzD,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;IACzB,6DAA6D;IAC7D,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,8DAA8D;IAC9D,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,kDAAkD;IAClD,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,6DAA6D;IAC7D,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,oEAAoE;IACpE,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB;oFACgF;IAChF,MAAM,CAAC,EAAE,MAAM,CAAA;CAClB;AAED,MAAM,WAAW,iBAAiB;IAC9B,2CAA2C;IAC3C,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;IACpB,gCAAgC;IAChC,IAAI,EAAE,MAAM,CAAA;IACZ,+BAA+B;IAC/B,GAAG,EAAE,MAAM,CAAA;IACX,sBAAsB;IACtB,KAAK,EAAE,MAAM,CAAA;IACb,uBAAuB;IACvB,MAAM,EAAE,MAAM,CAAA;IACd,+CAA+C;IAC/C,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,gCAAgC;IAChC,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;IACvB,qBAAqB;IACrB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,qDAAqD;IACrD,cAAc,CAAC,EAAE,WAAW,GAAG,UAAU,CAAA;IACzC,4CAA4C;IAC5C,MAAM,CAAC,EAAE,KAAK,CAAC,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAA;IAChC,iCAAiC;IACjC,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,8BAA8B;IAC9B,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,uCAAuC;IACvC,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,qCAAqC;IACrC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;CACzB;AAED,MAAM,WAAW,sBAAsB;IACnC,oEAAoE;IACpE,GAAG,EAAE,MAAM,CAAA;IACX,sCAAsC;IACtC,KAAK,EAAE,MAAM,CAAA;IACb,wEAAwE;IACxE,SAAS,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,EAAE;QAAE,EAAE,EAAE,MAAM,GAAG,MAAM,CAAC;QAAC,YAAY,EAAE,MAAM,CAAC;QAAC,WAAW,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,EAAE,CAAC;QAAC,aAAa,CAAC,EAAE,MAAM,CAAC;QAAC,cAAc,CAAC,EAAE,MAAM,CAAA;KAAE,KAAK,MAAM,GAAG,KAAK,CAAC,SAAS,CAAA;IACnM,uDAAuD;IACvD,IAAI,CAAC,EAAE,OAAO,CAAA;CACjB;AAED,MAAM,WAAW,oBAAoB;IACjC,iEAAiE;IACjE,kBAAkB,CAAC,EAAE,sBAAsB,EAAE,CAAA;IAC7C,yDAAyD;IACzD,kBAAkB,CAAC,EAAE,OAAO,CAAA;IAC5B,yDAAyD;IACzD,mBAAmB,CAAC,EAAE,OAAO,CAAA;IAC7B,mDAAmD;IACnD,gBAAgB,CAAC,EAAE,OAAO,CAAA;IAC1B,yBAAyB;IACzB,UAAU,CAAC,EAAE,MAAM,CAAA;CACtB;AAED,MAAM,WAAW,gBAAgB;IAC7B,iDAAiD;IACjD,SAAS,EAAE,cAAc,CAAA;IACzB,0EAA0E;IAC1E,WAAW,CAAC,EAAE,iBAAiB,EAAE,GAAG,iBAAiB,CAAA;IACrD,qEAAqE;IACrE,aAAa,CAAC,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAA;IACnC,iFAAiF;IACjF,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,oCAAoC;IACpC,aAAa,CAAC,EAAE,CAAC,MAAM,EAAE,mBAAmB,KAAK,IAAI,CAAA;IACrD,0CAA0C;IAC1C,iBAAiB,CAAC,EAAE,CAAC,UAAU,EAAE,iBAAiB,KAAK,IAAI,CAAA;IAC3D,2CAA2C;IAC3C,sBAAsB,CAAC,EAAE,MAAM,CAAA;IAC/B,mCAAmC;IACnC,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,qDAAqD;IACrD,UAAU,CAAC,EAAE,oBAAoB,CAAA;IACjC,4BAA4B;IAC5B,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB;mFAC+E;IAC/E,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;IACxB,0DAA0D;IAC1D,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;IACvB,4DAA4D;IAC5D,kBAAkB,CAAC,EAAE,OAAO,CAAA;IAC5B,sEAAsE;IACtE,oBAAoB,CAAC,EAAE,oBAAoB,CAAA;IAC3C;2EACuE;IACvE,sBAAsB,CAAC,EAAE,MAAM,CAAA;IAC/B;oFACgF;IAChF,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB;wGACoG;IACpG,OAAO,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,WAAW,KAAK,OAAO,CAAC,QAAQ,CAAC,CAAA;IACnE,mGAAmG;IACnG,UAAU,CAAC,EAAE,WAAW,CAAA;IACxB,qEAAqE;IACrE,sBAAsB,CAAC,EAAE,OAAO,CAAA;IAChC,4DAA4D;IAC5D,wBAAwB,CAAC,EAAE,MAAM,CAAA;CACpC;AAgED;;;GAGG;AACH,eAAO,MAAM,WAAW,yFAq4BvB,CAAA"}