ProtoTwin API
    Preparing search index...

    Class Plots

    Plot Collection.

    Hierarchy (View Summary)

    Index

    Accessors

    • get all(): readonly Plot[]

      The complete list of plots.

      Returns readonly Plot[]

    • get subscribed(): boolean

      Whether there are any subscribers.

      Returns boolean

    Methods

    • Creates a new plot.

      Parameters

      • name: string

        The unique name that identifies the plot.

      • title: string = ""

        The title for the plot.

      Returns null | Plot

      The created plot, or null if a plot already exists with the specified name.

    • Removes all plots.

      Returns void

    • Finds a plot.

      Parameters

      • name: string

        The name of the plot to find.

      Returns null | Plot

      The found plot, or null if no plot with the specified name was found.

    • Finds or creates a plot.

      Parameters

      • name: string

        The unique name that identifies the plot.

      Returns Plot

      The found or created plot.

      This function will attempt to find a plot with the specified name. If no plot was found then a new plot is created.