JS Bridge API Reference¶
Generated by tools/scripts/generate_widget_bridge_api.py --write from core/view/src/widget_bridge_api_manifest.tsv, JS preamble globals, and the capability map in core/view/include/pulp/view/reload_autocaps.hpp.
Status: experimental
The bridge installs these names as globals on the active JS engine. Pure UI groups are always registered. Effectful groups are capability-scoped during hot reload, so an ungranted group's symbols are absent at runtime rather than installed and guarded. Generated TypeScript marks those gated globals as | undefined and exposes per-capability groups through PulpBridgeGlobals<C>.
Run python3 tools/scripts/generate_widget_bridge_api.py --check for an exact content check. pulp doctor --only WidgetBridge performs a non-executing input-fingerprint freshness check.
Capability Model¶
| Capability | Bridge globals |
|---|---|
exec |
2 |
clipboard |
2 |
filesystem |
16 |
storage |
9 |
ai |
2 |
runtime_import |
2 |
| always registered | 380 |
API Surface¶
Accessibility¶
| Name | Kind | Signature | Capability | JSX | Source |
|---|---|---|---|---|---|
setAccessibilityLabel |
function |
(id: string, value: string) => void |
always | - |
core/view/src/widget_bridge/accessibility_api.cpp |
setAccessibilityRole |
function |
(id: string, value: string) => void |
always | - |
core/view/src/widget_bridge/accessibility_api.cpp |
setAccessibilityState |
function |
(id: string, ...args: unknown[]) => void |
always | - |
core/view/src/widget_bridge/accessibility_api.cpp |
Animation¶
| Name | Kind | Signature | Capability | JSX | Source |
|---|---|---|---|---|---|
animate |
function |
(id: string, property: string, targetValue: number \| string, durationMs: number, easingName?: string) => void |
always | - |
core/view/src/widget_bridge/animation_api.cpp |
setTransitionDuration |
function |
(id: string, seconds: number) => void |
always | - |
core/view/src/widget_bridge/animation_api.cpp |
setTransition |
function |
(id: string, css: string) => void |
always | - |
core/view/src/widget_bridge/animation_api.cpp |
setTransitionProperty |
function |
(id: string, properties: string) => void |
always | - |
core/view/src/widget_bridge/animation_api.cpp |
setTransitionTimingFunction |
function |
(id: string, easing: string) => void |
always | - |
core/view/src/widget_bridge/animation_api.cpp |
setTransitionDelay |
function |
(id: string, seconds: number) => void |
always | - |
core/view/src/widget_bridge/animation_api.cpp |
setTranslate |
function |
(id: string, x: number, y: number) => void |
always | - |
core/view/src/widget_bridge/animation_api.cpp |
setRotation |
function |
(id: string, value: number) => void |
always | - |
core/view/src/widget_bridge/animation_api.cpp |
setTransform |
function |
(id: string, a: number, b: number, c: number, d: number, e: number, f: number) => void |
always | - |
core/view/src/widget_bridge/animation_api.cpp |
clearTransform |
function |
(id: string) => void |
always | - |
core/view/src/widget_bridge/animation_api.cpp |
setTransformOrigin |
function |
(id: string, x: number, y?: number) => void |
always | - |
core/view/src/widget_bridge/animation_api.cpp |
defineKeyframes |
function |
(name: string, stopsJson: string) => void |
always | - |
core/view/src/widget_bridge/animation_api.cpp |
setAnimation |
function |
(id: string, name: string, duration: number, iterations?: number, direction?: string) => void |
always | - |
core/view/src/widget_bridge/animation_api.cpp |
setScale |
function |
(id: string, scale: number) => void |
always | - |
core/view/src/widget_bridge/animation_api.cpp |
setSkew |
function |
(id: string, xDegrees: number, yDegrees: number) => void |
always | - |
core/view/src/widget_bridge/animation_api.cpp |
CSS Style¶
| Name | Kind | Signature | Capability | JSX | Source |
|---|---|---|---|---|---|
setVisible |
function |
(id: string, value: boolean) => void |
always | - |
core/view/src/widget_bridge/style_visibility_api.cpp |
setPointerEvents |
function |
(id: string, value: string) => void |
always | - |
core/view/src/widget_bridge/style_visibility_api.cpp |
setBackfaceVisibility |
function |
(id: string, value: string) => void |
always | - |
core/view/src/widget_bridge/style_visibility_api.cpp |
setVisibility |
function |
(id: string, value: string) => void |
always | - |
core/view/src/widget_bridge/style_visibility_api.cpp |
setWhiteSpace |
function |
(id: string, value: string) => void |
always | - |
core/view/src/widget_bridge/style_visibility_api.cpp |
setUserSelect |
function |
(id: string, value: string) => void |
always | - |
core/view/src/widget_bridge/style_visibility_api.cpp |
setBackground |
function |
(id: string, value: string) => void |
always | - |
core/view/src/widget_bridge/style_visual_api.cpp |
setBorder |
function |
(id: string, color: string, width?: number, radius?: number) => void |
always | - |
core/view/src/widget_bridge/border_box_api.cpp |
setBorderSide |
function |
(id: string, side: 'top' \| 'right' \| 'bottom' \| 'left', width: number, color: string) => void |
always | - |
core/view/src/widget_bridge/border_box_api.cpp |
setCornerRadius |
function |
(id: string, corner: 'All' \| 'TopLeft' \| 'TopRight' \| 'BottomLeft' \| 'BottomRight' \| string, radius: number) => void |
always | - |
core/view/src/widget_bridge/border_box_api.cpp |
setBorderColor |
function |
(id: string, value: string) => void |
always | - |
core/view/src/widget_bridge/border_box_api.cpp |
setBorderWidth |
function |
(id: string, value: number) => void |
always | - |
core/view/src/widget_bridge/border_box_api.cpp |
setBorderStyle |
function |
(id: string, value: string) => void |
always | - |
core/view/src/widget_bridge/border_box_api.cpp |
setListStyleType |
function |
(id: string, value: string) => void |
always | - |
core/view/src/widget_bridge/list_style_api.cpp |
setListStyleImage |
function |
(id: string, value: string) => void |
always | - |
core/view/src/widget_bridge/list_style_api.cpp |
setListStylePosition |
function |
(id: string, value: string) => void |
always | - |
core/view/src/widget_bridge/list_style_api.cpp |
setOutlineColor |
function |
(id: string, value: string) => void |
always | - |
core/view/src/widget_bridge/outline_api.cpp |
setOutlineOffset |
function |
(id: string, value: number) => void |
always | - |
core/view/src/widget_bridge/outline_api.cpp |
setOutlineStyle |
function |
(id: string, value: string) => void |
always | - |
core/view/src/widget_bridge/outline_api.cpp |
setOutlineWidth |
function |
(id: string, value: number) => void |
always | - |
core/view/src/widget_bridge/outline_api.cpp |
setBorderRadius |
function |
(id: string, value: number) => void |
always | - |
core/view/src/widget_bridge/border_radius_api.cpp |
setBorderTopLeftRadius |
function |
(id: string, value: number) => void |
always | - |
core/view/src/widget_bridge/border_radius_api.cpp |
setBorderTopRightRadius |
function |
(id: string, value: number) => void |
always | - |
core/view/src/widget_bridge/border_radius_api.cpp |
setBorderBottomLeftRadius |
function |
(id: string, value: number) => void |
always | - |
core/view/src/widget_bridge/border_radius_api.cpp |
setBorderBottomRightRadius |
function |
(id: string, value: number) => void |
always | - |
core/view/src/widget_bridge/border_radius_api.cpp |
setBorderTopColor |
function |
(id: string, color: string) => void |
always | - |
core/view/src/widget_bridge/border_side_api.cpp |
setBorderRightColor |
function |
(id: string, color: string) => void |
always | - |
core/view/src/widget_bridge/border_side_api.cpp |
setBorderBottomColor |
function |
(id: string, color: string) => void |
always | - |
core/view/src/widget_bridge/border_side_api.cpp |
setBorderLeftColor |
function |
(id: string, color: string) => void |
always | - |
core/view/src/widget_bridge/border_side_api.cpp |
setBorderTopWidth |
function |
(id: string, value: number) => void |
always | - |
core/view/src/widget_bridge/border_side_api.cpp |
setBorderRightWidth |
function |
(id: string, value: number) => void |
always | - |
core/view/src/widget_bridge/border_side_api.cpp |
setBorderBottomWidth |
function |
(id: string, value: number) => void |
always | - |
core/view/src/widget_bridge/border_side_api.cpp |
setBorderLeftWidth |
function |
(id: string, ...args: unknown[]) => void |
always | - |
core/view/src/widget_bridge/border_side_api.cpp |
setShadow |
function |
(id: string, ...args: unknown[]) => void |
always | - |
core/view/src/widget_bridge/style_visual_api.cpp |
setOpacity |
function |
(id: string, value: number) => void |
always | - |
core/view/src/widget_bridge/style_visual_api.cpp |
setOverflow |
function |
(id: string, value: string) => void |
always | - |
core/view/src/widget_bridge/style_visual_api.cpp |
setStateStyle |
function |
(id: string, ...args: unknown[]) => void |
always | - |
core/view/src/widget_bridge/style_state_api.cpp |
setEnabled |
function |
(id: string, value: boolean) => void |
always | - |
core/view/src/widget_bridge/style_state_api.cpp |
setDebugPaint |
function |
(id: string, value: boolean) => void |
always | - |
core/view/src/widget_bridge/style_state_api.cpp |
setBackgroundRepeat |
function |
(id: string, value: string) => void |
always | - |
core/view/src/widget_bridge/style_storage_api.cpp |
setCursor |
function |
(id: string, value: string) => void |
always | - |
core/view/src/widget_bridge/style_cursor_api.cpp |
setDirection |
function |
(id: string, value: string) => void |
always | - |
core/view/src/widget_bridge/style_cursor_api.cpp |
setFilter |
function |
(id: string, value: string) => void |
always | - |
core/view/src/widget_bridge/style_effects_api.cpp |
setBackdropFilter |
function |
(id: string, value: number) => void |
always | - |
core/view/src/widget_bridge/style_effects_api.cpp |
setClipPath |
function |
(id: string, value: string) => void |
always | - |
core/view/src/widget_bridge/style_effects_api.cpp |
setViewEffect |
function |
(id: string, ...args: unknown[]) => void |
always | - |
core/view/src/widget_bridge/style_effects_api.cpp |
setMaskImage |
function |
(id: string, value: string) => void |
always | - |
core/view/src/widget_bridge/style_storage_api.cpp |
setMask |
function |
(id: string, value: string) => void |
always | - |
core/view/src/widget_bridge/style_storage_api.cpp |
setMaskSize |
function |
(id: string, value: string) => void |
always | - |
core/view/src/widget_bridge/style_storage_api.cpp |
setAppearance |
function |
(id: string, value: string) => void |
always | - |
core/view/src/widget_bridge/style_storage_api.cpp |
setObjectFit |
function |
(id: string, value: string) => void |
always | - |
core/view/src/widget_bridge/style_storage_api.cpp |
setObjectPosition |
function |
(id: string, value: string) => void |
always | - |
core/view/src/widget_bridge/style_storage_api.cpp |
setMixBlendMode |
function |
(id: string, ...args: unknown[]) => void |
always | - |
core/view/src/widget_bridge/style_effects_api.cpp |
setShadowColor |
function |
(id: string, ...args: unknown[]) => void |
always | - |
core/view/src/widget_bridge/style_rn_compat_api.cpp |
setShadowOffset |
function |
(id: string, ...args: unknown[]) => void |
always | - |
core/view/src/widget_bridge/style_rn_compat_api.cpp |
setShadowOpacity |
function |
(id: string, value: number) => void |
always | - |
core/view/src/widget_bridge/style_rn_compat_api.cpp |
setShadowRadius |
function |
(id: string, value: number) => void |
always | - |
core/view/src/widget_bridge/style_rn_compat_api.cpp |
setIncludeFontPadding |
function |
(id: string, value: boolean) => void |
always | - |
core/view/src/widget_bridge/style_rn_compat_api.cpp |
setBorderCurve |
function |
(id: string, ...args: unknown[]) => void |
always | - |
core/view/src/widget_bridge/style_rn_compat_api.cpp |
setIsolation |
function |
(id: string, ...args: unknown[]) => void |
always | - |
core/view/src/widget_bridge/style_rn_compat_api.cpp |
setElevation |
function |
(id: string, value: number) => void |
always | - |
core/view/src/widget_bridge/style_rn_compat_api.cpp |
setScrollBehavior |
function |
(id: string, value: string) => void |
always | - |
core/view/src/widget_bridge/style_rn_compat_api.cpp |
setOverscrollBehavior |
function |
(id: string, value: string) => void |
always | - |
core/view/src/widget_bridge/style_rn_compat_api.cpp |
setBackgroundAttachment |
function |
(id: string, value: string) => void |
always | - |
core/view/src/widget_bridge/style_storage_api.cpp |
setBackgroundClip |
function |
(id: string, value: string) => void |
always | - |
core/view/src/widget_bridge/style_storage_api.cpp |
setBackgroundOrigin |
function |
(id: string, value: string) => void |
always | - |
core/view/src/widget_bridge/style_storage_api.cpp |
setBackgroundPosition |
function |
(id: string, value: string) => void |
always | - |
core/view/src/widget_bridge/style_storage_api.cpp |
setBackgroundSize |
function |
(id: string, value: string) => void |
always | - |
core/view/src/widget_bridge/style_storage_api.cpp |
setBackgroundGradient |
function |
(id: string, value: string) => void |
always | - |
core/view/src/widget_bridge/style_visual_api.cpp |
setBoxShadow |
function |
(id: string, offsetX: number, offsetY: number, blur: number, spread: number, color: string, inset?: boolean) => void |
always | - |
core/view/src/widget_bridge/style_visual_api.cpp |
addBoxShadow |
function |
(...args: unknown[]) => unknown |
always | - |
core/view/src/widget_bridge/style_visual_api.cpp |
clearBoxShadow |
function |
(id: string) => void |
always | - |
core/view/src/widget_bridge/style_visual_api.cpp |
Canvas 2D¶
| Name | Kind | Signature | Capability | JSX | Source |
|---|---|---|---|---|---|
createCanvas |
function |
(id: string, parentId: string) => string |
always | - |
core/view/src/widget_bridge/canvas2d_api.cpp |
canvasClear |
function |
(canvasId: string) => void |
always | - |
core/view/src/widget_bridge/canvas2d_api.cpp |
canvasRect |
function |
(canvasId: string, x: number, y: number, width: number, height: number, color?: string) => void |
always | - |
core/view/src/widget_bridge/canvas2d_api.cpp |
canvasFillRect |
function |
(canvasId: string, x: number, y: number, width: number, height: number, color?: string) => void |
always | - |
core/view/src/widget_bridge/canvas2d_api.cpp |
canvasStrokeRect |
function |
(canvasId: string, x: number, y: number, width: number, height: number, color?: string, lineWidth?: number) => void |
always | - |
core/view/src/widget_bridge/canvas2d_api.cpp |
canvasFillCircle |
function |
(canvasId: string, x: number, y: number, radius: number, color?: string) => void |
always | - |
core/view/src/widget_bridge/canvas2d_api.cpp |
canvasStrokeLine |
function |
(canvasId: string, x1: number, y1: number, x2: number, y2: number, color?: string, lineWidth?: number) => void |
always | - |
core/view/src/widget_bridge/canvas2d_api.cpp |
canvasFillText |
function |
(canvasId: string, text: string, x: number, y: number, fontSize?: number, color?: string) => void |
always | - |
core/view/src/widget_bridge/canvas2d_api.cpp |
canvasStrokeText |
function |
(canvasId: string, text: string, x: number, y: number, fontSize?: number, color?: string) => void |
always | - |
core/view/src/widget_bridge/canvas2d_api.cpp |
canvasSetFillColor |
function |
(canvasId: string, color: string) => void |
always | - |
core/view/src/widget_bridge/canvas2d_api.cpp |
canvasSetStrokeColor |
function |
(canvasId: string, color: string) => void |
always | - |
core/view/src/widget_bridge/canvas2d_api.cpp |
canvasSetLineWidth |
function |
(canvasId: string, width: number) => void |
always | - |
core/view/src/widget_bridge/canvas2d_api.cpp |
canvasSetFont |
function |
(canvasId: string, fontFamily: string, fontSize: number) => void |
always | - |
core/view/src/widget_bridge/canvas2d_api.cpp |
canvasSetFontFull |
function |
(canvasId: string, fontFamily: string, fontSize: number, fontWeight?: number, fontStyle?: string) => void |
always | - |
core/view/src/widget_bridge/canvas2d_api.cpp |
canvasBeginPath |
function |
(canvasId: string) => void |
always | - |
core/view/src/widget_bridge/canvas2d_api.cpp |
canvasMoveTo |
function |
(canvasId: string, x: number, y: number) => void |
always | - |
core/view/src/widget_bridge/canvas2d_api.cpp |
canvasLineTo |
function |
(canvasId: string, x: number, y: number) => void |
always | - |
core/view/src/widget_bridge/canvas2d_api.cpp |
canvasQuadTo |
function |
(canvasId: string, cpx: number, cpy: number, x: number, y: number) => void |
always | - |
core/view/src/widget_bridge/canvas2d_api.cpp |
canvasCubicTo |
function |
(canvasId: string, cp1x: number, cp1y: number, cp2x: number, cp2y: number, x: number, y: number) => void |
always | - |
core/view/src/widget_bridge/canvas2d_api.cpp |
canvasClosePath |
function |
(canvasId: string) => void |
always | - |
core/view/src/widget_bridge/canvas2d_api.cpp |
canvasFillPath |
function |
(canvasId: string) => void |
always | - |
core/view/src/widget_bridge/canvas2d_api.cpp |
canvasStrokePath |
function |
(canvasId: string) => void |
always | - |
core/view/src/widget_bridge/canvas2d_api.cpp |
canvasPathArc |
function |
(canvasId: string, x: number, y: number, radius: number, startAngle: number, endAngle: number, anticlockwise?: boolean) => void |
always | - |
core/view/src/widget_bridge/canvas2d_api.cpp |
canvasPathArcTo |
function |
(canvasId: string, x1: number, y1: number, x2: number, y2: number, radius: number) => void |
always | - |
core/view/src/widget_bridge/canvas2d_api.cpp |
canvasPathEllipse |
function |
(canvasId: string, x: number, y: number, radiusX: number, radiusY: number, rotation: number, startAngle: number, endAngle: number, anticlockwise?: boolean) => void |
always | - |
core/view/src/widget_bridge/canvas2d_api.cpp |
canvasPathRoundRect |
function |
(canvasId: string, x: number, y: number, width: number, height: number, radius: number) => void |
always | - |
core/view/src/widget_bridge/canvas2d_api.cpp |
canvasSave |
function |
(canvasId: string) => void |
always | - |
core/view/src/widget_bridge/canvas2d_api.cpp |
canvasRestore |
function |
(canvasId: string) => void |
always | - |
core/view/src/widget_bridge/canvas2d_api.cpp |
canvasTranslate |
function |
(canvasId: string, x: number, y: number) => void |
always | - |
core/view/src/widget_bridge/canvas2d_api.cpp |
canvasScale |
function |
(canvasId: string, x: number, y: number) => void |
always | - |
core/view/src/widget_bridge/canvas2d_api.cpp |
canvasRotate |
function |
(canvasId: string, radians: number) => void |
always | - |
core/view/src/widget_bridge/canvas2d_api.cpp |
beginPath |
function |
() => void |
always | - |
core/view/src/widget_bridge/canvas2d_api.cpp |
drawPath |
function |
(commands: string) => void |
always | - |
core/view/src/widget_bridge/canvas2d_api.cpp |
measureText |
function |
(text: string, fontSize?: number) => PulpBridgeTextMetrics |
always | - |
core/view/src/widget_bridge/canvas2d_api.cpp |
canvasSetLinearGradient |
function |
(canvasId: string, x0: number, y0: number, x1: number, y1: number, stopsJson: string) => void |
always | - |
core/view/src/widget_bridge/canvas2d_api.cpp |
canvasSetRadialGradient |
function |
(canvasId: string, x: number, y: number, radius: number, stopsJson: string) => void |
always | - |
core/view/src/widget_bridge/canvas2d_api.cpp |
canvasSetRadialGradientTwoCircles |
function |
(...args: unknown[]) => unknown |
always | - |
core/view/src/widget_bridge/canvas2d_api.cpp |
canvasClearGradient |
function |
(canvasId: string) => void |
always | - |
core/view/src/widget_bridge/canvas2d_api.cpp |
canvasSetStrokeLinearGradient |
function |
(canvasId: string, x0: number, y0: number, x1: number, y1: number, stopsJson: string) => void |
always | - |
core/view/src/widget_bridge/canvas2d_api.cpp |
canvasSetStrokeRadialGradient |
function |
(canvasId: string, x: number, y: number, radius: number, stopsJson: string) => void |
always | - |
core/view/src/widget_bridge/canvas2d_api.cpp |
canvasSetStrokeRadialGradientTwoCircles |
function |
(...args: unknown[]) => unknown |
always | - |
core/view/src/widget_bridge/canvas2d_api.cpp |
canvasSetStrokeConicGradient |
function |
(canvasId: string, x: number, y: number, angle: number, stopsJson: string) => void |
always | - |
core/view/src/widget_bridge/canvas2d_api.cpp |
canvasClearStrokeGradient |
function |
(canvasId: string) => void |
always | - |
core/view/src/widget_bridge/canvas2d_api.cpp |
canvasSetConicGradient |
function |
(canvasId: string, x: number, y: number, angle: number, stopsJson: string) => void |
always | - |
core/view/src/widget_bridge/canvas2d_api.cpp |
canvasSetFillPattern |
function |
(canvasId: string, source: string, repetition?: string) => void |
always | - |
core/view/src/widget_bridge/canvas2d_api.cpp |
canvasSetStrokePattern |
function |
(canvasId: string, source: string, repetition?: string) => void |
always | - |
core/view/src/widget_bridge/canvas2d_api.cpp |
canvasSetMiterLimit |
function |
(canvasId: string, limit: number) => void |
always | - |
core/view/src/widget_bridge/canvas2d_api.cpp |
canvasSetImageSmoothing |
function |
(canvasId: string, enabled: boolean, quality?: string) => void |
always | - |
core/view/src/widget_bridge/canvas2d_api.cpp |
canvasSetDirection |
function |
(canvasId: string, direction: 'ltr' \| 'rtl' \| 'inherit' \| string) => void |
always | - |
core/view/src/widget_bridge/canvas2d_api.cpp |
canvasSetFilter |
function |
(canvasId: string, filter: string) => void |
always | - |
core/view/src/widget_bridge/canvas2d_api.cpp |
canvasSetShaderEffect |
function |
(...args: unknown[]) => unknown |
always | - |
core/view/src/widget_bridge/canvas2d_api.cpp |
canvasArc |
function |
(canvasId: string, x: number, y: number, radius: number, startAngle: number, endAngle: number, anticlockwise?: boolean) => void |
always | - |
core/view/src/widget_bridge/canvas2d_api.cpp |
canvasSetTextAlign |
function |
(canvasId: string, align: string) => void |
always | - |
core/view/src/widget_bridge/canvas2d_api.cpp |
canvasSetTextBaseline |
function |
(canvasId: string, baseline: string) => void |
always | - |
core/view/src/widget_bridge/canvas2d_api.cpp |
canvasClearRect |
function |
(canvasId: string, x: number, y: number, width: number, height: number) => void |
always | - |
core/view/src/widget_bridge/canvas2d_api.cpp |
canvasClipRect |
function |
(canvasId: string, x: number, y: number, width: number, height: number) => void |
always | - |
core/view/src/widget_bridge/canvas2d_api.cpp |
canvasFillRoundedRect |
function |
(canvasId: string, x: number, y: number, width: number, height: number, radius: number, color?: string) => void |
always | - |
core/view/src/widget_bridge/canvas2d_api.cpp |
canvasStrokeRoundedRect |
function |
(canvasId: string, x: number, y: number, width: number, height: number, radius: number, color?: string, lineWidth?: number) => void |
always | - |
core/view/src/widget_bridge/canvas2d_api.cpp |
canvasStrokeCircle |
function |
(canvasId: string, x: number, y: number, radius: number, color?: string, lineWidth?: number) => void |
always | - |
core/view/src/widget_bridge/canvas2d_api.cpp |
canvasSetGlobalAlpha |
function |
(canvasId: string, alpha: number) => void |
always | - |
core/view/src/widget_bridge/canvas2d_api.cpp |
canvasSetLineCap |
function |
(canvasId: string, lineCap: string) => void |
always | - |
core/view/src/widget_bridge/canvas2d_api.cpp |
canvasSetLineJoin |
function |
(canvasId: string, lineJoin: string) => void |
always | - |
core/view/src/widget_bridge/canvas2d_api.cpp |
canvasSetBlendMode |
function |
(canvasId: string, blendMode: string) => void |
always | - |
core/view/src/widget_bridge/canvas2d_api.cpp |
canvasGlobalCompositeOperation |
function |
(canvasId: string, operation: string) => void |
always | - |
core/view/src/widget_bridge/canvas2d_api.cpp |
canvasSetTransform |
function |
(canvasId: string, a: number, b: number, c: number, d: number, e: number, f: number) => void |
always | - |
core/view/src/widget_bridge/canvas2d_api.cpp |
canvasClip |
function |
(canvasId: string) => void |
always | - |
core/view/src/widget_bridge/canvas2d_api.cpp |
canvasDrawImage |
function |
(canvasId: string, source: string, dx: number, dy: number, dw?: number, dh?: number, sx?: number, sy?: number, sw?: number, sh?: number) => void |
always | - |
core/view/src/widget_bridge/canvas2d_api.cpp |
canvasMeasureText |
function |
(canvasId: string, text: string) => PulpBridgeTextMetrics |
always | - |
core/view/src/widget_bridge/canvas2d_api.cpp |
canvasSetLineDash |
function |
(canvasId: string, segments: number[]) => void |
always | - |
core/view/src/widget_bridge/canvas2d_api.cpp |
canvasSetShadowColor |
function |
(canvasId: string, color: string) => void |
always | - |
core/view/src/widget_bridge/canvas2d_api.cpp |
canvasSetShadowBlur |
function |
(canvasId: string, blur: number) => void |
always | - |
core/view/src/widget_bridge/canvas2d_api.cpp |
canvasSetShadowOffsetX |
function |
(canvasId: string, x: number) => void |
always | - |
core/view/src/widget_bridge/canvas2d_api.cpp |
canvasSetShadowOffsetY |
function |
(canvasId: string, y: number) => void |
always | - |
core/view/src/widget_bridge/canvas2d_api.cpp |
canvasGetImageData |
function |
(canvasId: string, x: number, y: number, width: number, height: number) => PulpBridgeCanvasImageData |
always | - |
core/view/src/widget_bridge/canvas2d_api.cpp |
canvasPutImageData |
function |
(canvasId: string, imageData: PulpBridgeCanvasImageData, x: number, y: number) => void |
always | - |
core/view/src/widget_bridge/canvas2d_api.cpp |
DOM Compatibility¶
| Name | Kind | Signature | Capability | JSX | Source |
|---|---|---|---|---|---|
__domAppend |
function |
(...args: unknown[]) => unknown |
always | - |
core/view/src/widget_bridge/dom_api.cpp |
__domRemove |
function |
(...args: unknown[]) => unknown |
always | - |
core/view/src/widget_bridge/dom_api.cpp |
Events¶
| Name | Kind | Signature | Capability | JSX | Source |
|---|---|---|---|---|---|
on |
preamble_function |
(id: string, eventName: string, fn: (...args: unknown[]) => void) => void |
always | event:names |
core/view/src/widget_bridge.cpp |
registerHover |
function |
(id: string) => void |
always | - |
core/view/src/widget_bridge/event_api.cpp |
registerClick |
function |
(id: string, ...args: unknown[]) => void |
always | - |
core/view/src/widget_bridge/event_api.cpp |
claimOverlay |
function |
(id: string) => void |
always | - |
core/view/src/widget_bridge/event_api.cpp |
releaseOverlay |
function |
(id: string) => void |
always | - |
core/view/src/widget_bridge/event_api.cpp |
registerPointer |
function |
(id: string) => void |
always | - |
core/view/src/widget_bridge/event_api.cpp |
registerGesture |
function |
(id: string) => void |
always | - |
core/view/src/widget_bridge/event_api.cpp |
registerTapGesture |
function |
(id: string, ...args: unknown[]) => void |
always | - |
core/view/src/widget_bridge/event_api.cpp |
registerDoubleTapGesture |
function |
(id: string, ...args: unknown[]) => void |
always | - |
core/view/src/widget_bridge/event_api.cpp |
registerLongPressGesture |
function |
(id: string, ...args: unknown[]) => void |
always | - |
core/view/src/widget_bridge/event_api.cpp |
registerPanGesture |
function |
(id: string, ...args: unknown[]) => void |
always | - |
core/view/src/widget_bridge/event_api.cpp |
registerSwipeGesture |
function |
(id: string, ...args: unknown[]) => void |
always | - |
core/view/src/widget_bridge/event_api.cpp |
registerFlingGesture |
function |
(id: string, ...args: unknown[]) => void |
always | - |
core/view/src/widget_bridge/event_api.cpp |
registerPinchGesture |
function |
(id: string, ...args: unknown[]) => void |
always | - |
core/view/src/widget_bridge/event_api.cpp |
registerRotateGesture |
function |
(id: string, ...args: unknown[]) => void |
always | - |
core/view/src/widget_bridge/event_api.cpp |
nativeSetPointerCapture |
function |
(id: string, pointerId: number) => void |
always | - |
core/view/src/widget_bridge/event_api.cpp |
nativeReleasePointerCapture |
function |
(id: string, pointerId: number) => void |
always | - |
core/view/src/widget_bridge/event_api.cpp |
enableInspectClick |
function |
() => void |
always | - |
core/view/src/widget_bridge/event_api.cpp |
registerWheel |
function |
(id: string) => void |
always | - |
core/view/src/widget_bridge/event_api.cpp |
registerContextMenu |
function |
(id: string, callbackName: string) => void |
always | - |
core/view/src/widget_bridge/event_api.cpp |
showContextMenu |
function |
(itemsJson: string, x: number, y: number) => number |
always | - |
core/view/src/widget_bridge/event_api.cpp |
registerShortcut |
function |
(keyCode: number, modMask: number, callbackName: string) => void |
always | - |
core/view/src/widget_bridge/event_api.cpp |
registerDrop |
function |
(id: string) => void |
always | - |
core/view/src/widget_bridge/event_api.cpp |
GPU¶
| Name | Kind | Signature | Capability | JSX | Source |
|---|---|---|---|---|---|
getGPUInfo |
function |
() => PulpBridgeJsonObject |
always | - |
core/view/src/widget_bridge/gpu_api.cpp |
navigatorGPU |
host_object |
PulpBridgeHostObject |
always | - |
core/view/src/widget_bridge/gpu_api.cpp |
__describeNativeAdapterImpl |
function |
(...args: unknown[]) => unknown |
always | - |
core/view/src/widget_bridge/gpu_api.cpp |
__describeNativeDeviceImpl |
function |
(...args: unknown[]) => unknown |
always | - |
core/view/src/widget_bridge/gpu_api.cpp |
__gpuCanvasConfigureImpl |
function |
(...args: unknown[]) => unknown |
always | - |
core/view/src/widget_bridge/gpu_api.cpp |
__gpuCanvasDescribeCurrentTextureImpl |
function |
(...args: unknown[]) => unknown |
always | - |
core/view/src/widget_bridge/gpu_api.cpp |
__gpuCreateTextureImpl |
function |
(...args: unknown[]) => unknown |
always | - |
core/view/src/widget_bridge/gpu_api.cpp |
__gpuQueueWriteTextureImpl |
function |
(...args: unknown[]) => unknown |
always | - |
core/view/src/widget_bridge/gpu_api.cpp |
__decodeImageDataImpl |
function |
(...args: unknown[]) => unknown |
always | - |
core/view/src/widget_bridge/gpu_api.cpp |
__gpuDestroyTextureImpl |
function |
(...args: unknown[]) => unknown |
always | - |
core/view/src/widget_bridge/gpu_api.cpp |
__gpuQueueSubmitImpl |
function |
(...args: unknown[]) => unknown |
always | - |
core/view/src/widget_bridge/gpu_api.cpp |
__gpuQueueDrawImpl |
function |
(...args: unknown[]) => unknown |
always | - |
core/view/src/widget_bridge/gpu_api.cpp |
__gpuQueueDrawBufferedImpl |
function |
(...args: unknown[]) => unknown |
always | - |
core/view/src/widget_bridge/gpu_api.cpp |
__gpuQueuePresentTextureImpl |
function |
(...args: unknown[]) => unknown |
always | - |
core/view/src/widget_bridge/gpu_api.cpp |
__gpuCanvasPresentImpl |
function |
(...args: unknown[]) => unknown |
always | - |
core/view/src/widget_bridge/gpu_api.cpp |
__requestAdapterImpl |
promise_function |
(...args: unknown[]) => Promise<unknown> |
always | - |
core/view/src/widget_bridge/gpu_api.cpp |
__gpuComputeDispatchImpl |
function |
(...args: unknown[]) => unknown |
always | - |
core/view/src/widget_bridge/gpu_api.cpp |
__dracoDecodeBuffer |
function |
(...args: unknown[]) => unknown |
always | - |
core/view/src/widget_bridge/gpu_api.cpp |
Layout¶
| Name | Kind | Signature | Capability | JSX | Source |
|---|---|---|---|---|---|
createGrid |
function |
(id: string, parentId: string) => string |
always | - |
core/view/src/widget_bridge/layout_api.cpp |
setGrid |
function |
(id: string, key: string, value: number \| string) => void |
always | - |
core/view/src/widget_bridge/layout_api.cpp |
setFlex |
function |
(id: string, key: string, value: number \| string) => void |
always | - |
core/view/src/widget_bridge/layout_api.cpp |
layout |
function |
() => void |
always | - |
core/view/src/widget_bridge/layout_api.cpp |
getLayoutRect |
function |
(id: string) => PulpBridgeRect |
always | - |
core/view/src/widget_bridge/layout_api.cpp |
getLayoutAncestorRects |
function |
(id: string) => PulpBridgeRect[] |
always | - |
core/view/src/widget_bridge/layout_api.cpp |
getRootSize |
function |
() => PulpBridgeSize |
always | - |
core/view/src/widget_bridge/layout_api.cpp |
setBoxSizing |
function |
(id: string, value: string) => void |
always | - |
core/view/src/widget_bridge/layout_api.cpp |
setPosition |
function |
(id: string, position: string) => void |
always | - |
core/view/src/widget_bridge/layout_api.cpp |
setSubpixelLayout |
function |
(id: string, enabled: boolean) => void |
always | - |
core/view/src/widget_bridge/layout_api.cpp |
setTop |
function |
(id: string, value: number \| string) => void |
always | - |
core/view/src/widget_bridge/layout_api.cpp |
setRight |
function |
(id: string, value: number \| string) => void |
always | - |
core/view/src/widget_bridge/layout_api.cpp |
setBottom |
function |
(id: string, value: number \| string) => void |
always | - |
core/view/src/widget_bridge/layout_api.cpp |
setLeft |
function |
(id: string, value: number \| string) => void |
always | - |
core/view/src/widget_bridge/layout_api.cpp |
setZIndex |
function |
(id: string, value: number) => void |
always | - |
core/view/src/widget_bridge/layout_api.cpp |
Metadata¶
| Name | Kind | Signature | Capability | JSX | Source |
|---|---|---|---|---|---|
removeWidget |
function |
(id: string) => void |
always | - |
core/view/src/widget_bridge/metadata_api.cpp |
setAnchor |
function |
(id: string, value: string) => void |
always | - |
core/view/src/widget_bridge/metadata_api.cpp |
setSource |
function |
(id: string, value: string) => void |
always | - |
core/view/src/widget_bridge/metadata_api.cpp |
getComputedValue |
function |
(id: string, property: string) => string |
always | - |
core/view/src/widget_bridge/metadata_api.cpp |
Platform Services¶
| Name | Kind | Signature | Capability | JSX | Source |
|---|---|---|---|---|---|
setAICli |
function |
(command: string) => void |
requires ai |
- |
core/view/src/widget_bridge/platform_services_api.cpp |
getAICli |
function |
() => string |
requires ai |
- |
core/view/src/widget_bridge/platform_services_api.cpp |
exec |
function |
(command: string) => string |
requires exec |
- |
core/view/src/widget_bridge/platform_services_api.cpp |
execAsync |
function |
(command: string, callbackId: string) => void |
requires exec |
- |
core/view/src/widget_bridge/platform_services_api.cpp |
showOpenDialog |
function |
(title?: string, filterDescription?: string, extensions?: string) => string |
requires filesystem |
- |
core/view/src/widget_bridge/platform_services_api.cpp |
showSaveDialog |
function |
(title?: string, filterDescription?: string, extensions?: string) => string |
requires filesystem |
- |
core/view/src/widget_bridge/platform_services_api.cpp |
chooseFolder |
function |
(title?: string) => string |
requires filesystem |
- |
core/view/src/widget_bridge/platform_services_api.cpp |
readClipboard |
function |
() => string |
requires clipboard |
- |
core/view/src/widget_bridge/platform_services_api.cpp |
writeClipboard |
function |
(text: string) => void |
requires clipboard |
- |
core/view/src/widget_bridge/platform_services_api.cpp |
Runtime¶
| Name | Kind | Signature | Capability | JSX | Source |
|---|---|---|---|---|---|
__requestFrame__ |
function |
(callbackName: string) => number |
always | - |
core/view/src/widget_bridge/runtime_api.cpp |
__cancelFrame__ |
function |
(requestId: number) => void |
always | - |
core/view/src/widget_bridge/runtime_api.cpp |
__flushFrames__ |
function |
() => void |
always | - |
core/view/src/widget_bridge/runtime_api.cpp |
__motionPublishValue__ |
function |
(key: string, value: number) => void |
always | - |
core/view/src/widget_bridge/runtime_api.cpp |
__motionSetProvenance__ |
function |
(key: string, source: string) => void |
always | - |
core/view/src/widget_bridge/runtime_api.cpp |
__motionClearProvenance__ |
function |
(key: string) => void |
always | - |
core/view/src/widget_bridge/runtime_api.cpp |
__scheduleTimer__ |
function |
(callbackName: string, delayMs: number, repeat?: boolean) => number |
always | - |
core/view/src/widget_bridge/runtime_api.cpp |
__cancelTimer__ |
function |
(timerId: number) => void |
always | - |
core/view/src/widget_bridge/runtime_api.cpp |
__flushTimers__ |
function |
() => void |
always | - |
core/view/src/widget_bridge/runtime_api.cpp |
__performanceNow__ |
function |
() => number |
always | - |
core/view/src/widget_bridge/runtime_api.cpp |
Runtime Import¶
| Name | Kind | Signature | Capability | JSX | Source |
|---|---|---|---|---|---|
__pulpRuntimeImport__ |
function |
(specifier: string, options?: unknown) => unknown |
requires runtime_import |
- |
core/view/src/widget_bridge/runtime_import_api.cpp |
__pulpRuntimeSettle__ |
function |
(rounds?: number) => void |
requires runtime_import |
- |
core/view/src/widget_bridge/runtime_import_api.cpp |
SVG¶
| Name | Kind | Signature | Capability | JSX | Source |
|---|---|---|---|---|---|
createSvgPath |
function |
(id: string, parentId: string) => string |
always | factory:SvgPath |
core/view/src/widget_bridge/svg_api.cpp |
setSvgPath |
function |
(id: string, pathData: string) => void |
always | prop:SvgPath.d |
core/view/src/widget_bridge/svg_api.cpp |
setSvgViewBox |
function |
(id: string, width: number, height: number) => void |
always | prop:SvgPath.viewBox |
core/view/src/widget_bridge/svg_api.cpp |
setSvgFill |
function |
(id: string, value: string) => void |
always | prop:SvgPath.fill |
core/view/src/widget_bridge/svg_api.cpp |
setSvgFillGradient |
function |
(id: string, value: string) => void |
always | prop:SvgPath.fillGradient |
core/view/src/widget_bridge/svg_api.cpp |
setSvgFillRule |
function |
(id: string, value: string) => void |
always | prop:SvgPath.fillRule |
core/view/src/widget_bridge/svg_api.cpp |
setSvgStroke |
function |
(id: string, value: string) => void |
always | prop:SvgPath.stroke |
core/view/src/widget_bridge/svg_api.cpp |
setSvgStrokeGradient |
function |
(id: string, value: string) => void |
always | prop:SvgPath.strokeGradient |
core/view/src/widget_bridge/svg_api.cpp |
setSvgStrokeWidth |
function |
(id: string, width: number) => void |
always | prop:SvgPath.strokeWidth |
core/view/src/widget_bridge/svg_api.cpp |
createSvgRect |
function |
(id: string, parentId: string) => string |
always | factory:SvgRect |
core/view/src/widget_bridge/svg_api.cpp |
setSvgRect |
function |
(id: string, x: number, y: number, width: number, height: number) => void |
always | geometry:SvgRect.x,y,width,height |
core/view/src/widget_bridge/svg_api.cpp |
createSvgLine |
function |
(id: string, parentId: string) => string |
always | factory:SvgLine |
core/view/src/widget_bridge/svg_api.cpp |
setSvgLine |
function |
(id: string, x1: number, y1: number, x2: number, y2: number) => void |
always | geometry:SvgLine.x1,y1,x2,y2 |
core/view/src/widget_bridge/svg_api.cpp |
Shader¶
| Name | Kind | Signature | Capability | JSX | Source |
|---|---|---|---|---|---|
compileShader |
function |
(skslCode: string) => PulpBridgeJsonObject |
always | - |
core/view/src/widget_bridge/shader_api.cpp |
setWidgetShader |
function |
(id: string, skslCode: string) => PulpBridgeJsonObject |
always | - |
core/view/src/widget_bridge/shader_api.cpp |
clearWidgetShader |
function |
(id: string) => PulpBridgeJsonObject |
always | - |
core/view/src/widget_bridge/shader_api.cpp |
State Binding¶
| Name | Kind | Signature | Capability | JSX | Source |
|---|---|---|---|---|---|
onParamChanged |
preamble_function |
(...args: unknown[]) => unknown |
always | internal |
core/view/src/widget_bridge/state_binding_api.cpp |
offParamChanged |
preamble_function |
(...args: unknown[]) => unknown |
always | internal |
core/view/src/widget_bridge/state_binding_api.cpp |
bindEvents |
preamble_function |
(source: string, handler: (events: Array<{frameIndex: number, value: number}>) => void) => number |
always | internal |
core/view/src/widget_bridge/state_binding_api.cpp |
unbindEvents |
preamble_function |
(id: number) => boolean |
always | internal |
core/view/src/widget_bridge/state_binding_api.cpp |
__subscribeParam__ |
function |
(...args: unknown[]) => unknown |
always | - |
core/view/src/widget_bridge/state_binding_api.cpp |
__unsubscribeParam__ |
function |
(...args: unknown[]) => unknown |
always | - |
core/view/src/widget_bridge/state_binding_api.cpp |
__bindEvents__ |
function |
(source: string) => number |
always | - |
core/view/src/widget_bridge/state_binding_api.cpp |
__unbindEvents__ |
function |
(id: number) => boolean |
always | - |
core/view/src/widget_bridge/state_binding_api.cpp |
getParamMetadata |
function |
(...args: unknown[]) => unknown |
always | - |
core/view/src/widget_bridge/state_binding_api.cpp |
formatParamValue |
function |
(...args: unknown[]) => unknown |
always | - |
core/view/src/widget_bridge/state_binding_api.cpp |
parseParamValue |
function |
(...args: unknown[]) => unknown |
always | - |
core/view/src/widget_bridge/state_binding_api.cpp |
getParam |
function |
(name: string) => number |
always | - |
core/view/src/widget_bridge/state_binding_api.cpp |
setParam |
function |
(name: string, value: number) => void |
always | - |
core/view/src/widget_bridge/state_binding_api.cpp |
bindWidgetToParam |
function |
(widgetId: string, paramName: string, transform?: PulpBridgeBindingTransform) => boolean |
always | - |
core/view/src/widget_bridge/state_binding_api.cpp |
bindMeter |
function |
(widgetId: string, source: string, transform?: PulpBridgeBindingTransform) => boolean |
always | - |
core/view/src/widget_bridge/state_binding_api.cpp |
bindScope |
function |
(...args: unknown[]) => unknown |
always | - |
core/view/src/widget_bridge/state_binding_api.cpp |
listValueChannels |
function |
(...args: unknown[]) => unknown |
always | - |
core/view/src/widget_bridge/state_binding_api.cpp |
unbindWidget |
function |
(widgetId: string) => number |
always | - |
core/view/src/widget_bridge/state_binding_api.cpp |
Storage and Assets¶
| Name | Kind | Signature | Capability | JSX | Source |
|---|---|---|---|---|---|
storageGetItem |
function |
(key: string) => string \| null |
requires storage |
- |
core/view/src/widget_bridge/storage_assets_api.cpp |
storageSetItem |
function |
(key: string, value: string) => void |
requires storage |
- |
core/view/src/widget_bridge/storage_assets_api.cpp |
storageRemoveItem |
function |
(key: string) => void |
requires storage |
- |
core/view/src/widget_bridge/storage_assets_api.cpp |
__loadAssetSync__ |
function |
(...args: unknown[]) => unknown |
requires filesystem |
- |
core/view/src/widget_bridge/storage_assets_api.cpp |
loadFont |
function |
(path: string) => boolean |
requires filesystem |
- |
core/view/src/widget_bridge/storage_assets_api.cpp |
registerFont |
function |
(family: string, path: string) => boolean |
requires filesystem |
- |
core/view/src/widget_bridge/storage_assets_api.cpp |
Theme¶
| Name | Kind | Signature | Capability | JSX | Source |
|---|---|---|---|---|---|
setTheme |
function |
(name: 'dark' \| 'light' \| 'pro_audio' \| string) => void |
always | - |
core/view/src/widget_bridge/theme_api.cpp |
applyTokenDiff |
function |
(json: string) => void |
always | - |
core/view/src/widget_bridge/theme_api.cpp |
getThemeJson |
function |
() => string |
always | - |
core/view/src/widget_bridge/theme_api.cpp |
importDesignTokens |
function |
(json: string) => void |
always | - |
core/view/src/widget_bridge/theme_api.cpp |
exportDesignTokens |
function |
() => string |
always | - |
core/view/src/widget_bridge/theme_api.cpp |
Tokens¶
| Name | Kind | Signature | Capability | JSX | Source |
|---|---|---|---|---|---|
setMotionToken |
function |
(name: string, value: number) => void |
always | - |
core/view/src/widget_bridge/tokens_api.cpp |
getMotionToken |
function |
(name: string) => number \| undefined |
always | - |
core/view/src/widget_bridge/tokens_api.cpp |
setStringToken |
function |
(name: string, value: string) => void |
always | - |
core/view/src/widget_bridge/tokens_api.cpp |
getStringToken |
function |
(name: string) => string \| undefined |
always | - |
core/view/src/widget_bridge/tokens_api.cpp |
setColorToken |
function |
(id: string, value: string) => void |
always | - |
core/view/src/widget_bridge/tokens_api.cpp |
setDimensionToken |
function |
(id: string, value: number) => void |
always | - |
core/view/src/widget_bridge/tokens_api.cpp |
Typography¶
| Name | Kind | Signature | Capability | JSX | Source |
|---|---|---|---|---|---|
setFontFamily |
function |
(id: string, value: string) => void |
always | - |
core/view/src/widget_bridge/typography_api.cpp |
setFontWeight |
function |
(id: string, value: number) => void |
always | - |
core/view/src/widget_bridge/typography_api.cpp |
setFontStyle |
function |
(id: string, value: string) => void |
always | - |
core/view/src/widget_bridge/typography_api.cpp |
setLetterSpacing |
function |
(id: string, value: number) => void |
always | - |
core/view/src/widget_bridge/typography_api.cpp |
setLineHeight |
function |
(id: string, value: number) => void |
always | - |
core/view/src/widget_bridge/typography_api.cpp |
setTextAlign |
function |
(id: string, value: string) => void |
always | - |
core/view/src/widget_bridge/typography_api.cpp |
setMultiLine |
function |
(id: string, value: boolean) => void |
always | - |
core/view/src/widget_bridge/typography_api.cpp |
setCapturedLineBoxes |
function |
(id: string, boxes: Array<{ left: number; top: number; width: number; height: number; start: number; length: number }>, basisWidth: number, basisFace: string, wrapOnCacheMiss?: boolean) => void |
always | - |
core/view/src/widget_bridge/typography_api.cpp |
setFontSize |
function |
(id: string, value: number) => void |
always | - |
core/view/src/widget_bridge/typography_api.cpp |
setTextRuns |
function |
(id: string, runs: Array<{ start: number; end: number; fontWeight?: number; fontSize?: number; fontFamily?: string; color?: string; fontStyle?: string; letterSpacing?: number; textDecoration?: string }>) => void |
always | - |
core/view/src/widget_bridge/text_runs_api.cpp |
setTextColor |
function |
(id: string, value: string) => void |
always | - |
core/view/src/widget_bridge/typography_api.cpp |
setTextTransform |
function |
(id: string, value: string) => void |
always | - |
core/view/src/widget_bridge/typography_api.cpp |
setTextDecoration |
function |
(id: string, value: string) => void |
always | - |
core/view/src/widget_bridge/typography_api.cpp |
setTextDecorationColor |
function |
(id: string, value: string) => void |
always | - |
core/view/src/widget_bridge/typography_api.cpp |
setTextDecorationStyle |
function |
(id: string, value: string) => void |
always | - |
core/view/src/widget_bridge/typography_api.cpp |
setLineClamp |
function |
(id: string, value: number) => void |
always | - |
core/view/src/widget_bridge/typography_api.cpp |
setTextOverflow |
function |
(id: string, value: string) => void |
always | - |
core/view/src/widget_bridge/typography_api.cpp |
setTextIndent |
function |
(id: string, value: number) => void |
always | - |
core/view/src/widget_bridge/typography_api.cpp |
setVerticalAlign |
function |
(id: string, value: string) => void |
always | - |
core/view/src/widget_bridge/typography_api.cpp |
setWordBreak |
function |
(id: string, value: string) => void |
always | - |
core/view/src/widget_bridge/typography_api.cpp |
setFontVariant |
function |
(id: string, value: string) => void |
always | - |
core/view/src/widget_bridge/typography_api.cpp |
setTextShadowColor |
function |
(id: string, ...args: unknown[]) => void |
always | - |
core/view/src/widget_bridge/typography_api.cpp |
setTextShadowOffset |
function |
(id: string, ...args: unknown[]) => void |
always | - |
core/view/src/widget_bridge/typography_api.cpp |
setTextShadowRadius |
function |
(id: string, value: number) => void |
always | - |
core/view/src/widget_bridge/typography_api.cpp |
setTextShadow |
function |
(id: string, ...args: unknown[]) => void |
always | - |
core/view/src/widget_bridge/typography_api.cpp |
Widget Assets¶
| Name | Kind | Signature | Capability | JSX | Source |
|---|---|---|---|---|---|
setImageSource |
function |
(id: string, path: string) => void |
requires filesystem |
- |
core/view/src/widget_bridge/widget_assets_api.cpp |
setKnobSpriteStrip |
function |
(id: string, imagePath: string, frameCount?: number, orientation?: 'vertical' \| 'horizontal' \| string) => void |
requires filesystem |
- |
core/view/src/widget_bridge/widget_assets_api.cpp |
setKnobSpriteCore |
function |
(id: string, coreX: number, coreY: number, coreWidth: number, coreHeight: number) => void |
requires filesystem |
- |
core/view/src/widget_bridge/widget_assets_api.cpp |
setKnobCapturedIndicator |
function |
(id: string, ...args: unknown[]) => void |
requires filesystem |
- |
core/view/src/widget_bridge/widget_assets_api.cpp |
setFaderCapturedArt |
function |
(id: string, ...args: unknown[]) => void |
requires filesystem |
- |
core/view/src/widget_bridge/widget_assets_api.cpp |
setFaderSkin |
function |
(id: string, trackColor?: string, fillColor?: string, thumbColor?: string, thumbBorderColor?: string, thumbWidth?: number, thumbHeight?: number, cornerRadius?: number) => void |
requires filesystem |
- |
core/view/src/widget_bridge/widget_assets_api.cpp |
setFaderTrackWidth |
function |
(id: string, width: number) => void |
requires filesystem |
- |
core/view/src/widget_bridge/widget_assets_api.cpp |
setFaderTrackBorder |
function |
(id: string, color: string) => void |
requires filesystem |
- |
core/view/src/widget_bridge/widget_assets_api.cpp |
setMeterColors |
function |
(id: string, backgroundColor: string, stopsCsv: string) => void |
requires filesystem |
- |
core/view/src/widget_bridge/widget_assets_api.cpp |
setMeterBarRatio |
function |
(id: string, ratio: number) => void |
requires filesystem |
- |
core/view/src/widget_bridge/widget_assets_api.cpp |
Widget Factory¶
| Name | Kind | Signature | Capability | JSX | Source |
|---|---|---|---|---|---|
createKnob |
function |
(id: string, parentId: string) => string |
always | - |
core/view/src/widget_bridge/factory_api.cpp |
createFader |
function |
(id: string, orientation: 'vertical' \| 'horizontal', parentId: string) => string |
always | - |
core/view/src/widget_bridge/factory_api.cpp |
createToggle |
function |
(id: string, parentId: string) => string |
always | - |
core/view/src/widget_bridge/factory_api.cpp |
createSegmented |
function |
(id: string, parentId: string) => string |
always | - |
core/view/src/widget_bridge/factory_api.cpp |
createRangeSlider |
function |
(id: string, parentId: string) => string |
always | - |
core/view/src/widget_bridge/factory_api.cpp |
createIcon |
function |
(id: string, type: 'image_upload' \| 'send' \| 'search' \| 'close' \| string, parentId: string) => string |
always | - |
core/view/src/widget_bridge/factory_api.cpp |
createImage |
function |
(id: string, parentId: string) => string |
always | - |
core/view/src/widget_bridge/factory_api.cpp |
createCheckbox |
function |
(id: string, parentId: string) => string |
always | - |
core/view/src/widget_bridge/factory_api.cpp |
createToggleButton |
function |
(id: string, parentId: string) => string |
always | - |
core/view/src/widget_bridge/factory_api.cpp |
createLabel |
function |
(id: string, text: string, parentId: string) => string |
always | - |
core/view/src/widget_bridge/factory_api.cpp |
createBadge |
function |
(id: string, text: string, tone: string, parentId: string) => string |
always | - |
core/view/src/widget_bridge/factory_api.cpp |
createStepper |
function |
(id: string, parentId: string) => string |
always | - |
core/view/src/widget_bridge/factory_api.cpp |
createPan |
function |
(id: string, parentId: string) => string |
always | - |
core/view/src/widget_bridge/factory_api.cpp |
createRow |
function |
(id: string, parentId: string) => string |
always | - |
core/view/src/widget_bridge/factory_api.cpp |
createCol |
function |
(id: string, parentId: string) => string |
always | - |
core/view/src/widget_bridge/factory_api.cpp |
createModal |
function |
(id: string, parentId: string) => string |
always | - |
core/view/src/widget_bridge/factory_api.cpp |
createPanel |
function |
(id: string, parentId: string) => string |
always | - |
core/view/src/widget_bridge/factory_api.cpp |
createMeter |
function |
(id: string, orientation: 'vertical' \| 'horizontal', parentId: string) => string |
always | - |
core/view/src/widget_bridge/factory_api.cpp |
createXYPad |
function |
(id: string, parentId: string) => string |
always | - |
core/view/src/widget_bridge/factory_api.cpp |
createWaveform |
function |
(id: string, parentId: string) => string |
always | - |
core/view/src/widget_bridge/factory_api.cpp |
createSpectrum |
function |
(id: string, parentId: string) => string |
always | - |
core/view/src/widget_bridge/factory_api.cpp |
createCombo |
function |
(id: string, parentId: string) => string |
always | - |
core/view/src/widget_bridge/factory_api.cpp |
createProgress |
function |
(id: string, parentId: string) => string |
always | - |
core/view/src/widget_bridge/factory_api.cpp |
createScrollView |
function |
(id: string, parentId: string) => string |
always | - |
core/view/src/widget_bridge/factory_api.cpp |
createNativeView |
function |
(id: string, parentId: string) => string |
always | - |
core/view/src/widget_bridge/factory_api.cpp |
createListBox |
function |
(id: string, parentId: string) => string |
always | - |
core/view/src/widget_bridge/factory_api.cpp |
createVirtualList |
function |
(id: string, parentId: string) => string |
always | - |
core/view/src/widget_bridge/factory_api.cpp |
createVirtualGrid |
function |
(id: string, parentId: string) => string |
always | - |
core/view/src/widget_bridge/factory_api.cpp |
createTextEditor |
function |
(id: string, parentId: string) => string |
always | - |
core/view/src/widget_bridge/factory_api.cpp |
Widget Schema¶
| Name | Kind | Signature | Capability | JSX | Source |
|---|---|---|---|---|---|
setWidgetSchema |
function |
(id: string, schemaJson: string) => void |
requires storage |
- |
core/view/src/widget_bridge/widget_schema_api.cpp |
setWidgetLottie |
function |
(id: string, lottieJson: string) => void |
requires storage |
- |
core/view/src/widget_bridge/widget_schema_api.cpp |
seekWidgetLottie |
function |
(id: string, time01: number) => void |
requires storage |
- |
core/view/src/widget_bridge/widget_schema_api.cpp |
clearWidgetSchema |
function |
(id: string) => void |
requires storage |
- |
core/view/src/widget_bridge/widget_schema_api.cpp |
saveStylePreset |
function |
(name: string, payload: unknown) => void |
requires storage |
- |
core/view/src/widget_bridge/widget_schema_api.cpp |
loadStylePreset |
function |
(name: string) => unknown |
requires storage |
- |
core/view/src/widget_bridge/widget_schema_api.cpp |
setWidgetLottie stores Lottie JSON and scrub state on a widget for tool workflows.
Native Skottie rendering is available through the LottieView widget and LottieAnimation canvas path; opt in with the PULP_LOTTIE CMake option, which links the Skia skottie module when the bundled Skia toolchain provides the required SkJSON and skresources support.
Widget Value¶
| Name | Kind | Signature | Capability | JSX | Source |
|---|---|---|---|---|---|
setValue |
function |
(id: string, value: number) => void |
always | - |
core/view/src/widget_bridge/widget_value_controls_api.cpp |
getValue |
function |
(id: string) => number |
always | - |
core/view/src/widget_bridge/widget_value_controls_api.cpp |
setMin |
function |
(id: string, value: number) => void |
always | - |
core/view/src/widget_bridge/widget_value_controls_api.cpp |
setMax |
function |
(id: string, value: number) => void |
always | - |
core/view/src/widget_bridge/widget_value_controls_api.cpp |
setStep |
function |
(id: string, value: number) => void |
always | - |
core/view/src/widget_bridge/widget_value_controls_api.cpp |
setOrientation |
function |
(id: string, value: string) => void |
always | - |
core/view/src/widget_bridge/widget_value_controls_api.cpp |
setAccentColor |
function |
(id: string, value: string) => void |
always | - |
core/view/src/widget_bridge/widget_value_controls_api.cpp |
setListItems |
function |
(id: string, items: string[] \| string) => void |
always | - |
core/view/src/widget_bridge/widget_value_list_api.cpp |
setListSelected |
function |
(id: string, value: number) => void |
always | - |
core/view/src/widget_bridge/widget_value_list_api.cpp |
setListRowHeight |
function |
(id: string, value: number) => void |
always | - |
core/view/src/widget_bridge/widget_value_list_api.cpp |
setVirtualListRowCount |
function |
(id: string, ...args: unknown[]) => void |
always | - |
core/view/src/widget_bridge/widget_value_list_api.cpp |
setVirtualListOverscan |
function |
(id: string, ...args: unknown[]) => void |
always | - |
core/view/src/widget_bridge/widget_value_list_api.cpp |
setVirtualListSelectionMode |
function |
(id: string, ...args: unknown[]) => void |
always | - |
core/view/src/widget_bridge/widget_value_list_api.cpp |
setVirtualListSelected |
function |
(id: string, ...args: unknown[]) => void |
always | - |
core/view/src/widget_bridge/widget_value_list_api.cpp |
scrollVirtualListToRow |
function |
(...args: unknown[]) => unknown |
always | - |
core/view/src/widget_bridge/widget_value_list_api.cpp |
refreshVirtualListRows |
function |
(...args: unknown[]) => unknown |
always | - |
core/view/src/widget_bridge/widget_value_list_api.cpp |
setVirtualGridItemCount |
function |
(id: string, ...args: unknown[]) => void |
always | - |
core/view/src/widget_bridge/widget_value_list_api.cpp |
setVirtualGridCellSize |
function |
(id: string, ...args: unknown[]) => void |
always | - |
core/view/src/widget_bridge/widget_value_list_api.cpp |
setVirtualGridColumnCount |
function |
(id: string, ...args: unknown[]) => void |
always | - |
core/view/src/widget_bridge/widget_value_list_api.cpp |
setVirtualGridOverscan |
function |
(id: string, ...args: unknown[]) => void |
always | - |
core/view/src/widget_bridge/widget_value_list_api.cpp |
setVirtualGridSelectionMode |
function |
(id: string, ...args: unknown[]) => void |
always | - |
core/view/src/widget_bridge/widget_value_list_api.cpp |
setVirtualGridSelected |
function |
(id: string, ...args: unknown[]) => void |
always | - |
core/view/src/widget_bridge/widget_value_list_api.cpp |
scrollVirtualGridToItem |
function |
(...args: unknown[]) => unknown |
always | - |
core/view/src/widget_bridge/widget_value_list_api.cpp |
refreshVirtualGridCells |
function |
(...args: unknown[]) => unknown |
always | - |
core/view/src/widget_bridge/widget_value_list_api.cpp |
setLabel |
function |
(id: string, value: string) => void |
always | - |
core/view/src/widget_bridge/widget_value_basic_api.cpp |
setStyle |
function |
(id: string, ...args: unknown[]) => void |
always | - |
core/view/src/widget_bridge/widget_value_basic_api.cpp |
setWidgetStyle |
function |
(id: string, value: string) => void |
always | - |
core/view/src/widget_bridge/widget_value_basic_api.cpp |
setDesignedOverlay |
function |
(id: string, ...args: unknown[]) => void |
always | - |
core/view/src/widget_bridge/widget_value_basic_api.cpp |
setItems |
function |
(id: string, items: string[] \| string) => void |
always | - |
core/view/src/widget_bridge/widget_value_basic_api.cpp |
setSegments |
function |
(id: string, ...args: unknown[]) => void |
always | - |
core/view/src/widget_bridge/widget_value_basic_api.cpp |
setSelected |
function |
(id: string, index: number) => void |
always | - |
core/view/src/widget_bridge/widget_value_basic_api.cpp |
setProgress |
function |
(id: string, value: number) => void |
always | - |
core/view/src/widget_bridge/widget_value_content_api.cpp |
setMeterLevel |
function |
(id: string, peak: number, rms?: number) => void |
always | - |
core/view/src/widget_bridge/widget_value_content_api.cpp |
setXY |
function |
(id: string, x: number, y: number) => void |
always | - |
core/view/src/widget_bridge/widget_value_content_api.cpp |
setWaveformData |
function |
(id: string, samples: PulpBridgeArrayLikeNumber) => void |
always | - |
core/view/src/widget_bridge/widget_value_content_api.cpp |
setSpectrumData |
function |
(id: string, samples: PulpBridgeArrayLikeNumber) => void |
always | - |
core/view/src/widget_bridge/widget_value_content_api.cpp |
setPlaceholder |
function |
(id: string, value: string) => void |
always | - |
core/view/src/widget_bridge/widget_value_content_api.cpp |
setText |
function |
(id: string, value: string) => void |
always | - |
core/view/src/widget_bridge/widget_value_content_api.cpp |
getText |
function |
(id: string) => string |
always | - |
core/view/src/widget_bridge/widget_value_content_api.cpp |
setPanelStyle |
function |
(id: string, backgroundToken: string, borderToken?: string, radius?: number, width?: number) => void |
always | - |
core/view/src/widget_bridge/widget_value_content_api.cpp |
setScrollContentSize |
function |
(id: string, width: number, height: number) => void |
always | - |
core/view/src/widget_bridge/widget_value_content_api.cpp |
query¶
| Name | Kind | Signature | Capability | JSX | Source |
|---|---|---|---|---|---|
queryIndexBuild |
function |
(...args: unknown[]) => unknown |
always | - |
core/view/src/widget_bridge/query_service_api.cpp |
queryIndexSearch |
function |
(...args: unknown[]) => unknown |
always | - |
core/view/src/widget_bridge/query_service_api.cpp |
queryIndexRelease |
function |
(...args: unknown[]) => unknown |
always | - |
core/view/src/widget_bridge/query_service_api.cpp |