Preparing search index...
The search index is not available
LineUpJS - v4.12.0
LineUpJS
IRenderTaskExecutor
Interface IRenderTaskExecutor
interface
IRenderTaskExecutor
{
copyCache
(
col
:
Column
,
from
:
Column
)
:
void
;
copyData2Summary
(
ranking
:
Ranking
)
:
void
;
dirtyColumn
(
col
:
Column
,
type
:
"data"
|
"summary"
|
"group"
)
:
void
;
dirtyRanking
(
ranking
:
Ranking
,
type
:
"data"
|
"summary"
|
"group"
)
:
void
;
groupBoxPlotStats
(
col
:
Column
&
INumberColumn
,
group
:
IOrderedGroup
,
raw
?:
boolean
,
)
:
IRenderTask
<
{
data
:
IAdvancedBoxPlotData
;
group
:
IAdvancedBoxPlotData
;
summary
:
IAdvancedBoxPlotData
;
}
,
>
;
groupCategoricalStats
(
col
:
Column
&
ICategoricalLikeColumn
,
group
:
IOrderedGroup
,
)
:
IRenderTask
<
{
data
:
ICategoricalStatistics
;
group
:
ICategoricalStatistics
;
summary
:
ICategoricalStatistics
;
}
,
>
;
groupCompare
(
ranking
:
Ranking
,
group
:
IGroup
,
rows
:
IndicesArray
,
)
:
IRenderTask
<
ICompareValue
[]
>
;
groupDateStats
(
col
:
Column
&
IDateColumn
,
group
:
IOrderedGroup
,
)
:
IRenderTask
<
{
data
:
IDateStatistics
;
group
:
IDateStatistics
;
summary
:
IDateStatistics
;
}
,
>
;
groupExampleRows
<
T
>
(
col
:
Column
,
group
:
IOrderedGroup
,
key
:
string
,
compute
:
(
rows
:
ISequence
<
IDataRow
>
)
=>
T
,
)
:
IRenderTask
<
T
>
;
groupNumberStats
(
col
:
Column
&
INumberColumn
,
group
:
IOrderedGroup
,
raw
?:
boolean
,
)
:
IRenderTask
<
{
data
:
IStatistics
;
group
:
IStatistics
;
summary
:
IStatistics
}
,
>
;
groupRows
<
T
>
(
col
:
Column
,
group
:
IOrderedGroup
,
key
:
string
,
compute
:
(
rows
:
ISequence
<
IDataRow
>
)
=>
T
,
)
:
IRenderTask
<
T
>
;
groupStringStats
(
col
:
StringColumn
,
group
:
IOrderedGroup
,
)
:
IRenderTask
<
{
data
:
IStringStatistics
;
group
:
IStringStatistics
;
summary
:
IStringStatistics
;
}
,
>
;
preCompute
(
ranking
:
Ranking
,
groups
:
{
group
:
IGroup
;
rows
:
IndicesArray
}
[]
,
maxDataIndex
:
number
,
)
:
void
;
preComputeCol
(
col
:
Column
)
:
void
;
preComputeData
(
ranking
:
Ranking
)
:
void
;
setData
(
data
:
IDataRow
[]
)
:
void
;
sort
(
ranking
:
Ranking
,
group
:
IGroup
,
indices
:
IndicesArray
,
singleCall
:
boolean
,
maxDataIndex
:
number
,
lookups
?:
CompareLookup
,
)
:
Promise
<
IndicesArray
>
;
summaryBoxPlotStats
(
col
:
Column
&
INumberColumn
,
raw
?:
boolean
,
)
:
IRenderTask
<
{
data
:
IAdvancedBoxPlotData
;
summary
:
IAdvancedBoxPlotData
}
,
>
;
summaryCategoricalStats
(
col
:
Column
&
ICategoricalLikeColumn
,
)
:
IRenderTask
<
{
data
:
ICategoricalStatistics
;
summary
:
ICategoricalStatistics
}
,
>
;
summaryDateStats
(
col
:
Column
&
IDateColumn
,
)
:
IRenderTask
<
{
data
:
IDateStatistics
;
summary
:
IDateStatistics
}
>
;
summaryNumberStats
(
col
:
Column
&
INumberColumn
,
raw
?:
boolean
,
)
:
IRenderTask
<
{
data
:
IStatistics
;
summary
:
IStatistics
}
>
;
summaryStringStats
(
col
:
StringColumn
,
)
:
IRenderTask
<
{
data
:
IStringStatistics
;
summary
:
IStringStatistics
}
>
;
terminate
()
:
void
;
valueCache
(
col
:
Column
)
:
(
dataIndex
:
number
)
=>
any
;
}
Hierarchy (
View Summary
)
IRenderTasks
IRenderTaskExecutor
Index
Methods
copy
Cache
copy
Data2
Summary
dirty
Column
dirty
Ranking
group
Box
Plot
Stats
group
Categorical
Stats
group
Compare
group
Date
Stats
group
Example
Rows
group
Number
Stats
group
Rows
group
String
Stats
pre
Compute
pre
Compute
Col
pre
Compute
Data
set
Data
sort
summary
Box
Plot
Stats
summary
Categorical
Stats
summary
Date
Stats
summary
Number
Stats
summary
String
Stats
terminate
value
Cache
Methods
copy
Cache
copyCache
(
col
:
Column
,
from
:
Column
)
:
void
Parameters
col
:
Column
from
:
Column
Returns
void
copy
Data2
Summary
copyData2Summary
(
ranking
:
Ranking
)
:
void
Parameters
ranking
:
Ranking
Returns
void
dirty
Column
dirtyColumn
(
col
:
Column
,
type
:
"data"
|
"summary"
|
"group"
)
:
void
Parameters
col
:
Column
type
:
"data"
|
"summary"
|
"group"
Returns
void
dirty
Ranking
dirtyRanking
(
ranking
:
Ranking
,
type
:
"data"
|
"summary"
|
"group"
)
:
void
Parameters
ranking
:
Ranking
type
:
"data"
|
"summary"
|
"group"
Returns
void
group
Box
Plot
Stats
groupBoxPlotStats
(
col
:
Column
&
INumberColumn
,
group
:
IOrderedGroup
,
raw
?:
boolean
,
)
:
IRenderTask
<
{
data
:
IAdvancedBoxPlotData
;
group
:
IAdvancedBoxPlotData
;
summary
:
IAdvancedBoxPlotData
;
}
,
>
Parameters
col
:
Column
&
INumberColumn
group
:
IOrderedGroup
Optional
raw
:
boolean
Returns
IRenderTask
<
{
data
:
IAdvancedBoxPlotData
;
group
:
IAdvancedBoxPlotData
;
summary
:
IAdvancedBoxPlotData
;
}
,
>
group
Categorical
Stats
groupCategoricalStats
(
col
:
Column
&
ICategoricalLikeColumn
,
group
:
IOrderedGroup
,
)
:
IRenderTask
<
{
data
:
ICategoricalStatistics
;
group
:
ICategoricalStatistics
;
summary
:
ICategoricalStatistics
;
}
,
>
Parameters
col
:
Column
&
ICategoricalLikeColumn
group
:
IOrderedGroup
Returns
IRenderTask
<
{
data
:
ICategoricalStatistics
;
group
:
ICategoricalStatistics
;
summary
:
ICategoricalStatistics
;
}
,
>
group
Compare
groupCompare
(
ranking
:
Ranking
,
group
:
IGroup
,
rows
:
IndicesArray
,
)
:
IRenderTask
<
ICompareValue
[]
>
Parameters
ranking
:
Ranking
group
:
IGroup
rows
:
IndicesArray
Returns
IRenderTask
<
ICompareValue
[]
>
group
Date
Stats
groupDateStats
(
col
:
Column
&
IDateColumn
,
group
:
IOrderedGroup
,
)
:
IRenderTask
<
{
data
:
IDateStatistics
;
group
:
IDateStatistics
;
summary
:
IDateStatistics
;
}
,
>
Parameters
col
:
Column
&
IDateColumn
group
:
IOrderedGroup
Returns
IRenderTask
<
{
data
:
IDateStatistics
;
group
:
IDateStatistics
;
summary
:
IDateStatistics
;
}
,
>
group
Example
Rows
groupExampleRows
<
T
>
(
col
:
Column
,
group
:
IOrderedGroup
,
key
:
string
,
compute
:
(
rows
:
ISequence
<
IDataRow
>
)
=>
T
,
)
:
IRenderTask
<
T
>
Type Parameters
T
Parameters
col
:
Column
group
:
IOrderedGroup
key
:
string
compute
:
(
rows
:
ISequence
<
IDataRow
>
)
=>
T
Returns
IRenderTask
<
T
>
group
Number
Stats
groupNumberStats
(
col
:
Column
&
INumberColumn
,
group
:
IOrderedGroup
,
raw
?:
boolean
,
)
:
IRenderTask
<
{
data
:
IStatistics
;
group
:
IStatistics
;
summary
:
IStatistics
}
,
>
Parameters
col
:
Column
&
INumberColumn
group
:
IOrderedGroup
Optional
raw
:
boolean
Returns
IRenderTask
<
{
data
:
IStatistics
;
group
:
IStatistics
;
summary
:
IStatistics
}
>
group
Rows
groupRows
<
T
>
(
col
:
Column
,
group
:
IOrderedGroup
,
key
:
string
,
compute
:
(
rows
:
ISequence
<
IDataRow
>
)
=>
T
,
)
:
IRenderTask
<
T
>
Type Parameters
T
Parameters
col
:
Column
group
:
IOrderedGroup
key
:
string
compute
:
(
rows
:
ISequence
<
IDataRow
>
)
=>
T
Returns
IRenderTask
<
T
>
group
String
Stats
groupStringStats
(
col
:
StringColumn
,
group
:
IOrderedGroup
,
)
:
IRenderTask
<
{
data
:
IStringStatistics
;
group
:
IStringStatistics
;
summary
:
IStringStatistics
;
}
,
>
Parameters
col
:
StringColumn
group
:
IOrderedGroup
Returns
IRenderTask
<
{
data
:
IStringStatistics
;
group
:
IStringStatistics
;
summary
:
IStringStatistics
;
}
,
>
pre
Compute
preCompute
(
ranking
:
Ranking
,
groups
:
{
group
:
IGroup
;
rows
:
IndicesArray
}
[]
,
maxDataIndex
:
number
,
)
:
void
Parameters
ranking
:
Ranking
groups
:
{
group
:
IGroup
;
rows
:
IndicesArray
}
[]
maxDataIndex
:
number
Returns
void
pre
Compute
Col
preComputeCol
(
col
:
Column
)
:
void
Parameters
col
:
Column
Returns
void
pre
Compute
Data
preComputeData
(
ranking
:
Ranking
)
:
void
Parameters
ranking
:
Ranking
Returns
void
set
Data
setData
(
data
:
IDataRow
[]
)
:
void
Parameters
data
:
IDataRow
[]
Returns
void
sort
sort
(
ranking
:
Ranking
,
group
:
IGroup
,
indices
:
IndicesArray
,
singleCall
:
boolean
,
maxDataIndex
:
number
,
lookups
?:
CompareLookup
,
)
:
Promise
<
IndicesArray
>
Parameters
ranking
:
Ranking
group
:
IGroup
indices
:
IndicesArray
singleCall
:
boolean
maxDataIndex
:
number
Optional
lookups
:
CompareLookup
Returns
Promise
<
IndicesArray
>
summary
Box
Plot
Stats
summaryBoxPlotStats
(
col
:
Column
&
INumberColumn
,
raw
?:
boolean
,
)
:
IRenderTask
<
{
data
:
IAdvancedBoxPlotData
;
summary
:
IAdvancedBoxPlotData
}
,
>
Parameters
col
:
Column
&
INumberColumn
Optional
raw
:
boolean
Returns
IRenderTask
<
{
data
:
IAdvancedBoxPlotData
;
summary
:
IAdvancedBoxPlotData
}
>
summary
Categorical
Stats
summaryCategoricalStats
(
col
:
Column
&
ICategoricalLikeColumn
,
)
:
IRenderTask
<
{
data
:
ICategoricalStatistics
;
summary
:
ICategoricalStatistics
}
,
>
Parameters
col
:
Column
&
ICategoricalLikeColumn
Returns
IRenderTask
<
{
data
:
ICategoricalStatistics
;
summary
:
ICategoricalStatistics
}
>
summary
Date
Stats
summaryDateStats
(
col
:
Column
&
IDateColumn
,
)
:
IRenderTask
<
{
data
:
IDateStatistics
;
summary
:
IDateStatistics
}
>
Parameters
col
:
Column
&
IDateColumn
Returns
IRenderTask
<
{
data
:
IDateStatistics
;
summary
:
IDateStatistics
}
>
summary
Number
Stats
summaryNumberStats
(
col
:
Column
&
INumberColumn
,
raw
?:
boolean
,
)
:
IRenderTask
<
{
data
:
IStatistics
;
summary
:
IStatistics
}
>
Parameters
col
:
Column
&
INumberColumn
Optional
raw
:
boolean
Returns
IRenderTask
<
{
data
:
IStatistics
;
summary
:
IStatistics
}
>
summary
String
Stats
summaryStringStats
(
col
:
StringColumn
,
)
:
IRenderTask
<
{
data
:
IStringStatistics
;
summary
:
IStringStatistics
}
>
Parameters
col
:
StringColumn
Returns
IRenderTask
<
{
data
:
IStringStatistics
;
summary
:
IStringStatistics
}
>
terminate
terminate
()
:
void
Returns
void
value
Cache
valueCache
(
col
:
Column
)
:
(
dataIndex
:
number
)
=>
any
Parameters
col
:
Column
Returns
(
dataIndex
:
number
)
=>
any
Settings
Member Visibility
Protected
Inherited
Theme
OS
Light
Dark
On This Page
Methods
copy
Cache
copy
Data2
Summary
dirty
Column
dirty
Ranking
group
Box
Plot
Stats
group
Categorical
Stats
group
Compare
group
Date
Stats
group
Example
Rows
group
Number
Stats
group
Rows
group
String
Stats
pre
Compute
pre
Compute
Col
pre
Compute
Data
set
Data
sort
summary
Box
Plot
Stats
summary
Categorical
Stats
summary
Date
Stats
summary
Number
Stats
summary
String
Stats
terminate
value
Cache
LineUpJS - v4.12.0
Loading...