Class Point

Represents a Point shape.

Hierarchy (view full)

Constructors

constructor

Properties

attrs children kwargs tag transform x y

Methods

add clone equals repeat rotate scale show toString translate

Constructors

constructor

  • new Point(x?, y?, kwargs?): Point

  • Creates an instance of Point.

    Parameters

    • x: number = 0

      The x-coordinate of the point. Defaults to 0.

    • y: number = 0

      The y-coordinate of the point. Defaults to 0.

    • kwargs: {} = {}

      Returns Point

    Properties

    attrs

    attrs: any

    children

    children: Shape[]

    kwargs

    kwargs: any

    tag

    tag: string

    transform

    transform: Transformation[]

    x

    x: number

    y

    y: number

    Methods

    add

    • add(shape): Point

    • Adds a child shape to the current Shape instance.

      Parameters

      • shape: Shape

        A child shape.

      Returns Point

      The current instance of Shape for chaining.

    clone

    • clone(newKwargs?): Shape

    • Returns a clone of the current Shape instance with new styling information if available.

      Parameters

      • newKwargs: {} = {}

        Key value pairs to provide styling information for a shape. eg { fill: 'red', stroke: 'blue' }.

        Returns Shape

        A new instance of Shape.

      equals

      • equals(p): boolean

      • Checks if the Point passed as the parameter is equal to the current instance.

        Parameters

        • p: Point

          An instance of Point.

        Returns boolean

        A boolean representing whether the current Point instance has the same attributes as the parameter.

      repeat

      • repeat(n, transform): Point

      • Repeats the current shape n times by applying transform iteratively.

        Parameters

        • n: number

          A positive integer representing the number of times a shape is to be repeated.

        • transform: Transformation | ((index: number) => TransformationWithStyle) | ((index: number) => Transformation)

          An instance of Transformation that is applied every time the shape is repeated.

        Returns Point

        The current instance of Shape for chaining.

      rotate

      • rotate(angle?): Point

      • Applies a Rotate transformation to the current Shape instance.

        Parameters

        • angle: number = 0

          Amount to rotate clockwise in degrees. Defaults to 0.

        Returns Point

        The current instance of Shape for chaining.

      scale

      • scale(x?, y?): Point

      • Applies a Scale transformation to the current Shape instance.

        Parameters

        • x: number = 1

          Amount to scale along the positive x-axis. Defaults to 1.

        • y: number = 1

          Amount to scale along the positive y-axis. Defaults to 1.

        Returns Point

        The current instance of Shape for chaining.

      show

      • show(r?): void

      • Displays a shape. Steps performed for display are as follows.

        • Apply the transforms that exist on a shape.
        • Apply the styling that exists on a shape.
        • Draw the shape.
        • Draw children shapes.

        Parameters

        • Optionalr: Drawable

          An instance of Drawable.

        Returns void

      toString

      • toString(): string

      • Returns a string representation of Point.

        Returns string

        A string with the name of the shape and its' attributes.

      translate

      • translate(x?, y?): Point

      • Applies a Translate transformation to the current Shape instance.

        Parameters

        • x: number = 0

          Amount to translate along the positive x-axis. Defaults to 0.

        • y: number = 0

          Amount to translate along the positive y-axis. Defaults to 0.

        Returns Point

        The current instance of Shape for chaining.

      Settings

      Member Visibility

      On This Page

      Constructors
      Properties
      Methods