@dclimate/zarr-map 0.1.0

package/dist/react/index.d.cts

@@ -0,0 +1,71 @@
+import { CreateDClimateSourceOptions, DClimateDatasetRequest, DClimateSelectionBounds, DClimateBoundsSelection, DClimateBoundsSelectionOptions, DClimateTimeRange } from '../dclimate/index.cjs';
+import { MapLibreMapConfig, GridLayerOptions, GridLayerLoadingState, GridLayerController } from '../renderers/index.cjs';
+import { d as GridDataSource, u as GridSelectors, a as GridColorScale, n as GridQuerySample, m as GridQueryResult, q as GridRequestPreflightConfig, p as GridRequestPreflight, T as TimeCoordinate } from '../types-DEZwfJNY.cjs';
+import { CSSProperties, ReactNode } from 'react';
+import '../jaxray-D_mmLPHk.cjs';
+
+declare function useMountEffect(effect: () => void | (() => void)): void;
+
+declare const BASE_PLAYBACK_INTERVAL_MS = 700;
+declare const PLAYBACK_SPEED_OPTIONS: readonly [1, 1.5, 2, 3];
+interface LegendProps {
+    colorScale: GridColorScale;
+    label?: string;
+}
+declare function Legend({ colorScale, label }: LegendProps): ReactNode;
+interface TimeSliderProps {
+    source: GridDataSource;
+    dimension?: string;
+    value?: number;
+    defaultValue?: number;
+    debounceMs?: number;
+    autoPlay?: boolean;
+    playback?: boolean;
+    playbackIntervalMs?: number;
+    onChange?: (coordinate: TimeCoordinate) => void;
+}
+declare function TimeSlider({ source, dimension, value, defaultValue, debounceMs, autoPlay, playback, playbackIntervalMs, onChange }: TimeSliderProps): ReactNode;
+interface ZarrMapProps {
+    source: GridDataSource;
+    variable: string;
+    selector?: GridSelectors;
+    initialSelector?: GridSelectors;
+    colorScale?: GridColorScale;
+    opacity?: number;
+    map: Omit<MapLibreMapConfig, "container">;
+    timeDimension?: string;
+    controls?: {
+        legend?: boolean;
+        timeSlider?: boolean;
+        timePlayback?: boolean;
+        timePlaybackAutoPlay?: boolean;
+        inspect?: ZarrMapInspectControl;
+    };
+    className?: string;
+    style?: CSSProperties;
+    renderer?: Pick<GridLayerOptions, "layerFactory" | "mapFactory">;
+    formatInspectValue?: (sample: GridQuerySample, result: GridQueryResult) => ReactNode;
+    onSelectorChange?: (selector: GridSelectors) => void;
+    onInspect?: (result: GridQueryResult) => void;
+    onLoadingStateChange?: (state: GridLayerLoadingState) => void;
+    onReady?: (controller: GridLayerController) => void;
+    children?: ReactNode;
+}
+type ZarrMapInspectMode = "click" | "hover";
+type ZarrMapInspectControl = boolean | ZarrMapInspectMode | {
+    mode?: ZarrMapInspectMode;
+    debounceMs?: number;
+};
+declare function ZarrMap(props: ZarrMapProps): ReactNode;
+interface DClimateZarrMapProps extends Omit<ZarrMapProps, "source">, Pick<CreateDClimateSourceOptions, "client" | "clientOptions" | "gatewayUrl" | "openIpfsStore"> {
+    dataset: DClimateDatasetRequest;
+    bounds?: DClimateSelectionBounds | DClimateBoundsSelection;
+    boundsOptions?: DClimateBoundsSelectionOptions;
+    timeRange?: DClimateTimeRange;
+    preflight?: GridRequestPreflightConfig;
+    onPreflight?: (preflight: GridRequestPreflight) => void;
+    sourceOptions?: Omit<CreateDClimateSourceOptions, "client" | "clientOptions" | "gatewayUrl" | "openIpfsStore" | "preflight">;
+}
+declare function DClimateZarrMap(props: DClimateZarrMapProps): ReactNode;
+
+export { BASE_PLAYBACK_INTERVAL_MS, DClimateZarrMap, type DClimateZarrMapProps, Legend, type LegendProps, PLAYBACK_SPEED_OPTIONS, TimeSlider, type TimeSliderProps, ZarrMap, type ZarrMapInspectControl, type ZarrMapInspectMode, type ZarrMapProps, useMountEffect };

package/dist/react/index.d.ts

@@ -0,0 +1,71 @@
+import { CreateDClimateSourceOptions, DClimateDatasetRequest, DClimateSelectionBounds, DClimateBoundsSelection, DClimateBoundsSelectionOptions, DClimateTimeRange } from '../dclimate/index.js';
+import { MapLibreMapConfig, GridLayerOptions, GridLayerLoadingState, GridLayerController } from '../renderers/index.js';
+import { d as GridDataSource, u as GridSelectors, a as GridColorScale, n as GridQuerySample, m as GridQueryResult, q as GridRequestPreflightConfig, p as GridRequestPreflight, T as TimeCoordinate } from '../types-DEZwfJNY.js';
+import { CSSProperties, ReactNode } from 'react';
+import '../jaxray-CZWT_ZgD.js';
+
+declare function useMountEffect(effect: () => void | (() => void)): void;
+
+declare const BASE_PLAYBACK_INTERVAL_MS = 700;
+declare const PLAYBACK_SPEED_OPTIONS: readonly [1, 1.5, 2, 3];
+interface LegendProps {
+    colorScale: GridColorScale;
+    label?: string;
+}
+declare function Legend({ colorScale, label }: LegendProps): ReactNode;
+interface TimeSliderProps {
+    source: GridDataSource;
+    dimension?: string;
+    value?: number;
+    defaultValue?: number;
+    debounceMs?: number;
+    autoPlay?: boolean;
+    playback?: boolean;
+    playbackIntervalMs?: number;
+    onChange?: (coordinate: TimeCoordinate) => void;
+}
+declare function TimeSlider({ source, dimension, value, defaultValue, debounceMs, autoPlay, playback, playbackIntervalMs, onChange }: TimeSliderProps): ReactNode;
+interface ZarrMapProps {
+    source: GridDataSource;
+    variable: string;
+    selector?: GridSelectors;
+    initialSelector?: GridSelectors;
+    colorScale?: GridColorScale;
+    opacity?: number;
+    map: Omit<MapLibreMapConfig, "container">;
+    timeDimension?: string;
+    controls?: {
+        legend?: boolean;
+        timeSlider?: boolean;
+        timePlayback?: boolean;
+        timePlaybackAutoPlay?: boolean;
+        inspect?: ZarrMapInspectControl;
+    };
+    className?: string;
+    style?: CSSProperties;
+    renderer?: Pick<GridLayerOptions, "layerFactory" | "mapFactory">;
+    formatInspectValue?: (sample: GridQuerySample, result: GridQueryResult) => ReactNode;
+    onSelectorChange?: (selector: GridSelectors) => void;
+    onInspect?: (result: GridQueryResult) => void;
+    onLoadingStateChange?: (state: GridLayerLoadingState) => void;
+    onReady?: (controller: GridLayerController) => void;
+    children?: ReactNode;
+}
+type ZarrMapInspectMode = "click" | "hover";
+type ZarrMapInspectControl = boolean | ZarrMapInspectMode | {
+    mode?: ZarrMapInspectMode;
+    debounceMs?: number;
+};
+declare function ZarrMap(props: ZarrMapProps): ReactNode;
+interface DClimateZarrMapProps extends Omit<ZarrMapProps, "source">, Pick<CreateDClimateSourceOptions, "client" | "clientOptions" | "gatewayUrl" | "openIpfsStore"> {
+    dataset: DClimateDatasetRequest;
+    bounds?: DClimateSelectionBounds | DClimateBoundsSelection;
+    boundsOptions?: DClimateBoundsSelectionOptions;
+    timeRange?: DClimateTimeRange;
+    preflight?: GridRequestPreflightConfig;
+    onPreflight?: (preflight: GridRequestPreflight) => void;
+    sourceOptions?: Omit<CreateDClimateSourceOptions, "client" | "clientOptions" | "gatewayUrl" | "openIpfsStore" | "preflight">;
+}
+declare function DClimateZarrMap(props: DClimateZarrMapProps): ReactNode;
+
+export { BASE_PLAYBACK_INTERVAL_MS, DClimateZarrMap, type DClimateZarrMapProps, Legend, type LegendProps, PLAYBACK_SPEED_OPTIONS, TimeSlider, type TimeSliderProps, ZarrMap, type ZarrMapInspectControl, type ZarrMapInspectMode, type ZarrMapProps, useMountEffect };