문서
API
Types
Type: GridReportViewer

Type: GridReportViewer

GridReportViewer

ReportViewer에서 상속된 객체로 RealGrid의 GridView (opens in a new tab) 객체를 이용해 리포트 양식을 자동으로 생성해 주는 컴포넌트 입니다.

declare class GridReportViewer extends ReportViewer {
    constructor(container: string | HTMLDivElement, grid: GridView, options?: GridReportOptions);
    /**
     * 컨테이너에 미리보기 랜더링
     */
    preview(): void;
}

GridReportOptions

GridView를 Report로 생성하는데 필요한 옵션을 지정합니다. 옵션은 GridReportViewer를 생성할때 인자로 넘겨줍니다. 옵션을 인자로 넘기지 않을 경우 기본값을 사용합니다.

interface GridReportOptions extends ReportOptions {
    paper?: PaperOptions;
    title?: GridReportTitle;
    subTitle?: GridReportTitle;
    gridHeader?: GridReportHeader;
    pageHeader?: PageHeader;
    pageFooter?: PageFooter;
    layout: GridReportLayout;
}

paperOptions

  • 타입: PaperOptions
  • 설명: 보고서 출력을 위한 페이퍼 정보
class PaperOptions {
    orientation: PaperOrientation,
    size: PaperSize,
    width: string,
    height: string,
    marginLeft: string,
    marginRight: string,
    marginTop: string,
    marginBottom: string,
}

title

  • 타입: TextItem
  • 설명: 보고서의 상단에 표시되는 보고서의 제목입니다.
  • 출력 영역: Report Header

subTitle

  • 타입: TextItem
  • 설명: 보고서 제목의 하단에 표시되는 부제목입니다.
  • 출력 영역: Report Header

pageHeader

  • 타입: TextItem 배열
  • 설명: 페이지 상단에 페이지 번호등을 표시합니다.
  • 출력 영역: Report Header

gridHeader

type GridReportHeader {
    items: TextItem[]
}

pageFooter

  • 타입: TextItem 배열
  • 설명: 페이지 하단에 페이지 번호등을 표시합니다.
  • 출력 영역: Report Footer

layout

  • 타입: GridReportLayout
  • 설명: 그리드 레이아웃 정보
/**
 * 컬럼 이름
 */
declare type ColumnName = string;
/**
* 그리드 리포트 레이아웃 정보
*/
declare type GridReportLayout = {
    /**
     * 보고서 생성시 제외할 그리드의 컬럼이름
     */
    exclude?: ColumnName[];
    /**
     * 그리드의 너비에 맞게 리포트의 컬럼 너비를 자동 조정
     */
    autoWidth: boolean;
};