rangeCreators.md

solid-knobs / rangeCreators

Namespace: rangeCreators

Table of contents

Functions

• createFrequencyRange
• createVolumeRange
• createPercentageRange
• createBipolarPercentageRange
• createAccuratePercentageRange
• createToggleRange

Functions

createFrequencyRange

▸ createFrequencyRange(start?, end?): ContinuousRange

Creates a range for frequency values.

Parameters

Name	Type	Default value	Description
start	number	20	The start frequency in hertz (default = 20).
end	number	20000	The end frequency in hertz (default = 20000).

Returns

ContinuousRange

---

createVolumeRange

▸ createVolumeRange(start?, end?): ContinuousRange

Parameters

Name	Type	Default value
start	number	0
end	number	1

Returns

ContinuousRange

---

createPercentageRange

▸ createPercentageRange(start?, end?): ContinuousRange

Creates a range for percentage values.

Parameters

Name	Type	Default value	Description
start	number	0	The start value (default = 0).
end	number	1	The end value (default = 1).

Returns

ContinuousRange

---

createBipolarPercentageRange

▸ createBipolarPercentageRange(start?, end?): ContinuousRange

Creates a range for percentages going from -end ... end.

Parameters

Name	Type	Default value	Description
start	number	0	The start value (default = 0).
end	number	1	The end value (default = 1).

Returns

ContinuousRange

---

createAccuratePercentageRange

▸ createAccuratePercentageRange(start?, end?): ContinuousRange

Creates a range that displays percentages with more accuracy.

Parameters

Name	Type	Default value	Description
start	number	0	The start value (default = 0).
end	number	1	The end value (default = 1).

Returns

ContinuousRange

---

createToggleRange

▸ createToggleRange(offLabel?, onLabel?): ChoiceRange

Creates a range whose value is either 0 or 1.

Parameters

Name	Type	Default value	Description
offLabel	string	'Off'	The label for when the value is 0.
onLabel	string	'On'	The label for when the value is 1.

Returns

ChoiceRange