Line class

This page explains the Line class.

What class is this?

The Line class creates a straight-line vector graphics object.

Basic usage

The Line class constructor requires the start_point and end_point arguments.

The constructor also accepts each style’s argument, such as the line_color.

import apysc as ap

ap.Stage(
    background_color=ap.Color("#333"),
    stage_width=200,
    stage_height=100,
    stage_elem_id="stage",
)
line: ap.Line = ap.Line(
    start_point=ap.Point2D(x=50, y=50),
    end_point=ap.Point2D(x=150, y=50),
    line_color=ap.Color("#0af"),
    line_thickness=5,
)

ap.save_overall_html(dest_dir_path="line_basic_usage/")

Note of the draw_line or other interfaces

You can also create a line instance with the draw_line interface (or the other interfaces, such as the draw_dotted_line).

Please see also:

x property interface example

The x property updates or gets the instance’s x-coordinate:

import apysc as ap

ap.Stage(
    background_color=ap.Color("#333"),
    stage_width=200,
    stage_height=100,
    stage_elem_id="stage",
)
line: ap.Line = ap.Line(
    start_point=ap.Point2D(x=50, y=50),
    end_point=ap.Point2D(x=150, y=50),
    line_color=ap.Color("#0af"),
    line_thickness=5,
)
line.x = ap.Number(100)

ap.save_overall_html(dest_dir_path="line_x/")

Notes: This attribute’s value becomes the same as the arguments’ minimum point value.

y property interface example

The y property updates or gets the instance’s y-coordinate:

import apysc as ap

ap.Stage(
    background_color=ap.Color("#333"),
    stage_width=200,
    stage_height=100,
    stage_elem_id="stage",
)
line: ap.Line = ap.Line(
    start_point=ap.Point2D(x=50, y=50),
    end_point=ap.Point2D(x=150, y=50),
    line_color=ap.Color("#0af"),
    line_thickness=5,
)
line.y = ap.Number(80)

ap.save_overall_html(dest_dir_path="line_y/")

Notes: This attribute’s value becomes the same as the arguments’ minimum point value.

line_color property interface example

The line_color property updates or gets the instance’s line color:

import apysc as ap

ap.Stage(
    background_color=ap.Color("#333"),
    stage_width=200,
    stage_height=100,
    stage_elem_id="stage",
)
line: ap.Line = ap.Line(
    start_point=ap.Point2D(x=50, y=50),
    end_point=ap.Point2D(x=150, y=50),
    line_thickness=5,
)
line.line_color = ap.Color("#f0a")

ap.save_overall_html(dest_dir_path="line_line_color/")

line_alpha property interface example

The line_alpha property updates or gets the instance’s line alpha (opacity):

import apysc as ap

ap.Stage(
    background_color=ap.Color("#333"),
    stage_width=200,
    stage_height=100,
    stage_elem_id="stage",
)
line: ap.Line = ap.Line(
    start_point=ap.Point2D(x=50, y=50),
    end_point=ap.Point2D(x=150, y=50),
    line_color=ap.Color("#0af"),
    line_thickness=5,
)
line.line_alpha = ap.Number(0.3)

ap.save_overall_html(dest_dir_path="line_line_alpha/")

line_thickness property interface example

The line_thickness property updates or gets the instance’s line thickness (line width):

import apysc as ap

ap.Stage(
    background_color=ap.Color("#333"),
    stage_width=200,
    stage_height=100,
    stage_elem_id="stage",
)
line: ap.Line = ap.Line(
    start_point=ap.Point2D(x=50, y=50),
    end_point=ap.Point2D(x=150, y=50),
    line_color=ap.Color("#0af"),
)
line.line_thickness = ap.Int(10)

ap.save_overall_html(dest_dir_path="line_line_thickness/")

line_dot_setting property interface example

The line_dot_setting property updates or gets the instance’s line dot-style setting:

import apysc as ap

ap.Stage(
    background_color=ap.Color("#333"),
    stage_width=200,
    stage_height=100,
    stage_elem_id="stage",
)
line: ap.Line = ap.Line(
    start_point=ap.Point2D(x=50, y=50),
    end_point=ap.Point2D(x=150, y=50),
    line_color=ap.Color("#0af"),
    line_thickness=3,
)
line.line_dot_setting = ap.LineDotSetting(dot_size=3)

ap.save_overall_html(dest_dir_path="line_line_dot_setting/")

line_dash_setting property interface example

The line_dash_setting property updates or gets the instance’s line dash-style setting:

import apysc as ap

ap.Stage(
    background_color=ap.Color("#333"),
    stage_width=200,
    stage_height=100,
    stage_elem_id="stage",
)
line: ap.Line = ap.Line(
    start_point=ap.Point2D(x=50, y=50),
    end_point=ap.Point2D(x=150, y=50),
    line_color=ap.Color("#0af"),
    line_thickness=3,
)
line.line_dash_setting = ap.LineDashSetting(dash_size=6, space_size=2)

ap.save_overall_html(dest_dir_path="line_line_dash_setting/")

line_round_dot_setting property interface example

The line_round_dot_setting property updates or gets the instance’s line-round dot-style setting:

import apysc as ap

ap.Stage(
    background_color=ap.Color("#333"),
    stage_width=200,
    stage_height=100,
    stage_elem_id="stage",
)
line: ap.Line = ap.Line(
    start_point=ap.Point2D(x=50, y=50),
    end_point=ap.Point2D(x=150, y=50),
    line_color=ap.Color("#0af"),
)
line.line_round_dot_setting = ap.LineRoundDotSetting(round_size=5, space_size=3)

ap.save_overall_html(dest_dir_path="line_line_round_dot_setting/")

line_dash_dot_setting property interface example

The line_dash_dot_setting property updates or gets the instance’s dash-dotted line style setting:

import apysc as ap

ap.Stage(
    background_color=ap.Color("#333"),
    stage_width=200,
    stage_height=100,
    stage_elem_id="stage",
)
line: ap.Line = ap.Line(
    start_point=ap.Point2D(x=50, y=50),
    end_point=ap.Point2D(x=150, y=50),
    line_color=ap.Color("#0af"),
    line_thickness=3,
)
line.line_dash_dot_setting = ap.LineDashDotSetting(
    dot_size=2, dash_size=5, space_size=2
)

ap.save_overall_html(dest_dir_path="line_line_dash_dot_setting/")

rotation_around_center property interface example

The rotation_around_center property updates or gets the instance’s rotation value (0 to 359) from the center point:

import apysc as ap

ap.Stage(
    background_color=ap.Color("#333"),
    stage_width=200,
    stage_height=100,
    stage_elem_id="stage",
)
line: ap.Line = ap.Line(
    start_point=ap.Point2D(x=50, y=40),
    end_point=ap.Point2D(x=150, y=60),
    line_color=ap.Color("#0af"),
    line_thickness=3,
)


def on_timer(e: ap.TimerEvent, options: dict) -> None:
    """
    The timer event handler.

    Parameters
    ----------
    e : ap.TimerEvent
        Event instance.
    options : dict
        Optional arguments dictionary.
    """
    line.rotation_around_center += 1


ap.Timer(on_timer, delay=ap.FPS.FPS_60).start()
ap.save_overall_html(dest_dir_path="line_rotation_around_center/")

set_rotation_around_point and get_rotation_around_point methods interface example

The set_rotation_around_point method updates the instance’s rotation value (0 to 359) from a specified point.

Similarly, the get_rotation_around_point method gets the instance’s rotation value (0 to 359) from a specified point:

import apysc as ap

ap.Stage(
    background_color=ap.Color("#333"),
    stage_width=200,
    stage_height=100,
    stage_elem_id="stage",
)
line: ap.Line = ap.Line(
    start_point=ap.Point2D(x=50, y=40),
    end_point=ap.Point2D(x=150, y=60),
    line_color=ap.Color("#0af"),
    line_thickness=3,
)
x: ap.Int = ap.Int(100)
y: ap.Int = ap.Int(100)


def on_timer(e: ap.TimerEvent, options: dict) -> None:
    """
    The timer event handler.

    Parameters
    ----------
    e : ap.TimerEvent
        Event instance.
    options : dict
        Optional arguments dictionary.
    """
    rotation: ap.Int = line.get_rotation_around_point(x=x, y=y)
    rotation += 1
    line.set_rotation_around_point(rotation=rotation, x=x, y=y)


ap.Timer(on_timer, delay=ap.FPS.FPS_60).start()
ap.save_overall_html(dest_dir_path="line_set_rotation_around_point/")

scale_x_from_center property interface example

The scale_x_from_center property updates or gets the instance’s scale-x from the center point:

import apysc as ap

ap.Stage(
    background_color=ap.Color("#333"),
    stage_width=200,
    stage_height=100,
    stage_elem_id="stage",
)
line: ap.Line = ap.Line(
    start_point=ap.Point2D(x=50, y=40),
    end_point=ap.Point2D(x=150, y=60),
    line_color=ap.Color("#0af"),
    line_thickness=30,
)
direction: ap.Int = ap.Int(-1)


def on_timer(e: ap.TimerEvent, options: dict) -> None:
    """
    The timer event handler.

    Parameters
    ----------
    e : ap.TimerEvent
        Event instance.
    options : dict
        Optional arguments dictionary.
    """
    with ap.If(line.scale_x_from_center <= 0.001):
        direction.value = 1
    with ap.If(line.scale_x_from_center >= 2.0):
        direction.value = -1
    line.scale_x_from_center += direction * 0.005


ap.Timer(on_timer, delay=ap.FPS.FPS_60).start()
ap.save_overall_html(dest_dir_path="line_scale_x_from_center/")

scale_y_from_center property interface example

The scale_y_from_center property updates or gets the instance’s scale-y from the center point:

import apysc as ap

ap.Stage(
    background_color=ap.Color("#333"),
    stage_width=200,
    stage_height=100,
    stage_elem_id="stage",
)
line: ap.Line = ap.Line(
    start_point=ap.Point2D(x=50, y=40),
    end_point=ap.Point2D(x=150, y=60),
    line_color=ap.Color("#0af"),
    line_thickness=30,
)
direction: ap.Int = ap.Int(-1)


def on_timer(e: ap.TimerEvent, options: dict) -> None:
    """
    The timer event handler.

    Parameters
    ----------
    e : ap.TimerEvent
        Event instance.
    options : dict
        Optional arguments dictionary.
    """
    with ap.If(line.scale_y_from_center <= 0.001):
        direction.value = 1
    with ap.If(line.scale_y_from_center >= 2.0):
        direction.value = -1
    line.scale_y_from_center += direction * 0.005


ap.Timer(on_timer, delay=ap.FPS.FPS_60).start()
ap.save_overall_html(dest_dir_path="line_scale_y_from_center/")

set_scale_x_from_point and get_scale_x_from_point methods interface example

The set_scale_x_from_point method updates the instance’s scale-x from a specified point.

Similarly, the get_scale_x_from_point method gets the instance’s scale-x from a specified point:

import apysc as ap

ap.Stage(
    background_color=ap.Color("#333"),
    stage_width=200,
    stage_height=100,
    stage_elem_id="stage",
)
line: ap.Line = ap.Line(
    start_point=ap.Point2D(x=50, y=40),
    end_point=ap.Point2D(x=150, y=60),
    line_color=ap.Color("#0af"),
    line_thickness=30,
)
direction: ap.Int = ap.Int(-1)
x: ap.Int = ap.Int(150)


def on_timer(e: ap.TimerEvent, options: dict) -> None:
    """
    The timer event handler.

    Parameters
    ----------
    e : ap.TimerEvent
        Event instance.
    options : dict
        Optional arguments dictionary.
    """
    scale: ap.Number = line.get_scale_x_from_point(x=x)
    with ap.If(scale <= 0.001):
        direction.value = 1
    with ap.If(scale >= 2.0):
        direction.value = -1
    scale += direction * 0.005
    line.set_scale_x_from_point(scale_x=scale, x=x)


ap.Timer(on_timer, delay=ap.FPS.FPS_60).start()
ap.save_overall_html(dest_dir_path="line_scale_x_from_point/")

set_scale_y_from_point and get_scale_y_from_point methods interface example

The set_scale_y_from_point method updates the instance’s scale-y from a specified point.

Similarly, the get_scale_y_from_point method gets the instance’s scale-y from a specified point:

import apysc as ap

ap.Stage(
    background_color=ap.Color("#333"),
    stage_width=200,
    stage_height=100,
    stage_elem_id="stage",
)
line: ap.Line = ap.Line(
    start_point=ap.Point2D(x=50, y=40),
    end_point=ap.Point2D(x=150, y=60),
    line_color=ap.Color("#0af"),
    line_thickness=30,
)
direction: ap.Int = ap.Int(-1)
y: ap.Int = ap.Int(60)


def on_timer(e: ap.TimerEvent, options: dict) -> None:
    """
    The timer event handler.

    Parameters
    ----------
    e : ap.TimerEvent
        Event instance.
    options : dict
        Optional arguments dictionary.
    """
    scale: ap.Number = line.get_scale_y_from_point(y=y)
    with ap.If(scale <= 0.001):
        direction.value = 1
    with ap.If(scale >= 2.0):
        direction.value = -1
    scale += direction * 0.005
    line.set_scale_y_from_point(scale_y=scale, y=y)


ap.Timer(on_timer, delay=ap.FPS.FPS_60).start()
ap.save_overall_html(dest_dir_path="line_scale_y_from_point/")

flip_x property interface example

The flip_x property updates or gets the instance’s flip-x (reflecting state) boolean value:

import apysc as ap

ap.Stage(
    background_color=ap.Color("#333"),
    stage_width=200,
    stage_height=100,
    stage_elem_id="stage",
)
line: ap.Line = ap.Line(
    start_point=ap.Point2D(x=50, y=40),
    end_point=ap.Point2D(x=150, y=60),
    line_color=ap.Color("#0af"),
    line_thickness=3,
)


def on_timer(e: ap.TimerEvent, options: dict) -> None:
    """
    The timer event handler.

    Parameters
    ----------
    e : ap.TimerEvent
        Event instance.
    options : dict
        Optional arguments dictionary.
    """
    line.flip_x = line.flip_x.not_


ap.Timer(on_timer, delay=1000).start()
ap.save_overall_html(dest_dir_path="line_flip_x/")

Notes: Depending on the shape of the instance, this may be difficult to tell the difference between the x and y axes interfaces.

flip_y property interface example

The flip_y property updates or gets the instance’s flip-y (reflecting state) boolean value:

import apysc as ap

ap.Stage(
    background_color=ap.Color("#333"),
    stage_width=200,
    stage_height=100,
    stage_elem_id="stage",
)
line: ap.Line = ap.Line(
    start_point=ap.Point2D(x=50, y=40),
    end_point=ap.Point2D(x=150, y=60),
    line_color=ap.Color("#0af"),
    line_thickness=3,
)


def on_timer(e: ap.TimerEvent, options: dict) -> None:
    """
    The timer event handler.

    Parameters
    ----------
    e : ap.TimerEvent
        Event instance.
    options : dict
        Optional arguments dictionary.
    """
    line.flip_y = line.flip_y.not_


ap.Timer(on_timer, delay=1000).start()
ap.save_overall_html(dest_dir_path="line_flip_y/")

Notes: Depending on the shape of the instance, this may be difficult to tell the difference between the x and y axes interfaces.

skew_x property interface example

The skew_x property updates or gets the instance’s skew-x (distortion) value:

import apysc as ap

ap.Stage(
    background_color=ap.Color("#333"),
    stage_width=200,
    stage_height=100,
    stage_elem_id="stage",
)
line: ap.Line = ap.Line(
    start_point=ap.Point2D(x=50, y=40),
    end_point=ap.Point2D(x=150, y=60),
    line_color=ap.Color("#0af"),
    line_thickness=3,
)


def on_timer(e: ap.TimerEvent, options: dict) -> None:
    """
    The timer event handler.

    Parameters
    ----------
    e : ap.TimerEvent
        Event instance.
    options : dict
        Optional arguments dictionary.
    """
    line.skew_x += 1


ap.Timer(on_timer, delay=ap.FPS.FPS_60).start()
ap.save_overall_html(dest_dir_path="line_skew_x/")

Notes: Depending on the shape of the instance, this may be difficult to tell the difference between the x and y axes interfaces.

skew_y property interface example

The skew_y property updates or gets the instance’s skew-y (distortion) value:

import apysc as ap

ap.Stage(
    background_color=ap.Color("#333"),
    stage_width=200,
    stage_height=100,
    stage_elem_id="stage",
)
line: ap.Line = ap.Line(
    start_point=ap.Point2D(x=50, y=40),
    end_point=ap.Point2D(x=150, y=60),
    line_color=ap.Color("#0af"),
    line_thickness=3,
)


def on_timer(e: ap.TimerEvent, options: dict) -> None:
    """
    The timer event handler.

    Parameters
    ----------
    e : ap.TimerEvent
        Event instance.
    options : dict
        Optional arguments dictionary.
    """
    line.skew_y += 1


ap.Timer(on_timer, delay=ap.FPS.FPS_60).start()
ap.save_overall_html(dest_dir_path="line_skew_y/")

Notes: Depending on the shape of the instance, this may be difficult to tell the difference between the x and y axes interfaces.

Line class constructor API

Note: the document build script generates and updates this API document section automatically. Maybe this section is duplicated compared with previous sections.

[Interface signature] __init__(self, *, start_point: 'point2d.Point2D', end_point: 'point2d.Point2D', line_color: apysc._color.color.Color = Color(""), line_alpha: Union[float, apysc._type.number.Number] = 1.0, line_thickness: Union[int, apysc._type.int.Int] = 1, line_cap: Union[apysc._type.string.String, apysc._display.line_caps.LineCaps, NoneType] = None, line_dot_setting: Union[apysc._display.line_dot_setting.LineDotSetting, NoneType] = None, line_dash_setting: Union[apysc._display.line_dash_setting.LineDashSetting, NoneType] = None, line_round_dot_setting: Union[apysc._display.line_round_dot_setting.LineRoundDotSetting, NoneType] = None, line_dash_dot_setting: Union[apysc._display.line_dash_dot_setting.LineDashDotSetting, NoneType] = None, parent: Union[apysc._display.child_mixin.ChildMixIn, NoneType] = None, variable_name_suffix: str = '') -> None

[Interface summary]

Create a line vector graphic.

[Parameters]

  • start_point: Points2D

    • Line start point.

  • end_point: Points2D

    • Line end point.

  • line_color: Color, default COLORLESS

    • A line-color to set.

  • line_alpha: float or Number, default 1.0

    • A line-alpha to set.

  • line_thickness: int or Int, default 1

    • A line-thickness (line-width) to set.

  • line_cap: String or LineCaps or None, default None

    • A line-cap setting to set.

  • line_dot_setting: LineDotSetting or None, default None

    • A dot setting to set.

  • line_dash_setting: LineDashSetting or None, default None

    • A dash setting to set.

  • line_round_dot_setting: LineRoundDotSetting or None, default None

    • A round-dot setting to set.

  • line_dash_dot_setting: LineDashDotSetting or None, default None

    • A dash-dot (1-dot chain) setting to set.

  • parent: ChildMixIn or None, default None

    • A parent instance to add this instance. If the specified value is None, this interface uses a stage instance.

  • variable_name_suffix: str, default “”

    • A JavaScript variable name suffix string. This setting is sometimes useful for JavaScript debugging.

[Examples]

>>> import apysc as ap
>>> stage: ap.Stage = ap.Stage()
>>> line: ap.Line = ap.Line(
...     start_point=ap.Point2D(x=50, y=50),
...     end_point=ap.Point2D(x=150, y=50),
...     line_color=ap.Color("#ffffff"),
...     line_thickness=3,
... )
>>> line.line_color
Color("#ffffff")

>>> line.line_thickness
Int(3)