# makeSubTotal (method)

> `stdCol`(기준 열)의 같은 값끼리 그룹으로 묶어 합계, 평균, 건수 등을 계산한 소계행을 추가합니다.(`SearchMode` `0`, `2`만 지원)
> 데이터 조회 후 사용하며, onDataLoad에서 호출을 권장합니다.
> onSearchFinish에서 호출하면 데이터가 많을 경우 성능이 저하될 수 있습니다.
> 머지된 행을 1건으로 계산하려면 CalcMergeMode를 설정해야 합니다.

### Syntax

    void makeSubTotal( subTotalRows, usermerge, excludeSubTotalRowCount );

### Parameters

Name | Type | Required | Description
--- | --- | --- | ---
subTotalRows | `array[object]` | 필수 | 소계 행 설정 배열. 아래 `subTotalRows` 표 참고
usermerge | `boolean` | 선택 | 머지 방식 설정 `0(false)`:`stdCol` 기준으로 자동 머지 (`default`) — 사용자의 `DataMerge`, `PrevColumnMerge` 설정 무시 `1(true)`:사용자가 설정한 `DataMerge`, `PrevColumnMerge`에 따라 머지
excludeSubTotalRowCount | `boolean` | 선택 | 소계, 누계 행을 `SEQ` 컬럼과 `InfoRow` 행의 개수 카운트에서 제외 여부 `0(false)`:소계, 누계 행을 `SEQ` 컬럼과 `InfoRow` 행의 개수 카운트에 포함 (`default`) `1(true)`:소계, 누계 행을 `SEQ` 컬럼과 `InfoRow` 행의 개수 카운트에서 제외

### subTotalRows

Name | Type | Required | Description
--- | --- | --- | ---
stdCol | `string` | 필수 | 기준 열
sumCols | `string` | 선택 | 소계가 계산(합)되어야 할 열이름들을 '|'로 연결한 문자열
countCols | `string` | 선택 | 소계 행에 데이터 행의 수로 계산되어야 할 열이름들을 '|'로 연결한 문자열
avgCols | `string` | 선택 | 소계가 계산(평균값)되어야 할 열이름들을 '|'로 연결한 문자열
color | `string` | 선택 | 소계 행의 배경색
showCumulate | `boolean` | 선택 | 소계에 대한 누계 행 표시 여부 `0(false)`:소계에 대한 누계 행 표시 안함(`default`) `1(true)`:소계에 대한 누계 행 표시
cumulateColor | `string` | 선택 | 누계 행의 배경색
sort | `string` | 선택 | 기준 열의 정렬 처리 방법 `""`:사용안함 (`default`) `"asc"`:오름차순 정렬 `"desc"`:내림차순 정렬
position | `string` | 선택 | 소계행 생성 위치 `"bottom"`:각 그룹의 하단에 표시 (`default`) `"top"`:각 그룹의 상단에 표시 `"bottomAll"`:소계행을 시트 최하단에 모아서 표시 `"topAll"`:소계행을 시트 최상단에 모아서 표시
captionCol | `array[object]` | 선택 | 소계행에서 계산 컬럼(`sumCols`, `countCols`, `avgCols`) 외의 컬럼에 표시할 내용을 설정합니다. 설정하면 기본 텍스트(“소계: 값”)는 표시되지 않으며, 명시한 항목만 표시됩니다. `"col"`:대상 열이름 `"val"`:소계행에 표시할 값 (문자열 또는 함수) `"cumVal"`:누계행에 표시할 값 `"span"`:해당 `col` 기준으로 열머지할 컬럼 수 (`val`에 값이 있어야 병합됨) 사용 가능한 예약어 `%s`:소계(누계) 텍스트 `%col`:소계 기준값 `%cnt`:소계(누계) 건수 `%capCol`:`col`에 설정된 컬럼의 마지막 행 값 (default: `[{ col: "기준 열", val: "%s: %col" }]`)
mode | `number` | 선택 | 소계행 표시 방법을 설정 `0`:모든 그룹에 소계행 표시 (`default`) `1`:소계 계산 대상 행이 2건 이상인 그룹만 소계행 표시 `2`:`NoCalculate` 사용 시 소계 계산 대상 행이 1건 이상인 그룹만 소계행 표시 (소계행은 생성되며, 화면에서만 숨김 처리됩니다.)
hidden | `boolean` | 선택 | 감춰진 행(`Visible:0`)을 소계 계산에 포함할지 여부 `0(false)`:감춰진 행 제외 (`default`) `1(true)`:감춰진 행 포함

### Return Value

none

### Example

#### 단일 컬럼 소계

    // captionCol 미설정 — 기본 캡션("소계: 값")이 자동 표시
    sheet.makeSubTotal([
      {
        stdCol: 'sPolicy',
        sumCols: 'A|B|C|D',
        position: 'bottom',
        color: '#dbe2eb'
      }
    ]);

#### 단일 컬럼 소계 (mode:1)

    // mode:1 — 소계 계산 대상 행이 2건 이상인 그룹만 소계행 표시
    sheet.makeSubTotal([
      {
        stdCol: 'sPolicy',
        sumCols: 'A|B|C|D',
        position: 'bottom',
        color: '#dbe2eb',
        mode: 1
      }
    ]);

#### 단일 컬럼 소계/누계

    // captionCol 설정 시 기본 캡션("소계: 값")은 사라지므로,
    // 표시하려면 captionCol에 { col: 'stdCol명', val: '%s: %col' }을 직접 지정해야 합니다.
    sheet.makeSubTotal([
      {
        stdCol: 'sPolicy',
        sumCols: 'A|B|C|D',
        color: '#dbe2eb',
        cumulateColor: '#b2c4d9',
        showCumulate: 1,
        position: 'bottom',
        captionCol: [
          { col: 'sPolicy', val: '%s: %col', cumVal: '%s: %col' }
        ]
      }
    ]);

#### captionCol 함수형 val 사용

    // captionCol의 val에 함수를 사용하여 소계 값을 동적으로 계산
    // 소계행은 Text 타입이므로 숫자 포맷이 필요하면 함수에서 직접 처리해야 합니다.
    sheet.makeSubTotal([
      {
        stdCol: 'sPolicy',
        sumCols: 'A|B|C|D',
        position: 'bottom',
        captionCol: [
          {
            col: 'E',
            val: function (fr) {
              // Type과 Format을 직접 설정하면 숫자 포맷 적용 가능
              var ratio = (fr.Row["B"] / fr.Row["A"] * 100).toFixed(1);
              var type = fr.Sheet.getAttribute("", fr.Col, "Type");
              fr.Row[fr.Col + "Type"] = type;
              fr.Row[fr.Col + "Format"] = "#,##0.##### \\%";
              return ratio;
            }
          },
          {
            col: 'F',
            val: function (fr) {
              var val = fr.Row["A"] + fr.Row["B"];
              var type = fr.Sheet.getAttribute("", fr.Col, "Type");
              fr.Row[fr.Col + "Type"] = type;
              fr.Row[fr.Col + "Format"] = "#,##0";
              return val;
            }
          }
        ]
      }
    ]);

#### 소계 그룹 데이터 접근

    // captionCol function에서 소계 그룹의 데이터 행에 접근
    sheet.makeSubTotal([
      {
        stdCol: 'sPolicy',
        sumCols: 'A',
        avgCols: 'B',
        countCols: 'C',
        captionCol: [
          {
            col: 'sUnit',
            val: function (fr) {
              // 현재 소계행의 그룹 데이터를 가져옴
              var subSumSet = fr.Sheet.SubSumRowsArray.filter(function(rowSet) {
                return rowSet.SubSumRow == fr.Row;
              });
              // SubSumGroupedRows: 소계 그룹에 속한 데이터 행 배열
              return subSumSet[0].SubSumGroupedRows.length;
            }
          }
        ]
      }
    ]);

#### Def.SubSum으로 소계행 스타일 설정

소계행은 CSS로 스타일 변경이 안 됩니다.
배경색, 글자색, 포맷 등은 `Def.SubSum`에서 설정하며, `makeSubTotal`의 `color` 속성으로 배경색을 덮어쓸 수 있습니다.

    Def: {
      SubSum: {
        Color: '#f0f0f0',           // 소계행 기본 배경색 (makeSubTotal의 color로 덮어쓰기 가능)
        TextColor: 'red',           // 소계행 전체 글자 색상
        ATextColor: 'green',        // A컬럼 소계행 글자 색상
        // Format은 sumCols, avgCols, countCols로 계산된 컬럼만 적용 가능 (8.0.0.25~)
        // captionCol의 function으로 생성된 소계행은 Text 타입이라 Format이 적용되지 않음
        AFormat: '합계 : #,##0.##', // A컬럼 소계행 포맷
        BFormat: '#,##0'            // B컬럼 소계행 포맷
      }
    }

#### 다중 컬럼 소계

    sheet.makeSubTotal([
      {
        stdCol: 'sPolicy',
        sumCols: 'B|C',
        position: 'bottom',
        color: '#b2c4d9'
      },
      {
        stdCol: 'sUnit',
        avgCols: 'B|C',
        position: 'bottom',
        color: '#dbe2eb',
        captionCol: [
          { col: 'sUnit', val: '%s: %col' }
        ]
      }
    ]);

#### usermerge 사용

    // Cfg.DataMerge:0 (머지 없음) 설정일 때

    // usermerge:0 (기본값) — DataMerge:0 이어도 stdCol 기준으로 자동 머지
    sheet.makeSubTotal([
      { stdCol: 'sPolicy', sumCols: 'A|B|C|D', position: 'bottom', color: '#dbe2eb' }
    ]);

    // usermerge:1 — DataMerge:0 설정을 따르므로 머지 없이 소계행만 추가
    sheet.makeSubTotal([
      { stdCol: 'sPolicy', sumCols: 'A|B|C|D', position: 'bottom', color: '#dbe2eb' }
    ], 1);

### Read More

- SearchMode cfg
- CalcMergeMode cfg
- onDataLoad event
- removeSubTotal method
- getSubTotalRows method
- NoCalculate row

### Since

product | version | desc
--- | --- | ---
core | 8.0.0.0 | 기능 추가
core | 8.0.0.7 | `mode` 속성 기능 추가
core | 8.0.0.11 | `usermerge` 기능 추가
core | 8.0.0.11 | `%capCol` 예약어 추가
core | 8.0.0.18 | `onDataLoad` 이벤트에서 호출 권장
core | 8.0.0.22 | `hidden` 속성 추가
core | 8.1.0.78 | `excludeSubTotalRowCount` 기능 추가