RealGrid2 API
Class
RealGrid

RealGrid

RealGrid 메인 클래스

Signature:

export default class RealGrid 

Properties

PropertyTypeDescription
CustomCellRendererImpltypeof CustomCellRendererImpl
GridViewtypeof GridViewGridView Class를 반환한다. GridView 참조
LocalDataProvidertypeof LocalDataProviderLocalDataProvider Class를 반환한다. LocalDataProvider 참조
LocalTreeDataProvidertypeof LocalTreeDataProviderLocalTreeDataProvider Class를 반환한다. LocalTreeDataProvider 참조
TreeViewtypeof TreeViewTreeView Class를 반환한다. TreeView 참조

Methods

MethodTypeDescription
getActiveGrid()static getActiveGrid(): any;마지막으로 선택된 그리드를 반환한다.
getGridInstance(container)static getGridInstance(container: string | HTMLDivElement): any;입력한 element가 가지고 있는 그리드를 반환한다.
getVersion()static getVersion(): string;설치된 RealGrid 모듈의 version을 확인한다.
registerCustomRenderer(type, renderer, overwrite)static registerCustomRenderer(type: string, renderer: any, overwrite?: boolean): void;사용자 지정의 렌더러를 등록한다.
setDefault(options, dataOptions)static setDefault(options: ViewOptions, dataOptions?: DataOptions): void;그리드 기본설정을 지정한다.
setLicenseKey(key)static setLicenseKey(key: string): void;그리드 licenseKey를 입력한다.
setLocale(locale)static setLocale(locale: RealGridLocale): void;그리드에서 사용하는 메시지와 numberFormat등을 등록한다.
setMobile(value)static setMobile(value: boolean): void;그리드가 mobile모드로 생성되도록 한다.
setSlotMode(value)static setSlotMode(value: boolean): void;shadowDom 또는 slot의 하위로 생성하는 경우 설정한다.
setTablet(value)static setTablet(value: boolean): void;그리드가 tablet모드로 생성되도록 한다.

Properties Desc

CustomCellRendererImpl


GridView

GridView Class를 반환한다. GridView 참조


LocalDataProvider

LocalDataProvider Class를 반환한다. LocalDataProvider 참조


LocalTreeDataProvider

LocalTreeDataProvider Class를 반환한다. LocalTreeDataProvider 참조


TreeView

TreeView Class를 반환한다. TreeView 참조


Methods Desc

getActiveGrid

마지막으로 선택된 그리드를 반환한다.

Remarks:

현재 선택된 element가 그리드가 아닌경우에도 마지막으로 선택된 그리드가 반환된다.


getGridInstance

입력한 element가 가지고 있는 그리드를 반환한다.

[매개변수 목록]

container - string | HTMLDivElement

그리드를 생성할때 사용한 elementID 또는 element

[반환값] - any


getVersion

설치된 RealGrid 모듈의 version을 확인한다.


registerCustomRenderer

사용자 지정의 렌더러를 등록한다.

[매개변수 목록]

type - string

사용자가 지정한 렌더러 종류 (이름)

renderer - any

CustomCellRenderer 객체

overwrite - boolean

true이면 기존 정의된 renderer를 대체한다.

[반환값] - void

Example:

// CustomCellRenderer 모델
gridView.registerCustomRenderer("renderer01", {
    initContent(parent) {
        var span = this._span = document.createElement("span");
        parent.append(span);
    }
}
// class로 만드는 경우.
class CustomSpanRenderer extends RealGrid.CustomCellRendererImpl {
    private _span: HTMLSpanElement; // renderer가 필요한 속성 추가.
    get styleName() {
        return 'rg-renderer custom-span' // class명을 return
    }
    get refreshFocusChanged() {
        return true; // focus가 변경된경우 다시 render를 실행하도록 한다.
    }
    private spanClickHandler = (e: MouseEvent) => {  // arrow function으로 만들면 addEventListener할때 bind하지 않아도 this는 class의 instance를 참조한다.
    }
    protected _doInitContent(dom: HTMLElement): void {
        const span = this._span = document.createElement("span");
        span.addEventListener("click", this.spanClickHandler);  // 반드시 remove해야한다.
        dom.appendChild(this._span);
    }
    protected _doClearContent(dom: HTMLElement): void {
        this._span.parentElement && this._span.parentElement.removeChild(this._span);
        this._span.removeEventListener("click", this.spanClickHandler);
    }
    protected render(grid: GridBase, model: GridCell, w: number, h: number, info: any): void {
        this._span.textContent = model.value || "";
        const css = this._span.style;
        css.removeProperty("color");
        if (info.focused) {
            css.color = "red"
        }
    }
}

setDefault

그리드 기본설정을 지정한다.

[매개변수 목록]

options - ViewOptions

option 객체

dataOptions - DataOptions

[반환값] - void

Remarks:

GridBase.setOptions()와 동일한 형태로 지정하면 이후 생성되는 그리드의 기본설정으로 적용된다.


setLicenseKey

그리드 licenseKey를 입력한다.

Remarks:

licenseKey를 환경변수에 저장하는 경우 사용한다.


setLocale

그리드에서 사용하는 메시지와 numberFormat등을 등록한다.

[매개변수 목록]

locale - RealGridLocale

locale객체

[반환값] - void


setMobile

그리드가 mobile모드로 생성되도록 한다.

[매개변수 목록]

value - boolean

boolean

[반환값] - void

Remarks:

그리드가 브라우저의 mobile상태를 확인하지 못하는 경우 RealGrid.setMobile(true)을 이용해서 모바일 상태로 변경한다. 그리드가 생성되기 전에 설정해야 한다.


setSlotMode

shadowDom 또는 slot의 하위로 생성하는 경우 설정한다.

[매개변수 목록]

value - boolean

boolean;

[반환값] - void

Remarks:

filter, listEditor등이 그리드 내부에 생성되도록 한다. drag&drop등 일부 기능을 사용할수 없다.


setTablet

그리드가 tablet모드로 생성되도록 한다.

[매개변수 목록]

value - boolean

boolean;

[반환값] - void

Remarks:

기기가 tablet인지 확인하지 못하는 경우 RealGrid.setTablet(true)을 이용해서 태블릿 상태로 변경한다. 그리드가 생성되기 전에 설정해야 한다.