Home Reference Source
public class | source

ListProperty

Extends:

ToolPropertyIFToolProperty → ListProperty

List of other tool props (all of one type)

Constructor Summary

Public Constructor
public

Member Summary

Public Members
public get

length: *

public set
public

prop: *

public

uiname: *

public

value: *[]

public

Method Summary

Public Methods
public
public
public

clear()

public

copy(): *

public

copyTo(b: *): *

public

equals(b: *): boolean

public

getListItem(i: *): *

public

getValue(): *

public

push(item: *): *

public

setListItem(i: *, val: *)

public

setValue(value: *): *

Inherited Summary

From class ToolPropertyIF
public

apiname: *

public

data: *

public
public

flag: *

public

icon: *

public

subtype: *

public

type: *

public

uiname: *

public

copy()

public

copyTo(b: *)

public

equals(b: *)

public
public

off(type: *, cb: *)

public

on(type: *, cb: *)

public

setIcon(icon: *)

public

setRange(min: *, max: *)

public

setStep(step: *)

public

setUIRange(min: *, max: *)

public

setUnit(unit: *)

public

setValue(val: *)

private

_fire(type: *, arg1: *, arg2: *)

From class ToolProperty
public static

calcRelativeStep(step: *, value: *, logBase: number): *

public static

getClass(type: *): *

public static
public static

makeUIName(name: *): *

public static

register(cls: *): *

public static
public static
public

apiname: *

public
public

callbacks: {}

public

data: *

public
public
public
public

flag: *

public

icon: *

public

icon2: *

public

radix: *

public
public
public
public

subtype: *

public

type: *

public
public

uiname: *

public
public
public
public

copy(): *

public

copyTo(b: *)

public

equals(b: *)

public

getStep(value: number): *

public

getValue(): *

public

loadJSON(obj: *): *

public

loadSTRUCT(reader: *)

public

noUnits(): *

public

off(type: *, cb: *): *

public

on(type: *, cb: *): *

public

once(type: *, cb: *): *

public

private(): *

public

report()

public
public

setBaseUnit(unit: *): *

public

setDescription(s: *): *

public

setDisplayUnit(unit: *): *

public

setFlag(f: *, combine: boolean): *

public

setIcon(icon: *): *

public

setIcon2(icon: *): *

public

setRange(min: *, max: *): *

public

setRelativeStep(step: *)

public

setStep(step: *): *

public

setUIName(s: *): *

public

setUIRange(min: *, max: *): *

public

setValue(val: *)

public

toJSON(): {"type": *, "subtype": *, "apiname": *, "uiname": *, "description": *, "flag": *, "icon": *, "data": *, "range": *, "uiRange": *, "step": *}

private

_fire(type: *, arg1: *, arg2: *): *

Public Constructors

public constructor() source

Override:

ToolProperty#constructor

Public Members

public get length: * source

public set length source

public prop: * source

public uiname: * source

Override:

ToolProperty#uiname

public value: *[] source

public wasSet: boolean source

Override:

ToolProperty#wasSet

Public Methods

public [Symbol.iterator](): * source

Return:

*

public calcMemSize(): * source

Override:

ToolProperty#calcMemSize

Return:

*

public clear() source

public copy(): * source

Override:

ToolProperty#copy

Return:

*

public copyTo(b: *): * source

Override:

ToolProperty#copyTo

Params:

NameTypeAttributeDescription
b *

Return:

*

public equals(b: *): boolean source

Override:

ToolProperty#equals

Params:

NameTypeAttributeDescription
b *

Return:

boolean

public getListItem(i: *): * source

Params:

NameTypeAttributeDescription
i *

Return:

*

public getValue(): * source

Override:

ToolProperty#getValue

Return:

*

public push(item: *): * source

Params:

NameTypeAttributeDescription
item *
  • optional
  • default: undefined

Return:

*

public setListItem(i: *, val: *) source

Params:

NameTypeAttributeDescription
i *
val *

public setValue(value: *): * source

Override:

ToolProperty#setValue

Params:

NameTypeAttributeDescription
value *

Return:

*