Home > @i2analyze/notebook-sdk > visual > IBrushSet
visual.IBrushSet interface
A brush set that maps records to brush indices and applies colors based on a color range.
Signature:
interface IBrushSet
Introduced: version 1.9
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| colorRange |
readonly
| IBrushColorRange | null |
Gets the current color range for this brush set, or null if no color range is set.
|
| id |
readonly
| string | Gets the unique identifier of the brush set. |
| isActive |
readonly
| boolean | Indicates whether the brush set is currently active. |
Methods
| Method | Description |
|---|---|
| clear() | Removes all record mappings from the brush set. |
| getBrushIndex(recordId) |
Gets the brush index for a record, or undefined if the record is not in the brush set.
|
| remove(records) | Removes specific records from the brush set. |
| set(record, index) | Sets the brush index for a single record. |
| set(entries) | Sets the brush index for multiple records. |
| setColorRange(range) | Sets the color range for this brush set. |