const propertyId = {
name: {parameter name defined in operator definition},
row: {row in table/array}, // optional when col not set
col: {col in table}, // optional
propertyId: {propertyId of the nested structure} // optional
}
setPropertyValues(values)
updatePropertyValue(propertyId, value)
/*
* options - optional object of config options where
* filterHiddenDisabled (boolean): when set to true, filter out data values with a state of disabled or hidden
* applyProperties (boolean): when set to true, will return data values in the format expected by the `applyPropertyChanges` callback. If unset or false, will return the internal format used by common properties.
*/
getPropertyValue(propertyId, options)
/*
/*
* Returns current list of error messages
* @filteredPipeline (boolean) optional
* @filterHiddenDisable (boolean) optional. If true, will not return error messages from controls that are hidden or disabled
* @filterDisplayError (boolean) optional. If true, will not return error messages that are not displayed in the editor
* when filteredPipeline=true returns enabled/visible control messages and only 1 per control.
*/
getAllErrorMessages()
getErrorMessages(filteredPipeline, filterHiddenDisable, filterSuccess, filterDisplayError = true)
State methods (disable/enabled & hidden/visible)
getControlState(propertyId)
getControlStates()
setControlStates(states)
/*
* @propertyId - see above
* @state - valid values are "enabled", "disabled", "visible", "hidden"
*/
updateControlState(propertyId, state)
getDatasetMetadata()
/*
* @datasetMetadata - see [schema](https://github.com/elyra-ai/pipeline-schemas/blob/master/common-pipeline/datarecord-metadata/datarecord-metadata-v1-schema.json)
*/
setDatasetMetadata(datasetMetadata)
/*
* Returns table row selection indices as an array of integers.
* @propertyId - see above
*/
getSelectedRows(propertyId)
/*
* Updates table row selections for the given table control.
* @propertyId - see above
/*
* Runs validation conditions on all controls
*/
validatePropertiesValues()
/*
/*
* Update the enum values for a given control. Used when enum values aren't static
* @propertyId - see above
* @valuesObj (array) [{ value: <string, number, boolean> , label: "<string>" }]
*/
updateControlEnumValues(propertyId, valuesObj)
/*
* Returns the current size of the RHS flyout.
*/
getEditorSize()
/**
* Disable table row move buttons for all propertyIds in given array
* @param propertyIds Array of propertyIds
*
*/
setDisableRowMoveButtons(propertyIds)
/**
* Returns array of propertyIds for which row move buttons will be disabled
* @return Array of propertyIds
Custom panel and control methods
/*
* Only used in custom panel to allow for custom property summary values to be displayed
* Displays the value set in propertiesReducer for that parameter
* @propertyId - see above
* @label (string)
* @inSummary (boolean)
*/
setControlInSummary(propertyId, label, inSummary)
maxLength for single-line and multi-line control methods
/*
* Returns the maximum characters allowed for multi-line string controls
* Default value is 1024
*/
getMaxLengthForMultiLineControls()
/*
* Returns the maximum characters allowed for single-line string controls
* Default value is 128
/*
* Set the addRemoveRows attribute to 'enabled' for the given propertyId
* @param propertyId The unique property identifier
* @param enabled boolean value to enable or disable addRemoveRows
*/
setAddRemoveRows(propertyId, enabled)
/*
* Returns the true if addRemoveRows is enabled for the given propertyID
/*
* Set the main "save" button to disabled(true) or enabled(false)
* @param saveDisable (boolean)
*/
setSaveButtonDisable(saveDisable)
/*
* Returns the true if the main "save" button is disabled, false otherwise
* @return boolean
updateStaticRows(propertyId, staticRowsArr)