Skip to main content

Interface: VectorSceneOptions

Defined in: src/core/VectorScene.ts:14

Options for configuring a VectorScene.

Extends​

Properties​

autoRender?​

optional autoRender: boolean

Defined in: src/core/Scene.ts:70

Enable auto-render on add/remove. Defaults to true.

Inherited from​

SceneOptions.autoRender

autoResize?​

optional autoResize: boolean

Defined in: src/core/Scene.ts:81

Automatically resize the canvas when its container (or the window, on mobile rotation) changes size. Only active when both width and height are omitted — passing either dimension is treated as a request for a pinned canvas size, so auto-resize stays off. Defaults to true.

Inherited from​

SceneOptions.autoResize

backgroundColor?​

optional backgroundColor: string

Defined in: src/core/Scene.ts:60

Background color as CSS color string. Defaults to Manim's dark gray (#1C1C1C).

Inherited from​

SceneOptions.backgroundColor

backgroundOpacity?​

optional backgroundOpacity: number

Defined in: src/core/Scene.ts:72

Background opacity (0 = fully transparent, 1 = fully opaque). Defaults to 1. Not supported when exporting to video or GIF formats.

Inherited from​

SceneOptions.backgroundOpacity

frameHeight?​

optional frameHeight: number

Defined in: src/core/Scene.ts:64

Frame height in world units. Defaults to 8 (Manim standard).

Inherited from​

SceneOptions.frameHeight

frameWidth?​

optional frameWidth: number

Defined in: src/core/Scene.ts:62

Frame width in world units. Defaults to 14 (Manim standard).

Inherited from​

SceneOptions.frameWidth

frustumCulling?​

optional frustumCulling: boolean

Defined in: src/core/Scene.ts:68

Enable frustum culling optimization. Defaults to true.

Inherited from​

SceneOptions.frustumCulling

headless?​

optional headless: boolean

Defined in: src/core/Scene.ts:74

Enable headless mode (no WebGL renderer). Useful for testing scene logic without a DOM.

Inherited from​

SceneOptions.headless

height?​

optional height: number

Defined in: src/core/Scene.ts:58

Canvas height in pixels. Defaults to container height.

Inherited from​

SceneOptions.height

iColor?​

optional iColor: string

Defined in: src/core/VectorScene.ts:26

Color for the i basis vector. Defaults to green.

jColor?​

optional jColor: string

Defined in: src/core/VectorScene.ts:28

Color for the j basis vector. Defaults to red.

showBasisVectors?​

optional showBasisVectors: boolean

Defined in: src/core/VectorScene.ts:30

Whether to show basis vectors on creation. Defaults to false.

showPlane?​

optional showPlane: boolean

Defined in: src/core/VectorScene.ts:16

Whether to show the coordinate plane by default. Defaults to true.

targetFps?​

optional targetFps: number

Defined in: src/core/Scene.ts:66

Target frame rate in fps. Defaults to 60.

Inherited from​

SceneOptions.targetFps

width?​

optional width: number

Defined in: src/core/Scene.ts:56

Canvas width in pixels. Defaults to container width.

Inherited from​

SceneOptions.width

xLength?​

optional xLength: number

Defined in: src/core/VectorScene.ts:22

Visual length of the x-axis. Defaults to 10.

xRange?​

optional xRange: [number, number, number]

Defined in: src/core/VectorScene.ts:18

X-axis range as [min, max, step]. Defaults to [-5, 5, 1].

yLength?​

optional yLength: number

Defined in: src/core/VectorScene.ts:24

Visual length of the y-axis. Defaults to 6.

yRange?​

optional yRange: [number, number, number]

Defined in: src/core/VectorScene.ts:20

Y-axis range as [min, max, step]. Defaults to [-3, 3, 1].