DataColumn

ValueColumn 을 상속한 컬럼 정보 모델

Signature:

export interface DataColumn extends ValueColumn 

Extends: ValueColumn

Remarks

추가로 정렬, 필터링, 그룹 정보 등이 들어가 있다.

[상위 클래스]

GridColumn - ValueColumn

Events

Properties

Methods

Events Desc

displayCallback

화면에 표시하는 값을 설정하기 위한 콜백

Type - DisplayCallback

objectCallback

field의 dataType이 object인 경우 화면에 표시하는 값을 설정하기 위한 콜백

Type - ColumnObjectCallback

Properties Desc

autoFilter

자동 필터링 적용 여부

Type - boolean

autoFilters

자동으로 생성된 filter들

Type - ColumnFilterCollection

Remarks:

autoFilter가 true이면서 filterIcon을 클릭했을때 갱신된다. 또는 GridBase.autoFiltersRefresh()를 이용해서 갱신한다.

breakMergeOnEmpty

빈 셀일 때 머지 중단 여부

Type - boolean

button

데이터 셀의 우측에 표시할 버튼 종류

Type - CellButton

buttonWidth

버튼의 너비

Type - number

cellProtectProps

엑셀 export시 셀의 잠금 또는 수식 숨기기를 설정한다.

Type - CellProtectProperties

Remarks:

GridExportOptions.sheetProtect와 함께 사용한다.

defaultValue

초기값

Type - any

Remarks:

insert 또는 append시 해당 컬럼의 기본값이다.

displayText

header/export/feedback에 표시되는 text;

Type - string

editable

편집 가능 여부

Type - boolean

Remarks:

컬럼의 editable이 undefined이면 GridBase.editOptions의 editable을 따라간다.

true이면 해당 컬럼은 편집가능하고 false이면 그리드 편집기가 활성화 되지 않는다.

equalBlank

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

Type - boolean

Remarks:

mergeRule과는 다르게 셀을 merge하지 않고 단지 text만 보여주지 않는다.

equalBlankExpression

equalBlank 가 true인 경우 같은 값으로 처리할 수식

Type - string

equalBlankLine

이전행의 값과 동일할때 셀 하단 라인 표시 여부

Type - boolean

equalBlankText

이전행의 값과 동일할때 표시되는 string

Type - string

excelFormat

엑셀 export 시 출력되는 서식

Type - string

Remarks:

예) excelFormat: #,##0;[Red]-#,##0;-

excelFormulaStatement

엑셀 export시 출력되는 수식

Type - string

Remarks:

예) excelFormulaStatement: '${excelcolumn[‘컬럼1’]}${row} + ${excelcolumn[‘컬럼2’]}${row}'

fieldIndex

컬럼이 표시하는 필드의 인덱스

Type - number

fieldName

컬럼이 표시하는 데이터 필드의 이름

Type - string

Remarks:

존재하지 않는 필드 이름을 지정하거나 지정하지 않으면 이 컬럼에 해당하는 셀은 아무것도 표시하지 않는다.

filterable

필터링 가능 여부

Type - boolean

filterIconVisible

필터 Icon 표시여부

Type - boolean

filters

필터들

Type - ColumnFilterCollection

Remarks:

반환할 때는 ColumnFilterCollection 모델만을 따르지만, 설정할 때는 GridBase.setColumnFilters() 의 매개변수 형식과 동일하다.

filterSelectorWidth

필터 선택창의 너비

Type - number

Remarks:

필터 선택창의 너비를 지정한다.

groupable

true로 지정하면 사용자가 컬럼 헤더를 마우스로 드래깅해서 그룹핑을 할 수 있다.

Type - boolean

groupLevel

rowGroup의 group순번.

Type - number

Remarks:

rowGroup상태일때 컬럼이 참조하는 field의 groupLevel

hasFilters

컬럼에 filter가 있는지 확인한다.

Type - boolean

labelField

컬럼 셀에 표시될 값의 목록을 지정하는 필드

Type - string

Remarks:

labelField 가 다른 필드로 지정되면, 해당 컬럼 셀에는 실제 값 대신 이 필드의 셀과 같은 행에 있는 labelField 의 값을 표시한다. values, labels 속성보다 labelField 속성이 우선한다.

labels

컬럼 셀에 표시될 값의 목록

Type - string[]

Remarks:

values 에 셀 값에 해당하는 항목이 없으면 셀 값이 그대로 표시된다.

lookupData

values와 labels를 설정한다.

Type - ConfigObject | ConfigObject[]

Remarks:

서버에서 code정보를 map 형태로 가져온후 values와 labels를 설정할때 사용한다.

Example:

var col = grid.columnByName("column");
var codeInfo = {
  "type": "areacode",
  "list": [
    {code:"11", text:"서울특별시"},
    {code:"21", text:"부산광역시"}
  ]
}
col.lookupData = codeInfo;
 
// 배열로 설정하는 경우.
var codeList = [
 {code:"11", text:"서울특별시"},
 {code:"21", text:"부산광역시"}
 ...
];
col.lookupData = codeList;

lookupDisplay

컬럼 셀에 values 목록 중 셀의 값에 해당하는 위치에 있는 labels 항목의 값의 표시 여부

Type - boolean

lookupKeyFields

lookupKeyFields

Type - string[]

Remarks:

lookupSourceTree를 이용해서 lookup을 표시할때 선행 value를 찾아오기 위한 field의 name들

lookupSourceId

등록한 lookupSourceTree의 id

Type - string

mergeEdit

merge된 셀을 편집했을때 merge된 모든 행을 변경한다.

Type - boolean

Remarks:

true이면 mergeRule 또는 mergedRowGrouping에 의해서 merge된 셀을 수정한 경우 merge된 행 전체를 수정한다. commitByCell 이 true여야 한다.

mergeRule

컬럼 머지 규칙

Type - string | { criteria: string; }

Remarks:

컬럼에 속한 셀들을 묶어서 표시할 수 있다. 이전 행의 셀과 병합할 것인 지를 판단할 수식을 설정한다. {criteria: string}형식은 이전버전과 호환을 위해 사용한다.

nanText

값이 NaN 일 경우 표시되는 텍스트

Type - string

Remarks:

dataType 이 숫자인 경우에만 가능

objectKey

field의 dataType이 object인 경우 화면에 보여주고자하는 name

Type - string

Remarks:

objectKey가 지정되면 해당 name은 편집이 가능.

placeHolder

셀 데이터가 없는 경우 표시되는 문자열

Type - string

Remarks:

데이터가 없는 경우 해당 문자열이 표시된다.

placeHolderStyleName

셀 데이터가 없는 경우 적용되는 class명

Type - string

readOnly

readOnly 여부

Type - boolean

Remarks:

true이면 그리드 편집기는 활성화되지만 편집은 할수 없다.

required

필수 여부

Type - boolean

requiredLevel

검증 시 값이 요구될 때 표시될 레벨

Type - ValidationLevel

requiredMessage

검증 시 값이 요구될 때 발생하는 메시지

Type - string

showInlineFilter

filterPanel의 입력창 표시여부

Type - boolean

Remarks:

FilterPanel.showInput이 false이면 column.showInlineFilter가 true인 것만 표시된다.

sortable

정렬 가능 여부

Type - boolean

Remarks:

false인경우 컬럼 header를 클릭하여도 정렬되지 않는다.

sortByLabel

Label 기준으로 정렬 여부

Type - boolean

sortDirection

정렬 방식

Type - SortDirection

sortOrder

정렬 순서

Type - number

tag

사용자가 지정하는 임의 값

Type - any

Remarks:

columnByTag또는 columnsByTag를 이용해서 가져올수 있다.

textOfInvalid

셀 데이터가 lookup values 에 없는 경우 표시되는 텍스트

Type - string

Remarks:

문자열을 지정하면 해당 문자열이 표시된다.

type

컬럼의 type

Type - "data"

validations

이 컬럼에 적용할 EditValidation 목록

Type - EditValidationCollection

Remarks:

반환할 때는 EditValidationCollection 모델을 따르지만, 설정할 때는 GridBase.setValidations() 의 매개변수 형식과 동일하다.

values

컬럼 셀에 실제 값의 목록

Type - string[]

Remarks:

values 에 셀 값에 해당하는 항목이 없으면 셀 값이 그대로 표시된다.

valueType

컬럼에 연결된 데이터 필드의 dataType

Type - ValueType

zeroText

값이 0일 때 표시되는 텍스트

Type - string

Remarks:

dataType 이 숫자인 경우에만 가능

Methods Desc

activateAllFilters

filters에 등록된 filter의 active상태를 입력된 값으로 변경한다.

[매개변수 목록]

active - boolean

boolean

[반환값] - void

activateFilters

filters에서 지정된 filter의 active상태를 변경한다.

addFilters

filters에 filter를 추가한다.

[매개변수 목록]

filters - (ColumnFilter | ConfigObject) | (ColumnFilter | ConfigObject)[]

filter객체 배열

overwrite - boolean

filterName이 존재하는 경우 덮어쓰기한다 defaultValue false

[반환값] - void

Remarks:

컬럼에 filter를 등록한다.

autoFilterRefresh

autoFilter가 true일때 filter정보를 갱신한다.

clearFilters

filters에 등록된 filter를 삭제하고 초기화 한다.

getActiveFilters

입력된 active상태에 있는 filte들을 가져온다.

[매개변수 목록]

active - boolean

boolean;

[반환값] - ColumnFilter[]

getFilter

컬럼 필터객체를 가져온다.

hideAllColumnFilters

컬럼의 모든 filter를 숨기거나 표시한다.

[매개변수 목록]

hide - boolean

boolean;

[반환값] - void

hideColumnFilters

지정된 filter를 filter Selector에서 보이지 않도록 한다. hide상태여도 filter의 active상태는 그리드에 적용된다.

[매개변수 목록]

filterNames - string | string[]

숨기거나 보이고자하는 filter의 name 배열

hide - boolean

boolean;

[반환값] - void

isFiltered

컬럼이 filtering중인지 확인한다.

[반환값] boolean

removeFilters

filters에서 filter를 제거한다.

setFilters

컬럼에 filter를 설정한다.

[매개변수 목록]

filters - (ColumnFilter | ConfigObject)[]

filter 설정 정보 배열

[반환값] - void

Example:

var col = gridView.columnByName("areacode");
var filters = [{
  name:"서울",
  criteria:"value = '11'",
  active: true
}, {
  name:"부산",
  criteria:"value = '21'",
  text:"부산광역시",
  active: false
}];
col.setFilters(filters);

toggleAllFilters

컬럼의 모든 filter들의 active상태를 toggle한다.

toggleFilters

지정된 filter의 acitve상태를 toggle한다.

[매개변수 목록]

filterNames - string | string[]

active 상태를 변경하려는 filter의 name들

[반환값] - void