RealGrid2 API
Interface
ColumnHeader

ColumnHeader

그리드 헤더 영역에 표시되는 컬럼 헤더에 대한 설정 정보 모델

Signature:

export interface ColumnHeader extends ColumnObject 

Extends: ColumnObject

Remarks

GridColumn.header 에서 사용한다.

[상위 클래스]

ColumnObject

Example

let col = grid.columnByName('col1')
col.header.checkLocation = 'leftEdge';

Properties

PropertyTypeDescription
checkLocationColumnHeaderItemLocation헤더 문자열을 기준으로한 체크박스의 위치
exportStyleNamestringexcel로 export될때 적용될 스타일 명
itemGapnumber헤더 문자열과 이미지나 체크박스와의 간격
itemOffsetnumber이미지나 체크박스와 셀 경계와의 공백
localeTextConfigObject다국어를 사용하는 경우 사용한다.
showTooltipboolean툴팁 표시 여부
styleNamestring스타일 클래스 이름
templateCallbackRealizeHeaderCallbackColumnObject.template에 특정 문자열을 교체해서 표시할때 사용
textstring컬럼 헤더에 표시될 문자열
tooltipstring표시할 툴팁 메시지

Properties Desc

checkLocation

헤더 문자열을 기준으로한 체크박스의 위치

Type - ColumnHeaderItemLocation


exportStyleName

excel로 export될때 적용될 스타일 명

Type - string


itemGap

헤더 문자열과 이미지나 체크박스와의 간격

Type - number


itemOffset

이미지나 체크박스와 셀 경계와의 공백

Type - number


localeText

다국어를 사용하는 경우 사용한다.

Type - ConfigObject

Example:

gridView.setColumns([
  { fieldName: "fieldName",
    name: "columnName",
    text: "기본",
    localeText: {
      "ko": "한국",
      "en": "영어",
      "en-CA": "영어-캐나다"
    }
  }
])

showTooltip

툴팁 표시 여부

Type - boolean

Remarks:

grid.header.showTooltip이 undefined이면 column.header.showTooltip이 true인 컬럼만 tooltip을 표시한다. grid.header.showTooltip이 true이면 column.header.showTooltip이 undefined이거나 true인 컬럼의 tooltip을 표시한다. grid.header.showTooltip이 false인경우 표시되지 않는다.


styleName

스타일 클래스 이름

Type - string


templateCallback

ColumnObject.template에 특정 문자열을 교체해서 표시할때 사용

Type - RealizeHeaderCallback

Remarks:

values에 없는 문자열인 경우 호출된다.


text

컬럼 헤더에 표시될 문자열

Type - string

Remarks:

이 값이 null 이면 컬럼에 연결된 데이터필드 이름을 표시한다. 데이터필드가 연결되지 않았다면 컬럼의 이름을 표시한다.


tooltip

표시할 툴팁 메시지

Type - string

Remarks:

지정되지 않으면 text를 표시한다.