SmartEditApi
Provides run-time access to the Smart Edit Module
TypeScript
export interfaceMethods
| Method | Description |
|---|---|
| getSmartEditCustomOperations() | Retrieves an Smart Edit Custom Operations (provided in Edit Options) |
| getSmartEditOperation() | Gets current Smart Edit Operation |
| getSmartEditValue() | Returns current Smart Edit Value |
| openSmartEditSettingsPanel() | Opens Settings Panel with Smart Edit section selected and visible |
| setCustomSmartEditOperation(customOperationName) | Sets current Smart Edit Operation to a Custom Operation |
| setSmartEditOperation(operation) | Sets (shipped) Smart Edit Operation: 'Add','Subtract','Multiply','Divide' |
| setSmartEditValue(smartEditValue) | Sets Smart Edit Value |
Method Details
getSmartEditCustomOperations
Retrieves an Smart Edit Custom Operations (provided in Edit Options)
TypeScript
getSmartEditCustomOperations(): SmartEditCustomOperation[];Returns
getSmartEditOperation
Gets current Smart Edit Operation
TypeScript
getSmartEditOperation(): SmartEditOperation;Returns
getSmartEditValue
Returns current Smart Edit Value
TypeScript
getSmartEditValue(): number;Returns
number
openSmartEditSettingsPanel
Opens Settings Panel with Smart Edit section selected and visible
TypeScript
openSmartEditSettingsPanel(): void;Returns
void
setCustomSmartEditOperation
Sets current Smart Edit Operation to a Custom Operation
TypeScript
setCustomSmartEditOperation(customOperationName: string): void;Parameters
| Parameter | Type | Description |
|---|---|---|
| customOperationName | string | name of Custom Smart Edit Operation |
Returns
void
setSmartEditOperation
Sets (shipped) Smart Edit Operation: 'Add','Subtract','Multiply','Divide'
TypeScript
setSmartEditOperation(operation: MathOperation): void;Parameters
| Parameter | Type | Description |
|---|---|---|
| operation | MathOperation | operation to run |
Returns
void
setSmartEditValue
Sets Smart Edit Value
TypeScript
setSmartEditValue(smartEditValue: number): void;Parameters
| Parameter | Type | Description |
|---|---|---|
| smartEditValue | number | the value to use in Smart Edit Operation |
Returns
void