HISE Docs

ScriptTable

Create a reference to a Table UI component and modify its values.

const var Table1 = Content.getComponent("Table1");


Class methods

addToMacroControl

Adds the knob / button to a macro controller (from 0 to 7). Edit on GitHub

ScriptTable.addToMacroControl(int macroIndex)



changed

Call this to indicate that the value has changed (the onControl callback will be executed. Edit on GitHub

ScriptTable.changed()



createLocalLookAndFeel

Returns a local look and feel if it was registered before. Edit on GitHub

ScriptTable.createLocalLookAndFeel(ScriptContentComponent *contentComponent, Component *componentToRegister)



fadeComponent

Toggles the visibility and fades a component using the global animator. Edit on GitHub

ScriptTable.fadeComponent(bool shouldBeVisible, int milliseconds)



get

returns the value of the property. Edit on GitHub

ScriptTable.get(String propertyName)



getAllProperties

Returns a list of all property IDs as array. Edit on GitHub

ScriptTable.getAllProperties()



getChildComponents

Returns list of component's children Edit on GitHub

ScriptTable.getChildComponents()



getGlobalPositionX

Returns the absolute x-position relative to the interface. Edit on GitHub

ScriptTable.getGlobalPositionX()



getGlobalPositionY

Returns the absolute y-position relative to the interface. Edit on GitHub

ScriptTable.getGlobalPositionY()



getHeight

Returns the height of the component. Edit on GitHub

ScriptTable.getHeight()



getId

Returns the ID of the component. Edit on GitHub

ScriptTable.getId()



getLocalBounds

Returns a [x, y, w, h] array that was reduced by the given amount. Edit on GitHub

ScriptTable.getLocalBounds(float reduceAmount)



getTableValue

Returns the table value from 0.0 to 1.0 according to the input value from 0.0 to 1.0. Edit on GitHub

ScriptTable.getTableValue(float inputValue)



getValue

Returns the current value. Edit on GitHub

ScriptTable.getValue()



getValueNormalized

Returns the normalized value. Edit on GitHub

ScriptTable.getValueNormalized()



getWidth

Returns the width of the component. Edit on GitHub

ScriptTable.getWidth()



grabFocus

Call this method in order to grab the keyboard focus for this component. Edit on GitHub

ScriptTable.grabFocus()



loseFocus

Call this method in order to give away the focus for this component. Edit on GitHub

ScriptTable.loseFocus()



referToData

Connects it to a table data object (or UI element in the same interface). -1 sets it back to its internal data object. Edit on GitHub

ScriptTable.referToData(var tableData)



registerAtParent

Registers this table (and returns a reference to the data) with the given index so you can use it from the outside. Edit on GitHub

ScriptTable.registerAtParent(int index)



sendRepaintMessage

Manually sends a repaint message for the component. Edit on GitHub

ScriptTable.sendRepaintMessage()



set

Sets the property. Edit on GitHub

ScriptTable.set(String propertyName, var value)



setColour

sets the colour of the component (BG, IT1, IT2, TXT). Edit on GitHub

ScriptTable.setColour(int colourId, int colourAs32bitHex)



setConsumedKeyPresses

Registers a selection of key presses to be consumed by this component. Edit on GitHub

ScriptTable.setConsumedKeyPresses(var listOfKeys)



setControlCallback

Pass a inline function for a custom callback event. Edit on GitHub

ScriptTable.setControlCallback(var controlFunction)



setKeyPressCallback

Adds a callback to react on key presses (when this component is focused). Edit on GitHub

ScriptTable.setKeyPressCallback(var keyboardFunction)



setLocalLookAndFeel

Attaches the local look and feel to this component. Edit on GitHub

ScriptTable.setLocalLookAndFeel(var lafObject)



setPosition

Sets the position of the component. Edit on GitHub

ScriptTable.setPosition(int x, int y, int w, int h)



setPropertiesFromJSON

Restores all properties from a JSON object. Edit on GitHub

ScriptTable.setPropertiesFromJSON( var jsonData)



setSnapValues

Connects the table to an existing Processor. Makes the table snap to the given x positions (from 0.0 to 1.0). Edit on GitHub

ScriptTable.setSnapValues(var snapValueArray)



setStyleSheetClass

Sets the given class selectors for the component stylesheet. Edit on GitHub

ScriptTable.setStyleSheetClass( String classIds)



setStyleSheetProperty

Sets a variable for this component that can be queried from a style sheet. Edit on GitHub

ScriptTable.setStyleSheetProperty( String variableId,  var value,  String type)



setStyleSheetPseudoState

Programatically sets a pseudo state (:hover, :active, :checked, :focus, :disabled) that will be used by the CSS renderer. Edit on GitHub

ScriptTable.setStyleSheetPseudoState( String pseudoState)



setTablePopupFunction

Pass a function that takes a double and returns a String in order to override the popup display text. Edit on GitHub

ScriptTable.setTablePopupFunction(var newFunction)



setTooltip

Shows a informative text on mouse hover. Edit on GitHub

ScriptTable.setTooltip( String tooltip)



setValue

Sets the current value Edit on GitHub

ScriptTable.setValue(var newValue)



setValueNormalized

Sets the current value from a range 0.0 ... 1.0. Edit on GitHub

ScriptTable.setValueNormalized(double normalizedValue)



setValueWithUndo

Sets the current value and adds it to the undo list. Don't call this from onControl! Edit on GitHub

ScriptTable.setValueWithUndo(var newValue)



setZLevel

Changes the depth hierarchy (z-axis) of sibling components (Back, Default, Front or AlwaysOnTop). Edit on GitHub

ScriptTable.setZLevel(String zLevel)



showControl

Hides / Shows the control. Edit on GitHub

ScriptTable.showControl(bool shouldBeVisible)



updateContentPropertyInternal

This updates the internal content data object from the script processor. Edit on GitHub

ScriptTable.updateContentPropertyInternal(int propertyId,  var newValue)



updateValueFromProcessorConnection

Updates the value from the processor connection. Call this method whenever the module state has changed and you want to refresh the knob value to show the current state. Edit on GitHub

ScriptTable.updateValueFromProcessorConnection()