RealGrid2 API
Interface
CellLayoutColumnItem

CellLayoutColumnItem

컬럼 레이아웃 정보 모델

Signature:

export interface CellLayoutColumnItem extends CellLayoutItem 

Extends: CellLayoutItem

Remarks

GridBase.getLayoutByColumn() 에서 해당 모델을 반환할 수 있다.

GridBase.setColumnLayout() 로 설정될 때에는 특정 속성만 사용 가능하다.

GridColumn.layout 의 속성으로 설정 가능하다.

CellLayoutItem 을 상속한다.

[상위 클래스]

CellLayoutItem

Example

// 반환값일 경우
{
     mergeRule: undefined,
     breakMergeOnEmpty: false,
     equalBlank: undefined,
     equalBlankExpression: undefined,
     cellSpan: 1,
     headerSpan: undefined,
     summarySpan: undefined,
     footerSpan: undefined,
     dataSpan: undefined,
     spanCallback: undefined,
     visible: true,
     vindex: 1,
     width: 100,
     fillWidth: NaN,
     cellWidth: 250
}
 
// method 로 설정할 경우
{
     column: 'Country'
     cellSpan: 3,
     width: 100,
}
 
{
     column: 'Country'
     headerSpan: 2,
     summarySpan: 2,
     footerSpan: 2,
     dataSpan: 4,
}
 
// 컬럼에 설정할 경우
column.layout.spanCallback = function (grid, layout, itemIndex) {
    var value = grid.getValue(itemIndex, layout.column.name);
    if (value) {
        return value[0] === "B" ? 2 : value[0] === "F" ? 3 : 1;
    }

Events

PropertyTypeDescription
footerSpanCallbackSummaryCellSpanCallback사용자 지정 footer 스팬을 위한 콜백
groupFooterSpanCallbackGroupFooterCellSpanCallback사용자 지정 groupFooter 스팬을 위한 콜백
groupFooterUserSpanCallbackGroupFooterUserSpanCallback사용자 지정 groupFooter UserSpan을 위한 콜백 groupFooterSpanCallback과는 다르게 block단위로 span할수 있다.
spanCallbackCellSpanCallback사용자 지정 스팬을 위한 콜백
summarySpanCallbackSummaryCellSpanCallback사용자 지정 headerSummary 스팬을 위한 콜백

Properties

PropertyTypeDescription
breakMergeOnEmptyboolean빈 셀일 때 머지 중단 여부
cellSpannumber기본 셀 스팬 개수
columnstring | ValueColumn컬럼명
dataSpannumber셀 스팬 개수
equalBlankboolean같은 컬럼의 이전 행의 셀과 값이 동일할때 셀의 묶음 여부
equalBlankExpressionstringequalBlanktrue인 경우 같은 값으로 처리할 수식
footerSpannumberfooter가 하나일때 컬럼레이아웃별 footer의 span을 지정한다.
footerSpansnumber[]푸터 스팬 개수
footerUserSpansUserSpan[]사용자 지정 footer span
groupFooterSpansnumber[]그룹 푸터 스팬 개수
groupFooterUserSpansUserSpan[]사용자 지정 groupFooter span
headerSpannumber헤더 스팬 개수
mergeRulestring | { criteria: string; }컬럼 머지할 때의 규칙
summarySpannumberheaderSummary가 하나일때 컬럼레이아웃별 headerSummary의 span을 지정한다.
summarySpansnumber[]summary 스팬 개수
summaryUserSpansUserSpan[]사용자 지정 headerSummary span

Events Desc

footerSpanCallback

사용자 지정 footer 스팬을 위한 콜백

Type - SummaryCellSpanCallback


groupFooterSpanCallback

사용자 지정 groupFooter 스팬을 위한 콜백

Type - GroupFooterCellSpanCallback


groupFooterUserSpanCallback

사용자 지정 groupFooter UserSpan을 위한 콜백 groupFooterSpanCallback과는 다르게 block단위로 span할수 있다.

Type - GroupFooterUserSpanCallback


spanCallback

사용자 지정 스팬을 위한 콜백

Type - CellSpanCallback

Example:

let layout = column.layout
layout.spanCallback = function (grid, layout, itemIndex) {
    var value = grid.getValue(itemIndex, layout.column.dataIndex);
    if (value) {
        return value[0] === "B" ? 3 : value[0] === "F" ? 2 : 1;
    }
    return 1;
};

summarySpanCallback

사용자 지정 headerSummary 스팬을 위한 콜백

Type - SummaryCellSpanCallback


Properties Desc

breakMergeOnEmpty

빈 셀일 때 머지 중단 여부

Type - boolean


cellSpan

기본 셀 스팬 개수

Type - number

Remarks:

다른 스팬이 지정이 되지 않을 때, 해당 값을 따른다.

GridBase.setColumnLayout() 로 설정될 때 사용 가능하다.


column

컬럼명

Type - string | ValueColumn


dataSpan

셀 스팬 개수

Type - number

Remarks:

상위 그룹의 direction이 vertical인 경우 rowSpan하고 horizontal인 경우 colspan한다. GridBase.setColumnLayout() 로 설정될 때 사용 가능하다.


equalBlank

같은 컬럼의 이전 행의 셀과 값이 동일할때 셀의 묶음 여부

Type - boolean


equalBlankExpression

equalBlanktrue인 경우 같은 값으로 처리할 수식

Type - string


footerSpan

footer가 하나일때 컬럼레이아웃별 footer의 span을 지정한다.

Type - number


footerSpans

푸터 스팬 개수

Type - number[]

Remarks:

footer가 하나인 경우 footerSpan 으로 지정한다. GridBase.setColumnLayout() 로 설정될 때 사용 가능하다.


footerUserSpans

사용자 지정 footer span

Type - UserSpan[]


groupFooterSpans

그룹 푸터 스팬 개수

Type - number[]

Remarks:

groupFooter가 하나인 경우 groupFooterSpan으로 지정한다. GridBase.setColumnLayout() 로 설정될 때 사용 가능하다.


groupFooterUserSpans

사용자 지정 groupFooter span

Type - UserSpan[]


headerSpan

헤더 스팬 개수

Type - number

Remarks:

GridBase.setColumnLayout() 로 설정될 때 사용 가능하다.


mergeRule

컬럼 머지할 때의 규칙

Type - string | { criteria: string; }

Remarks:

undefined 이면(기본값) 컬럼의 mergeRule 로 병합한다. null 이면 컬럼의 mergeRule 을 무시한다. {criteria: string}은 이전버전과 호환성을 위해서 사용한다.


summarySpan

headerSummary가 하나일때 컬럼레이아웃별 headerSummary의 span을 지정한다.

Type - number


summarySpans

summary 스팬 개수

Type - number[]

Remarks:

summary가 하나인 경우 summarySpan 으로 지정한다. GridBase.setColumnLayout() 로 설정될 때 사용 가능하다.


summaryUserSpans

사용자 지정 headerSummary span

Type - UserSpan[]