Home > @activeviam/activeui-sdk > ChartOverlayImplementationProperties
ChartOverlayImplementationProperties interface
Display an overlay over a chart.
Signature:
export interface ChartOverlayImplementationProperties
Properties
| Property | Type | Description |
|---|---|---|
| getCustomizableParameters | () => OverlayCustomizableParameter[] | These parameters will generate controls in the UI for the user to configure the overlay. |
| getDescription | () => React.ReactElement<any> | The description of the overlay as React elements, to display a small summary of it. |
| render | (renderOverlayPayload: RenderOverlayPayload) => void | The code ran by this method should render the overlay inside of the provided d3 selection. |