class Latex extends SVG
A node for animating equations with LaTeX.
import ...
export default makeScene2D(function* (view) {
const tex = createRef<Latex>();
view.add(<Latex ref={tex} tex="{{y=}}{{a}}{{x^2}}" fill="white" />);
yield* waitFor(0.2);
yield* tex().tex('{{y=}}{{a}}{{x^2}} + {{bx}}', 1);
yield* waitFor(0.2);
yield* tex().tex(
'{{y=}}{{\\left(}}{{a}}{{x^2}} + {{bx}}{{\\over 1}}{{\\right)}}',
1,
);
yield* waitFor(0.2);
yield* tex().tex('{{y=}}{{a}}{{x^2}}', 1);
});
Constructors
constructor
Parameters
props: LatexProps
SVG.constructorProperties
absolutePosition
readonly public absolutePosition: SimpleVector2SignalLatex
A helper signal for operating on the position in world space.
Retrieving the position using this signal returns the position in world space. Similarly, setting the position using this signal transforms the new value to local space.
If the new value is a function, the position of this node will be continuously updated to always match the position returned by the function. This can be useful to "pin" the node in a specific place or to make it follow another node's position.
Unlike position, this signal is not compound - it doesn't contain
separate signals for the x and y components.
SVG.absolutePositionabsoluteRotation
readonly public absoluteRotation: SimpleSignalnumberLatex
A helper signal for operating on the rotation in world space.
Retrieving the rotation using this signal returns the rotation in world space. Similarly, setting the rotation using this signal transforms the new value to local space.
If the new value is a function, the rotation of this node will be continuously updated to always match the rotation returned by the function.
Inherited fromSVG.absoluteRotationabsoluteScale
readonly public absoluteScale: SimpleVector2SignalLatex
A helper signal for operating on the scale in world space.
Retrieving the scale using this signal returns the scale in world space. Similarly, setting the scale using this signal transforms the new value to local space.
If the new value is a function, the scale of this node will be continuously updated to always match the position returned by the function.
Unlike scale, this signal is not compound - it doesn't contain
separate signals for the x and y components.
SVG.absoluteScalealignContent
readonly public alignContent: SimpleSignalFlexContentLatex
SVG.alignContentalignItems
readonly public alignItems: SimpleSignalFlexItemsLatex
SVG.alignItemsalignSelf
readonly public alignSelf: SimpleSignalFlexItemsLatex
SVG.alignSelfantialiased
readonly public antialiased: SimpleSignalbooleanLatex
SVG.antialiasedbasis
readonly public basis: SimpleSignalFlexBasisLatex
SVG.basisbottom
readonly public bottom: SimpleVector2SignalLatex
The position of the bottom edge of this node.
When set, this shortcut property will modify the node's position so that the bottom edge ends up in the given place.
When retrieved, it will return the position of the bottom edge in the parent space.
Inherited fromSVG.bottombottomLeft
readonly public bottomLeft: SimpleVector2SignalLatex
The position of the bottom left corner of this node.
When set, this shortcut property will modify the node's position so that the bottom left corner ends up in the given place.
When retrieved, it will return the position of the bottom left corner in the parent space.
Inherited fromSVG.bottomLeftbottomRight
readonly public bottomRight: SimpleVector2SignalLatex
The position of the bottom right corner of this node.
When set, this shortcut property will modify the node's position so that the bottom right corner ends up in the given place.
When retrieved, it will return the position of the bottom right corner in the parent space.
Inherited fromSVG.bottomRightcache
readonly public cache: SimpleSignalbooleanLatex
SVG.cachecachePadding
readonly public cachePadding: SpacingSignalLatex
Controls the padding of the cached canvas used by this node.
By default, the size of the cache is determined based on the bounding box
of the node and its children. That includes effects such as stroke or
shadow. This property can be used to expand the cache area further.
Usually used to account for custom effects created by shaders.
SVG.cachePaddingchildren
readonly public children: SignalComponentChildrenNode[]LatexSignalContextComponentChildrenNode[]Latex
SVG.childrenclip
readonly public clip: SimpleSignalbooleanLatex
SVG.clipcomposite
readonly public composite: SimpleSignalbooleanLatex
SVG.compositecompositeOperation
readonly public compositeOperation: SimpleSignalGlobalCompositeOperationLatex
SVG.compositeOperationcreationStack
readonly public creationStack?: string
SVG.creationStackdirection
readonly public direction: SimpleSignalFlexDirectionLatex
SVG.directionelement
public element: HTMLElement
SVG.elementfill
readonly public fill: CanvasStyleSignalLatex
SVG.fillfilters
readonly public filters: FiltersSignalLatex
SVG.filtersfontFamily
readonly public fontFamily: SimpleSignalstringLatex
SVG.fontFamilyfontSize
readonly public fontSize: SimpleSignalnumberLatex
SVG.fontSizefontStyle
readonly public fontStyle: SimpleSignalstringLatex
SVG.fontStylefontWeight
readonly public fontWeight: SimpleSignalnumberLatex
SVG.fontWeightgap
readonly public gap: Vector2LengthSignalLatex
SVG.gapgrow
readonly public grow: SimpleSignalnumberLatex
SVG.growisClass
public isClass: boolean
SVG.isClassjustifyContent
readonly public justifyContent: SimpleSignalFlexContentLatex
SVG.justifyContentkey
readonly public key: string
SVG.keylayout
readonly public layout: SimpleSignalLayoutModeLatex
SVG.layoutleft
readonly public left: SimpleVector2SignalLatex
The position of the left edge of this node.
When set, this shortcut property will modify the node's position so that the left edge ends up in the given place.
When retrieved, it will return the position of the left edge in the parent space.
Inherited fromSVG.leftletterSpacing
readonly public letterSpacing: SimpleSignalnumberLatex
SVG.letterSpacinglineCap
readonly public lineCap: SimpleSignalCanvasLineCapLatex
SVG.lineCaplineDash
readonly public lineDash: SimpleSignalnumber[]Latex
SVG.lineDashlineDashOffset
readonly public lineDashOffset: SimpleSignalnumberLatex
SVG.lineDashOffsetlineHeight
readonly public lineHeight: SimpleSignalLengthLatex
SVG.lineHeightlineJoin
readonly public lineJoin: SimpleSignalCanvasLineJoinLatex
SVG.lineJoinlineWidth
readonly public lineWidth: SimpleSignalnumberLatex
SVG.lineWidthmargin
readonly public margin: SpacingSignalLatex
SVG.marginmaxHeight
readonly public maxHeight: SimpleSignalLengthLimitLatex
SVG.maxHeightmaxWidth
readonly public maxWidth: SimpleSignalLengthLimitLatex
SVG.maxWidthmiddle
readonly public middle: SimpleVector2SignalLatex
The position of the center of this node.
When set, this shortcut property will modify the node's position so that the center ends up in the given place.
If the offset has not been changed, this will be the same as the
position.
When retrieved, it will return the position of the center in the parent space.
Inherited fromSVG.middleminHeight
readonly public minHeight: SimpleSignalLengthLimitLatex
SVG.minHeightminWidth
readonly public minWidth: SimpleSignalLengthLimitLatex
SVG.minWidthoffset
readonly public offset: Vector2SignalLatex
Represents the offset of this node's origin.
By default, the origin of a node is located at its center. The origin serves as the pivot point when rotating and scaling a node, but it doesn't affect the placement of its children.
The value is relative to the size of this node. A value of 1 means as far
to the right/bottom as possible. Here are a few examples of offsets:
[-1, -1]- top left corner[1, -1]- top right corner[0, 1]- bottom edge[-1, 1]- bottom left corner
SVG.offsetopacity
readonly public opacity: SimpleSignalnumberLatex
Represents the opacity of this node in the range 0-1.
The value is clamped to the range 0-1.
Inherited fromSVG.opacityoptions
readonly public options: SimpleSignalOptionListLatex
padding
readonly public padding: SpacingSignalLatex
SVG.paddingparent
readonly public parent: SimpleSignalnullNodevoid = ...
SVG.parentposition
readonly public position: Vector2SignalLatex
Represents the position of this node in local space of its parent.
Examples
Inherited fromSVG.positionproperties
readonly public properties: RecordstringPropertyMetadataany = ...
SVG.propertiesratio
readonly public ratio: SimpleSignalnullnumberLatex
SVG.ratioright
readonly public right: SimpleVector2SignalLatex
The position of the right edge of this node.
When set, this shortcut property will modify the node's position so that the right edge ends up in the given place.
When retrieved, it will return the position of the right edge in the parent space.
Inherited fromSVG.rightrotation
readonly public rotation: SimpleSignalnumberLatex
Represents the rotation (in degrees) of this node relative to its parent.
Inherited fromSVG.rotationscale
readonly public scale: Vector2SignalLatex
Represents the scale of this node in local space of its parent.
Examples
Inherited fromSVG.scaleshaders
readonly public shaders: SignalPossibleShaderConfigShaderConfig[]LatexSignalContextPossibleShaderConfigShaderConfig[]Latex
SVG.shadersshadowBlur
readonly public shadowBlur: SimpleSignalnumberLatex
SVG.shadowBlurshadowColor
readonly public shadowColor: ColorSignalLatex
SVG.shadowColorshadowOffset
readonly public shadowOffset: Vector2SignalLatex
SVG.shadowOffsetshrink
readonly public shrink: SimpleSignalnumberLatex
SVG.shrinksize
readonly public size: Vector2LengthSignalLatex
Represents the size of this node.
A size is a two-dimensional vector, where x represents the width, and y
represents the height.
The value of both x and y is of type Length which is
either:
number- the desired length in pixels${number}%- a string with the desired length in percents, for example'50%'null- an automatic length
When retrieving the size, all units are converted to pixels, using the
current state of the layout. For example, retrieving the width set to
'50%', while the parent has a width of 200px will result in the number
100 being returned.
When the node is not part of the layout, setting its size using percents refers to the size of the entire scene.
Examples
Inherited fromSVG.sizeskew
readonly public skew: Vector2SignalLatex
Represents the skew of this node in local space of its parent.
Examples
Inherited fromSVG.skewstroke
readonly public stroke: CanvasStyleSignalLatex
SVG.strokestrokeFirst
readonly public strokeFirst: SimpleSignalbooleanLatex
SVG.strokeFirststyles
public styles: CSSStyleDeclaration
SVG.stylessvg
readonly public svg: SimpleSignalstringLatex
SVG string to be rendered
Inherited fromSVG.svgtex
readonly public tex: Signalstringstring[]string[]LatexSignalContextstringstring[]string[]Latex
textAlign
readonly public textAlign: SimpleSignalCanvasTextAlignLatex
SVG.textAligntextDirection
readonly public textDirection: SimpleSignalCanvasDirectionLatex
SVG.textDirectiontextWrap
readonly public textWrap: SimpleSignalTextWrapLatex
SVG.textWraptop
readonly public top: SimpleVector2SignalLatex
The position of the top edge of this node.
When set, this shortcut property will modify the node's position so that the top edge ends up in the given place.
When retrieved, it will return the position of the top edge in the parent space.
Inherited fromSVG.toptopLeft
readonly public topLeft: SimpleVector2SignalLatex
The position of the top left corner of this node.
When set, this shortcut property will modify the node's position so that the top left corner ends up in the given place.
When retrieved, it will return the position of the top left corner in the parent space.
Inherited fromSVG.topLefttopRight
readonly public topRight: SimpleVector2SignalLatex
The position of the top right corner of this node.
When set, this shortcut property will modify the node's position so that the top right corner ends up in the given place.
When retrieved, it will return the position of the top right corner in the parent space.
Inherited fromSVG.topRightwrap
readonly public wrap: SimpleSignalFlexWrapLatex
SVG.wrapwrapper
public wrapper: Node
Child to wrap all SVG node
Inherited fromSVG.wrapperzIndex
readonly public zIndex: SimpleSignalnumberLatex
SVG.zIndexAccessors
columnGap
public get columnGap(): SignalLengthnumberthisSignalContextLengthnumberthis
SVG.columnGapheight
public get height(): SignalLengthnumberthisSignalContextLengthnumberthis
SVG.heightrowGap
public get rowGap(): SignalLengthnumberthisSignalContextLengthnumberthis
SVG.rowGapwidth
public get width(): SignalLengthnumberthisSignalContextLengthnumberthis
SVG.widthx
public get x(): SimpleSignalnumberthis
SVG.xy
public get y(): SimpleSignalnumberthis
SVG.yMethods
[iterator]
public [iterator](): Generatorkey: stringmeta: PropertyMetadataanysignal: SimpleSignalanyvoidunknown
SVG.[iterator]