@itwin/imodel-components-react 3.4.4 → 3.4.5

package/lib/cjs/imodel-components-react/timeline/interfaces.d.ts

@@ -1,175 +1,175 @@
-/** @packageDocumentation
- * @module Timeline
- */
-import { ColorDef } from "@itwin/core-common";
-import { ScreenViewport } from "@itwin/core-frontend";
-import { GenericUiEventArgs } from "@itwin/appui-abstract";
-/**
- * A range of time which can be used to focus in on activities scheduled around a milestone.
- * @public
- */
-export interface MilestoneRange {
-    start: Date;
-    end: Date;
-}
-/**
- * A Milestone event that is to be noted in the timeline.
- * @internal
- * @deprecated
- */
-export interface Milestone {
-    /** uniqueId of milestone */
-    id: string;
-    /** milestone date */
-    date: Date;
-    parentId?: string;
-    /** Milestone label that is display if space allows */
-    label?: string;
-    /** Milestone description that is show as tooltip */
-    description?: string;
-    /** animation range that includes milestone */
-    range?: MilestoneRange;
-    /** Set to true if read only. */
-    readonly?: boolean;
-    children?: Milestone[];
-}
-/** The timeline scale.
- * @public
- */
-export declare enum TimelineScale {
-    /** Show years */
-    Years = 0,
-    /** Show quarters */
-    Quarters = 1,
-    /** Show months */
-    Months = 2,
-    /** Show days */
-    Days = 3,
-    /** Show hours */
-    Hours = 4
-}
-/** Determines if data displayed to use is the actual date or the amount of time elapsed since project start.
- * @public
- */
-export declare enum TimelineDateDisplay {
-    /** Display time axis using actual start/end dates */
-    ActualTime = 0,
-    /** Display time axis using time relative to actual start/end dates */
-    ProjectTime = 1
-}
-/**
- * Playback Settings.
- * @public
- */
-export interface PlaybackSettings {
-    /** time in milliseconds to play animation from start date to end date */
-    duration?: number;
-    /** Set to True if animation to restart each time playbackEnd is reached. Defaults to false. */
-    loop?: boolean;
-    /** If true a minimal set of data is displayed. */
-    minimized?: boolean;
-    /** Playback start. If defined must be within start-end range. If not define 'start' is used. */
-    playbackStart?: Date;
-    /** Playback end. If defined must be within start-end range and later than playbackStart. If not define 'end' is used. */
-    playbackEnd?: Date;
-    /** Set to True if user should be allowed to insert milestone dates. Defaults to false */
-    allowMilestoneEdits?: boolean;
-    /** Define if actual date/times are used or date/times relative to project are used to draw timeline axis. */
-    dateDisplay?: TimelineDateDisplay;
-}
-/**
- * An interface used to notify Handlers of the current pointer position in the timeline playback. Valid range is 0 to 1 and it determines percentage complete.
- * @public
- */
-export declare type AnimationFractionChangeHandler = (animationFraction: number) => void;
-/**
- * An interface used to notify Handlers of Playback Settings changes.
- * Contains the settings to be used.
- * @public
- */
-export declare type PlaybackSettingsChangeHandler = (settingsChange: PlaybackSettings) => void;
-/** Actions for Pause/Play event
- * @public
- */
-export declare enum TimelinePausePlayAction {
-    Toggle = 0,
-    Pause = 1,
-    Play = 2
-}
-/** Args for event to pause or play the timeline component
- * @public
- */
-export interface TimelinePausePlayArgs extends GenericUiEventArgs {
-    timelineAction: TimelinePausePlayAction;
-}
-/** Interface for a timeline data provider class
- * @public
- */
-export interface TimelineDataProvider {
-    /** uniqueId of provider */
-    id: string;
-    /** view id when viewport is initially assigned */
-    viewId: string;
-    /** returns true if the provider has timeline animation data available */
-    supportsTimelineAnimation: boolean;
-    /** Starting date for entire timeline */
-    start?: Date;
-    /** End date for entire timeline */
-    end?: Date;
-    /** Current animation fraction from 0.0 to 1.0 */
-    animationFraction?: number;
-    getSettings(): PlaybackSettings;
-    /** Called to get the initial scrubber location. This must be a value between 0 and the duration in PlaybackSettings. */
-    initialDuration: number;
-    /** Called to get the duration of the Playback. */
-    duration: number;
-    /** If true the playback will continuously loop. */
-    loop: boolean;
-    /** Called to save the playback settings */
-    updateSettings(settings: PlaybackSettings): void;
-    /** Async call to load milestone and settings data */
-    loadTimelineData(): Promise<boolean>;
-    /** Called when an internal process has defined the playback settings and the UI needs to be updated */
-    onPlaybackSettingChanged?: PlaybackSettingsChangeHandler;
-    /** Called when the an internal process has defined the playback settings and the UI needs to be updated */
-    onAnimationFractionChanged?: AnimationFractionChangeHandler;
-    /** viewport to show animation */
-    viewport?: ScreenViewport;
-}
-/**
- * An interface used to notify Handlers of Playback progress.
- * Contains the settings to be used.
- * @alpha
- */
-export declare type SolarPlaybackProgressHandler = (time: Date) => void;
-/** Data Provider interface for getting and setting solar position
- * @alpha
- */
-export interface SolarDataProvider {
-    viewId: string;
-    /** returns true if the provider has timeline animation data available */
-    supportsTimelineAnimation: boolean;
-    readonly shouldShowTimeline: boolean;
-    /** Starting date for entire timeline */
-    day: Date;
-    /** Starting time for day in milliseconds */
-    readonly dayStartMs: number;
-    /** Time of day for sun */
-    readonly timeOfDay: Date;
-    /** Called during playback to update animation */
-    onTimeChanged?: SolarPlaybackProgressHandler;
-    /** viewport to show animation */
-    viewport?: ScreenViewport;
-    /** Time of Sunrise to nearest minute */
-    readonly sunrise: Date;
-    /** time of Sunrise to nearest minute */
-    readonly sunset: Date;
-    /** shadow color */
-    shadowColor: ColorDef;
-    /** timezone offset for local project time */
-    readonly timeZoneOffset: number;
-    /** set date for shadow study. If isProjectDate is false the is assume to be in users
-     * current time and the value is adjusted to be the same date and time at the project location. */
-    setDateAndTime: (day: Date, isProjectDate?: boolean) => void;
-}
+/** @packageDocumentation
+ * @module Timeline
+ */
+import { ColorDef } from "@itwin/core-common";
+import { ScreenViewport } from "@itwin/core-frontend";
+import { GenericUiEventArgs } from "@itwin/appui-abstract";
+/**
+ * A range of time which can be used to focus in on activities scheduled around a milestone.
+ * @public
+ */
+export interface MilestoneRange {
+    start: Date;
+    end: Date;
+}
+/**
+ * A Milestone event that is to be noted in the timeline.
+ * @internal
+ * @deprecated
+ */
+export interface Milestone {
+    /** uniqueId of milestone */
+    id: string;
+    /** milestone date */
+    date: Date;
+    parentId?: string;
+    /** Milestone label that is display if space allows */
+    label?: string;
+    /** Milestone description that is show as tooltip */
+    description?: string;
+    /** animation range that includes milestone */
+    range?: MilestoneRange;
+    /** Set to true if read only. */
+    readonly?: boolean;
+    children?: Milestone[];
+}
+/** The timeline scale.
+ * @public
+ */
+export declare enum TimelineScale {
+    /** Show years */
+    Years = 0,
+    /** Show quarters */
+    Quarters = 1,
+    /** Show months */
+    Months = 2,
+    /** Show days */
+    Days = 3,
+    /** Show hours */
+    Hours = 4
+}
+/** Determines if data displayed to use is the actual date or the amount of time elapsed since project start.
+ * @public
+ */
+export declare enum TimelineDateDisplay {
+    /** Display time axis using actual start/end dates */
+    ActualTime = 0,
+    /** Display time axis using time relative to actual start/end dates */
+    ProjectTime = 1
+}
+/**
+ * Playback Settings.
+ * @public
+ */
+export interface PlaybackSettings {
+    /** time in milliseconds to play animation from start date to end date */
+    duration?: number;
+    /** Set to True if animation to restart each time playbackEnd is reached. Defaults to false. */
+    loop?: boolean;
+    /** If true a minimal set of data is displayed. */
+    minimized?: boolean;
+    /** Playback start. If defined must be within start-end range. If not define 'start' is used. */
+    playbackStart?: Date;
+    /** Playback end. If defined must be within start-end range and later than playbackStart. If not define 'end' is used. */
+    playbackEnd?: Date;
+    /** Set to True if user should be allowed to insert milestone dates. Defaults to false */
+    allowMilestoneEdits?: boolean;
+    /** Define if actual date/times are used or date/times relative to project are used to draw timeline axis. */
+    dateDisplay?: TimelineDateDisplay;
+}
+/**
+ * An interface used to notify Handlers of the current pointer position in the timeline playback. Valid range is 0 to 1 and it determines percentage complete.
+ * @public
+ */
+export declare type AnimationFractionChangeHandler = (animationFraction: number) => void;
+/**
+ * An interface used to notify Handlers of Playback Settings changes.
+ * Contains the settings to be used.
+ * @public
+ */
+export declare type PlaybackSettingsChangeHandler = (settingsChange: PlaybackSettings) => void;
+/** Actions for Pause/Play event
+ * @public
+ */
+export declare enum TimelinePausePlayAction {
+    Toggle = 0,
+    Pause = 1,
+    Play = 2
+}
+/** Args for event to pause or play the timeline component
+ * @public
+ */
+export interface TimelinePausePlayArgs extends GenericUiEventArgs {
+    timelineAction: TimelinePausePlayAction;
+}
+/** Interface for a timeline data provider class
+ * @public
+ */
+export interface TimelineDataProvider {
+    /** uniqueId of provider */
+    id: string;
+    /** view id when viewport is initially assigned */
+    viewId: string;
+    /** returns true if the provider has timeline animation data available */
+    supportsTimelineAnimation: boolean;
+    /** Starting date for entire timeline */
+    start?: Date;
+    /** End date for entire timeline */
+    end?: Date;
+    /** Current animation fraction from 0.0 to 1.0 */
+    animationFraction?: number;
+    getSettings(): PlaybackSettings;
+    /** Called to get the initial scrubber location. This must be a value between 0 and the duration in PlaybackSettings. */
+    initialDuration: number;
+    /** Called to get the duration of the Playback. */
+    duration: number;
+    /** If true the playback will continuously loop. */
+    loop: boolean;
+    /** Called to save the playback settings */
+    updateSettings(settings: PlaybackSettings): void;
+    /** Async call to load milestone and settings data */
+    loadTimelineData(): Promise<boolean>;
+    /** Called when an internal process has defined the playback settings and the UI needs to be updated */
+    onPlaybackSettingChanged?: PlaybackSettingsChangeHandler;
+    /** Called when the an internal process has defined the playback settings and the UI needs to be updated */
+    onAnimationFractionChanged?: AnimationFractionChangeHandler;
+    /** viewport to show animation */
+    viewport?: ScreenViewport;
+}
+/**
+ * An interface used to notify Handlers of Playback progress.
+ * Contains the settings to be used.
+ * @alpha
+ */
+export declare type SolarPlaybackProgressHandler = (time: Date) => void;
+/** Data Provider interface for getting and setting solar position
+ * @alpha
+ */
+export interface SolarDataProvider {
+    viewId: string;
+    /** returns true if the provider has timeline animation data available */
+    supportsTimelineAnimation: boolean;
+    readonly shouldShowTimeline: boolean;
+    /** Starting date for entire timeline */
+    day: Date;
+    /** Starting time for day in milliseconds */
+    readonly dayStartMs: number;
+    /** Time of day for sun */
+    readonly timeOfDay: Date;
+    /** Called during playback to update animation */
+    onTimeChanged?: SolarPlaybackProgressHandler;
+    /** viewport to show animation */
+    viewport?: ScreenViewport;
+    /** Time of Sunrise to nearest minute */
+    readonly sunrise: Date;
+    /** time of Sunrise to nearest minute */
+    readonly sunset: Date;
+    /** shadow color */
+    shadowColor: ColorDef;
+    /** timezone offset for local project time */
+    readonly timeZoneOffset: number;
+    /** set date for shadow study. If isProjectDate is false the is assume to be in users
+     * current time and the value is adjusted to be the same date and time at the project location. */
+    setDateAndTime: (day: Date, isProjectDate?: boolean) => void;
+}
 //# sourceMappingURL=interfaces.d.ts.map

package/lib/cjs/imodel-components-react/timeline/interfaces.js

@@ -1,46 +1,46 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Timeline
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TimelinePausePlayAction = exports.TimelineDateDisplay = exports.TimelineScale = void 0;
-/** The timeline scale.
- * @public
- */
-var TimelineScale;
-(function (TimelineScale) {
-    /** Show years */
-    TimelineScale[TimelineScale["Years"] = 0] = "Years";
-    /** Show quarters */
-    TimelineScale[TimelineScale["Quarters"] = 1] = "Quarters";
-    /** Show months */
-    TimelineScale[TimelineScale["Months"] = 2] = "Months";
-    /** Show days */
-    TimelineScale[TimelineScale["Days"] = 3] = "Days";
-    /** Show hours */
-    TimelineScale[TimelineScale["Hours"] = 4] = "Hours";
-})(TimelineScale = exports.TimelineScale || (exports.TimelineScale = {}));
-/** Determines if data displayed to use is the actual date or the amount of time elapsed since project start.
- * @public
- */
-var TimelineDateDisplay;
-(function (TimelineDateDisplay) {
-    /** Display time axis using actual start/end dates */
-    TimelineDateDisplay[TimelineDateDisplay["ActualTime"] = 0] = "ActualTime";
-    /** Display time axis using time relative to actual start/end dates */
-    TimelineDateDisplay[TimelineDateDisplay["ProjectTime"] = 1] = "ProjectTime";
-})(TimelineDateDisplay = exports.TimelineDateDisplay || (exports.TimelineDateDisplay = {}));
-/** Actions for Pause/Play event
- * @public
- */
-var TimelinePausePlayAction;
-(function (TimelinePausePlayAction) {
-    TimelinePausePlayAction[TimelinePausePlayAction["Toggle"] = 0] = "Toggle";
-    TimelinePausePlayAction[TimelinePausePlayAction["Pause"] = 1] = "Pause";
-    TimelinePausePlayAction[TimelinePausePlayAction["Play"] = 2] = "Play";
-})(TimelinePausePlayAction = exports.TimelinePausePlayAction || (exports.TimelinePausePlayAction = {}));
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Timeline
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TimelinePausePlayAction = exports.TimelineDateDisplay = exports.TimelineScale = void 0;
+/** The timeline scale.
+ * @public
+ */
+var TimelineScale;
+(function (TimelineScale) {
+    /** Show years */
+    TimelineScale[TimelineScale["Years"] = 0] = "Years";
+    /** Show quarters */
+    TimelineScale[TimelineScale["Quarters"] = 1] = "Quarters";
+    /** Show months */
+    TimelineScale[TimelineScale["Months"] = 2] = "Months";
+    /** Show days */
+    TimelineScale[TimelineScale["Days"] = 3] = "Days";
+    /** Show hours */
+    TimelineScale[TimelineScale["Hours"] = 4] = "Hours";
+})(TimelineScale = exports.TimelineScale || (exports.TimelineScale = {}));
+/** Determines if data displayed to use is the actual date or the amount of time elapsed since project start.
+ * @public
+ */
+var TimelineDateDisplay;
+(function (TimelineDateDisplay) {
+    /** Display time axis using actual start/end dates */
+    TimelineDateDisplay[TimelineDateDisplay["ActualTime"] = 0] = "ActualTime";
+    /** Display time axis using time relative to actual start/end dates */
+    TimelineDateDisplay[TimelineDateDisplay["ProjectTime"] = 1] = "ProjectTime";
+})(TimelineDateDisplay = exports.TimelineDateDisplay || (exports.TimelineDateDisplay = {}));
+/** Actions for Pause/Play event
+ * @public
+ */
+var TimelinePausePlayAction;
+(function (TimelinePausePlayAction) {
+    TimelinePausePlayAction[TimelinePausePlayAction["Toggle"] = 0] = "Toggle";
+    TimelinePausePlayAction[TimelinePausePlayAction["Pause"] = 1] = "Pause";
+    TimelinePausePlayAction[TimelinePausePlayAction["Play"] = 2] = "Play";
+})(TimelinePausePlayAction = exports.TimelinePausePlayAction || (exports.TimelinePausePlayAction = {}));
 //# sourceMappingURL=interfaces.js.map

package/lib/cjs/imodel-components-react/timeline/interfaces.js.map

@@ -1 +1 @@
-{"version":3,"file":"interfaces.js","sourceRoot":"","sources":["../../../../src/imodel-components-react/timeline/interfaces.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAsCH;;GAEG;AACH,IAAY,aAWX;AAXD,WAAY,aAAa;IACvB,iBAAiB;IACjB,mDAAK,CAAA;IACL,oBAAoB;IACpB,yDAAQ,CAAA;IACR,kBAAkB;IAClB,qDAAM,CAAA;IACN,gBAAgB;IAChB,iDAAI,CAAA;IACJ,iBAAiB;IACjB,mDAAK,CAAA;AACP,CAAC,EAXW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAWxB;AAED;;GAEG;AACH,IAAY,mBAKX;AALD,WAAY,mBAAmB;IAC7B,qDAAqD;IACrD,yEAAU,CAAA;IACV,sEAAsE;IACtE,2EAAW,CAAA;AACb,CAAC,EALW,mBAAmB,GAAnB,2BAAmB,KAAnB,2BAAmB,QAK9B;AAoCD;;GAEG;AACH,IAAY,uBAIX;AAJD,WAAY,uBAAuB;IACjC,yEAAM,CAAA;IACN,uEAAK,CAAA;IACL,qEAAI,CAAA;AACN,CAAC,EAJW,uBAAuB,GAAvB,+BAAuB,KAAvB,+BAAuB,QAIlC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Timeline\n */\n\nimport { ColorDef } from \"@itwin/core-common\";\nimport { ScreenViewport } from \"@itwin/core-frontend\";\nimport { GenericUiEventArgs } from \"@itwin/appui-abstract\";\n\n/**\n * A range of time which can be used to focus in on activities scheduled around a milestone.\n * @public\n */\nexport interface MilestoneRange {\n  start: Date;\n  end: Date;\n}\n\n/**\n * A Milestone event that is to be noted in the timeline.\n * @internal\n * @deprecated\n */\nexport interface Milestone {\n  /** uniqueId of milestone */\n  id: string;\n  /** milestone date */\n  date: Date;\n  parentId?: string;\n  /** Milestone label that is display if space allows */\n  label?: string;\n  /** Milestone description that is show as tooltip */\n  description?: string;\n  /** animation range that includes milestone */\n  range?: MilestoneRange;\n  /** Set to true if read only. */\n  readonly?: boolean;\n  // eslint-disable-next-line deprecation/deprecation\n  children?: Milestone[];\n}\n\n/** The timeline scale.\n * @public\n */\nexport enum TimelineScale {\n  /** Show years */\n  Years,\n  /** Show quarters */\n  Quarters,\n  /** Show months */\n  Months,\n  /** Show days */\n  Days,\n  /** Show hours */\n  Hours,\n}\n\n/** Determines if data displayed to use is the actual date or the amount of time elapsed since project start.\n * @public\n */\nexport enum TimelineDateDisplay {\n  /** Display time axis using actual start/end dates */\n  ActualTime,\n  /** Display time axis using time relative to actual start/end dates */\n  ProjectTime,\n}\n\n/**\n * Playback Settings.\n * @public\n */\nexport interface PlaybackSettings {\n  /** time in milliseconds to play animation from start date to end date */\n  duration?: number;\n  /** Set to True if animation to restart each time playbackEnd is reached. Defaults to false. */\n  loop?: boolean;\n  /** If true a minimal set of data is displayed. */\n  minimized?: boolean;\n  /** Playback start. If defined must be within start-end range. If not define 'start' is used. */\n  playbackStart?: Date;\n  /** Playback end. If defined must be within start-end range and later than playbackStart. If not define 'end' is used. */\n  playbackEnd?: Date;\n  /** Set to True if user should be allowed to insert milestone dates. Defaults to false */\n  allowMilestoneEdits?: boolean;\n  /** Define if actual date/times are used or date/times relative to project are used to draw timeline axis. */\n  dateDisplay?: TimelineDateDisplay;\n}\n\n/**\n * An interface used to notify Handlers of the current pointer position in the timeline playback. Valid range is 0 to 1 and it determines percentage complete.\n * @public\n */\nexport type AnimationFractionChangeHandler = (animationFraction: number) => void;\n\n/**\n * An interface used to notify Handlers of Playback Settings changes.\n * Contains the settings to be used.\n * @public\n */\nexport type PlaybackSettingsChangeHandler = (settingsChange: PlaybackSettings) => void;\n\n/** Actions for Pause/Play event\n * @public\n */\nexport enum TimelinePausePlayAction {\n  Toggle,\n  Pause,\n  Play,\n}\n/** Args for event to pause or play the timeline component\n * @public\n */\nexport interface TimelinePausePlayArgs extends GenericUiEventArgs {\n  timelineAction: TimelinePausePlayAction;\n}\n/** Interface for a timeline data provider class\n * @public\n */\nexport interface TimelineDataProvider {\n  /** uniqueId of provider */\n  id: string;\n  /** view id when viewport is initially assigned */\n  viewId: string;\n  /** returns true if the provider has timeline animation data available */\n  supportsTimelineAnimation: boolean;\n  /** Starting date for entire timeline */\n  start?: Date;\n  /** End date for entire timeline */\n  end?: Date;\n  /** Current animation fraction from 0.0 to 1.0 */\n  animationFraction?: number;\n  getSettings(): PlaybackSettings;\n  /** Called to get the initial scrubber location. This must be a value between 0 and the duration in PlaybackSettings. */\n  initialDuration: number;\n  /** Called to get the duration of the Playback. */\n  duration: number;\n  /** If true the playback will continuously loop. */\n  loop: boolean;\n  /** Called to save the playback settings */\n  updateSettings(settings: PlaybackSettings): void;\n  /** Async call to load milestone and settings data */\n  loadTimelineData(): Promise<boolean>;\n  /** Called when an internal process has defined the playback settings and the UI needs to be updated */\n  onPlaybackSettingChanged?: PlaybackSettingsChangeHandler;\n  /** Called when the an internal process has defined the playback settings and the UI needs to be updated */\n  onAnimationFractionChanged?: AnimationFractionChangeHandler;\n  /** viewport to show animation */\n  viewport?: ScreenViewport;\n}\n\n/**\n * An interface used to notify Handlers of Playback progress.\n * Contains the settings to be used.\n * @alpha\n */\nexport type SolarPlaybackProgressHandler = (time: Date) => void;\n\n/** Data Provider interface for getting and setting solar position\n * @alpha\n */\nexport interface SolarDataProvider {\n  // View Id used to determine sunrise and sunset\n  viewId: string;\n  /** returns true if the provider has timeline animation data available */\n  supportsTimelineAnimation: boolean;\n  // set to true is timeline should be shown - return false if view is not set to display shadow.\n  readonly shouldShowTimeline: boolean;\n  /** Starting date for entire timeline */\n  day: Date;\n  /** Starting time for day in milliseconds */\n  readonly dayStartMs: number;\n  /** Time of day for sun */\n  readonly timeOfDay: Date;\n  /** Called during playback to update animation */\n  onTimeChanged?: SolarPlaybackProgressHandler;\n  /** viewport to show animation */\n  viewport?: ScreenViewport;\n  /** Time of Sunrise to nearest minute */\n  readonly sunrise: Date;\n  /** time of Sunrise to nearest minute */\n  readonly sunset: Date;\n  /** shadow color */\n  shadowColor: ColorDef;\n  /** timezone offset for local project time */\n  readonly timeZoneOffset: number;\n  /** set date for shadow study. If isProjectDate is false the is assume to be in users\n   * current time and the value is adjusted to be the same date and time at the project location. */\n  setDateAndTime: (day: Date, isProjectDate?: boolean) => void;\n}\n"]}
+{"version":3,"file":"interfaces.js","sourceRoot":"","sources":["../../../../src/imodel-components-react/timeline/interfaces.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAsCH;;GAEG;AACH,IAAY,aAWX;AAXD,WAAY,aAAa;IACvB,iBAAiB;IACjB,mDAAK,CAAA;IACL,oBAAoB;IACpB,yDAAQ,CAAA;IACR,kBAAkB;IAClB,qDAAM,CAAA;IACN,gBAAgB;IAChB,iDAAI,CAAA;IACJ,iBAAiB;IACjB,mDAAK,CAAA;AACP,CAAC,EAXW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAWxB;AAED;;GAEG;AACH,IAAY,mBAKX;AALD,WAAY,mBAAmB;IAC7B,qDAAqD;IACrD,yEAAU,CAAA;IACV,sEAAsE;IACtE,2EAAW,CAAA;AACb,CAAC,EALW,mBAAmB,GAAnB,2BAAmB,KAAnB,2BAAmB,QAK9B;AAoCD;;GAEG;AACH,IAAY,uBAIX;AAJD,WAAY,uBAAuB;IACjC,yEAAM,CAAA;IACN,uEAAK,CAAA;IACL,qEAAI,CAAA;AACN,CAAC,EAJW,uBAAuB,GAAvB,+BAAuB,KAAvB,+BAAuB,QAIlC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Timeline\r\n */\r\n\r\nimport { ColorDef } from \"@itwin/core-common\";\r\nimport { ScreenViewport } from \"@itwin/core-frontend\";\r\nimport { GenericUiEventArgs } from \"@itwin/appui-abstract\";\r\n\r\n/**\r\n * A range of time which can be used to focus in on activities scheduled around a milestone.\r\n * @public\r\n */\r\nexport interface MilestoneRange {\r\n  start: Date;\r\n  end: Date;\r\n}\r\n\r\n/**\r\n * A Milestone event that is to be noted in the timeline.\r\n * @internal\r\n * @deprecated\r\n */\r\nexport interface Milestone {\r\n  /** uniqueId of milestone */\r\n  id: string;\r\n  /** milestone date */\r\n  date: Date;\r\n  parentId?: string;\r\n  /** Milestone label that is display if space allows */\r\n  label?: string;\r\n  /** Milestone description that is show as tooltip */\r\n  description?: string;\r\n  /** animation range that includes milestone */\r\n  range?: MilestoneRange;\r\n  /** Set to true if read only. */\r\n  readonly?: boolean;\r\n  // eslint-disable-next-line deprecation/deprecation\r\n  children?: Milestone[];\r\n}\r\n\r\n/** The timeline scale.\r\n * @public\r\n */\r\nexport enum TimelineScale {\r\n  /** Show years */\r\n  Years,\r\n  /** Show quarters */\r\n  Quarters,\r\n  /** Show months */\r\n  Months,\r\n  /** Show days */\r\n  Days,\r\n  /** Show hours */\r\n  Hours,\r\n}\r\n\r\n/** Determines if data displayed to use is the actual date or the amount of time elapsed since project start.\r\n * @public\r\n */\r\nexport enum TimelineDateDisplay {\r\n  /** Display time axis using actual start/end dates */\r\n  ActualTime,\r\n  /** Display time axis using time relative to actual start/end dates */\r\n  ProjectTime,\r\n}\r\n\r\n/**\r\n * Playback Settings.\r\n * @public\r\n */\r\nexport interface PlaybackSettings {\r\n  /** time in milliseconds to play animation from start date to end date */\r\n  duration?: number;\r\n  /** Set to True if animation to restart each time playbackEnd is reached. Defaults to false. */\r\n  loop?: boolean;\r\n  /** If true a minimal set of data is displayed. */\r\n  minimized?: boolean;\r\n  /** Playback start. If defined must be within start-end range. If not define 'start' is used. */\r\n  playbackStart?: Date;\r\n  /** Playback end. If defined must be within start-end range and later than playbackStart. If not define 'end' is used. */\r\n  playbackEnd?: Date;\r\n  /** Set to True if user should be allowed to insert milestone dates. Defaults to false */\r\n  allowMilestoneEdits?: boolean;\r\n  /** Define if actual date/times are used or date/times relative to project are used to draw timeline axis. */\r\n  dateDisplay?: TimelineDateDisplay;\r\n}\r\n\r\n/**\r\n * An interface used to notify Handlers of the current pointer position in the timeline playback. Valid range is 0 to 1 and it determines percentage complete.\r\n * @public\r\n */\r\nexport type AnimationFractionChangeHandler = (animationFraction: number) => void;\r\n\r\n/**\r\n * An interface used to notify Handlers of Playback Settings changes.\r\n * Contains the settings to be used.\r\n * @public\r\n */\r\nexport type PlaybackSettingsChangeHandler = (settingsChange: PlaybackSettings) => void;\r\n\r\n/** Actions for Pause/Play event\r\n * @public\r\n */\r\nexport enum TimelinePausePlayAction {\r\n  Toggle,\r\n  Pause,\r\n  Play,\r\n}\r\n/** Args for event to pause or play the timeline component\r\n * @public\r\n */\r\nexport interface TimelinePausePlayArgs extends GenericUiEventArgs {\r\n  timelineAction: TimelinePausePlayAction;\r\n}\r\n/** Interface for a timeline data provider class\r\n * @public\r\n */\r\nexport interface TimelineDataProvider {\r\n  /** uniqueId of provider */\r\n  id: string;\r\n  /** view id when viewport is initially assigned */\r\n  viewId: string;\r\n  /** returns true if the provider has timeline animation data available */\r\n  supportsTimelineAnimation: boolean;\r\n  /** Starting date for entire timeline */\r\n  start?: Date;\r\n  /** End date for entire timeline */\r\n  end?: Date;\r\n  /** Current animation fraction from 0.0 to 1.0 */\r\n  animationFraction?: number;\r\n  getSettings(): PlaybackSettings;\r\n  /** Called to get the initial scrubber location. This must be a value between 0 and the duration in PlaybackSettings. */\r\n  initialDuration: number;\r\n  /** Called to get the duration of the Playback. */\r\n  duration: number;\r\n  /** If true the playback will continuously loop. */\r\n  loop: boolean;\r\n  /** Called to save the playback settings */\r\n  updateSettings(settings: PlaybackSettings): void;\r\n  /** Async call to load milestone and settings data */\r\n  loadTimelineData(): Promise<boolean>;\r\n  /** Called when an internal process has defined the playback settings and the UI needs to be updated */\r\n  onPlaybackSettingChanged?: PlaybackSettingsChangeHandler;\r\n  /** Called when the an internal process has defined the playback settings and the UI needs to be updated */\r\n  onAnimationFractionChanged?: AnimationFractionChangeHandler;\r\n  /** viewport to show animation */\r\n  viewport?: ScreenViewport;\r\n}\r\n\r\n/**\r\n * An interface used to notify Handlers of Playback progress.\r\n * Contains the settings to be used.\r\n * @alpha\r\n */\r\nexport type SolarPlaybackProgressHandler = (time: Date) => void;\r\n\r\n/** Data Provider interface for getting and setting solar position\r\n * @alpha\r\n */\r\nexport interface SolarDataProvider {\r\n  // View Id used to determine sunrise and sunset\r\n  viewId: string;\r\n  /** returns true if the provider has timeline animation data available */\r\n  supportsTimelineAnimation: boolean;\r\n  // set to true is timeline should be shown - return false if view is not set to display shadow.\r\n  readonly shouldShowTimeline: boolean;\r\n  /** Starting date for entire timeline */\r\n  day: Date;\r\n  /** Starting time for day in milliseconds */\r\n  readonly dayStartMs: number;\r\n  /** Time of day for sun */\r\n  readonly timeOfDay: Date;\r\n  /** Called during playback to update animation */\r\n  onTimeChanged?: SolarPlaybackProgressHandler;\r\n  /** viewport to show animation */\r\n  viewport?: ScreenViewport;\r\n  /** Time of Sunrise to nearest minute */\r\n  readonly sunrise: Date;\r\n  /** time of Sunrise to nearest minute */\r\n  readonly sunset: Date;\r\n  /** shadow color */\r\n  shadowColor: ColorDef;\r\n  /** timezone offset for local project time */\r\n  readonly timeZoneOffset: number;\r\n  /** set date for shadow study. If isProjectDate is false the is assume to be in users\r\n   * current time and the value is adjusted to be the same date and time at the project location. */\r\n  setDateAndTime: (day: Date, isProjectDate?: boolean) => void;\r\n}\r\n"]}

package/lib/cjs/imodel-components-react/viewport/ViewportComponent.d.ts

@@ -1,43 +1,43 @@
-/** @packageDocumentation
- * @module Viewport
- */
-import * as React from "react";
-import { Id64String } from "@itwin/core-bentley";
-import { IModelConnection, ScreenViewport, TentativePoint, ViewManager, ViewState } from "@itwin/core-frontend";
-import { CommonProps } from "@itwin/core-react";
-/** Type for a ViewState prop
- * @public
- */
-export declare type ViewStateProp = ViewState | (() => ViewState);
-/**
- * Properties for [[ViewportComponent]] component.
- * @public
- */
-export interface ViewportProps extends CommonProps {
-    /** IModel to display */
-    imodel: IModelConnection;
-    /** Id of a default view definition to load as a starting point */
-    viewDefinitionId?: Id64String;
-    /** ViewState to use as a starting point */
-    viewState?: ViewStateProp;
-    /** Function to get a reference to the ScreenViewport */
-    viewportRef?: (v: ScreenViewport) => void;
-    /** controlId for this content component @internal */
-    controlId?: string;
-    /** @internal */
-    onContextMenu?: (e: React.MouseEvent) => boolean;
-    /** @internal */
-    getViewOverlay?: (viewport: ScreenViewport) => React.ReactNode;
-    /** @internal used only for testing */
-    viewManagerOverride?: ViewManager;
-    /** @internal used only for testing */
-    screenViewportOverride?: typeof ScreenViewport;
-    /** @internal used only for testing */
-    tentativePointOverride?: TentativePoint;
-}
-/**
- * A viewport React component that creates a ScreenViewport.
- * @public
- */
-export declare function ViewportComponent(props: ViewportProps): JSX.Element;
+/** @packageDocumentation
+ * @module Viewport
+ */
+import * as React from "react";
+import { Id64String } from "@itwin/core-bentley";
+import { IModelConnection, ScreenViewport, TentativePoint, ViewManager, ViewState } from "@itwin/core-frontend";
+import { CommonProps } from "@itwin/core-react";
+/** Type for a ViewState prop
+ * @public
+ */
+export declare type ViewStateProp = ViewState | (() => ViewState);
+/**
+ * Properties for [[ViewportComponent]] component.
+ * @public
+ */
+export interface ViewportProps extends CommonProps {
+    /** IModel to display */
+    imodel: IModelConnection;
+    /** Id of a default view definition to load as a starting point */
+    viewDefinitionId?: Id64String;
+    /** ViewState to use as a starting point */
+    viewState?: ViewStateProp;
+    /** Function to get a reference to the ScreenViewport */
+    viewportRef?: (v: ScreenViewport) => void;
+    /** controlId for this content component @internal */
+    controlId?: string;
+    /** @internal */
+    onContextMenu?: (e: React.MouseEvent) => boolean;
+    /** @internal */
+    getViewOverlay?: (viewport: ScreenViewport) => React.ReactNode;
+    /** @internal used only for testing */
+    viewManagerOverride?: ViewManager;
+    /** @internal used only for testing */
+    screenViewportOverride?: typeof ScreenViewport;
+    /** @internal used only for testing */
+    tentativePointOverride?: TentativePoint;
+}
+/**
+ * A viewport React component that creates a ScreenViewport.
+ * @public
+ */
+export declare function ViewportComponent(props: ViewportProps): JSX.Element;
 //# sourceMappingURL=ViewportComponent.d.ts.map