@itwin/imodel-components-react 3.5.0-dev.66 → 3.5.0-dev.68

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

@@ -1,134 +1,134 @@
-/** @packageDocumentation
- * @module Timeline
- */
-import "./TimelineComponent.scss";
-import * as React from "react";
-import { DateFormatOptions } from "@itwin/components-react";
-import { PlaybackSettings } from "./interfaces";
-/**
- * [[TimelineMenuItemOption]]: specifies how the app wants the timeline speeds to be installed on the TimelineComponent's ContextMenu
- * "replace" : use the app-supplied items in place of the standard items
- * "append" : add the app-supplied items following the standard items
- * "prefix" : add the app-supplied items before the standard items
- *
- * @public
- */
-export declare type TimelineMenuItemOption = "replace" | "append" | "prefix";
-/**
- * [[TimelineMenuItemProps]] specifies playback speed entries in the Timeline's ContextMenu
- * @public
- */
-export interface TimelineMenuItemProps {
-    /** localized label for menu item */
-    label: string;
-    /** duration for the entire timeline to play */
-    timelineDuration: number;
-}
-/** TimelineDateMarkerProps: Mark a date on the timeline with an indicator
- * @public
- */
-export interface TimelineDateMarkerProps {
-    /** Date to mark. If undefined, today's date will be used. */
-    date?: Date;
-    /** ReactNode to use as the marker on the timeline. If undefined, a short vertical bar will mark the date. */
-    dateMarker?: React.ReactNode;
-}
-/**
- *  [[TimelineComponentProps]] configure the timeline
- * @public
- */
-export interface TimelineComponentProps {
-    /** Start date: beginning of the date range of a date-based timeline. */
-    startDate?: Date;
-    /** End date: end of the date range of a date-based timeline. */
-    endDate?: Date;
-    /** Total duration: range of the timeline in milliseconds. */
-    totalDuration: number;
-    /** Initial value for the current duration (the location of the thumb) in milliseconds */
-    initialDuration?: number;
-    /** Show in minimized mode (For future use. This prop will always be treated as true.) */
-    minimized?: boolean;
-    /** When playing, repeat indefinitely */
-    repeat?: boolean;
-    /** Show duration instead of time */
-    showDuration?: boolean;
-    /** Callback with current duration value (as a fraction) */
-    onChange?: (duration: number) => void;
-    /** Callback triggered when play/pause button is pressed */
-    onPlayPause?: (playing: boolean) => void;
-    /** Callback triggered when backward/forward buttons are pressed */
-    onJump?: (forward: boolean) => void;
-    /** Callback triggered when a setting is changed */
-    onSettingsChange?: (arg: PlaybackSettings) => void;
-    /** Always display in miniMode with no expand menu (For future use. This prop will always be treated as true) */
-    alwaysMinimized?: boolean;
-    /** ComponentId -- must be set to use TimelineComponentEvents */
-    componentId?: string;
-    /** Include the repeat option on the Timeline Context Menu */
-    includeRepeat?: boolean;
-    /** App-supplied speed entries in the Timeline Context Menu */
-    appMenuItems?: TimelineMenuItemProps[];
-    /** How to include the supplied app menu items in the Timeline Context Menu (prefix, append, replace)*/
-    appMenuItemOption?: TimelineMenuItemOption;
-    /** Display date and time offset by the number of minutes specified. When undefined - local timezone will be used */
-    timeZoneOffset?: number;
-    /** Display a marker on the timeline rail to indicate current date - will only work if starDate and endDate are defined */
-    markDate?: TimelineDateMarkerProps;
-    /** Options used to format date string. If not defined it will user browser default locale settings. */
-    dateFormatOptions?: DateFormatOptions;
-    /** Options used to format time string. If not defined it will user browser default locale settings. */
-    timeFormatOptions?: DateFormatOptions;
-}
-/** @internal */
-interface TimelineComponentState {
-    /**  True if timeline is currently playing, false if paused */
-    isPlaying: boolean;
-    /** Minimized mode (For future use. This will always be true) */
-    minimized?: boolean;
-    /** Current duration in milliseconds */
-    currentDuration: number;
-    /** Total duration in milliseconds */
-    totalDuration: number;
-    /** If true, automatically restart when the timeline is finished playing */
-    repeat: boolean;
-    /** If true, include the repeat option in the timeline context menu */
-    includeRepeat: boolean;
-}
-/**
- * [[TimelineComponent]] is used to playback timeline data
- * @public
- */
-export declare class TimelineComponent extends React.Component<TimelineComponentProps, TimelineComponentState> {
-    private _timeLastCycle;
-    private _requestFrame;
-    private _unmounted;
-    private _repeatLabel;
-    private _removeListener?;
-    private _standardTimelineMenuItems;
-    constructor(props: TimelineComponentProps);
-    componentWillUnmount(): void;
-    shouldComponentUpdate(nextProps: TimelineComponentProps, nextState: TimelineComponentState): boolean;
-    componentDidUpdate(prevProps: TimelineComponentProps): void;
-    private _handleTimelinePausePlayEvent;
-    private _onBackward;
-    private _onForward;
-    private _onPlay;
-    private _onPause;
-    private _onTimelineChange;
-    private _setDuration;
-    private _updateAnimation;
-    private _play;
-    private _replay;
-    private _displayTime;
-    private _getMilliseconds;
-    private _onTotalDurationChange;
-    private _changeRepeatSetting;
-    private _onRepeatChanged;
-    private _currentDate;
-    private _onSetTotalDuration;
-    private _createMenuItemNode;
-    private _renderSettings;
-    render(): JSX.Element;
-}
-export {};
+/** @packageDocumentation
+ * @module Timeline
+ */
+import "./TimelineComponent.scss";
+import * as React from "react";
+import { DateFormatOptions } from "@itwin/components-react";
+import { PlaybackSettings } from "./interfaces";
+/**
+ * [[TimelineMenuItemOption]]: specifies how the app wants the timeline speeds to be installed on the TimelineComponent's ContextMenu
+ * "replace" : use the app-supplied items in place of the standard items
+ * "append" : add the app-supplied items following the standard items
+ * "prefix" : add the app-supplied items before the standard items
+ *
+ * @public
+ */
+export declare type TimelineMenuItemOption = "replace" | "append" | "prefix";
+/**
+ * [[TimelineMenuItemProps]] specifies playback speed entries in the Timeline's ContextMenu
+ * @public
+ */
+export interface TimelineMenuItemProps {
+    /** localized label for menu item */
+    label: string;
+    /** duration for the entire timeline to play */
+    timelineDuration: number;
+}
+/** TimelineDateMarkerProps: Mark a date on the timeline with an indicator
+ * @public
+ */
+export interface TimelineDateMarkerProps {
+    /** Date to mark. If undefined, today's date will be used. */
+    date?: Date;
+    /** ReactNode to use as the marker on the timeline. If undefined, a short vertical bar will mark the date. */
+    dateMarker?: React.ReactNode;
+}
+/**
+ *  [[TimelineComponentProps]] configure the timeline
+ * @public
+ */
+export interface TimelineComponentProps {
+    /** Start date: beginning of the date range of a date-based timeline. */
+    startDate?: Date;
+    /** End date: end of the date range of a date-based timeline. */
+    endDate?: Date;
+    /** Total duration: range of the timeline in milliseconds. */
+    totalDuration: number;
+    /** Initial value for the current duration (the location of the thumb) in milliseconds */
+    initialDuration?: number;
+    /** Show in minimized mode (For future use. This prop will always be treated as true.) */
+    minimized?: boolean;
+    /** When playing, repeat indefinitely */
+    repeat?: boolean;
+    /** Show duration instead of time */
+    showDuration?: boolean;
+    /** Callback with current duration value (as a fraction) */
+    onChange?: (duration: number) => void;
+    /** Callback triggered when play/pause button is pressed */
+    onPlayPause?: (playing: boolean) => void;
+    /** Callback triggered when backward/forward buttons are pressed */
+    onJump?: (forward: boolean) => void;
+    /** Callback triggered when a setting is changed */
+    onSettingsChange?: (arg: PlaybackSettings) => void;
+    /** Always display in miniMode with no expand menu (For future use. This prop will always be treated as true) */
+    alwaysMinimized?: boolean;
+    /** ComponentId -- must be set to use TimelineComponentEvents */
+    componentId?: string;
+    /** Include the repeat option on the Timeline Context Menu */
+    includeRepeat?: boolean;
+    /** App-supplied speed entries in the Timeline Context Menu */
+    appMenuItems?: TimelineMenuItemProps[];
+    /** How to include the supplied app menu items in the Timeline Context Menu (prefix, append, replace)*/
+    appMenuItemOption?: TimelineMenuItemOption;
+    /** Display date and time offset by the number of minutes specified. When undefined - local timezone will be used */
+    timeZoneOffset?: number;
+    /** Display a marker on the timeline rail to indicate current date - will only work if starDate and endDate are defined */
+    markDate?: TimelineDateMarkerProps;
+    /** Options used to format date string. If not defined it will user browser default locale settings. */
+    dateFormatOptions?: DateFormatOptions;
+    /** Options used to format time string. If not defined it will user browser default locale settings. */
+    timeFormatOptions?: DateFormatOptions;
+}
+/** @internal */
+interface TimelineComponentState {
+    /**  True if timeline is currently playing, false if paused */
+    isPlaying: boolean;
+    /** Minimized mode (For future use. This will always be true) */
+    minimized?: boolean;
+    /** Current duration in milliseconds */
+    currentDuration: number;
+    /** Total duration in milliseconds */
+    totalDuration: number;
+    /** If true, automatically restart when the timeline is finished playing */
+    repeat: boolean;
+    /** If true, include the repeat option in the timeline context menu */
+    includeRepeat: boolean;
+}
+/**
+ * [[TimelineComponent]] is used to playback timeline data
+ * @public
+ */
+export declare class TimelineComponent extends React.Component<TimelineComponentProps, TimelineComponentState> {
+    private _timeLastCycle;
+    private _requestFrame;
+    private _unmounted;
+    private _repeatLabel;
+    private _removeListener?;
+    private _standardTimelineMenuItems;
+    constructor(props: TimelineComponentProps);
+    componentWillUnmount(): void;
+    shouldComponentUpdate(nextProps: TimelineComponentProps, nextState: TimelineComponentState): boolean;
+    componentDidUpdate(prevProps: TimelineComponentProps): void;
+    private _handleTimelinePausePlayEvent;
+    private _onBackward;
+    private _onForward;
+    private _onPlay;
+    private _onPause;
+    private _onTimelineChange;
+    private _setDuration;
+    private _updateAnimation;
+    private _play;
+    private _replay;
+    private _displayTime;
+    private _getMilliseconds;
+    private _onTotalDurationChange;
+    private _changeRepeatSetting;
+    private _onRepeatChanged;
+    private _currentDate;
+    private _onSetTotalDuration;
+    private _createMenuItemNode;
+    private _renderSettings;
+    render(): JSX.Element;
+}
+export {};
 //# sourceMappingURL=TimelineComponent.d.ts.map