标记文本

合格名称：manim.mobject.text.text\_mobject.MarkupText

class MarkupText(text, fill_opacity=1, stroke_width=0, color=None, font_size=48, line_spacing=- 1, font='', slant='NORMAL', weight='NORMAL', justify=False, gradient=None, tab_width=4, height=None, width=None, should_center=True, disable_ligatures=False, warn_missing_font=True, **kwargs)

Bases: SVGMobject

显示使用 Pango渲染的（非 LaTeX）文本。

文本对象的行为类似于VGroup给定文本中所有字符的类似迭代。特别地，切片是可能的。

什么是 PangoMarkup？

PangoMarkup 是一种类似于 html 的小型标记语言，它可以帮助您在对文本片段进行着色或设计样式时避免使用“字符范围”。您可以将这种语言与MarkupText.

标记字符串的一个简单示例可能是：

<span foreground="blue" size="x-large">Blue text</span> is <i>cool</i>!"

它可以与MarkupTextas 一起使用

示例：标记示例

from manim import *

class MarkupExample(Scene):
    def construct(self):
        text = MarkupText('<span foreground="blue" size="x-large">Blue text</span> is <i>cool</i>!"')
        self.add(text)

一个更详细的例子是：

示例：MarkupElaborateExample

from manim import *

class MarkupElaborateExample(Scene):
    def construct(self):
        text = MarkupText(
            '<span foreground="purple">ا</span><span foreground="red">َ</span>'
            'ل<span foreground="blue">ْ</span>ع<span foreground="red">َ</span>ر'
            '<span foreground="red">َ</span>ب<span foreground="red">ِ</span>ي'
            '<span foreground="green">ّ</span><span foreground="red">َ</span>ة'
            '<span foreground="blue">ُ</span>'
        )
        self.add(text)

PangoMarkup 还可以包含 XML 功能，例如数字字符实体，例如©也可以使用 for ©。

最通用的标记是<span>，然后还有一些便利标记。

以下是支持的标签列表：

• <b>bold</b>,<i>italic</i>和<b><i>bold+italic</i></b>
• <ul>underline</ul>和<s>strike through</s>
• <tt>typewriter font</tt>
• <big>bigger font</big>和<small>smaller font</small>
• <sup>superscript</sup>和<sub>subscript</sub>
• <span underline="double" underline_color="green">double underline</span>
• <span underline="error">error underline</span>
• <span overline="single" overline_color="green">overline</span>
• <span strikethrough="true" strikethrough_color="red">strikethrough</span>
• <span font_family="sans">temporary change of font</span>
• <span foreground="red">temporary change of color</span>
• <span fgcolor="red">temporary change of color</span>
• <gradient from="YELLOW" to="RED">temporary gradient</gradient>

对于<span>标记，颜色可以指定为十六进制三元组，如#aabbcc或命名为 CSS 颜色，如 AliceBlue. 该<gradient>标签由 Manim 而不是 Pango 处理，并支持十六进制三元组或 Manim 常量，例如 RED或RED_A。RED_A如果你想像 with 一样使用 Manim 常量<span>，则需要使用 Python 的 f-String 语法，如下所示：

MarkupText(f'<span foreground="{RED_A}">here you go</span>')

如果您的文本包含连字，则MarkupTextClass在创建渐变时可能会错误地确定第一个和最后一个字母。这是因为它们fl是两个单独的字符，但可以设置为一个字形 - 连字。如果您的语言不依赖于连字，请考虑设置disable_ligatures 为True。如果必须使用连字，则gradient标记支持可选属性offset，可用于补偿该错误。

例如：

• <gradient from="RED" to="YELLOW" offset="1">example</gradient>提前一个字母开始渐变
• <gradient from="RED" to="YELLOW" offset=",1">example</gradient>提前一个字母结束渐变
• <gradient from="RED" to="YELLOW" offset="2,1">example</gradient>提前两个字母开始渐变并提前一个字母结束

如果要着色的文本本身包含连字，则可能需要指定第二个偏移量。当使用 HTML 实体表示特殊字符时，也会发生同样的情况。

当使用underline,overline或strikethrough与 <gradient>标签一起使用时，您还需要使用偏移量，因为下划线是最终SVGMobject. 查看以下示例。

特殊字符的转义：> 应写为> while<且& 必须写为<and &。

您可以在相应的文档页面找到有关 Pango 标记格式的更多信息： Pango Markup。请注意，并非该类支持所有功能，并且<gradient>Pango 不支持上述标签。

参数

• text ( str ) – 需要创建为 mobject 的文本。
• fill_opacity ( float ) – 填充不透明度，1 表示不透明，0 表示透明。
• stroke_width( float ) – 描边宽度。
• font_size ( float ) – 字体大小。
• line_spacing ( int ) – 行间距。
• font ( str ) – 整个文本的全局字体设置。本地覆盖是可能的。
• slant ( str ) – 全局倾斜设置，例如 NORMAL 或 ITALIC。本地覆盖是可能的。
• weight( str ) – 全局权重设置，例如 NORMAL 或 BOLD。本地覆盖是可能的。
• gradient( tuple ) – 全局梯度设置。本地覆盖是可能的。
• warn_missing_font ( _bool ) – 如果为 True （默认），如果从_manimpango.list_fonts()返回的字体（区分大小写）列表中不存在该字体，Manim 将发出警告。
• color（Color|None）–
• justify( bool ) –
• tab_width ( int ) –
• height( int ) –
• width( int ) –
• should_center (bool) –
• disable_ligatures( bool ) –

返回

文本以VGroup类似 mobject 的形式显示。

返回类型

MarkupText

例子

示例：BasicMarkupExample

from manim import *

class BasicMarkupExample(Scene):
    def construct(self):
        text1 = MarkupText("<b>foo</b> <i>bar</i> <b><i>foobar</i></b>")
        text2 = MarkupText("<s>foo</s> <u>bar</u> <big>big</big> <small>small</small>")
        text3 = MarkupText("H<sub>2</sub>O and H<sub>3</sub>O<sup>+</sup>")
        text4 = MarkupText("type <tt>help</tt> for help")
        text5 = MarkupText(
            '<span underline="double">foo</span> <span underline="error">bar</span>'
        )
        group = VGroup(text1, text2, text3, text4, text5).arrange(DOWN)
        self.add(group)

示例：颜色示例

from manim import *

class ColorExample(Scene):
    def construct(self):
        text1 = MarkupText(
            f'all in red <span fgcolor="{YELLOW}">except this</span>', color=RED
        )
        text2 = MarkupText("nice gradient", gradient=(BLUE, GREEN))
        text3 = MarkupText(
            'nice <gradient from="RED" to="YELLOW">intermediate</gradient> gradient',
            gradient=(BLUE, GREEN),
        )
        text4 = MarkupText(
            'fl ligature <gradient from="RED" to="YELLOW">causing trouble</gradient> here'
        )
        text5 = MarkupText(
            'fl ligature <gradient from="RED" to="YELLOW" offset="1">defeated</gradient> with offset'
        )
        text6 = MarkupText(
            'fl ligature <gradient from="RED" to="YELLOW" offset="1">floating</gradient> inside'
        )
        text7 = MarkupText(
            'fl ligature <gradient from="RED" to="YELLOW" offset="1,1">floating</gradient> inside'
        )
        group = VGroup(text1, text2, text3, text4, text5, text6, text7).arrange(DOWN)
        self.add(group)

示例：下划线示例

from manim import *

class UnderlineExample(Scene):
    def construct(self):
        text1 = MarkupText(
            '<span underline="double" underline_color="green">bla</span>'
        )
        text2 = MarkupText(
            '<span underline="single" underline_color="green">xxx</span><gradient from="#ffff00" to="RED">aabb</gradient>y'
        )
        text3 = MarkupText(
            '<span underline="single" underline_color="green">xxx</span><gradient from="#ffff00" to="RED" offset="-1">aabb</gradient>y'
        )
        text4 = MarkupText(
            '<span underline="double" underline_color="green">xxx</span><gradient from="#ffff00" to="RED">aabb</gradient>y'
        )
        text5 = MarkupText(
            '<span underline="double" underline_color="green">xxx</span><gradient from="#ffff00" to="RED" offset="-2">aabb</gradient>y'
        )
        group = VGroup(text1, text2, text3, text4, text5).arrange(DOWN)
        self.add(group)

示例：字体示例

from manim import *

class FontExample(Scene):
    def construct(self):
        text1 = MarkupText(
            'all in sans <span font_family="serif">except this</span>', font="sans"
        )
        text2 = MarkupText(
            '<span font_family="serif">mixing</span> <span font_family="sans">fonts</span> <span font_family="monospace">is ugly</span>'
        )
        text3 = MarkupText("special char > or &gt;")
        text4 = MarkupText("special char &lt; and &amp;")
        group = VGroup(text1, text2, text3, text4).arrange(DOWN)
        self.add(group)

示例：换行示例

from manim import *

class NewlineExample(Scene):
    def construct(self):
        text = MarkupText('foooo<span foreground="red">oo\nbaa</span>aar')
        self.add(text)

示例：NoLigaturesExample

from manim import *

class NoLigaturesExample(Scene):
    def construct(self):
        text1 = MarkupText('fl<gradient from="RED" to="GREEN">oat</gradient>ing')
        text2 = MarkupText('fl<gradient from="RED" to="GREEN">oat</gradient>ing', disable_ligatures=True)
        group = VGroup(text1, text2).arrange(DOWN)
        self.add(group)

由于MarkupText使用 Pango 渲染文本，渲染非英文字符是很容易的：

示例：多语言

from manim import *

class MultiLanguage(Scene):
    def construct(self):
        morning = MarkupText("வணக்கம்", font="sans-serif")
        japanese = MarkupText(
            '<span fgcolor="blue">日本</span>へようこそ'
        )  # works as in ``Text``.
        mess = MarkupText("Multi-Language", weight=BOLD)
        russ = MarkupText("Здравствуйте मस नम म ", font="sans-serif")
        hin = MarkupText("नमस्ते", font="sans-serif")
        chinese = MarkupText("臂猿「黛比」帶著孩子", font="sans-serif")
        group = VGroup(morning, japanese, mess, russ, hin, chinese).arrange(DOWN)
        self.add(group)

您可以通过传递参数来调整文本justify。

示例：对齐文本

from manim import *

class JustifyText(Scene):
    def construct(self):
        ipsum_text = (
            "Lorem ipsum dolor sit amet, consectetur adipiscing elit."
            "Praesent feugiat metus sit amet iaculis pulvinar. Nulla posuere "
            "quam a ex aliquam, eleifend consectetur tellus viverra. Aliquam "
            "fermentum interdum justo, nec rutrum elit pretium ac. Nam quis "
            "leo pulvinar, dignissim est at, venenatis nisi."
        )
        justified_text = MarkupText(ipsum_text, justify=True).scale(0.4)
        not_justified_text = MarkupText(ipsum_text, justify=False).scale(0.4)
        just_title = Title("Justified")
        njust_title = Title("Not Justified")
        self.add(njust_title, not_justified_text)
        self.play(
            FadeOut(not_justified_text),
            FadeIn(justified_text),
            FadeOut(njust_title),
            FadeIn(just_title),
        )
        self.wait(1)

测试

检查作品创作情况MarkupText：

>>> MarkupText('The horse does not eat cucumber salad.')
MarkupText('The horse does not eat cucumber salad.')

方法

属性

animate	用于对 的任何方法的应用程序进行动画处理self。
animation_overrides
color
depth	对象的深度。
fill_color	如果有多种颜色（对于渐变），则返回第一个颜色
font_size
hash_seed	表示生成的对象点结果的唯一哈希值。
height	mobject 的高度。
n_points_per_curve
sheen_factor
stroke_color
width	mobject 的宽度。