Color
Defined in: js-api/src/color.ts:9
Color-related routines.
Constructors
Constructor
new Color():
Color
Returns
Color
Accessors
areaSelection
Get Signature
get
staticareaSelection():number
Defined in: js-api/src/color.ts:262
Returns
number
areaZoom
Get Signature
get
staticareaZoom():number
Defined in: js-api/src/color.ts:274
Returns
number
barChart
Get Signature
get
staticbarChart():number
Defined in: js-api/src/color.ts:246
Returns
number
black
Get Signature
get
staticblack():number
Defined in: js-api/src/color.ts:158
Returns
number
blue
Get Signature
get
staticblue():number
Defined in: js-api/src/color.ts:146
Returns
number
categoricalPalette
Get Signature
get
staticcategoricalPalette():number[]
Defined in: js-api/src/color.ts:90
Returns the standard palette of the categorical colors used across all visualizations in Datagrok.
Returns
number[]
categoricalPalettes
Get Signature
get
staticcategoricalPalettes():object
Defined in: js-api/src/color.ts:95
Returns the map of existing palettes used in Datagrok.
Returns
object
categoricalSchemes
Get Signature
get
staticcategoricalSchemes():number[]
Defined in: js-api/src/color.ts:100
Returns the list of categorical color schemes used in Datagrok.
Returns
number[]
colSelection
Get Signature
get
staticcolSelection():number
Defined in: js-api/src/color.ts:270
Returns
number
continuousSchemes
Get Signature
get
staticcontinuousSchemes():number[]
Defined in: js-api/src/color.ts:105
Returns the list of continuous color schemes for linear coloring used in Datagrok.
Returns
number[]
currentRow
Get Signature
get
staticcurrentRow():number
Defined in: js-api/src/color.ts:238
Returns
number
cyan
Get Signature
get
staticcyan():number
Defined in: js-api/src/color.ts:214
Returns
number
darkBlue
Get Signature
get
staticdarkBlue():number
Defined in: js-api/src/color.ts:198
Returns
number
darkGray
Get Signature
get
staticdarkGray():number
Defined in: js-api/src/color.ts:142
Returns
number
darkGreen
Get Signature
get
staticdarkGreen():number
Defined in: js-api/src/color.ts:154
Returns
number
darkOrange
Get Signature
get
staticdarkOrange():number
Defined in: js-api/src/color.ts:190
Returns
number
darkRed
Get Signature
get
staticdarkRed():number
Defined in: js-api/src/color.ts:174
Returns
number
failure
Get Signature
get
staticfailure():number
Defined in: js-api/src/color.ts:286
Returns
number
filteredOutRows
Get Signature
get
staticfilteredOutRows():number
Defined in: js-api/src/color.ts:222
Returns
number
filteredRows
Get Signature
get
staticfilteredRows():number
Defined in: js-api/src/color.ts:218
Returns
number
gray
Get Signature
get
staticgray():number
Defined in: js-api/src/color.ts:130
Returns
number
green
Get Signature
get
staticgreen():number
Defined in: js-api/src/color.ts:150
Returns
number
gridWarningBackground
Get Signature
get
staticgridWarningBackground():number
Defined in: js-api/src/color.ts:278
Returns
number
histogramBar
Get Signature
get
statichistogramBar():number
Defined in: js-api/src/color.ts:242
Returns
number
lightBlue
Get Signature
get
staticlightBlue():number
Defined in: js-api/src/color.ts:194
Returns
number
lightGray
Get Signature
get
staticlightGray():number
Defined in: js-api/src/color.ts:138
Returns
number
lightLightGray
Get Signature
get
staticlightLightGray():number
Defined in: js-api/src/color.ts:134
Returns
number
maroon
Get Signature
get
staticmaroon():number
Defined in: js-api/src/color.ts:178
Returns
number
missingValueRows
Get Signature
get
staticmissingValueRows():number
Defined in: js-api/src/color.ts:230
Returns
number
mouseOverRows
Get Signature
get
staticmouseOverRows():number
Defined in: js-api/src/color.ts:234
Returns
number
navy
Get Signature
get
staticnavy():number
Defined in: js-api/src/color.ts:210
Returns
number
olive
Get Signature
get
staticolive():number
Defined in: js-api/src/color.ts:182
Returns
number
orange
Get Signature
get
staticorange():number
Defined in: js-api/src/color.ts:186
Returns
number
purple
Get Signature
get
staticpurple():number
Defined in: js-api/src/color.ts:202
Returns
number
red
Get Signature
get
staticred():number
Defined in: js-api/src/color.ts:170
Returns
number
rowSelection
Get Signature
get
staticrowSelection():number
Defined in: js-api/src/color.ts:266
Returns
number
scatterPlotMarker
Get Signature
get
staticscatterPlotMarker():number
Defined in: js-api/src/color.ts:250
Returns
number
scatterPlotSelection
Get Signature
get
staticscatterPlotSelection():number
Defined in: js-api/src/color.ts:254
Returns
number
scatterPlotZoom
Get Signature
get
staticscatterPlotZoom():number
Defined in: js-api/src/color.ts:258
Returns
number
selectedRows
Get Signature
get
staticselectedRows():number
Defined in: js-api/src/color.ts:226
Returns
number
success
Get Signature
get
staticsuccess():number
Defined in: js-api/src/color.ts:282
Returns
number
white
Get Signature
get
staticwhite():number
Defined in: js-api/src/color.ts:166
Returns
number
whitesmoke
Get Signature
get
staticwhitesmoke():number
Defined in: js-api/src/color.ts:206
Returns
number
yellow
Get Signature
get
staticyellow():number
Defined in: js-api/src/color.ts:162
Returns
number
Methods
a()
statica(c):number
Defined in: js-api/src/color.ts:30
Returns the Alpha component of the color represented as ARGB-formatted integer.
Parameters
| Parameter | Type |
|---|---|
c | number |
Returns
number
argb()
staticargb(a,r,g,b):number
Defined in: js-api/src/color.ts:41
Parameters
| Parameter | Type |
|---|---|
a | number |
r | number |
g | number |
b | number |
Returns
number
b()
staticb(c):number
Defined in: js-api/src/color.ts:39
Returns the Blue component of the color represented as ARGB-formatted integer.
Parameters
| Parameter | Type |
|---|---|
c | number |
Returns
number
darken()
staticdarken(color,diff):number
Defined in: js-api/src/color.ts:118
Parameters
| Parameter | Type |
|---|---|
color | number |
diff | number |
Returns
number
fromHtml()
staticfromHtml(htmlColor):number
Defined in: js-api/src/color.ts:69
Convert HTML-formatted string (such as #ffffff) to ARGB-fromatted integer color
Parameters
| Parameter | Type |
|---|---|
htmlColor | string |
Returns
number
g()
staticg(c):number
Defined in: js-api/src/color.ts:36
Returns the Green component of the color represented as ARGB-formatted integer.
Parameters
| Parameter | Type |
|---|---|
c | number |
Returns
number
getCategoricalColor()
staticgetCategoricalColor(i):number
Defined in: js-api/src/color.ts:56
Returns i-th categorical color (looping over the palette if needed)
Parameters
| Parameter | Type |
|---|---|
i | number |
Returns
number
getCategoryColor()
staticgetCategoryColor(column,category):number
Defined in: js-api/src/color.ts:25
Returns a color associated with the specified category within a column. Returns ARGB-formatted integer. To convert to html color, use toHtml.
Parameters
| Parameter | Type |
|---|---|
column | Column |
category | any |
Returns
number
getCellColor()
staticgetCellColor(cell):number
Defined in: js-api/src/color.ts:13
Returns a color associated with the specified cell as an ARGB-formatted integer. To convert to html color, use getCellColorHtml or toHtml.
Parameters
| Parameter | Type |
|---|---|
cell | Cell |
Returns
number
getCellColorHtml()
staticgetCellColorHtml(cell):string
Defined in: js-api/src/color.ts:19
Returns a string representation of the color associated with the specified cell. For batch color manipulations, use getCellColor.
Parameters
| Parameter | Type |
|---|---|
cell | Cell |
Returns
string
getContrastColor()
staticgetContrastColor(color):number
Defined in: js-api/src/color.ts:61
Returns either black or white color, depending on which one would be most contrast to the specified [color].
Parameters
| Parameter | Type |
|---|---|
color | number |
Returns
number
getRowColor()
staticgetRowColor(column,row):number
Defined in: js-api/src/color.ts:122
Parameters
| Parameter | Type |
|---|---|
column | Column |
row | number |
Returns
number
hexToPercentRgb()
statichexToPercentRgb(hex):number[] |null
Defined in: js-api/src/color.ts:77
For RDKit molecule substruct highlight
Parameters
| Parameter | Type |
|---|---|
hex | string |
Returns
number[] | null
highlight()
statichighlight(color):number
Defined in: js-api/src/color.ts:114
Parameters
| Parameter | Type |
|---|---|
color | number |
Returns
number
opaqueIfNoAlpha()
staticopaqueIfNoAlpha(color):number
Defined in: js-api/src/color.ts:51
Returns [color] opaque when it has no alpha (written as 0xRRGGBB), as viewers draw it; otherwise unchanged.
Parameters
| Parameter | Type |
|---|---|
color | number |
Returns
number
r()
staticr(c):number
Defined in: js-api/src/color.ts:33
Returns the Red component of the color represented as ARGB-formatted integer.
Parameters
| Parameter | Type |
|---|---|
c | number |
Returns
number
scale()
staticscale(x,min,max):number
Defined in: js-api/src/color.ts:126
Parameters
| Parameter | Type |
|---|---|
x | number |
min | number |
max | number |
Returns
number
scaleColor()
staticscaleColor(x,min,max,alpha?,colorScheme?,belowMinColor?,aboveMaxColor?):number
Defined in: js-api/src/color.ts:110
Parameters
| Parameter | Type |
|---|---|
x | number |
min | number |
max | number |
alpha? | number |
colorScheme? | number[] |
belowMinColor? | number |
aboveMaxColor? | number |
Returns
number
setAlpha()
staticsetAlpha(color,alpha):number
Defined in: js-api/src/color.ts:46
Returns the color with the specified alpha component (0-255).
Parameters
| Parameter | Type |
|---|---|
color | number |
alpha | number |
Returns
number
toHtml()
statictoHtml(color):string
Defined in: js-api/src/color.ts:66
Converts ARGB-formatted integer color to a HTML-formatted string (such as #ffffff). See also toRgb.
Parameters
| Parameter | Type |
|---|---|
color | number |
Returns
string
toRgb()
statictoRgb(color):string
Defined in: js-api/src/color.ts:72
Converts ARGB-formatted integer color to a HTML-formatted string (such as rbg(20, 46, 124)). See also toHtml.
Parameters
| Parameter | Type |
|---|---|
color | number |
Returns
string