Class: Labels
Manages the labels for the Cosmograph visualization. This class is responsible for updating, rendering, and handling the display of labels for the points in the Cosmograph.
Constructors
Constructor
new Labels(
_,dispatchWheelEventElement):Labels
Parameters
| Parameter | Type |
|---|---|
_ | ICosmographInternalApi |
dispatchWheelEventElement | HTMLCanvasElement |
Returns
Labels
Properties
| Property | Modifier | Type |
|---|---|---|
labelsContainer | public | HTMLDivElement |
Methods
render()
render():
Promise<void>
Renders the labels for the Cosmograph visualization.
Returns
Promise<void>
update()
update():
Promise<void>
Updates the labels for the Cosmograph visualization.
Returns
Promise<void>
updatePositions()
updatePositions():
void
Returns
void
renderHoveredLabel()
renderHoveredLabel(
pointIndexBy?,pointSpacePosition?):Promise<void>
Renders a hovered label for a point in the Cosmograph visualization.
Parameters
| Parameter | Type |
|---|---|
pointIndexBy? | number |
pointSpacePosition? | [number, number] |
Returns
Promise<void>
setCustomLabels()
setCustomLabels(
labels?):void
Parameters
| Parameter | Type |
|---|---|
labels? | CosmographCustomLabel[] |
Returns
void
setZooming()
setZooming(
isZooming,isManual):void
Set zooming state
Parameters
| Parameter | Type | Default value |
|---|---|---|
isZooming | boolean | undefined |
isManual | boolean | true |
Returns
void
destroy()
destroy():
void
Destroys the labels module, removing event listeners and destroying internal components.
Returns
void
clear()
clear():
void
Clears the labels data and resets the CSS labels renderer.
Returns
void