src/lib/types/configuration.ts
Configuration of the event display.
Properties |
|
| allowUrlOptions |
allowUrlOptions:
|
Type : boolean
|
| Optional |
|
Whether to allow URL options or not (true by default). |
| defaultEventFile |
defaultEventFile:
|
Type : literal type
|
| Optional |
|
Default event to load when none given in URL. |
| defaultView |
defaultView:
|
Type : number[]
|
| Optional |
|
Default view [x,y,z]. |
| elementId |
elementId:
|
Type : string
|
| Optional |
|
ID of the wrapper element. |
| enableDatGUIMenu |
enableDatGUIMenu:
|
Type : boolean
|
| Optional |
|
Whether to enable dat.GUI menu or not. |
| eventDataLoader |
eventDataLoader:
|
Type : EventDataLoader
|
| Optional |
|
Event data loader responsible for processing and loading event data. |
| forceColourTheme |
forceColourTheme:
|
Type : string
|
| Optional |
|
Whether to force a theme ('dark' or 'light' are current options) |
| phoenixMenuRoot |
phoenixMenuRoot:
|
Type : PhoenixMenuNode
|
| Optional |
|
Root node of the phoenix menu. |
| presetAnimations |
presetAnimations:
|
Type : AnimationPreset[]
|
| Optional |
|
Preset animations for switching event display camera. |
| presetViews |
presetViews:
|
Type : PresetView[]
|
| Optional |
|
Preset views for switching event display camera. |
import { PresetView } from '../models/preset-view.model';
import type { EventDataLoader } from '../../loaders/event-data-loader';
import type { PhoenixMenuNode } from '../../managers/ui-manager/phoenix-menu/phoenix-menu-node';
import type { AnimationPreset } from '../../managers/three-manager/animations-manager';
/**
* Configuration of the event display.
*/
export interface Configuration {
/** Default view [x,y,z]. */
defaultView?: number[];
/** Preset views for switching event display camera. */
presetViews?: PresetView[];
/** Preset animations for switching event display camera. */
presetAnimations?: AnimationPreset[];
/** Event data loader responsible for processing and loading event data. */
eventDataLoader?: EventDataLoader;
/** Root node of the phoenix menu. */
phoenixMenuRoot?: PhoenixMenuNode;
/** Whether to enable dat.GUI menu or not. */
enableDatGUIMenu?: boolean;
/** ID of the wrapper element. */
elementId?: string;
/** Default event to load when none given in URL. */
defaultEventFile?: { eventFile: string; eventType: string };
/** Whether to allow URL options or not (true by default). */
allowUrlOptions?: boolean;
/** Whether to force a theme ('dark' or 'light' are current options) */
forceColourTheme?: string;
}