LineSegment

class indicatortools.LineSegment(arrow_width=None, dash_fraction=None, dash_period=None, left_broken_padding=None, left_broken_text=None, left_hspace=None, left_padding=None, left_stencil_align_direction_y=None, right_arrow=None, right_broken_arrow=None, right_broken_padding=None, right_padding=None, right_stencil_align_direction_y=None, style=None)

Line segment.

>>> import abjad

Line segments format as text spanners.

Default line segment:

>>> line_segment = abjad.LineSegment()
>>> f(line_segment)
LineSegment()

Todo

Add examples.

Use line segments to start a markup-terminated text spanner.

Lineage

digraph InheritanceGraph { graph [background=transparent, bgcolor=transparent, color=lightslategrey, fontname=Arial, outputorder=edgesfirst, overlap=prism, penwidth=2, rankdir=LR, root="__builtin__.object", splines=spline, style="dotted, rounded", truecolor=true]; node [colorscheme=pastel19, fontname=Arial, fontsize=12, penwidth=2, style="filled, rounded"]; edge [color=lightsteelblue2, penwidth=2]; subgraph cluster_abctools { graph [label=abctools]; "abjad.tools.abctools.AbjadObject.AbjadObject" [color=1, group=0, label=AbjadObject, shape=box]; "abjad.tools.abctools.AbjadObject.AbstractBase" [color=1, group=0, label=AbstractBase, shape=box]; "abjad.tools.abctools.AbjadValueObject.AbjadValueObject" [color=1, group=0, label=AbjadValueObject, shape=box]; "abjad.tools.abctools.AbjadObject.AbjadObject" -> "abjad.tools.abctools.AbjadValueObject.AbjadValueObject"; "abjad.tools.abctools.AbjadObject.AbstractBase" -> "abjad.tools.abctools.AbjadObject.AbjadObject"; } subgraph cluster_indicatortools { graph [label=indicatortools]; "abjad.tools.indicatortools.ArrowLineSegment.ArrowLineSegment" [color=3, group=2, label=ArrowLineSegment, shape=box]; "abjad.tools.indicatortools.LineSegment.LineSegment" [color=black, fontcolor=white, group=2, label=<<B>LineSegment</B>>, shape=box, style="filled, rounded"]; "abjad.tools.indicatortools.LineSegment.LineSegment" -> "abjad.tools.indicatortools.ArrowLineSegment.ArrowLineSegment"; } subgraph cluster_builtins { graph [label=builtins]; "builtins.object" [color=2, group=1, label=object, shape=box]; } "abjad.tools.abctools.AbjadValueObject.AbjadValueObject" -> "abjad.tools.indicatortools.LineSegment.LineSegment"; "builtins.object" -> "abjad.tools.abctools.AbjadObject.AbstractBase"; }

Bases

Attribute summary

arrow_width Gets arrow width of line segment.
dash_fraction Gets dash fraction of line segment.
dash_period Gets dash period of line segment.
left_broken_padding Gets left broken padding of line segment.
left_broken_text Gets left broken text of line segment.
left_hspace Gets left hspace of line segment.
left_padding Gets left padding of line segment.
left_stencil_align_direction_y Gets left stencil align direction Y of line segment.
right_arrow Is true when right end of line segment carries an arrow.
right_broken_arrow Gets right broken arrow of line segment.
right_broken_padding Gets right broken padding of line segment.
right_padding Gets right padding of line segment.
right_stencil_align_direction_y Gets right stencil align direction Y of line segment.
style Gets style of line segment.
__copy__(*arguments) Copies Abjad value object.
__eq__(argument) Is true when all initialization values of Abjad value object equal the initialization values of argument.
__format__([format_specification]) Formats Abjad object.
__hash__() Hashes Abjad value object.
__ne__(argument) Is true when Abjad object does not equal argument.
__repr__() Gets interpreter representation of Abjad object.

Read-only properties

LineSegment.arrow_width

Gets arrow width of line segment.

Returns float or none.

LineSegment.dash_fraction

Gets dash fraction of line segment.

Returns float or none.

LineSegment.dash_period

Gets dash period of line segment.

Returns float or none.

LineSegment.left_broken_padding

Gets left broken padding of line segment.

Returns float or none.

LineSegment.left_broken_text

Gets left broken text of line segment.

Returns markup, false or none.

LineSegment.left_hspace

Gets left hspace of line segment.

Returns float or none.

LineSegment.left_padding

Gets left padding of line segment.

Returns float or none.

LineSegment.left_stencil_align_direction_y

Gets left stencil align direction Y of line segment.

Returns float or none.

LineSegment.right_arrow

Is true when right end of line segment carries an arrow. Otherwise false.

Returns true, false or none.

LineSegment.right_broken_arrow

Gets right broken arrow of line segment.

Returns float or none.

LineSegment.right_broken_padding

Gets right broken padding of line segment.

Returns float or none.

LineSegment.right_padding

Gets right padding of line segment.

Returns float or none.

LineSegment.right_stencil_align_direction_y

Gets right stencil align direction Y of line segment.

Returns float or none.

LineSegment.style

Gets style of line segment.

Returns string or none.

Special methods

(AbjadValueObject).__copy__(*arguments)

Copies Abjad value object.

Returns new Abjad value object.

(AbjadValueObject).__eq__(argument)

Is true when all initialization values of Abjad value object equal the initialization values of argument.

Returns true or false.

(AbjadObject).__format__(format_specification='')

Formats Abjad object.

Set format_specification to ‘’ or ‘storage’. Interprets ‘’ equal to ‘storage’.

Returns string.

(AbjadValueObject).__hash__()

Hashes Abjad value object.

Returns integer.

(AbjadObject).__ne__(argument)

Is true when Abjad object does not equal argument. Otherwise false.

Returns true or false.

(AbjadObject).__repr__()

Gets interpreter representation of Abjad object.

Returns string.