Interface: CallbackConfig
Extended by
Properties
onPointsFiltered()?
optionalonPointsFiltered: (filteredPoints,selectedPointIndices,selectedLinkIndices) =>void
Callback function that will be called when the points was filtered by point crossfilter.
Parameters
| Parameter | Type | Description |
|---|---|---|
filteredPoints | CosmographData | A Table of filtered points. |
selectedPointIndices | undefined | null | number[] | Array of selected point indices related to the indicies in the internal points table. |
selectedLinkIndices | undefined | number[] | Array of selected link indices related to the indicies in the internal links table. |
Returns
void
onLinksFiltered()?
optionalonLinksFiltered: (filteredLinks,selectedPointIndices,selectedLinkIndices) =>void
Callback function that will be called when the links was filtered by link crossfilter.
Parameters
| Parameter | Type | Description |
|---|---|---|
filteredLinks | CosmographData | A Table of filtered links. |
selectedPointIndices | undefined | null | number[] | Array of selected point indices related to the indicies in the internal points table. |
selectedLinkIndices | undefined | number[] | Array of selected link indices related to the indicies in the internal links table. |
Returns
void
onLabelClick()?
optionalonLabelClick: (index,id,event) =>void
Callback function that will be called when clicked on a label.
Parameters
| Parameter | Type | Description |
|---|---|---|
index | number | Point index for this label. |
id | string | Point id for this label. |
event | MouseEvent | Corresponding mouse event. |
Returns
void
onClusterLabelClick()?
optionalonClusterLabelClick: (index,id,event) =>void
Callback function that will be called when clicked on a cluster label.
Parameters
| Parameter | Type | Description |
|---|---|---|
index | number | Cluster index for this label. |
id | string | Cluster id for this label. |
event | MouseEvent | Corresponding mouse event. |
Returns
void
onGraphRebuilt()?
optionalonGraphRebuilt: (stats) =>void
Callback function that executes after the graph completes rebuilding with new data.
Parameters
| Parameter | Type | Description |
|---|---|---|
stats | { pointsCount: number; linksCount: number; pointsSummary?: Record<string, unknown>[]; linksSummary?: Record<string, unknown>[]; } | Graph statistics after rebuilding |
stats.pointsCount | number | Number of rendered points in the graph |
stats.linksCount | number | Number of rendered links in the graph |
stats.pointsSummary? | Record<string, unknown>[] | Summary information for the rendered points |
stats.linksSummary? | Record<string, unknown>[] | Summary information for the rendered links |
Returns
void
onGraphDataUpdated()?
optionalonGraphDataUpdated: () =>void
Callback function that will be called when points or links data is replaced or modified at the local database.
Returns
void
onConfigUpdated()?
optionalonConfigUpdated: () =>void
Callback function that will be called after the config was updated.
Returns
void
onRectSelected()?
optionalonRectSelected: (selection) =>void
Callback function that will be called when area selection was performed.
Parameters
| Parameter | Type | Description |
|---|---|---|
selection | null | [[number, number], [number, number]] | — The selected area or null if the selection was cleared. |
Returns
void
onPolygonSelected()?
optionalonPolygonSelected: (polygonPoints) =>void
Callback function that will be called when polygonal selection was performed.
Parameters
| Parameter | Type | Description |
|---|---|---|
polygonPoints | [number, number][] | The points of the polygon. |
Returns
void