All files / src/settings timelineOptions.ts

0% Statements 0/0
0% Branches 0/0
0% Functions 0/0
0% Lines 0/0

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111                                                                                                                                                                                                                             
import { TimelineRowStyle } from './styles/timelineRowStyle';
import { TimelineStyle } from './styles/timelineStyle';
import { TimelineRanged } from '../models/timelineRanged';
 
export interface TimelineOptions extends TimelineRanged {
  /**
   * Id or HTMLElement of the timeline container.
   */
  id?: string | HTMLElement | null;
  /**
   * Check whether snapping is enabled.
   */
  snapEnabled?: boolean;
  /**
   *  Snap all selected keyframes as one bundle during the drag.
   */
  snapAllKeyframesOnMove?: boolean;
  /**
   * Approximate step for the timeline in pixels for 1 second
   */
  stepPx?: number;
  /**
   * Number of points that should fit into the one stepPx.
   */
  stepVal?: number;
  stepSmallPx?: number;
  /**
   * Snap step in units. from 0 to stepVal
   */
  snapStep?: number;
  /**
   * additional left margin in pixels to start the line gauge from.
   */
  leftMargin?: number;
  /**
   * Component header background color.
   */
  headerFillColor?: string;
  /**
   * Component background color.
   */
  fillColor?: string;
  /**
   * Header labels color.
   */
  labelsColor?: string;
  /**
   * Header gauge tick color.
   */
  tickColor?: string;
  /**
   * Selection rectangle color.
   */
  selectionColor?: string;
 
  /**
   * Header height in pixels
   */
  headerHeight?: number;
  /**
   * Header ticks font
   */
  font?: string;
  /**
   * Default zoom level = 1. where screen pixels are equals to the corresponding stepVal stepPx.
   */
  zoom?: number;
  /**
   * Default zoom speed.
   */
  zoomSpeed?: number;
  /**
   * Max zoom value.
   */
  zoomMin?: number;
  /**
   * Min zoom value.
   */
  zoomMax?: number;
  /**
   * Set this to true in a MAC OS environment: The Meta key will be used instead of the Ctrl key.
   */
  controlKeyIsMetaKey?: boolean;
  /**
   * Access the scroll container via this class for e.g. scroll bar styling.
   */
  scrollContainerClass?: string;
  /**
   * Default rows style.
   * Can be overridden by setting style individually for each row.
   */
  rowsStyle?: TimelineRowStyle;
  /**
   * Timeline indicator style.
   */
  timelineStyle?: TimelineStyle;
 
  /**
   * keyframes group is draggable. Default: true
   */
  groupsDraggable?: boolean;
  /**
   * keyframes group is draggable. Default: true
   */
  keyframesDraggable?: boolean;
  /**
   * Timeline can be dragged or position can be changed by user interaction. Default: true
   */
  timelineDraggable?: boolean;
}