Class ClusterScatterComponent

Implements

AfterViewInit
OnDestroy
OnChanges

Index

Constructors

constructor

Accessors

EntityLegend Is3D ProjectedClusterLabels RenderPoints ViewBox

Constructors

constructor

new ClusterScatterComponent(): ClusterScatterComponent
Returns ClusterScatterComponent

Properties

AfterClusteringComplete

AfterClusteringComplete: EventEmitter<ClusterVisualizationResult> = ...

Fires after new Points and Clusters are received and centroids have been computed, delivering the full visualization result.

AnimateTransitions

AnimateTransitions: boolean = true

Whether scatter plot transitions (zoom, highlight) should be animated.

Default

true

BeforePointClick

BeforePointClick: EventEmitter<CancelableEvent<ClusterPoint>> = ...

Fires before PointClicked. Set event.Cancel = true to suppress the click entirely.

Example

onBeforeClick(event: CancelableEvent<ClusterPoint>): void {
    if (event.Data.ClusterId === -1) {
        event.Cancel = true; // ignore outlier clicks
    }
}

BeforePointHover

BeforePointHover: EventEmitter<CancelableEvent<ClusterPoint>> = ...

Fires before the tooltip is shown on hover. Set event.Cancel = true to suppress the tooltip for this point.

BeforeZoom

BeforeZoom: EventEmitter<CancelableEvent<ViewportRect>> = ...

Fires before a zoom or pan operation is applied. Set event.Cancel = true to reject the viewport change.

The payload contains the proposed viewport rectangle.

ClusterCentroids

ClusterCentroids: {
    ClusterId: number;
    Color: string;
    Cx: number;
    Cy: number;
    R: number;
}[] = []

Computed cluster centroids used for radial glow effects.

ClusterMembers

ClusterMembers: ClusterPoint[] = []

Cluster members for the selected point's cluster.

ClusterMembersExpanded

ClusterMembersExpanded: boolean = true

Whether the cluster members list is expanded.

Clusters

Clusters: ClusterInfo[] = []

Cluster summary information used for the legend and color mapping.

ClusterSelected

ClusterSelected: EventEmitter<ClusterSelectedEvent> = ...

Fires when the user clicks a cluster label or legend swatch.

ColorBy

ColorBy: "cluster" | "entity" = 'cluster'

Legend / color mode. 'cluster' (default) colors each point by its assigned cluster; 'entity' colors by the point's source entity (Metadata.EntityName), which is the useful mode for multi-entity analyses.

ColorPalette

ColorPalette: string[] = []

Override the default cluster color palette.

Colors are assigned to clusters by index: cluster 0 gets ColorPalette[0], cluster 1 gets ColorPalette[1], etc. Wraps around when there are more clusters than colors.

Default

CLUSTER_COLORS (10 accessible colors)

DetailEntries

DetailEntries: { Key: string; Value: unknown }[] = []

Metadata entries for the detail panel (computed on selection).

DotOpacity

DotOpacity: number = 0.75

Base opacity for data point dots (0 to 1).

When a point is hovered, non-hovered points are dimmed below this value.

Default

0.75

DotRadius

DotRadius: number = 5

Base radius (in SVG units) for each data point dot.

Default

EditingClusterId

EditingClusterId: number = null

The cluster ID currently being edited, or null if none.

EditingLabelDraft

EditingLabelDraft: string = ''

The draft label text during editing.

EnablePan

EnablePan: boolean = true

Enable or disable panning via click-and-drag.

Default

true

EnableZoom

EnableZoom: boolean = true

Enable or disable zoom via mouse wheel.

Default

true

EntityName

EntityName: string = null

The entity name for metadata-driven field display in tooltips and detail panels. When set, the mj-entity-card component uses EntityInfo to prioritize fields by IsNameField and DefaultInView.

FieldDisplayNames

FieldDisplayNames: Record<string, string> = {}

Map of field names to human-readable display names. Used to show "First Name" instead of "FirstName" in tooltips and detail panels. If a field is not in this map, the raw key is shown.

Default

{} (use raw key names)

FieldPriority

FieldPriority: string[] = []

Ordered list of metadata field keys for prioritized display in tooltips and the detail panel. When set, fields are displayed in this order instead of raw metadata key order. Fields not in this list appear after the prioritized fields.

Typically computed from entity metadata (DefaultInView, Sequence) by the consuming component and passed in.

Default

[] (no prioritization — original key order)

HighlightedKey

HighlightedKey: string = null

Currently highlighted (single-clicked) point key.

HighlightRadius

HighlightRadius: number = 8

Radius used for the highlight ring on hovered or selected points.

Default

HorizontalGridLines

HorizontalGridLines: number[] = ...

Background grid lines for visual orientation.

HoveredPoint

HoveredPoint: ClusterPoint = null

Currently hovered point (null when idle).

IsLoading

IsLoading: boolean = false

When true, a semi-transparent loading overlay is displayed on top of the scatter plot.

LabelEdited

LabelEdited: EventEmitter<
{ ClusterId: number; NewLabel: string; OldLabel: string },
> = ...

Fires when the user edits a cluster label inline. Payload: { ClusterId, OldLabel, NewLabel }.

MaxZoom

MaxZoom: number = 10

Maximum zoom level (largest allowed viewBox multiplier).

A value of 10 means the user can zoom out until the viewBox is 10x the default 1000x700 size.

Default

MinZoom

MinZoom: number = 0.5

Minimum zoom level (smallest allowed viewBox multiplier).

A value of 0.5 means the user can zoom in until the viewBox is half of the default 1000x700 size.

Default

0.5

OpenRecordRequested

OpenRecordRequested: EventEmitter<ClusterPoint> = ...

Emitted when the user clicks "Open Record" in the detail panel. The parent should wire this to NavigationService.OpenEntityRecord().

Pitch

Pitch: number = 0.45

PointClicked

PointClicked: EventEmitter<ClusterPoint> = ...

Emitted when a point is clicked (after BeforePointClick completes without cancellation).

PointHovered

PointHovered: EventEmitter<ClusterPoint> = ...

Emitted when the mouse enters or leaves a data point. Emits null on mouse-leave.

Points

Points: ClusterPoint[] = []

Array of 2D-projected points to render.

Each point carries its cluster assignment, label, and metadata. Typically produced by ClusteringService.RunPipeline().

SelectedPoint

SelectedPoint: ClusterPoint = null

The currently selected point shown in the detail panel.

SelectedPointIds

SelectedPointIds: Set<string> = ...

Externally controlled set of selected point IDs (by VectorKey).

When provided, the component renders selection rings for matching points and emits SelectionChanged when the user modifies the set interactively.

Default

(empty Set)

Example

<mj-cluster-scatter
    [SelectedPointIds]="mySelectedIds"
    (SelectionChanged)="mySelectedIds = $event">
</mj-cluster-scatter>

SelectionChanged

SelectionChanged: EventEmitter<Set<string>> = ...

Fires whenever the set of selected point IDs changes (via user click or programmatic SelectPoints / ClearSelection).

ShowDetailPanel

ShowDetailPanel: boolean = false

Whether the detail panel is visible.

ShowLegend

ShowLegend: boolean = true

Whether to show the color-coded cluster legend overlay.

Default

true

ShowTooltip

ShowTooltip: boolean = true

Whether to show the tooltip popup on point hover.

When false, BeforePointHover and PointHovered still fire but the built-in tooltip DOM is not rendered.

Default

true

TooltipEntries

TooltipEntries: { Key: string; Value: unknown }[] = []

Filtered metadata entries for the tooltip (computed on hover).

TooltipFields

TooltipFields: string[] = []

Which metadata keys to display inside the tooltip.

When empty (the default), all metadata keys are shown.

Default

[]

Example

<mj-cluster-scatter [TooltipFields]="['EntityRecordID', 'Score']">
</mj-cluster-scatter>

TooltipX

TooltipX: number = 0

Screen-space tooltip X position.

TooltipY

TooltipY: number = 0

Screen-space tooltip Y position.

VerticalGridLines

VerticalGridLines: number[] = ...

Background vertical grid lines.

ViewBoxString

ViewBoxString: string = '0 0 1000 700'

Cached viewBox string for template binding (avoids NG0100 on recalc).

ViewportChanged

ViewportChanged: EventEmitter<ViewportRect> = ...

Fires after every zoom or pan that changes the visible viewport.

Yaw

Yaw: number = 0.6

Orbit angles (radians) for the interactive 3D projection. Updated by drag.

Accessors

EntityLegend

get EntityLegend(): { Color: string; Count: number; Name: string }[]
Distinct source entities present in the data (for the entity legend).

Returns { Color: string; Count: number; Name: string }[]
- Defined in Angular/Generic/clustering/src/lib/cluster-scatter.component.ts:577

Is3D

get Is3D(): boolean
True when any point carries a Z coordinate (a 3D projection).

Returns boolean
- Defined in Angular/Generic/clustering/src/lib/cluster-scatter.component.ts:596

ProjectedClusterLabels

get ProjectedClusterLabels(): {
    ClusterId: number;
    Color: string;
    X: number;
    Y: number;
}[]
Cluster labels positioned at each cluster's centroid in projected space. Used to label clusters in 3D (where the 2D centroid-glow path is disabled). Recomputes as the user orbits because it depends on PX/PY (yaw/pitch).

Returns { ClusterId: number; Color: string; X: number; Y: number }[]
- Defined in Angular/Generic/clustering/src/lib/cluster-scatter.component.ts:653

RenderPoints

get RenderPoints(): ClusterPoint[]
Points in render order. In 3D, far points are drawn first so nearer points paint on top (SVG has no z-index); in 2D the original order is preserved.

Returns ClusterPoint[]
- Defined in Angular/Generic/clustering/src/lib/cluster-scatter.component.ts:676

ViewBox

get ViewBox(): number[]
Returns number[]
- Defined in Angular/Generic/clustering/src/lib/cluster-scatter.component.ts:397
set ViewBox(value: number[]): void
Parameters
- value: number[]
Returns void
- Defined in Angular/Generic/clustering/src/lib/cluster-scatter.component.ts:401

Methods

CancelLabelEdit

CancelLabelEdit(): void
Cancel editing.

Returns void
- Defined in Angular/Generic/clustering/src/lib/cluster-scatter.component.ts:373

ClearSelection

ClearSelection(): void
Clear all selected points.

Returns void
- Defined in Angular/Generic/clustering/src/lib/cluster-scatter.component.ts:1021

CloseDetailPanel

CloseDetailPanel(): void
Close the detail panel.

Returns void
- Defined in Angular/Generic/clustering/src/lib/cluster-scatter.component.ts:1068

CommitLabelEdit

CommitLabelEdit(cluster: ClusterInfo): void
Commit the edited label.
Parameters
- cluster: ClusterInfo
Returns void
- Defined in Angular/Generic/clustering/src/lib/cluster-scatter.component.ts:361

ExportSVG

ExportSVG(): string
Export the current scatter plot as an SVG string.

The returned string is a self-contained <svg> element that can be saved to a file or embedded in HTML.

Returns string
SVG markup string, or empty string if the SVG element is not yet rendered.
- Defined in Angular/Generic/clustering/src/lib/cluster-scatter.component.ts:1037

GetClusterColor

GetClusterColor(clusterId: number): string
Get the color for a cluster by its ID, used in the detail panel.
Parameters
- clusterId: number
  The cluster ID.
Returns string
CSS color string.
- Defined in Angular/Generic/clustering/src/lib/cluster-scatter.component.ts:1111

GetClusterLabel

GetClusterLabel(point: ClusterPoint): string
Resolve the human-readable label for a point's cluster.
Parameters
- point: ClusterPoint
  The point to look up.
Returns string
Cluster label string, or "Outlier" for noise points.
- Defined in Angular/Generic/clustering/src/lib/cluster-scatter.component.ts:885

GetClusterLabelById

GetClusterLabelById(clusterId: number): string
Get the label for a cluster by ID (used for SVG text labels on the chart).
Parameters
- clusterId: number
Returns string
- Defined in Angular/Generic/clustering/src/lib/cluster-scatter.component.ts:892

GetPointColor

GetPointColor(point: ClusterPoint): string
Resolve the display color for a given point based on its cluster assignment and the active ColorPalette.
Parameters
- point: ClusterPoint
  The point to colorize.
Returns string
CSS color string.
- Defined in Angular/Generic/clustering/src/lib/cluster-scatter.component.ts:547

GetPointOpacity

GetPointOpacity(point: ClusterPoint): number
Compute the fill opacity for a data point.

Non-hovered points are dimmed when another point is hovered.
Parameters
- point: ClusterPoint
  The point to evaluate.
Returns number
Opacity value between 0 and 1.
- Defined in Angular/Generic/clustering/src/lib/cluster-scatter.component.ts:708

GetPointRadius

GetPointRadius(point: ClusterPoint): number
Compute the SVG radius for a data point.

Selected points use the larger HighlightRadius; all others use DotRadius.
Parameters
- point: ClusterPoint
  The point to size.
Returns number
Radius in SVG units.
- Defined in Angular/Generic/clustering/src/lib/cluster-scatter.component.ts:689

GetViewBoxString

GetViewBoxString(): string
Returns the current SVG viewBox as a space-separated string.

Returns string
e.g. "0 0 1000 700"
- Defined in Angular/Generic/clustering/src/lib/cluster-scatter.component.ts:536

GetViewportTransform

GetViewportTransform(): ViewportTransform
Get the current viewport transform for saving/restoring.

Returns ViewportTransform
- Defined in Angular/Generic/clustering/src/lib/cluster-scatter.component.ts:407

GetVisiblePoints

GetVisiblePoints(): ClusterPoint[]
Return all points currently visible within the viewport bounds.

Returns ClusterPoint[]
Array of ClusterPoint objects whose X/Y fall inside the current viewBox.
- Defined in Angular/Generic/clustering/src/lib/cluster-scatter.component.ts:986

HighlightCluster

HighlightCluster(clusterId: number): void
Visually emphasize all points belonging to a cluster by increasing their radius and dimming non-members.

Call ResetZoom() or re-assign Points to clear the highlight.
Parameters
- clusterId: number
  The numeric cluster ID to emphasize.
Returns void
- Defined in Angular/Generic/clustering/src/lib/cluster-scatter.component.ts:1052

IsHighlighted

IsHighlighted(point: ClusterPoint): boolean
Whether the given point is the currently highlighted (last-clicked) point.
Parameters
- point: ClusterPoint
  The point to check.
Returns boolean
true if highlighted.
- Defined in Angular/Generic/clustering/src/lib/cluster-scatter.component.ts:785

IsSelected

IsSelected(point: ClusterPoint): boolean
Whether the given point is in the current selection set.
Parameters
- point: ClusterPoint
  The point to check.
Returns boolean
true if selected.
- Defined in Angular/Generic/clustering/src/lib/cluster-scatter.component.ts:795

ngAfterViewInit

ngAfterViewInit(): void
A callback method that is invoked immediately after Angular has completed initialization of a component's view. It is invoked only once when the view is instantiated.

Returns void
Implementation of AfterViewInit.ngAfterViewInit
- Defined in Angular/Generic/clustering/src/lib/cluster-scatter.component.ts:485

ngOnChanges

ngOnChanges(changes: { [propName: string]: SimpleChange<any> }): void
A callback method that is invoked immediately after the default change detector has checked data-bound properties if at least one has changed, and before the view and content children are checked.
Parameters
- changes: { [propName: string]: SimpleChange<any> }
  The changed properties.
Returns void
Implementation of OnChanges.ngOnChanges
- Defined in Angular/Generic/clustering/src/lib/cluster-scatter.component.ts:497

ngOnDestroy

ngOnDestroy(): void
A callback method that performs custom clean-up, invoked immediately before a directive, pipe, or service instance is destroyed.

Returns void
Implementation of OnDestroy.ngOnDestroy
- Defined in Angular/Generic/clustering/src/lib/cluster-scatter.component.ts:492

OnClusterLegendClick

OnClusterLegendClick(cluster: ClusterInfo): void
Handle a click on a cluster legend item.
Parameters
- cluster: ClusterInfo
  The cluster that was clicked.
Returns void
- Defined in Angular/Generic/clustering/src/lib/cluster-scatter.component.ts:870

OnClusterMemberClick

OnClusterMemberClick(point: ClusterPoint): void
Select a point from the cluster members list, updating the detail panel and highlighting the point on the chart.
Parameters
- point: ClusterPoint
  The cluster member point to select.
Returns void
- Defined in Angular/Generic/clustering/src/lib/cluster-scatter.component.ts:1092

OnLabelEditKeydown

OnLabelEditKeydown(event: KeyboardEvent, cluster: ClusterInfo): void
Handle keydown in the edit input.
Parameters
- event: KeyboardEvent
- cluster: ClusterInfo
Returns void
- Defined in Angular/Generic/clustering/src/lib/cluster-scatter.component.ts:379

OnMouseDown

OnMouseDown(event: MouseEvent): void
Start panning on left-mousedown.
Parameters
- event: MouseEvent
  The native mouse event.
Returns void
- Defined in Angular/Generic/clustering/src/lib/cluster-scatter.component.ts:846

OnOpenRecordClick

OnOpenRecordClick(): void
Emit the OpenRecordRequested event for the currently selected point (triggered by the "Open Record" button in the detail panel).

Returns void
- Defined in Angular/Generic/clustering/src/lib/cluster-scatter.component.ts:1080

OnPointClick

OnPointClick(point: ClusterPoint): void
Handle click on a data point: fires BeforePointClick, toggles selection, opens the detail panel, then fires PointClicked and SelectionChanged.
Parameters
- point: ClusterPoint
  The clicked point.
Returns void
- Defined in Angular/Generic/clustering/src/lib/cluster-scatter.component.ts:755

OnPointMouseEnter

OnPointMouseEnter(point: ClusterPoint, event: MouseEvent): void
Handle mouseenter on a data point: show tooltip, fire hover events.
Parameters
- point: ClusterPoint
  The hovered point.
- event: MouseEvent
  The native mouse event (used for tooltip positioning).
Returns void
- Defined in Angular/Generic/clustering/src/lib/cluster-scatter.component.ts:725

OnPointMouseLeave

OnPointMouseLeave(): void
Handle mouseleave on a data point: hide tooltip, emit null hover.

Returns void
- Defined in Angular/Generic/clustering/src/lib/cluster-scatter.component.ts:741

OnWheel

OnWheel(event: WheelEvent): void
Handle mouse wheel events for zooming.

Fires BeforeZoom and ViewportChanged. Respects EnableZoom, MinZoom, and MaxZoom constraints.
Parameters
- event: WheelEvent
  The native wheel event.
Returns void
- Defined in Angular/Generic/clustering/src/lib/cluster-scatter.component.ts:807

PX

PX(point: ClusterPoint): number
Project a point's (X,Y,Z) to a screen X in the SVG coordinate space.
Parameters
- point: ClusterPoint
Returns number
- Defined in Angular/Generic/clustering/src/lib/cluster-scatter.component.ts:622

PY

PY(point: ClusterPoint): number
Project a point's (X,Y,Z) to a screen Y in the SVG coordinate space.
Parameters
- point: ClusterPoint
Returns number
- Defined in Angular/Generic/clustering/src/lib/cluster-scatter.component.ts:628

ResetRotation

ResetRotation(): void
Reset the 3D orbit to the default viewing angle.

Returns void
- Defined in Angular/Generic/clustering/src/lib/cluster-scatter.component.ts:642

ResetZoom

ResetZoom(): void
Reset the viewport to the default zoom level (full view).

Returns void
Example
```
this.scatter.ResetZoom();
```
- Defined in Angular/Generic/clustering/src/lib/cluster-scatter.component.ts:968

SelectPoints

SelectPoints(ids: string[]): void
Programmatically select points by their VectorKey IDs.

Merges with the existing selection. Use ClearSelection() first to replace the selection entirely.
Parameters
- ids: string[]
  Array of VectorKey strings to select.
Returns void
Example
```
this.scatter.SelectPoints(['abc-123', 'def-456']);
```
- Defined in Angular/Generic/clustering/src/lib/cluster-scatter.component.ts:1008

SetViewportTransform

SetViewportTransform(vt: ViewportTransform): void
Restore a previously saved viewport transform.
Parameters
- vt: ViewportTransform
Returns void
- Defined in Angular/Generic/clustering/src/lib/cluster-scatter.component.ts:416

StartLabelEdit

StartLabelEdit(cluster: ClusterInfo, event: MouseEvent): void
Start inline editing for a cluster label.
Parameters
- cluster: ClusterInfo
- event: MouseEvent
Returns void
- Defined in Angular/Generic/clustering/src/lib/cluster-scatter.component.ts:353

ToggleClusterMembers

ToggleClusterMembers(): void
Toggle the cluster members list expansion state.

Returns void
- Defined in Angular/Generic/clustering/src/lib/cluster-scatter.component.ts:1101

TrackCentroidBy

TrackCentroidBy(_index: number, centroid: { ClusterId: number }): number
Internal
TrackBy function for centroid loops.
Parameters
- _index: number
- centroid: { ClusterId: number }
Returns number
- Defined in Angular/Generic/clustering/src/lib/cluster-scatter.component.ts:908

TrackClusterBy

TrackClusterBy(_index: number, cluster: ClusterInfo): number
Internal
TrackBy function for cluster loops.
Parameters
- _index: number
- cluster: ClusterInfo
Returns number
- Defined in Angular/Generic/clustering/src/lib/cluster-scatter.component.ts:903

TrackMemberBy

TrackMemberBy(_index: number, point: ClusterPoint): string
Internal
TrackBy function for cluster member loops.
Parameters
- _index: number
- point: ClusterPoint
Returns string
- Defined in Angular/Generic/clustering/src/lib/cluster-scatter.component.ts:1163

TrackPointBy

TrackPointBy(_index: number, point: ClusterPoint): string
Internal
TrackBy function for point loops.
Parameters
- _index: number
- point: ClusterPoint
Returns string
- Defined in Angular/Generic/clustering/src/lib/cluster-scatter.component.ts:898

ZoomToCluster

ZoomToCluster(clusterId: number): void
Animate the viewport to center on a specific cluster's centroid.

The zoom level is adjusted so that all cluster members are visible with some padding.
Parameters
- clusterId: number
  The numeric ID of the cluster to zoom into.
Returns void
Example
```
@ViewChild(ClusterScatterComponent) scatter!: ClusterScatterComponent;
this.scatter.ZoomToCluster(2);
```
- Defined in Angular/Generic/clustering/src/lib/cluster-scatter.component.ts:930

Class ClusterScatterComponent

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns ClusterScatterComponent

Properties

AfterClusteringComplete

AnimateTransitions

Default

BeforePointClick

Example

BeforePointHover

BeforeZoom

ClusterCentroids

ClusterMembers

ClusterMembersExpanded

Clusters

ClusterSelected

ColorBy

ColorPalette

Default

DetailEntries

DotOpacity

Default

DotRadius

Default

EditingClusterId

EditingLabelDraft

EnablePan

Default

EnableZoom

Default

EntityName

FieldDisplayNames

Default

FieldPriority

Default

HighlightedKey

HighlightRadius

Default

HorizontalGridLines

HoveredPoint

IsLoading

LabelEdited

MaxZoom

Default

MinZoom

Default

OpenRecordRequested

Pitch

PointClicked

PointHovered

Points

SelectedPoint

SelectedPointIds

Default

Example

SelectionChanged

ShowDetailPanel

ShowLegend

Default

ShowTooltip

Default

TooltipEntries

TooltipFields

Default

Example

TooltipX

TooltipY

VerticalGridLines

ViewBoxString

ViewportChanged

Yaw

Accessors

EntityLegend