Interface PanelMap

Marker interface intentionally left empty. Built-in panels populate it via declare module augmentation in builtinPanels.ts; SDK users register custom panels by augmenting it from their own code.

Each entry has the shape { panel: SomePanel; params: SomeParams }. Use void for params when the panel takes no per-call config.

interface PanelMap {
    angleMeasurements: {
        panel: AngleMeasurementsTool;
        params: { view: View } & Partial<AngleMeasurementsToolParams>;
    };
    angleMeasurementsPanel: {
        panel: AngleMeasurementsPanel;
        params: { view: View };
    };
    boundariesPanel: { panel: BoundariesPanel; params: void };
    cameraTourPanel: { panel: CameraTourPanel; params: void };
    cullingPanel: { panel: CullingPanel; params: void };
    dataHealth: {
        panel: DataHealthPanel;
        params: { focusDataModel?: DataModel; schema?: DataFormatSchema };
    };
    dataStats: { panel: DataStatsPanel; params: void };
    dataTexturesPanel: { panel: DataTexturesPanel; params: void };
    daylightAnalysisPanel: {
        panel: DaylightAnalysisPanel;
        params: {
            initialDaysPerYear?: number;
            initialGrid?: AnalysisGrid;
            initialHoursPerDay?: number;
            initialSkyModel?: SkyModel;
            initialYear?: number;
            scene: Scene;
            sunStudy: SunStudy;
        };
    };
    distanceMeasurements: {
        panel: DistanceMeasurementTool;
        params: { view: View } & Partial<DistanceMeasurementToolParams>;
    };
    distanceMeasurementsPanel: {
        panel: DistanceMeasurementsPanel;
        params: { view: View };
    };
    drawingsPanel: { panel: DrawingsPanel; params: void };
    explorerPanel: { panel: ExplorerPanel; params: void };
    exportBCFPanel: { panel: ExportBCFPanel; params: void };
    exportDialog: { panel: ExportDialog; params: void };
    gpuMemory: { panel: GPUMemoryPanel; params: void };
    issuesPanel: { panel: IssuesPanel; params: void };
    modelsPanel: { panel: ModelsPanel; params: void };
    navCube: {
        panel: NavCube;
        params: { view: View } & Partial<NavCubeParams>;
    };
    pdfImport: { panel: PdfImportPanel; params: void };
    rendererPanel: { panel: RendererPanel; params: void };
    sampleModels: { panel: SampleModelsPanel; params: void };
    sceneHealth: {
        panel: SceneHealthPanel;
        params: { focusSceneModel?: SceneModel };
    };
    sceneStats: { panel: SceneStatsPanel; params: void };
    schedulePanel: { panel: SchedulePanel; params: { player: SchedulePlayer } };
    schemaMaterials: {
        panel: SchemaMaterialsPanel;
        params: { focusSceneModel?: SceneModel };
    };
    sectionPlanesPanel: { panel: SectionPlanesPanel; params: { view: View } };
    shadersPanel: { panel: ShadersPanel; params: void };
    sunStudyPanel: {
        panel: SunStudyPanel;
        params: { player?: AnnualSunPlayer; sunStudy: SunStudy };
    };
    tasksPanel: { panel: TasksPanel; params: void };
    tilesPanel: { panel: TilesPanel; params: void };
    toolbar: { panel: Toolbar; params: void };
    transformControls: {
        panel: TransformControls;
        params: { view: View } & Partial<TransformControlsParams>;
    };
    viewerConfig: { panel: ViewerConfigPanel; params: void };
    volumeOverlayPanel: {
        panel: VolumeOverlayPanel;
        params: {
            grid: VoxelGrid;
            initialAxis?: SliceAxis;
            initialColormap?: string;
            initialIsovalue?: number;
            initialPosition?: number;
            initialSeedDensity?: number;
            initialTechnique?: "slice" | "isosurface" | "streamlines";
            scene: Scene;
            vectorGrid?: VectorGrid;
        };
    };
}

Properties

angleMeasurements angleMeasurementsPanel boundariesPanel cameraTourPanel cullingPanel dataHealth dataStats dataTexturesPanel daylightAnalysisPanel distanceMeasurements distanceMeasurementsPanel drawingsPanel explorerPanel exportBCFPanel exportDialog gpuMemory issuesPanel modelsPanel navCube pdfImport rendererPanel sampleModels sceneHealth sceneStats schedulePanel schemaMaterials sectionPlanesPanel shadersPanel sunStudyPanel tasksPanel tilesPanel toolbar transformControls viewerConfig volumeOverlayPanel

Properties

angleMeasurements

angleMeasurements: {
    panel: AngleMeasurementsTool;
    params: { view: View } & Partial<AngleMeasurementsToolParams>;
}

angleMeasurementsPanel

angleMeasurementsPanel: {
    panel: AngleMeasurementsPanel;
    params: { view: View };
}

boundariesPanel

boundariesPanel: { panel: BoundariesPanel; params: void }

cameraTourPanel

cameraTourPanel: { panel: CameraTourPanel; params: void }

cullingPanel

cullingPanel: { panel: CullingPanel; params: void }

dataHealth

dataHealth: {
    panel: DataHealthPanel;
    params: { focusDataModel?: DataModel; schema?: DataFormatSchema };
}

dataStats

dataStats: { panel: DataStatsPanel; params: void }

dataTexturesPanel

dataTexturesPanel: { panel: DataTexturesPanel; params: void }

daylightAnalysisPanel

daylightAnalysisPanel: {
    panel: DaylightAnalysisPanel;
    params: {
        initialDaysPerYear?: number;
        initialGrid?: AnalysisGrid;
        initialHoursPerDay?: number;
        initialSkyModel?: SkyModel;
        initialYear?: number;
        scene: Scene;
        sunStudy: SunStudy;
    };
}

distanceMeasurements

distanceMeasurements: {
    panel: DistanceMeasurementTool;
    params: { view: View } & Partial<DistanceMeasurementToolParams>;
}

distanceMeasurementsPanel

distanceMeasurementsPanel: {
    panel: DistanceMeasurementsPanel;
    params: { view: View };
}

drawingsPanel

drawingsPanel: { panel: DrawingsPanel; params: void }

explorerPanel

explorerPanel: { panel: ExplorerPanel; params: void }

exportBCFPanel

exportBCFPanel: { panel: ExportBCFPanel; params: void }

exportDialog

exportDialog: { panel: ExportDialog; params: void }

gpuMemory

gpuMemory: { panel: GPUMemoryPanel; params: void }

issuesPanel

issuesPanel: { panel: IssuesPanel; params: void }

modelsPanel

modelsPanel: { panel: ModelsPanel; params: void }

navCube

navCube: { panel: NavCube; params: { view: View } & Partial<NavCubeParams> }

pdfImport

pdfImport: { panel: PdfImportPanel; params: void }

rendererPanel

rendererPanel: { panel: RendererPanel; params: void }

sampleModels

sampleModels: { panel: SampleModelsPanel; params: void }

sceneHealth

sceneHealth: {
    panel: SceneHealthPanel;
    params: { focusSceneModel?: SceneModel };
}

sceneStats

sceneStats: { panel: SceneStatsPanel; params: void }

schedulePanel

schedulePanel: { panel: SchedulePanel; params: { player: SchedulePlayer } }

schemaMaterials

schemaMaterials: {
    panel: SchemaMaterialsPanel;
    params: { focusSceneModel?: SceneModel };
}

sectionPlanesPanel

sectionPlanesPanel: { panel: SectionPlanesPanel; params: { view: View } }

shadersPanel

shadersPanel: { panel: ShadersPanel; params: void }

sunStudyPanel

sunStudyPanel: {
    panel: SunStudyPanel;
    params: { player?: AnnualSunPlayer; sunStudy: SunStudy };
}

tasksPanel

tasksPanel: { panel: TasksPanel; params: void }

tilesPanel

tilesPanel: { panel: TilesPanel; params: void }

toolbar

toolbar: { panel: Toolbar; params: void }

transformControls

transformControls: {
    panel: TransformControls;
    params: { view: View } & Partial<TransformControlsParams>;
}

viewerConfig

viewerConfig: { panel: ViewerConfigPanel; params: void }

volumeOverlayPanel

volumeOverlayPanel: {
    panel: VolumeOverlayPanel;
    params: {
        grid: VoxelGrid;
        initialAxis?: SliceAxis;
        initialColormap?: string;
        initialIsovalue?: number;
        initialPosition?: number;
        initialSeedDensity?: number;
        initialTechnique?: "slice" | "isosurface" | "streamlines";
        scene: Scene;
        vectorGrid?: VectorGrid;
    };
}

Settings

Member Visibility

On This Page

Properties