rMateGridH5 6.0

Class: SpanSummaryCollection

SpanSummaryCollection

new SpanSummaryCollection()

주어진 데이터를 병합하여 합산하는 기능을 제공하는 콜렉션 컴포넌트입니다.

이 컴포넌트로 그리드를 표현하는 경우 데이터가 변형되므로, 그리드를 통한 에디팅을 하실 수 없습니다.

See:

Example

레이아웃은 다음과 같은 형식으로 작성됩니다.

<rMateGrid>
     <SpanRowAttribute id="sumRowAttr" styleName="allTotalStyle" backgroundColor="#FAFF33"/>
     <SpanCellAttribute id="sum1CellAttr" colNo="0" styleName="subTotalStyle" backgroundColor="#CCDD66"/>
     <SpanCellAttribute id="sum2CellAttr" colNo="1" styleName="subTotalStyle" backgroundColor="#FFCC33"/>
     <SpanCellAttribute id="sumTotalCellAttr" colNo="0" styleName="allTotalHeaderStyle"/>
     <NumberFormatter id="numfmt" useThousandsSeparator="true"/>
     <PercentFormatter id="percfmt" useThousandsSeparator="true"/>
     <DataGrid id="dg1" horizontalScrollPolicy="auto" verticalAlign="middle">
         <groupedColumns>
           ...
         </groupedColumns>
         <dataProvider>
             <SpanSummaryCollection source="{$gridData}">
                 <summaries>
                     <SpanSummaryRow summaryPlacement="first" label="합계" labelDataField="Year" rowAttribute="{sumRowAttr}" cellAttribute="{sumTotalCellAttr}">
                         <SpanSummaryField dataField="Seoul" summaryOperation="SUM" />
                         <SpanSummaryField dataField="Busan" summaryOperation="SUM" />
                         <SpanSummaryField dataField="Incheon" summaryOperation="SUM" />
                         <SpanSummaryField dataField="NewYork" summaryOperation="SUM" />
                         <SpanSummaryField dataField="LA" summaryOperation="SUM" />
                         <SpanSummaryField dataField="Washington" summaryOperation="SUM" />
                     </SpanSummaryRow>
                 </summaries>
             </SpanSummaryCollection>
         </dataProvider>
     </DataGrid>
 </rMateGrid>

Members

asyncboolean

refresh함수의 비동기 실행여부.

Default Value:

false

dispatchEventEnabledboolean

이벤트 발생 여부

false로 할 경우 함수 addCellAttributeDetailAt(), addRowAttributeDetailAt() 함수등을 한꺼번에 여러 번 실행시킬 때,

이벤트가 발생하지 않아 매번 그리드가 다시 그려지는 것을 방지할 수 있습니다.

설정 후에는(true로 설정한 후) refresh()를 실행시켜 그리드를 다시 그리도록 합니다.

Default Value:

true

mergingFieldsArray

데이터의 병합에 사용되는 필드를 명시하는 SpanMergingField 객체의 배열.

배열에서 SpanMergingField객체의 순서는 병합시 필드의 우선순위를 결정합니다.

See:

SpanMergingField

sortSort

소팅시 적용할 Sort의 객체.

설정시 자동으로 정렬이 이루어지지 않으므로, 이 속성을 설정 한 후에 refresh() 메서드를 호출해야합니다.

See:

자바스크립트에서 사용할 때는 getter, setter함수를 사용합니다. - getSort(), setSort(value)
Sort

sourceobject

SpanSummaryCollection 의 원천 데이터값입니다.

배열이나, XML이 될 수 있습니다.

합산처리된 후에 source로 넣어진 값은 데이터 형식에 따라, 배열이면 ArrayCollection, XML이면 XMLListCollection이 됩니다.

See:

자바스크립트에서 사용할 때는 getter, setter함수를 사용합니다. - getSource(), setSource(value)

summariesArray

전체 데이터에 대한 합산을 정의한 SpanSummaryRow 인스턴스의 배열

한개 또는 2개이상의 SpanSummaryRow를 정의할 수 있습니다.

See:

SpanSummaryRow

Methods

addCellAttributeDetailAt(rowNo, colNo, rowSpan, colSpan, styleName, backgroundColor, formatString)

셀 속성을 추가합니다.

Name	Type	Description
`rowNo`	number	행의 index번호
`colNo`	number	컬럼의 index번호(DataGrid의 columns기준)
`rowSpan`	number	병합하려는 행의 개수
`colSpan`	number	병합하려는 컬럼의 개수
`styleName`	string	셀에 적용하려는 스타일명
`backgroundColor`	color	배경색
`formatString`	string	셀에 적용할 마스크 패턴

addEventListener(type, listener)

type에 선언된 이벤트가 발생할 경우 이벤트를 받을 수 있는 listener 함수를 등록합니다.

Name	Type	Description
`type`	string	이벤트 종류를 표현하는 문자열
`listener`	function	이벤트 발생시 불려질 함수

addRowAttributeDetailAt(rowNo, styleName, backgroundColor, formatString, editable, rowHeight)

행 속성을 추가합니다.

Name	Type	Description
`rowNo`	number	행의 index번호
`styleName`	string	셀에 적용하려는 스타일명
`backgroundColor`	color	배경색
`formatString`	string	셀에 적용할 마스크 패턴
`editable`	boolean	행의 수정가능 여부
`rowHeight`	number	행높이

cancelRefresh()

refresh명령 해제합니다.

refresh명령이 async에 의해 비동기로 실행될 경우 refresh명령을 해제합니다.

getCellAttributeAt(rowNo, colNo){SpanCellAttribute}

셀 속성을 반환합니다.

Name	Type	Description
`rowNo`	number	행의 index번호
`colNo`	number	컬럼의 index번호(DataGrid의 columns기준)

Returns:

Type	Description
SpanCellAttribute	셀 속성 객체, 없을시 null

getItemIndex(item){number}

특정 요소의 위치를 가져옵니다.

Name	Type	Description
`item`	object	검색하려는 요소

Returns:

Type	Description
number	요소의 위치 값. 없을 경우에는 -1

getRowAttributeAt(rowNo){SpanRowAttribute}

행 속성을 반환합니다.

Name	Type	Description
`rowNo`	number	행의 index번호

Returns:

Type	Description
SpanRowAttribute	행 속성 객체, 없을시 null

refresh()

정렬이나 필터링에 의해 재계산을 수행합니다.

removeAllAttribute()

모든 셀, 행 속성을 삭제합니다.

removeCellAttributeAt(rowNo, colNo){boolean}

셀의 속성을 삭제합니다.

Name	Type	Description
`rowNo`	number	행의 index번호
`colNo`	number	컬럼의 index번호(DataGrid의 columns기준)

Returns:

Type	Description
boolean	성공시 true, 실패시 false

removeEventListener(type, listener)

type에 선언된 이벤트에 연결된 listener 함수를 제거합니다.

Name	Type	Description
`type`	string	이벤트 종류를 표현하는 문자열
`listener`	function	이벤트 발생시 불려질 함수

removeRowAttributeAt(rowNo){boolean}

행의 속성을 삭제합니다.

Name	Type	Description
`rowNo`	number	행의 index번호

Returns:

Type	Description
boolean	성공시 true, 실패시 false

Events

collectionChange

콜렉션의 데이터에 변경이 일어났을때 발생합니다. (그리드의 에디팅 기능을 이용할 경우에는 발생하지 않음)

Type:

Event

Properties:

Name	Type	Description
`kind`	string	변경의 내용. 다음 중 한 개가 됩니다. - add : 데이터 행 추가 - remove : 데이터 행 삭제 - refresh : 소팅이나 필터링에 의해 데이터의 변화가 발생한 상태 - replace : 데이터 행 수정 - reset : 콜렉션 자체가 수정되어 reset이 필요한 상태 - update : 데이터의 여러행의 수정이 일어난 경우
`location`	number	데이터가 추가, 삭제, 수정된 경우 해당 행의 번호
`items`	Array	데이터가 추가, 삭제된 경우 해당 행이 들어있는 배열