Options
All
  • Public
  • Public/Protected
  • All
Menu

Dropdown with menu item labels that can be selected.

Hierarchy

Implements

Index

Constructors

constructor

  • new DropdownControl(x: number, y: number, optionLabels: string[], defaultIndex: number): DropdownControl
  • Constructs a dropdown control with given option labels at the given (x,y) position and with the default selection as the label at the given default index.

    Parameters

    • x: number
    • y: number
    • optionLabels: string[]
    • defaultIndex: number

    Returns DropdownControl

Properties

classList

classList: DOMTokenList

Class attribute for the root element.

collapsedView

collapsedView: Group

currSelection

currSelection: Group

currSelectionBox

currSelectionBox: Rectangle

currSelectionText

currSelectionText: Text

currentIndex

currentIndex: number

expanded

expanded: boolean

expandedView

expandedView: Group

optionLabels

optionLabels: string[]

root

root: SVGGElement

style

style: CSSStyleDeclaration

Style for the root element.

textWidth

textWidth: number

update

update: function

The update function describes how this element should update itself

Type declaration

    • (): void
    • Returns void

x

x: number

y

y: number

Static controller

controller: Controller = new Controller()

The controller manages the dependencies between elements. Every element is added to this controller upon creation.

Static count

count: number = 0

This number uniquely identifes elements

Static disable

disable: boolean = false

Allows for the events attatched to elements to be disabled.

Accessors

id

id:

Returns the unique generated identifier associated with this element.

onchange

onchange:

This function is called whenever the state of an input element changes. The default behavior of this function is to update the dependents of this element. WARNING: changing this function can have unintented side effects.

Methods

a

  • a(href: string): A
  • Constructs and appends an 'a' (link) within this element.

    Parameters

    • href: string

    Returns A

addDependency

appendChild

  • appendChild<T>(child: T): T

circle

  • circle(cx: number, cy: number, r: number): Circle
  • Parameters

    • cx: number
    • cy: number
    • r: number

    Returns Circle

clear

  • clear(): void
  • Removes all child elements from this element.

    Returns void

clipPath

  • Constructs and appends a clipPath within this element

    Returns ClipPath

contains

  • contains(element: Element): boolean
  • Returns true if this element contains the argument element.

    Parameters

    Returns boolean

defs

  • defs(): Defs

description

ellipse

  • ellipse(cx: number, cy: number, rx: number, ry: number): Ellipse
  • Parameters

    • cx: number
    • cy: number
    • rx: number
    • ry: number

    Returns Ellipse

getAttribute

getBoundingBox

  • getBoundingBox(): SVGRect
  • Returns the bounding box of this element. Note, this is different from the getBoundingClientRect method since the bounding box is affected by the current viewPort.

    If this element's root is not a SVGGraphics element as is the case for the marker, title, and more element, then null is returned instead of a DOMRect.

    Returns SVGRect

getCurrentSelection

  • getCurrentSelection(): string
  • Returns the text of the current selection in from the dropdown menu.

    Returns string

getLongestString

  • getLongestString(list: string[]): string
  • Returns the longest string in the given string array.

    Parameters

    • list: string[]

    Returns string

group

line

  • line(x1: number, y1: number, x2: number, y2: number): Line
  • Parameters

    • x1: number
    • y1: number
    • x2: number
    • y2: number

    Returns Line

metadata

path

  • path(d: string): Path
  • Parameters

    • d: string

    Returns Path

polygon

  • Parameters

    • points: string

    Returns Polygon

prependChild

  • prependChild<T>(child: T): T

rectangle

  • rectangle(x: number, y: number, width: number, height: number): Rectangle
  • Parameters

    • x: number
    • y: number
    • width: number
    • height: number

    Returns Rectangle

remove

  • remove(): void

setAttribute

svg

  • svg(x: number, y: number, width: number, height: number): SVG
  • Parameters

    • x: number
    • y: number
    • width: number
    • height: number

    Returns SVG

symbol

text

  • text(x: number, y: number, str: string): Text
  • Constructs and appends a text element within this element.

    Parameters

    • x: number
    • y: number
    • str: string

    Returns Text

title

updateDependents

  • updateDependents(): void

updateExpandedView

  • updateExpandedView(): void
  • Updates the expanded view of menu options.

    Returns void

use

  • use(x: number, y: number, width: number, height: number): Use
  • Parameters

    • x: number
    • y: number
    • width: number
    • height: number

    Returns Use

Static clear

  • clear(disable?: boolean): void
  • Clears the static data structures holding elements and resets the count.

    Parameters

    • Default value disable: boolean = false

    Returns void

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • 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