Skip to main content

Interface: StreamLinesOptions

Defined in: mobjects/graphing/VectorField.ts:63

Options for StreamLines

Extends

Properties

arrowSpacing?

optional arrowSpacing: number

Defined in: mobjects/graphing/VectorField.ts:79

Spacing between arrows on streamlines. Default: 1


color?

optional color: string | ColorFunction

Defined in: mobjects/graphing/VectorField.ts:37

Color function or static color. Default: magnitude-based gradient

Inherited from

VectorFieldBaseOptions.color


func

func: VectorFunction

Defined in: mobjects/graphing/VectorField.ts:29

The vector function mapping (x, y) to [vx, vy]

Inherited from

VectorFieldBaseOptions.func


lengthScale?

optional lengthScale: number

Defined in: mobjects/graphing/VectorField.ts:35

Length scaling factor for vectors. Default: 1

Inherited from

VectorFieldBaseOptions.lengthScale


maxAnchorsPerLine?

optional maxAnchorsPerLine: number

Defined in: mobjects/graphing/VectorField.ts:83

Maximum anchor points per line (downsamples if exceeded). Default: 100


maxLineLength?

optional maxLineLength: number

Defined in: mobjects/graphing/VectorField.ts:69

Maximum length of each streamline. Default: 10


maxMagnitude?

optional maxMagnitude: number

Defined in: mobjects/graphing/VectorField.ts:41

Maximum magnitude threshold (vectors are capped). Default: Infinity

Inherited from

VectorFieldBaseOptions.maxMagnitude


minMagnitude?

optional minMagnitude: number

Defined in: mobjects/graphing/VectorField.ts:39

Minimum magnitude threshold (vectors smaller are not drawn). Default: 0

Inherited from

VectorFieldBaseOptions.minMagnitude


minSteps?

optional minSteps: number

Defined in: mobjects/graphing/VectorField.ts:73

Minimum step count before stopping. Default: 3


noiseFactor?

optional noiseFactor: number

Defined in: mobjects/graphing/VectorField.ts:85

Noise added to grid start points. Default: yRange step / 2


nRepeats?

optional nRepeats: number

Defined in: mobjects/graphing/VectorField.ts:89

Number of lines per grid point. Default: 1


numLines?

optional numLines: number

Defined in: mobjects/graphing/VectorField.ts:65

Number of streamlines to draw. Default: 15


opacity?

optional opacity: number

Defined in: mobjects/graphing/VectorField.ts:45

Opacity. Default: 1

Inherited from

VectorFieldBaseOptions.opacity


padding?

optional padding: number

Defined in: mobjects/graphing/VectorField.ts:87

Padding beyond range boundaries for line termination. Default: 3


showArrows?

optional showArrows: boolean

Defined in: mobjects/graphing/VectorField.ts:77

Whether to draw arrows along streamlines. Default: false


startPoints?

optional startPoints: [number, number][]

Defined in: mobjects/graphing/VectorField.ts:67

Starting points for streamlines. If not provided, generated automatically.


stepSize?

optional stepSize: number

Defined in: mobjects/graphing/VectorField.ts:71

Integration step size. Default: 0.05


strokeWidth?

optional strokeWidth: number

Defined in: mobjects/graphing/VectorField.ts:43

Stroke width. Default: DEFAULT_STROKE_WIDTH / 2

Inherited from

VectorFieldBaseOptions.strokeWidth


variableWidth?

optional variableWidth: boolean

Defined in: mobjects/graphing/VectorField.ts:75

Line width variation based on magnitude. Default: false


virtualTime?

optional virtualTime: number

Defined in: mobjects/graphing/VectorField.ts:81

Total virtual time for the simulation. Default: 3


xRange?

optional xRange: [number, number, number]

Defined in: mobjects/graphing/VectorField.ts:31

X range as [min, max, step]. Default: [-5, 5, 0.5]

Inherited from

VectorFieldBaseOptions.xRange


yRange?

optional yRange: [number, number, number]

Defined in: mobjects/graphing/VectorField.ts:33

Y range as [min, max, step]. Default: [-3, 3, 0.5]

Inherited from

VectorFieldBaseOptions.yRange