@memberjunction/ng-clustering 0.0.1 → 5.24.0

package/dist/lib/cluster-config-panel.component.d.ts

@@ -0,0 +1,274 @@
+/**
+ * @fileoverview Floating glass-morphism configuration panel for clustering.
+ *
+ * `ClusterConfigPanelComponent` provides a draggable floating panel with
+ * entity picker, algorithm picker, parameter sliders, distance metric
+ * selector, max records input, run button, and result metrics display.
+ *
+ * It emits cancelable `BeforeXXX` events so consumers can intercept and
+ * validate before clustering starts or a visualization is saved.
+ *
+ * @example
+ * ```html
+ * <mj-cluster-config-panel
+ *     [IsRunning]="isRunning"
+ *     [Metrics]="result?.Metrics ?? null"
+ *     [EntityOptions]="myEntityOptions"
+ *     [ShowSaveButton]="true"
+ *     [DefaultAlgorithm]="'dbscan'"
+ *     [Collapsed]="false"
+ *     (BeforeRunClustering)="onBeforeRun($event)"
+ *     (RunClustering)="onRunClustering($event)"
+ *     (ConfigChanged)="onConfigChanged($event)"
+ *     (SaveVisualization)="onSave()">
+ * </mj-cluster-config-panel>
+ * ```
+ */
+import { EventEmitter, OnInit, OnDestroy } from '@angular/core';
+import { ClusterConfig, ClusterConfigPanelEntityOption, ClusterConfigPanelEntityDocOption, ClusterMetrics, ClusterAlgorithm, ClusterDistanceMetric, CancelableEvent } from './clustering.types';
+import * as i0 from "@angular/core";
+export declare class ClusterConfigPanelComponent implements OnInit, OnDestroy {
+    private cdr;
+    /**
+     * Whether a clustering run is currently in progress.
+     *
+     * When `true`, the Run button is disabled and shows a spinner.
+     *
+     * @default false
+     */
+    IsRunning: boolean;
+    /**
+     * Result metrics from the most recent clustering run.
+     *
+     * When non-null, the metrics section is displayed at the bottom
+     * of the panel showing silhouette score, cluster count, etc.
+     */
+    Metrics: ClusterMetrics | null;
+    /**
+     * Entity options for the dropdown.
+     *
+     * The parent component is responsible for populating this list,
+     * typically from MJ Metadata or a subset filtered by
+     * `AvailableEntities`.
+     */
+    private _entityOptions;
+    set EntityOptions(value: ClusterConfigPanelEntityOption[]);
+    get EntityOptions(): ClusterConfigPanelEntityOption[];
+    /** Entity Document options for the selected entity. Only shown when 2+ docs exist. */
+    EntityDocOptions: ClusterConfigPanelEntityDocOption[];
+    /**
+     * Whether to display the "Save this visualization" link.
+     *
+     * @default true
+     */
+    ShowSaveButton: boolean;
+    /**
+     * Whether to display the algorithm picker dropdown.
+     *
+     * When `false`, the algorithm is fixed to `DefaultAlgorithm`.
+     *
+     * @default true
+     */
+    ShowAlgorithmPicker: boolean;
+    /**
+     * Whether to display the distance metric picker dropdown.
+     *
+     * @default true
+     */
+    ShowMetricPicker: boolean;
+    /**
+     * Default algorithm selection when the panel initializes.
+     *
+     * @default 'kmeans'
+     */
+    DefaultAlgorithm: ClusterAlgorithm;
+    /**
+     * Restrict the entity picker to a specific list of entity names.
+     *
+     * When empty (the default), all entity options from the
+     * `EntityOptions` input are shown.  When non-empty, only entities
+     * whose `Name` appears in this array are shown.
+     *
+     * @default []
+     *
+     * @example
+     * ```html
+     * <mj-cluster-config-panel
+     *     [AvailableEntities]="['Companies', 'Contacts', 'Deals']">
+     * </mj-cluster-config-panel>
+     * ```
+     */
+    AvailableEntities: string[];
+    /**
+     * Whether the panel starts in a collapsed (minimized) state.
+     *
+     * The user can toggle between collapsed and expanded by clicking
+     * the collapse chevron in the panel header.
+     *
+     * @default false
+     */
+    Collapsed: boolean;
+    /**
+     * Emitted when the user clicks Run and `BeforeRunClustering` was not
+     * canceled.  Payload is a snapshot of the current config.
+     */
+    RunClustering: EventEmitter<ClusterConfig>;
+    /**
+     * Emitted when the user clicks the Save link and `BeforeSave` was
+     * not canceled.
+     */
+    SaveVisualization: EventEmitter<void>;
+    /**
+     * Fires **before** a clustering run starts.  Set `event.Cancel = true`
+     * to prevent the run (e.g., for validation).
+     *
+     * @example
+     * ```typescript
+     * onBeforeRun(event: CancelableEvent<ClusterConfig>): void {
+     *     if (!event.Data.EntityName) {
+     *         event.Cancel = true;
+     *         alert('Please select an entity first.');
+     *     }
+     * }
+     * ```
+     */
+    BeforeRunClustering: EventEmitter<CancelableEvent<ClusterConfig>>;
+    /**
+     * Fires **before** a visualization is saved.  Set `event.Cancel = true`
+     * to prevent the save (e.g., to prompt for a name first).
+     */
+    BeforeSave: EventEmitter<CancelableEvent<ClusterConfig>>;
+    /**
+     * Fires whenever any configuration value changes (entity, algorithm,
+     * K, epsilon, distance metric, max records, filter).
+     *
+     * Payload is a snapshot of the entire config at the time of change.
+     */
+    ConfigChanged: EventEmitter<ClusterConfig>;
+    /**
+     * Fires specifically when the algorithm selection changes.
+     *
+     * Useful for showing/hiding algorithm-specific UI in the parent.
+     */
+    AlgorithmChanged: EventEmitter<ClusterAlgorithm>;
+    /** The working configuration object. */
+    Config: ClusterConfig;
+    /** Filtered entity list for display (filtered by AvailableEntities). */
+    FilteredEntityOptions: ClusterConfigPanelEntityOption[];
+    /** Whether the panel body is currently visible. */
+    IsExpanded: boolean;
+    /** Algorithm options for the dropdown. */
+    AlgorithmOptions: Array<{
+        Value: ClusterAlgorithm;
+        Label: string;
+    }>;
+    /** Distance metric options for the dropdown. */
+    MetricOptions: Array<{
+        Value: ClusterDistanceMetric;
+        Label: string;
+    }>;
+    /** Current panel top offset in pixels. */
+    PanelTop: number;
+    /** Current panel left offset in pixels. */
+    PanelLeft: number;
+    private isDragging;
+    private dragStartX;
+    private dragStartY;
+    private dragStartTop;
+    private dragStartLeft;
+    private boundOnMouseMove;
+    private boundOnMouseUp;
+    private panelRef;
+    ngOnInit(): void;
+    ngOnDestroy(): void;
+    /**
+     * Whether the current algorithm is K-Means (controls which
+     * parameter sliders are shown).
+     */
+    get IsKMeans(): boolean;
+    /**
+     * Handle algorithm dropdown change.
+     *
+     * @param value  New algorithm value string.
+     */
+    OnAlgorithmChanged(value: string): void;
+    /**
+     * Handle distance metric dropdown change.
+     *
+     * @param value  New metric value string.
+     */
+    OnMetricChanged(value: string): void;
+    /**
+     * Handle entity dropdown change.
+     *
+     * @param value  New entity name.
+     */
+    OnEntityChanged(value: string): void;
+    /**
+     * Handle changes to any numeric/text config field (K, Epsilon,
+     * MinPoints, MaxRecords, Filter).
+     */
+    OnFieldChanged(): void;
+    /**
+     * Handle Run button click.  Fires `BeforeRunClustering`, and if not
+     * canceled, emits `RunClustering`.
+     */
+    OnRun(): void;
+    /**
+     * Handle Save link click.  Fires `BeforeSave`, and if not canceled,
+     * emits `SaveVisualization`.
+     */
+    OnSave(): void;
+    /**
+     * Toggle the panel between expanded and collapsed states.
+     */
+    ToggleCollapse(): void;
+    /**
+     * Format a silhouette score to 2 decimal places.
+     *
+     * @param score  The raw silhouette score.
+     * @returns Formatted string (e.g., `"0.72"`).
+     */
+    FormatSilhouette(score: number): string;
+    /**
+     * Whether a silhouette score indicates good clustering quality.
+     *
+     * @param score  The silhouette score to evaluate.
+     * @returns `true` if score >= 0.5.
+     */
+    IsSilhouetteGood(score: number): boolean;
+    /**
+     * Format a computation time in milliseconds to a human-readable string.
+     *
+     * @param ms  Milliseconds.
+     * @returns e.g., `"1.2s"` or `"450ms"`.
+     */
+    FormatTime(ms: number): string;
+    /**
+     * Start dragging the panel via header mousedown.
+     *
+     * @param event  The native mouse event.
+     */
+    OnHeaderMouseDown(event: MouseEvent): void;
+    /** @internal TrackBy for algorithm options. */
+    TrackAlgorithmBy(_index: number, item: {
+        Value: string;
+    }): string;
+    /** @internal TrackBy for metric options. */
+    TrackMetricBy(_index: number, item: {
+        Value: string;
+    }): string;
+    /** @internal TrackBy for entity options. */
+    TrackEntityBy(_index: number, item: ClusterConfigPanelEntityOption): string;
+    /**
+     * Rebuild the filtered entity list based on `AvailableEntities`.
+     */
+    private rebuildFilteredEntities;
+    /** Emit `ConfigChanged` with a snapshot of the current config. */
+    private emitConfigChanged;
+    private onMouseMove;
+    private onMouseUp;
+    static ɵfac: i0.ɵɵFactoryDeclaration<ClusterConfigPanelComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<ClusterConfigPanelComponent, "mj-cluster-config-panel", never, { "IsRunning": { "alias": "IsRunning"; "required": false; }; "Metrics": { "alias": "Metrics"; "required": false; }; "EntityOptions": { "alias": "EntityOptions"; "required": false; }; "EntityDocOptions": { "alias": "EntityDocOptions"; "required": false; }; "ShowSaveButton": { "alias": "ShowSaveButton"; "required": false; }; "ShowAlgorithmPicker": { "alias": "ShowAlgorithmPicker"; "required": false; }; "ShowMetricPicker": { "alias": "ShowMetricPicker"; "required": false; }; "DefaultAlgorithm": { "alias": "DefaultAlgorithm"; "required": false; }; "AvailableEntities": { "alias": "AvailableEntities"; "required": false; }; "Collapsed": { "alias": "Collapsed"; "required": false; }; }, { "RunClustering": "RunClustering"; "SaveVisualization": "SaveVisualization"; "BeforeRunClustering": "BeforeRunClustering"; "BeforeSave": "BeforeSave"; "ConfigChanged": "ConfigChanged"; "AlgorithmChanged": "AlgorithmChanged"; }, never, never, false, never>;
+}
+//# sourceMappingURL=cluster-config-panel.component.d.ts.map

package/dist/lib/cluster-config-panel.component.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cluster-config-panel.component.d.ts","sourceRoot":"","sources":["../../src/lib/cluster-config-panel.component.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AAEH,OAAO,EAIH,YAAY,EAGZ,MAAM,EACN,SAAS,EAGZ,MAAM,eAAe,CAAC;AACvB,OAAO,EACH,aAAa,EACb,8BAA8B,EAC9B,iCAAiC,EACjC,cAAc,EACd,gBAAgB,EAChB,qBAAqB,EACrB,eAAe,EAElB,MAAM,oBAAoB,CAAC;;AAE5B,qBAMa,2BAA4B,YAAW,MAAM,EAAE,SAAS;IACjE,OAAO,CAAC,GAAG,CAA6B;IAMxC;;;;;;OAMG;IACM,SAAS,UAAS;IAE3B;;;;;OAKG;IACM,OAAO,EAAE,cAAc,GAAG,IAAI,CAAQ;IAE/C;;;;;;OAMG;IACH,OAAO,CAAC,cAAc,CAAwC;IAE9D,IACI,aAAa,CAAC,KAAK,EAAE,8BAA8B,EAAE,EAGxD;IACD,IAAI,aAAa,IAAI,8BAA8B,EAAE,CAEpD;IAED,sFAAsF;IAC7E,gBAAgB,EAAE,iCAAiC,EAAE,CAAM;IAMpE;;;;OAIG;IACM,cAAc,UAAQ;IAE/B;;;;;;OAMG;IACM,mBAAmB,UAAQ;IAEpC;;;;OAIG;IACM,gBAAgB,UAAQ;IAEjC;;;;OAIG;IACM,gBAAgB,EAAE,gBAAgB,CAAY;IAEvD;;;;;;;;;;;;;;;OAeG;IACM,iBAAiB,EAAE,MAAM,EAAE,CAAM;IAE1C;;;;;;;OAOG;IACM,SAAS,UAAS;IAM3B;;;OAGG;IACO,aAAa,8BAAqC;IAE5D;;;OAGG;IACO,iBAAiB,qBAA4B;IAMvD;;;;;;;;;;;;;OAaG;IACO,mBAAmB,+CAAsD;IAEnF;;;OAGG;IACO,UAAU,+CAAsD;IAM1E;;;;;OAKG;IACO,aAAa,8BAAqC;IAE5D;;;;OAIG;IACO,gBAAgB,iCAAwC;IAMlE,wCAAwC;IACjC,MAAM,EAAE,aAAa,CAA0B;IAEtD,wEAAwE;IACjE,qBAAqB,EAAE,8BAA8B,EAAE,CAAM;IAEpE,mDAAmD;IAC5C,UAAU,UAAQ;IAEzB,0CAA0C;IACnC,gBAAgB,EAAE,KAAK,CAAC;QAAE,KAAK,EAAE,gBAAgB,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC,CAGxE;IAEF,gDAAgD;IACzC,aAAa,EAAE,KAAK,CAAC;QAAE,KAAK,EAAE,qBAAqB,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC,CAI1E;IAGF,0CAA0C;IACnC,QAAQ,SAAM;IACrB,2CAA2C;IACpC,SAAS,SAAM;IACtB,OAAO,CAAC,UAAU,CAAS;IAC3B,OAAO,CAAC,UAAU,CAAK;IACvB,OAAO,CAAC,UAAU,CAAK;IACvB,OAAO,CAAC,YAAY,CAAK;IACzB,OAAO,CAAC,aAAa,CAAK;IAC1B,OAAO,CAAC,gBAAgB,CAA0C;IAClE,OAAO,CAAC,cAAc,CAA0C;IAElB,OAAO,CAAC,QAAQ,CAA8B;IAM5F,QAAQ,IAAI,IAAI;IAahB,WAAW,IAAI,IAAI;IASnB;;;OAGG;IACH,IAAW,QAAQ,IAAI,OAAO,CAE7B;IAED;;;;OAIG;IACI,kBAAkB,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAQ9C;;;;OAIG;IACI,eAAe,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAK3C;;;;OAIG;IACI,eAAe,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAK3C;;;OAGG;IACI,cAAc,IAAI,IAAI;IAI7B;;;OAGG;IACI,KAAK,IAAI,IAAI;IAWpB;;;OAGG;IACI,MAAM,IAAI,IAAI;IAQrB;;OAEG;IACI,cAAc,IAAI,IAAI;IAK7B;;;;;OAKG;IACI,gBAAgB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM;IAI9C;;;;;OAKG;IACI,gBAAgB,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO;IAI/C;;;;;OAKG;IACI,UAAU,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM;IAIrC;;;;OAIG;IACI,iBAAiB,CAAC,KAAK,EAAE,UAAU,GAAG,IAAI;IASjD,+CAA+C;IACxC,gBAAgB,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,GAAG,MAAM;IAIxE,4CAA4C;IACrC,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,GAAG,MAAM;IAIrE,4CAA4C;IACrC,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,8BAA8B,GAAG,MAAM;IAQlF;;OAEG;IACH,OAAO,CAAC,uBAAuB;IAa/B,kEAAkE;IAClE,OAAO,CAAC,iBAAiB;IAIzB,OAAO,CAAC,WAAW;IASnB,OAAO,CAAC,SAAS;yCA5ZR,2BAA2B;2CAA3B,2BAA2B;CA+ZvC"}