Type

TextStyle

A title's styling. Sizes are fractions of the frame, so a title made at 1080p exports right at 4K. In a command you send only the fields you change; the rest take these defaults.

Fields

  • alignTextAlignoptional · default "center"

    Line alignment within the block; see TextAlign.

  • backgroundstringoptional · default ""

    A solid background behind the text, #rrggbb[aa]; its alpha is the background's opacity. Empty string for none. The painter and older comments call it the plate.

  • backgroundPaddingXnumberoptional · default 0.0315

    The air between the words and the background's left and right edges, as a fraction of frame height, on an axis the words size themselves: a box with a width is exactly that wide. The default is the air every background had before it was a dial, 35 % of the default size's em.

  • backgroundPaddingYnumberoptional · default 0.018

    The same above and below; 20 % of the default em by default.

  • backgroundRadiusnumberoptional · default 0.0135

    The background's corner radius as a fraction of frame height, so a title composed against 1080p keeps its corners at 4K. The default is the rounding every background wore before it had a dial - 15 % of the default size's em - and zero is square.

  • colorstringoptional · default "#ffffff"

    Fill colour as a CSS hex string, e.g. "#ffffff".

  • contentstringoptional · default "Your text"

    The words themselves, newlines included. The clip's display name is snapshotted from the first non-empty line.

  • fontFamilystringoptional · default "Hanken Grotesk"

    CSS-style family name, quotes included where the name needs them, e.g. "Hanken Grotesk". May name a CustomFont the user added.

  • fontSizenumberoptional · default 0.09

    Cap height as a fraction of frame height.

  • fontWeightnumberoptional · default 700

    CSS-scale weight, 100..=900; the reader clamps hand-edited values into that range.

  • italicbooloptional · default false

    Italic when true. A style flag, not a separate face.

  • lineHeightnumberoptional · default 1.2

    Baseline spacing as a multiple of the font size; the reader floors it at 0.5 so lines cannot collapse onto each other.

  • maxHeightnumberoptional · default 0

    The box's height as a fraction of frame height; the stage's top and bottom grips set it, and the inspector's Height field. Zero - the default - is the words' own height. With a height the block is a box exactly that tall, the words centred in it, so a lower third can be a band of a fixed size whatever is written on it. https://github.com/jub0t/Concat/issues/119

  • maxWidthnumberoptional · default 0

    The widest a line may run, as a fraction of frame width, before its words wrap onto the next; the stage's side grips set it. Zero - the default - is no limit: a line is as long as its words. With a limit the block is a box exactly that wide, plate included, and the lines align inside it.

  • opacitynumberoptional · default 1

    Opacity of the whole title in 0..=1, multiplied with the clip's own opacity.

  • runsTextRun[]optional

    Stretches of the words with a look of their own over the rest of this style - a word in another colour, in bold, bigger. Empty for a title in one look, and then not written at all, so a document without runs is the document it always was and an older build reads a document with them as the title in its own look.

  • shadowbooloptional · default true

    A drop shadow for legibility over footage. On by default.

  • strikethroughbooloptional · default false

    Draw a strike through the text using the selected face's metrics.

  • strokeColorstringoptional · default "#000000"

    Outline colour, only visible when strokeWidth is non-zero.

  • strokeWidthnumberoptional · default 0

    Outline thickness as a fraction of frame height. Zero - the default - means no stroke.

  • textCaseTextCaseoptional · default "original"

    Case is applied for painting; the editable source stays intact.

  • trackingnumberoptional · default 0

    Extra letter spacing, in the same frame-height fractions as fontSize. Zero is the font's natural fit.

  • underlinebooloptional · default false

    Draw an underline using the selected face's metrics.