API Reference

ADSR envelope (seconds + sustain level 0–1). Stages are proportionally fitted when A+D+R exceeds the layer duration.

Published type export AlignMode.

Published class export ApexifyAssetError.

Published class export ApexifyConfigError.

Published class export ApexifyDecodeError.

Published class export ApexifyError.

Published class export ApexifyExternalServiceError.

Published class export ApexifyInputError.

Install hook for optional features without growing the core {@link ApexPainter } class. Installation may be synchronous or asynchronous. `ApexPainter.use(plugin)` always returns a Promise and must be awaited before plugin APIs are considered installed. Plugin names are unique per painter. Registrations made through `painter.plugins` during a failed installation are rolled back.

Published class export ApexifyPluginError.

Published class export ApexifyProcessError.

Published class export ApexifyRemoteFetchError.

Published class export ApexifyResourceLimitError.

Published interface export ApexifyRuntimeConfig.

Published type export ApexifyRuntimeConfigInput.

Primary server-side rendering and media façade for the current Apexify.js package.

Published type export AssetKind.

Published interface export AssetRegistrationInfo.

Published type export AssetResolveFn.

Published type export AssetScalar.

Published type export AssetValue.

Procedural audio synthesis — oscillators, noise, envelopes, presets, sequencing, composition, and PCM16 WAV I/O.

Published interface export AvatarToLayersOptions.

Alignment for {@link BackgroundLayer} image `contain` / `cover` (same as `customBg.align`).

Published type export BackgroundLayer.

Repeat mode for tiled image patterns in {@link BackgroundLayer}.

Published interface export BadgeToLayersOptions.

Published interface export BaseRegion.

Batch/chain execution policy. Results preserve input order; failures are fail-fast.

Minimal painter surface for batch / chain helpers.

Published type export BatchOperation.

Published interface export BlendOptions.

Published type export borderPosition.

Published interface export BoxBackground.

Published interface export CacheRuntimeConfig.

Published interface export CanvasConfig.

Published interface export CanvasCustomBackground.

Placement/effect contract shared by still-image canvas backgrounds. `videoBg` uses these options after its selected video frame has been extracted to a raster image, keeping its public video selection API distinct while sharing the same image rendering semantics as `customBg`.

Result of {@link ApexPainter.createCanvas } — buffer + config for follow-up draws.

Published interface export CanvasVideoBackground.

Published interface export CardToLayersOptions.

Published interface export ChainOperation.

Chart `appearance` background options aligned with {@link CanvasConfig} / chart renderers.

Published type export ChartData.

Published type export ChartOptions.

Discriminated chart kind for `ChartCreator.createChart`. Combo / comparison use dedicated methods.

Published interface export CircleRegion.

Published interface export CircularArcLayoutOptions.

Published interface export CollageLayout.

Published interface export CompressionOptions.

Backward-compatible process-wide configuration merge.

Published interface export ConnectedLegendConfig.

Published interface export Coordinate.

Published interface export CreateImageOptions.

Published interface export cropCoordinate.

Published interface export cropOptions.

Published interface export CropOptions.

How measured line width **W**, user **radius**, and **sweep** (radians) are reconciled on a circle. - **fit** — `R = W / θ`. Arc length equals typographic width; `radius` is ignored for geometry. - **clamp** (default) — `R = max(radius ?? R_fit, R_fit)` so the arc is never shorter than the text. - **override** — `R = radius ?? R_fit`. If `R·θ < W`, **θ is expanded** to `W/R` so the string still fits without crowding (user sweep becomes a minimum when the arc is too tight).

Published interface export CustomOptions.

Published interface export CustomRegion.

Published constant export DEFAULT_APEXIFY_RUNTIME_CONFIG.

Published interface export DiagnosticsEvent.

Published type export DiagnosticsHandler.

Published interface export DiagnosticsRuntimeConfig.

Published interface export EllipseRegion.

Published interface export EnhancedTextStyle.

Published interface export ExtractFramesOptions.

Published interface export FilterOptions.

Published type export FilterType.

Published type export FitMode.

Published interface export Frame.

Published function export getDefaultApexifyRuntimeConfig.

Published interface export GIFAttachment.

Published type export GIFDisposalMethod.

Published interface export GIFEncodedFrame.

Published type export GIFFrameSource.

Published interface export GIFInputFrame.

Published interface export GIFOptions.

Published type export GIFOutputFormat.

Published interface export GIFResults.

Static text overlay. It uses the same renderer as `createText`; x/y default to 10/30.

Published type export GIFWatermarkPosition.

Watermark image applied after the frame raster and before GIF encoding.

Published interface export GlyphArcPlacement.

Published type export gradient.

Published interface export GradientConfig.

Published type export GradientStop.

Published interface export GroupTransformOptions.

Published interface export HitDetectionOptions.

Published interface export HitDetectionResult.

Published type export HitRegion.

One layer for {@link blendImageLayers } / `ApexPainter.prototype.blend`.

Image filter configuration interface

Published interface export ImageProperties.

Published interface export LegendEntry.

Canonical legend positions for chart layout (aliases normalized elsewhere in chart code).

Published interface export MaskOptions.

Published interface export MixAudioOperation.

Published interface export MixAudioOverlayClip.

Published interface export NetworkRuntimeConfig.

Configuration option to decide the outputformate from ApexPainter

Opt-in **`$name`** / **`$palette.key`** resolution for imperative {@link ApexPainter } methods. Scene APIs default resolution **on**; these flags default **off** unless noted.

Procedural SFX: `painter.createAudio.preset('laser')`, `.synth({ layers: [...] })`, `.sequence({ events })`.

Grouped hit-testing API: `await painter.detect.path(…)`, `.region(…)`, etc.

Grouped image / stitch / palette API: `await painter.image.stitchImages(…)`, `.resize`, …

Published interface export PainterImgurCredentials.

Encode / transfer finished PNG buffers: `painter.output.dataURL(buf)`, `.url(buf)`, etc.

Path2D + custom lines: `painter.path2d.create(…)`, `.draw(…)`, `.custom(…)`.

Pixel read/write: `await painter.pixels.getData(…)`, `.setData`, `.manipulate`, `.getColor`, `.setColor`.

Published interface export PaletteOptions.

Path2D drawing options (aligned with {@link Path2DCreator }).

Path command types for building Path2D objects (shared by Path2DCreator and hit testing).

Published interface export PathRegion.

Enhanced pattern options supporting all pattern types

Width/height target for procedural patterns (no full canvas required).

Published interface export PieChartOptions.

Published interface export PieSlice.

Published interface export PixelData.

Published interface export PixelManipulationOptions.

Published interface export PlaceholderResolveContext.

Published interface export Point.

Published interface export PolygonRegion.

Published interface export ProgressBarToLayersOptions.

Published interface export RectRegion.

Published type export RegionType.

Published interface export RenderLimits.

Published type export RenderPatternStackOptions.

Published function export resetApexifyRuntimeConfig.

Published interface export ResizeOptions.

Published function export resolveApexifyRuntimeConfig.

Published interface export ResolveContext.

Merged decorations: nested `decorations` wins for line marks and bold/italic; falls back to legacy flat fields.

Merged effects: nested `effects` wins; falls back to legacy flat fields.

Merged fill: nested `fill` wins; falls back to legacy flat fields.

Merged layout: nested `layout` wins; falls back to legacy flat fields.

Merged placement: nested `placement` wins; falls back to legacy flat fields.

Published interface export SaveOptions.

Published interface export SaveResult.

Published type export SceneBackground.

Published type export SceneChartType.

Published interface export SceneCreatorDeps.

Published type export SceneGifInputFrame.

One drawable item in deterministic paint order (array index 0 is bottom, final index is top).

Published interface export SceneRenderInput.

Published interface export SceneRenderOptions.

Published type export SceneRenderResult.

Published interface export SceneSurfacePlacement.

Published type export SceneToVideoResult.

Published type export SceneVideoFrameSlot.

Published interface export ShadowOptions.

Published interface export ShapeProperties.

Published type export ShapeType.

Published interface export StandardLegendConfig.

Published interface export StitchOptions.

Published interface export StrokeOptions.

Tone shaping applied to a composed clip after synthesis.

One source placed on a timeline. Multiple clips may overlap.

Published interface export SynthComposeOptions.

One tone/noise layer in a custom sound.

Deep layer override used by preset customization. Nested DSP objects merge with the preset layer by index.

Argument to {@link PainterCreateAudio.mix } and internal `mixSynthSounds`.

Published interface export SynthMixOptions.

Published interface export SynthPresetInfo.

Published type export SynthPresetName.

Preset overrides. Layer entries merge by index, including nested ADSR/filter/modulation objects.

One event on a timeline when using {@link SynthSequenceOptions}.

Published interface export SynthSequenceOptions.

Full custom sound definition.

Published type export TemplateData.

Published type export TemplateLayerInput.

Published interface export TemplateLayerInsertion.

Published type export TemplateLayerOverrides.

Published interface export TemplateOptions.

Published interface export TemplateRenderHost.

Published interface export TemplateRenderOptions.

Published type export TemplateSceneDefinition.

Canvas `textAlign` values.

Canvas `textBaseline` values.

Published interface export TextCurveConfig.

Typographic extras: line-edge marks plus bold/italic flags (canvas font string). Prefer nested `decorations` over flat `underline` / `bold` / etc.

Halo, drop shadow, and flat highlight behind text. Prefer this over top-level `glow` / `shadow` / `highlight`.

Primary fill paint and overall draw opacity. Prefer over top-level `color` / `gradient` / `opacity`.

Published interface export TextGlowStyle.

Published interface export TextHighlightStyle.

Line metrics, spacing, and wrap bounds. Prefer over top-level `lineHeight` / `maxWidth` / etc.

One line-edge decoration (underline / overline / strikethrough).

Published interface export TextMetrics.

Published interface export TextObject.

Anchor, baseline, and rotation around `(x, y)`. Prefer over top-level `textAlign` / `rotation` / etc.

Published interface export TextProperties.

Published interface export TextShadowStyle.

Outline drawn around glyph strokes (distinct from {@link TextLineDecoration}).

Published interface export TremoloOptions.

Published interface export VibratoOptions.

Published type export VideoAudioPolicy.

Published interface export VideoCreationOptions.

Published type export VideoFit.

Published interface export VideoOperationControls.

Published type export VideoOutputFormat.

Published interface export VideoPipelineAudioLayer.

Published type export VideoPipelineAudioTrack.

Published type export VideoPipelineLayer.

Published interface export VideoPipelineRenderOptions.

Published interface export VideoPipelineRenderResult.

Published interface export VideoPipelineSnapshot.

Published interface export VideoPipelineSourceLayer.

Published interface export VideoPipelineSpliceLayer.

Published interface export VideoPipelineTextLayer.

Published interface export VideoPipelineTrimLayer.

Typed, normalized ffprobe metadata. Raw ffprobe JSON is intentionally not the primary public API.

Published interface export VideoProbeStream.

Published type export VideoQuality.

Published type export VideoSource.

One timed caption using the same styling model as **`createText`** ({@link TextProperties}).

Published interface export VideoTextOverlayOperation.

Strip timeline fields; remainder is valid {@link TextProperties}.

Built-in or custom FFmpeg expression overrides (`t` = seconds).

Enter/exit motion for a {@link VideoTextOverlayClip} on the video timeline. Maps to FFmpeg overlay / alpha expressions (eval=frame).

Published interface export WatermarkToLayersOptions.

Published type export Waveform.