Member Junction
    Preparing search index...

    Class ClusterConfigPanelComponent

    Implements

    • OnInit
    • OnDestroy
    Index

    Constructors

    constructor

    Properties

    AlgorithmChanged AlgorithmOptions AllEntityDocOptions AvailableEntities BeforeRunClustering BeforeSave Collapsed Config ConfigChanged DefaultAlgorithm DimensionsChanged EntityDocOptions FilteredEntityOptions IsExpanded IsRunning MetricOptions Metrics PanelLeft PanelTop RunClustering SaveVisualization ShowAlgorithmPicker ShowDimensionToggle ShowMetricPicker ShowMultiEntity ShowMultiSource ShowSaveButton

    Accessors

    CanRun CanSave EntityOptions HasMultiSourceOptions IsKMeans IsMultiEntity SelectedDocIDs

    Methods

    FormatSilhouette FormatTime IsDocSelected IsSilhouetteGood ngOnDestroy ngOnInit OnAlgorithmChanged OnEntityChanged OnFieldChanged OnHeaderMouseDown OnMetricChanged OnMultiSourceExpandedChange OnRun OnSave SetColorBy SetDimensions ToggleCollapse ToggleDoc TrackAlgorithmBy TrackEntityBy TrackMetricBy

    Constructors

    Properties

    AlgorithmChanged: EventEmitter<ClusterAlgorithm> = ...

    Fires specifically when the algorithm selection changes.

    Useful for showing/hiding algorithm-specific UI in the parent.

    AlgorithmOptions: { Label: string; Value: ClusterAlgorithm }[] = ...

    Algorithm options for the dropdown.

    AllEntityDocOptions: ClusterConfigPanelEntityDocOption[] = []

    All Entity Documents across entities (each with EntityName), used to power the optional multi-entity source selector. When two or more are selected the run becomes a multi-entity analysis (their vectors are merged server-side).

    AvailableEntities: string[] = []

    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.

    []

    <mj-cluster-config-panel
        [AvailableEntities]="['Companies', 'Contacts', 'Deals']">
    </mj-cluster-config-panel>
    BeforeRunClustering: EventEmitter<CancelableEvent<ClusterConfig>> = ...

    Fires before a clustering run starts. Set event.Cancel = true to prevent the run (e.g., for validation).

    onBeforeRun(event: CancelableEvent<ClusterConfig>): void {
        if (!event.Data.EntityName) {
            event.Cancel = true;
            alert('Please select an entity first.');
        }
    }
    BeforeSave: 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).

    Collapsed: boolean = false

    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.

    false
    Config: ClusterConfig = ...

    The working configuration object.

    ConfigChanged: EventEmitter<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.

    DefaultAlgorithm: ClusterAlgorithm = 'kmeans'

    Default algorithm selection when the panel initializes.

    'kmeans'
    DimensionsChanged: EventEmitter<2 | 3> = ...

    Fires when the 2D/3D projection toggle changes. Hosts should re-run (or re-project) so the change is reflected immediately — a 3D projection needs a Z coordinate that only a fresh run produces.

    EntityDocOptions: ClusterConfigPanelEntityDocOption[] = []

    Entity Document options for the selected entity. Only shown when 2+ docs exist.

    FilteredEntityOptions: ClusterConfigPanelEntityOption[] = []

    Filtered entity list for display (filtered by AvailableEntities).

    IsExpanded: boolean = true

    Whether the panel body is currently visible.

    IsRunning: boolean = false

    Whether a clustering run is currently in progress.

    When true, the Run button is disabled and shows a spinner.

    false
    MetricOptions: { Label: string; Value: ClusterDistanceMetric }[] = ...

    Distance metric options for the dropdown.

    Metrics: ClusterMetrics = null

    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.

    PanelLeft: number = 12

    Current panel left offset in pixels.

    PanelTop: number = 12

    Current panel top offset in pixels.

    RunClustering: EventEmitter<ClusterConfig> = ...

    Emitted when the user clicks Run and BeforeRunClustering was not canceled. Payload is a snapshot of the current config.

    SaveVisualization: EventEmitter<void> = ...

    Emitted when the user clicks the Save link and BeforeSave was not canceled.

    ShowAlgorithmPicker: boolean = true

    Whether to display the algorithm picker dropdown.

    When false, the algorithm is fixed to DefaultAlgorithm.

    true
    ShowDimensionToggle: boolean = true

    Whether to show the 2D/3D projection toggle.

    true
    ShowMetricPicker: boolean = true

    Whether to display the distance metric picker dropdown.

    true
    ShowMultiEntity: boolean = true

    Whether to show the multi-entity source selector.

    true
    ShowMultiSource: boolean = false

    Whether the multi-entity source selector is expanded.

    ShowSaveButton: boolean = true

    Whether to display the "Save this visualization" link.

    true

    Accessors

    Methods

    • A callback method that is invoked immediately after the default change detector has checked the directive's data-bound properties for the first time, and before any of the view or content children have been checked. It is invoked only once when the directive is instantiated.

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods