Options
All
  • Public
  • Public/Protected
  • All
Menu

This is an alternate Boxes plugin that allows control over which sides of the box to draw.

This class mirrors closely the version found in SigPlot. However more methods have been added for supporting updating, etc. as well as drawing partial boxes.

Hierarchy

  • Boxes2Plugin

Index

Constructors

constructor

Properties

Private _maxX

_maxX: number

Maximum X position

Private _maxY

_maxY: number

Maximum Y Position

Private _minX

_minX: number

Minimum X position

Private _minY

_minY: number

Minimum Y position

Private boxes

boxes: Map<string, Box> = new Map<string, Box>()

Map of the boxes to draw

options

options: Boxes2Options

Private plot

plot: Plot

The plot to draw within

Accessors

maxX

maxX:

Maximum X position

maxY

maxY:

Maximum Y Position

minX

minX:

Minimum X position

minY

minY:

Minimum Y position

Methods

add_box

  • add_box(id: string, box: Box, redraw?: boolean): void
  • Add a box to the view

    Parameters

    • id: string

      The unique ID for the box

    • box: Box

      The box parameters to draw

    • Default value redraw: boolean = true

      Whether or not to redraw with this call

    Returns void

clear_boxes

  • clear_boxes(redraw?: boolean): void
  • Clears all boxes

    Parameters

    • Default value redraw: boolean = true

      Whether or not to redraw with this call

    Returns void

dispose

  • dispose(): void
  • Returns void

init

  • init(plot: Plot): void
  • Initialize the plugin for the plot

    Parameters

    • plot: Plot

    Returns void

menu

  • menu(): any
  • Menu callback

    Returns any

refresh

  • refresh(canvas: HTMLCanvasElement): void
  • Refresh all the drawn blocks

    Parameters

    • canvas: HTMLCanvasElement

    Returns void

remove_box

  • remove_box(id: string, redraw?: boolean): void
  • Remove a box from the view

    Parameters

    • id: string

      The unique ID for the box

    • Default value redraw: boolean = true

      Whether or not to redraw with this call

    Returns void

Private resetStats

  • resetStats(): void
  • Returns void

update_box

  • update_box(id: string, box: Box, redraw?: boolean): void
  • Update a box in the view

    Parameters

    • id: string

      The unique ID for the box

    • box: Box

      The box parameters to draw

    • Default value redraw: boolean = true

      Whether or not to redraw with this call

    Returns void

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc