WritingSystem#

class pymovements.stimulus.WritingSystem(directionality: Literal['left-to-right', 'right-to-left', 'top-to-bottom'] = 'left-to-right', *, axis: Literal['horizontal', 'vertical'] = 'horizontal', lining: Literal['top-to-bottom', 'left-to-right', 'right-to-left'] = 'top-to-bottom')[source]#

Writing system specification for text stimuli.

directionality#

Direction in which text flows within a line. For horizontal text, this is typically ‘left-to-right’ or ‘right-to-left’. For vertical text, this is typically ‘top-to-bottom’. Bidirectional/Boustrophedon scripts (e.g., Arabic with embedded English) is currently not supported. (default: ‘left-to-right’)

Type:

Literal[‘left-to-right’, ‘right-to-left’, ‘top-to-bottom’]

axis#

Primary axis along which text is laid out. (default: ‘horizontal’)

Type:

Literal[‘horizontal’, ‘vertical’]

lining#

Direction in which lines of text are stacked. For horizontal text, this is typically ‘top-to-bottom’. For vertical text, this is typically ‘left-to-right’ or ‘right-to-left’. (default: ‘top-to-bottom’)

Type:

Literal[‘top-to-bottom’, ‘left-to-right’, ‘right-to-left’]

DESCRIPTORS#

Valid descriptor strings for from_descriptor():

  • 'left-to-right', ltr

  • 'right-to-left', rtl

Type:

ClassVar[tuple[str, …]]

Examples

Typical configurations are:

  • Horizontal left-to-right (LTR):

    WritingSystem(
    directionality='left-to-right',
    axis='horizontal',
    lining='top-to-bottom',
)

  • Horizontal right-to-left (RTL):

    WritingSystem(
    directionality='right-to-left',
    axis='horizontal',
    lining='top-to-bottom',
)

  • Vertical right-to-left columns:

    WritingSystem(
    directionality='top-to-bottom',
    axis='vertical',
    lining='right-to-left',
)

  • Vertical left-to-right columns:

    WritingSystem(
    directionality='top-to-bottom',
    axis='vertical',
    lining='left-to-right',
)

Methods

__init__([directionality, axis, lining])

from_descriptor(descriptor)

Create a WritingSystem instance from a descriptor string.

Attributes

DESCRIPTORS

axis

directionality

lining