@unovis/ts 1.5.1-xplg.4 → 1.6.0-beta.0

package/components/timeline/config.js.map

@@ -1 +1 @@
-{"version":3,"file":"config.js","sources":["../../../src/components/timeline/config.ts"],"sourcesContent":["import { XYComponentConfigInterface, XYComponentDefaultConfig } from 'core/xy-component/config'\n\n// Types\nimport { WithOptional } from 'types/misc'\nimport { ColorAccessor, NumericAccessor, StringAccessor, GenericAccessor } from 'types/accessor'\nimport { TextAlign } from 'types/text'\nimport { Arrangement } from 'types/position'\n\n// Local Types\nimport type { TimelineArrow, TimelineLineRenderState, TimelineRowIcon, TimelineRowLabel } from './types'\n\nexport interface TimelineConfigInterface<Datum> extends WithOptional<XYComponentConfigInterface<Datum>, 'y'> {\n  // Items (Lines)\n  /** @deprecated This property has been renamed to `key` */\n  type?: StringAccessor<Datum>;\n  /** @deprecated This property has been renamed to `lineDuration` */\n  length?: NumericAccessor<Datum>;\n  /** @deprecated This property has been renamed to `lineCursor` */\n  cursor?: StringAccessor<Datum>;\n  /** Timeline item row accessor function. Records with the `lineRow` will be plotted in one row. Default: `undefined` */\n  lineRow?: StringAccessor<Datum>;\n  /** Timeline item duration accessor function. Default: `undefined`. Falls back to the deprecated `length` property */\n  lineDuration?: NumericAccessor<Datum>;\n  /** Timeline item color accessor function. Default: `d => d.color` */\n  color?: ColorAccessor<Datum>;\n  /** Width of the timeline items. Default: `8` */\n  lineWidth?: NumericAccessor<Datum>;\n  /** Display rounded ends for timeline items. Default: `true` */\n  lineCap?: boolean;\n  /** Provide a href to an SVG defined in container's `svgDefs` to display an icon at the start of the line. Default: undefined */\n  lineStartIcon?: StringAccessor<Datum>;\n  /** Line start icon color accessor function. Default: `undefined` */\n  lineStartIconColor?: StringAccessor<Datum>;\n  /** Line start icon size accessor function. Default: `undefined` */\n  lineStartIconSize?: NumericAccessor<Datum>;\n  /** Line start icon arrangement configuration. Controls how the icon is positioned relative to the line.\n   * Accepts values from the Arrangement enum: `Arrangement.Start`, `Arrangement.Middle`, `Arrangement.End` or a string equivalent.\n   * Default: `Arrangement.Inside` */\n  lineStartIconArrangement?: GenericAccessor<Arrangement | `${Arrangement}`, Datum>;\n  /** Provide a href to an SVG defined in container's `svgDefs` to display an icon at the end of the line. Default: undefined */\n  lineEndIcon?: StringAccessor<Datum>;\n  /** Line end icon color accessor function. Default: `undefined` */\n  lineEndIconColor?: StringAccessor<Datum>;\n  /** Line end icon size accessor function. Default: `undefined` */\n  lineEndIconSize?: NumericAccessor<Datum>;\n  /** Line end icon arrangement configuration. Controls how the icon is positioned relative to the line.\n   * Accepts values from the Arrangement enum: `Arrangement.Start`, `Arrangement.Middle`, `Arrangement.End` or a string equivalent.\n   * Default: `Arrangement.Inside` */\n  lineEndIconArrangement?: GenericAccessor<Arrangement | `${Arrangement}`, Datum>;\n  /** Configurable Timeline item cursor when hovering over. Default: `undefined` */\n  lineCursor?: StringAccessor<Datum>;\n  /** Sets the minimum line length to 1 pixel for better visibility of small values. Default: `false` */\n  showEmptySegments?: boolean;\n\n  /** Timeline row height. Default: `22` */\n  rowHeight?: number;\n  /** Alternating row colors. Default: `true` */\n  alternatingRowColors?: boolean;\n\n  // Row Labels\n  /** @deprecated This property has been renamed to `showRowLabels */\n  showLabels?: boolean;\n  /** @deprecated This property has been renamed to `rowLabelWidth */\n  labelWidth?: number;\n  /** @deprecated This property has been renamed to `rowMaxLabelWidth */\n  maxLabelWidth?: number;\n\n  /** Show row labels when set to `true`. Default: `false`. Falls back to deprecated `showLabels` */\n  showRowLabels?: boolean;\n  /** Row label style as an object with the `{ [property-name]: value }` format. Default: `undefined` */\n  rowLabelStyle?: GenericAccessor<Record<string, string>, TimelineRowLabel<Datum>>;\n  /** Row label formatter function. Default: `undefined` */\n  rowLabelFormatter?: (key: string, items: Datum[], i: number) => string;\n  /** Provide an icon href to be displayed before the row label. Default: `undefined` */\n  rowIcon?: (key: string, items: Datum[], i: number) => TimelineRowIcon | undefined;\n  /** Fixed label width in pixels. Labels longer than the specified value will be trimmed. Default: `undefined`. Falls back to deprecated `labelWidth`. */\n  rowLabelWidth?: number;\n  /** Maximum label width in pixels. Labels longer than the specified value will be trimmed. Default: `undefined`. Falls back to deprecated `maxLabelWidth`. */\n  rowMaxLabelWidth?: number;\n  /** Text alignment for labels: `TextAlign.Left`, `TextAlign.Center` or `TextAlign.Right`. Default: `TextAlign.Right` */\n  rowLabelTextAlign?: TextAlign | `${TextAlign}`;\n\n  // Arrows\n  arrows?: TimelineArrow[];\n\n  // Animation\n  /** Control the animation by specify the initial position for new lines as [x, y]. Default: `undefined` */\n  animationLineEnterPosition?:\n  [number | undefined | null, number | undefined | null] |\n  ((d: Datum & TimelineLineRenderState, i: number, data: (Datum & TimelineLineRenderState)[]) => [number | undefined, number | undefined]) |\n  undefined;\n  /** Control the animation by specify the destination position for exiting lines as [x, y]. Default: `undefined` */\n  animationLineExitPosition?: [number | undefined | null, number | undefined | null] |\n  ((d: Datum & TimelineLineRenderState, i: number, data: (Datum & TimelineLineRenderState)[]) => [number | undefined, number | undefined]) |\n  undefined;\n\n  // Callbacks\n  /** Scrolling callback function: `(scrollTop: number) => void`. Default: `undefined` */\n  onScroll?: (scrollTop: number) => void;\n}\n\nexport const TimelineDefaultConfig: TimelineConfigInterface<unknown> = {\n  ...XYComponentDefaultConfig,\n  id: undefined,\n\n  // Items (Lines)\n  cursor: undefined, // Deprecated (see above)\n  type: (d: unknown): string => (d as { type: string }).type, // Deprecated (see above)\n  length: (d: unknown): number => (d as { length: number }).length, // Deprecated (see above)\n  color: (d: unknown): string => (d as { color: string }).color,\n  lineRow: undefined,\n  lineDuration: undefined,\n  lineWidth: 8,\n  lineCap: false,\n  lineCursor: undefined,\n  showEmptySegments: false,\n  lineStartIcon: undefined,\n  lineStartIconColor: undefined,\n  lineStartIconSize: undefined,\n  lineStartIconArrangement: Arrangement.Inside,\n  lineEndIcon: undefined,\n  lineEndIconColor: undefined,\n  lineEndIconSize: undefined,\n  lineEndIconArrangement: Arrangement.Inside,\n\n  // Rows\n  rowHeight: 22,\n  alternatingRowColors: true,\n\n  // Row Labels\n  showLabels: false, // Deprecated (see above)\n  labelWidth: undefined, // Deprecated (see above)\n  maxLabelWidth: 120, // Deprecated (see above)\n\n  showRowLabels: undefined,\n  rowLabelFormatter: undefined,\n  rowIcon: undefined,\n  rowLabelStyle: undefined,\n  rowLabelWidth: undefined,\n  rowMaxLabelWidth: undefined,\n  rowLabelTextAlign: TextAlign.Right,\n\n  // Arrows\n  arrows: undefined,\n\n  // Animation\n  animationLineEnterPosition: undefined,\n\n  // Callbacks\n  onScroll: undefined,\n}\n"],"names":[],"mappings":";;;;MAqGa,qBAAqB,GAAA,MAAA,CAAA,MAAA,CAAA,MAAA,CAAA,MAAA,CAAA,EAAA,EAC7B,wBAAwB,CAC3B,EAAA,EAAA,EAAE,EAAE,SAAS;;IAGb,MAAM,EAAE,SAAS,EACjB,IAAI,EAAE,CAAC,CAAU,KAAc,CAAsB,CAAC,IAAI,EAC1D,MAAM,EAAE,CAAC,CAAU,KAAc,CAAwB,CAAC,MAAM,EAChE,KAAK,EAAE,CAAC,CAAU,KAAc,CAAuB,CAAC,KAAK,EAC7D,OAAO,EAAE,SAAS,EAClB,YAAY,EAAE,SAAS,EACvB,SAAS,EAAE,CAAC,EACZ,OAAO,EAAE,KAAK,EACd,UAAU,EAAE,SAAS,EACrB,iBAAiB,EAAE,KAAK,EACxB,aAAa,EAAE,SAAS,EACxB,kBAAkB,EAAE,SAAS,EAC7B,iBAAiB,EAAE,SAAS,EAC5B,wBAAwB,EAAE,WAAW,CAAC,MAAM,EAC5C,WAAW,EAAE,SAAS,EACtB,gBAAgB,EAAE,SAAS,EAC3B,eAAe,EAAE,SAAS,EAC1B,sBAAsB,EAAE,WAAW,CAAC,MAAM;;AAG1C,IAAA,SAAS,EAAE,EAAE,EACb,oBAAoB,EAAE,IAAI;;AAG1B,IAAA,UAAU,EAAE,KAAK,EACjB,UAAU,EAAE,SAAS,EACrB,aAAa,EAAE,GAAG,EAElB,aAAa,EAAE,SAAS,EACxB,iBAAiB,EAAE,SAAS,EAC5B,OAAO,EAAE,SAAS,EAClB,aAAa,EAAE,SAAS,EACxB,aAAa,EAAE,SAAS,EACxB,gBAAgB,EAAE,SAAS,EAC3B,iBAAiB,EAAE,SAAS,CAAC,KAAK;;AAGlC,IAAA,MAAM,EAAE,SAAS;;AAGjB,IAAA,0BAA0B,EAAE,SAAS;;IAGrC,QAAQ,EAAE,SAAS,EAAA;;;;"}
+{"version":3,"file":"config.js","sources":["../../../src/components/timeline/config.ts"],"sourcesContent":["import { XYComponentConfigInterface, XYComponentDefaultConfig } from 'core/xy-component/config'\n\n// Types\nimport { WithOptional } from 'types/misc'\nimport { ColorAccessor, NumericAccessor, StringAccessor } from 'types/accessor'\n\nexport interface TimelineConfigInterface<Datum> extends WithOptional<XYComponentConfigInterface<Datum>, 'y'> {\n  /** Timeline item color accessor function. Default: `d => d.color` */\n  color?: ColorAccessor<Datum>;\n  /** Width of the timeline items. Default: `8` */\n  lineWidth?: NumericAccessor<Datum>;\n  /** Display rounded ends for timeline items. Default: `true` */\n  lineCap?: boolean;\n  /** Timeline row height. Default: `22` */\n  rowHeight?: number;\n  /** Timeline item length accessor function. Default: `d => d.length` */\n  length?: NumericAccessor<Datum>;\n  /** Timeline item type accessor function. Records of one type will be plotted in one row. Default: `d => d.type` */\n  type?: StringAccessor<Datum>;\n  /** Configurable Timeline item cursor when hovering over. Default: `null` */\n  cursor?: StringAccessor<Datum>;\n  /** Show item type labels when set to `true`. Default: `false` */\n  showLabels?: boolean;\n  /** Fixed label width in pixels. Labels longer than the specified value will be trimmed. Default: `undefined` */\n  labelWidth?: number;\n  /** Maximum label width in pixels. Labels longer than the specified value will be trimmed. Default: `120` */\n  maxLabelWidth?: number;\n  /** Alternating row colors. Default: `true` */\n  alternatingRowColors?: boolean;\n  /** Scrolling callback function: `(scrollTop: number) => void`. Default: `undefined` */\n  onScroll?: (scrollTop: number) => void;\n  /** Sets the minimum line length to 1 pixel for better visibility of small values. Default: `false` */\n  showEmptySegments?: boolean;\n}\n\nexport const TimelineDefaultConfig: TimelineConfigInterface<unknown> = {\n  ...XYComponentDefaultConfig,\n  id: undefined,\n  color: (d: unknown): string => (d as { color: string }).color,\n  lineWidth: 8,\n  lineCap: false,\n  rowHeight: 22,\n  length: (d: unknown): number => (d as { length: number }).length,\n  type: (d: unknown): string => (d as { type: string }).type,\n  cursor: null,\n  labelWidth: undefined,\n  showLabels: false,\n  maxLabelWidth: 120,\n  alternatingRowColors: true,\n  onScroll: undefined,\n  showEmptySegments: false,\n}\n"],"names":[],"mappings":";;AAmCa,MAAA,qBAAqB,GAC7B,MAAA,CAAA,MAAA,CAAA,MAAA,CAAA,MAAA,CAAA,EAAA,EAAA,wBAAwB,KAC3B,EAAE,EAAE,SAAS,EACb,KAAK,EAAE,CAAC,CAAU,KAAc,CAAuB,CAAC,KAAK,EAC7D,SAAS,EAAE,CAAC,EACZ,OAAO,EAAE,KAAK,EACd,SAAS,EAAE,EAAE,EACb,MAAM,EAAE,CAAC,CAAU,KAAc,CAAwB,CAAC,MAAM,EAChE,IAAI,EAAE,CAAC,CAAU,KAAc,CAAsB,CAAC,IAAI,EAC1D,MAAM,EAAE,IAAI,EACZ,UAAU,EAAE,SAAS,EACrB,UAAU,EAAE,KAAK,EACjB,aAAa,EAAE,GAAG,EAClB,oBAAoB,EAAE,IAAI,EAC1B,QAAQ,EAAE,SAAS,EACnB,iBAAiB,EAAE,KAAK;;;;"}

package/components/timeline/index.d.ts

@@ -1,5 +1,4 @@
 import { XYComponentCore } from "../../core/xy-component";
-import { Spacing } from "../../types";
 import { TimelineConfigInterface } from './config';
 import * as s from './style';
 export declare class Timeline<Datum> extends XYComponentCore<Datum, TimelineConfigInterface<Datum>> {
@@ -13,10 +12,8 @@ export declare class Timeline<Datum> extends XYComponentCore<Datum, TimelineConf
     };
     private _background;
     private _rowsGroup;
-    private _arrowsGroup;
     private _linesGroup;
     private _labelsGroup;
-    private _rowIconsGroup;
     private _scrollBarGroup;
     private _scrollBarBackground;
     private _scrollBarHandle;
@@ -26,28 +23,20 @@ export declare class Timeline<Datum> extends XYComponentCore<Datum, TimelineConf
     private _maxScroll;
     private _scrollbarHeight;
     private _labelMargin;
-    private _labelWidth;
-    private _rowIconBleed;
-    private _lineBleed;
-    /** We define a dedicated clipping path for this component because it needs to behave
-     * differently than the regular XYContainer's clipPath */
-    private _clipPathId;
-    private _clipPath;
     constructor(config?: TimelineConfigInterface<Datum>);
-    setConfig(config: TimelineConfigInterface<Datum>): void;
-    setData(data: Datum[]): void;
-    get bleed(): Spacing;
+    get bleed(): {
+        top: number;
+        bottom: number;
+        left: number;
+        right: number;
+    };
     _render(customDuration?: number): void;
-    private _getLineLength;
-    private _getLineWidth;
-    private _getLineDuration;
-    private _prepareLinesData;
-    private _prepareArrowsData;
-    private _renderLines;
+    private _positionLines;
     private _onScrollbarDrag;
     private _onMouseWheel;
     private _updateScrollPosition;
-    private _getRecordKey;
-    private _getRowLabels;
+    private _getMaxLineWidth;
+    private _getRecordType;
+    private _getRecordLabels;
     getXDataExtent(): number[];
 }