createOverlay(value)
createOverlay create an overlay.
Reference
typescript
(
value:
string |
{
name: string
id?: string
groupId?: string
paneId?: string
lock?: boolean
visible?: boolean
zLevel?: number
needDefaultPointFigure?: boolean
needDefaultXAxisFigure?: boolean
needDefaultYAxisFigure?: boolean
mode?: 'normal' | 'weak_magnet' | 'strong_magnet'
modeSensitivity?: number
points?: Array<{ timestamp: number, dataIndex?: number, value?: number }>
extendData?: any
styles?: object
onDrawStart?: (event: object) => boolean
onDrawing?: (event: object) => boolean
onDrawEnd?: (event: object) => boolean
onClick?: (event: object) => boolean
onDoubleClick?: (event: object) => boolean
onRightClick?: (event: object) => boolean
onPressedMoveStart?: (event: object) => boolean
onPressedMoving?: (event: object) => boolean
onPressedMoveEnd?: (event: object) => boolean
onMouseEnter?: (event: object) => boolean
onMouseLeave?: (event: object) => boolean
onRemoved?: (event: object) => boolean
onSelected?: (event: object) => boolean
onDeselected?: (event: object) => boolean
} |
Array<
string |
{
name: string
id?: string
groupId?: string
paneId?: string
lock?: boolean
visible?: boolean
zLevel?: number
needDefaultPointFigure?: boolean
needDefaultXAxisFigure?: boolean
needDefaultYAxisFigure?: boolean
mode?: 'normal' | 'weak_magnet' | 'strong_magnet'
modeSensitivity?: number
points?: Array<{ timestamp: number, dataIndex?: number, value?: number }>
extendData?: any
styles?: object
onDrawStart?: (event: object) => boolean
onDrawing?: (event: object) => boolean
onDrawEnd?: (event: object) => boolean
onClick?: (event: object) => boolean
onDoubleClick?: (event: object) => boolean
onRightClick?: (event: object) => boolean
onPressedMoveStart?: (event: object) => boolean
onPressedMoving?: (event: object) => boolean
onPressedMoveEnd?: (event: object) => boolean
onMouseEnter?: (event: object) => boolean
onMouseLeave?: (event: object) => boolean
onRemoved?: (event: object) => boolean
onSelected?: (event: object) => boolean
onDeselected?: (event: object) => boolean
}
>
) => voidParameters
valueOverlay configuration, which can be an overlay name, an overlay object, or an array of overlay names and objects.nameOverlay name.idOverlay id.groupIdGroup id.paneIdPane id.lockWhether to lock and prevent dragging.visibleWhether it is visible.zLevelDrawing level, the larger the value, the closer it is displayed to the front, and it only works between the overlays.needDefaultPointFigureWhether the default point corresponding figures are required.needDefaultXAxisFigureWhether to use the default x-axis for the figure.needDefaultYAxisFigureWhether to use the default y-axis for the figure.modeMode, supportsnormal,weak_magnetandstrong_magnet.modeSensitivityMode sensitivity, only valid when mode isweak_magnet.pointsPoint information.extendDataCustom the extend data.stylesStyle configuration.onDrawStartStart drawing event.onDrawingDrawing event.onDrawEndDrawing end event.onClickClick event.onDoubleClickDouble click event.onRightClickRight click event.onPressedMoveStartPress and hold to start moving the event.onPressedMovingPress and hold the moving event.onPressedMoveEndPress and hold to end the move event.onMouseEnterMouse enter event.onMouseLeaveMouse leave event.onRemovedDelete event.onSelectedSelect the event.onDeselectedDeselect the event.
Returns
createOverlay returns string or null or Array<string | null> .