Page

Methods

getPageList() → {Array.<PageInfo>}

Source:
프로젝트를 구성하는 전체 페이지 리스트를 가져옴

프로젝트를 구성하는 전체 페이지를 배열 형태로 가져옴
배열의 순서가 페이지의 순서이며 각 배열의 요소에는 페이지의 아이디, 이름이 표시됨
Example
getPageList()
// [
//   {pageId: 'page12345', pageName: 'ironman mark 2'},
//   {pageId: 'page33242', pageName: 'ironman mark 5'},
//   {pageId: 'page83722', pageName: 'ironman mark 9'}
// ]
Returns:
프로젝트 리스트(PageInfo[])
Type
Array.<PageInfo>

getPageIdsByName(pageName) → {Array}

Source:
페이지의 이름으로 해당 페이지의 아이디를 가져옴
Example
getPageIdsByName()
// ['page12345', 'page33242', 'page83722']
Parameters:
Name Type Description
pageName string 페이지 이름
Returns:
페이지 아이디를 담은 배열
Type
Array

getCurrentPageId() → {string}

Source:
현재 페이지의 아이디를 가져옴
Example
getCurrentPageId()
// 'page12345'
Returns:
페이지 아이디
Type
string

getCurrentPageIndex() → {number}

Source:
0부터 시작하는 현재 페이지의 순서를 가져옴
Example
getCurrentPageIndex()
// 0
Returns:
페이지 인덱스
Type
number

getPageProperites(pageId) → {PageProperties}

Source:
해당 페이지의 상세 정보를 얻음

해당 페이지의 상세 정보를 가져옴
페이지 아이디를 파라미터로 전달하여 해당 페이지의 상세 정보를 가져옴
페이지가 존재하지 않을 경우 null을 반환함
페이지 속성:
* index: 페이지 순서
* id: 페이지 아이디
* name: 페이지 이름
* width: 페이지 width
* height: 페이지 height
* background: 페이지 백그라운드 컬러
Example
getPageProperties('page112423')
// {
//   index: 0,
//   id: 'page112423',
//   name: 'ironman mark 19',
//   width: 1280,
//   height: 720,
//   background: 'rgba(221, 25, 12, 1)'
// }
Parameters:
Name Type Description
pageId string 페이지 아이디
Returns:
페이지 속성 (PageProperties)
Type
PageProperties

setPageBackground(pageId, color) → {void}

Source:
해당 페이지의 백그라운드 색을 변경

해당 페이지의 백그라운드 컬러를 변경함
페이지의 아이디와 변경하려는 색을 파라미터로 전달함
변경할 수 있는 색의 범위는 css의 색의 범위를 따름
Example
setPageBackground('page115345', '#222244')

setPageBackground('page248281', 'rgba(121, 22, 1, .1)')

setPageBackground(null, 'rgba(111, 111, 222, 1)')
// (변경되지 않고 무시됨)
Parameters:
Name Type Description
pageId string 페이지 아이디
color string 페이지 백그라운드 컬러
Returns:
Type
void

setPageSize(pageId, size) → {void}

Source:
해당 페이지의 사이즈 변경

해당 페이지의 width, height를 변경함
페이지의 아이디와 변경하려는 width, height를 파라미터로 전달함
변경할 수 없는 사이즈로 변경 시도시 변경되지 않고 무시됨
Example
setPageSize('page22111', {
  width: 800
})
// (width만 800으로 변경됨)

setPageSize('page13312', {
  width: -200,
  height: 800
})
// (height만 800으로 변경됨)

setPageSize('page32323', {})
// (변경되지 않고 무시됨)
Parameters:
Name Type Description
pageId string 페이지 아이디
size object 변경하려는 width와 height
Properties
Name Type Description
width number width
height number height
Returns:
Type
void

movePage(pageId) → {void}

Source:
페이지 이동

이동하려는 페이지의 아이디 또는 인덱스를 파라미터로 전달하여 해당 페이지로 이동함
이동할 수 없는 페이지로 이동 시도시 이동하지 않고 무시됨
Example
movePage('page22123')
Parameters:
Name Type Description
pageId string 페이지 아이디
Returns:
Type
void

movePage(pageIndex) → {void}

Source:
페이지 이동

이동하려는 페이지의 아이디 또는 인덱스를 파라미터로 전달하여 해당 페이지로 이동함
이동할 수 없는 페이지로 이동 시도시 이동하지 않고 무시됨
Example
movePage(11)

movePage(-29)
// (이동되지 않고 무시됨)
Parameters:
Name Type Description
pageIndex number 페이지 순서
Returns:
Type
void

onPageEvent(type, pageId, handler) → {void}

Source:
페이지 단계에서 발생되는 이벤트에 핸들러를 지정함

페이지의 상태가 변경될 경우 발생하는 이벤트에 핸들러를 지정하여 처리할 수 있도록 함
핸들러 함수에는 이벤트 객체가 파라미터로 전달되며 전달되는 이벤트 객체에는 이벤트 종류에 맞는 데이터가 추가로 전달됨
이벤트 핸들러를 지정하면 리스너 아이디가 반환되며 추후 이벤트 핸들러를 해제할 때 사용됨
발생되는 이벤트 종류
* load: 페이지 로드 완료
* beforeUnload: 페이지 나가기 전
Example
var cb = function({pageId}) {
  alert('로드됨')
}

onPageEvent('load', pageId, cb)
Parameters:
Name Type Description
type string 이벤트 타입
pageId string 페이지 아이디
handler HandlerFunction 이벤트 핸들러
Returns:
Type
void

offPageEvent(type, pageId, handler) → {void}

Source:
페이지에 지정된 이벤트 리스너를 제거함

페이지의 상태가 변경될 경우 발생하는 이벤트에 지정된 핸들러를 제거함
특정한 리스너를 지정하여 제거하거나 특정 이벤트 전체의 리스너를 제거할 수 있음
Example
var cb = function({pageId}) {
  alert('로드됨')
}
offPageEvent('beforeUnload', pageId, cb)
Parameters:
Name Type Description
type string 이벤트 타입
pageId string 페이지 아이디
handler HandlerFunction 이벤트 핸들러
Returns:
Type
void

Type Definitions

PageInfo

Source:
Properties:
Name Type Description
pageId string 페이지 아이디(pageId)
pageName string 페이지 이름(pageName)
페이지 정보 객체 타입

페이지 리스트에 접근 시 사용되는 객체 타입
Type:
  • Object

PageProperties

Source:
Properties:
Name Type Description
index number 페이지 순서(index). 0부터 시작
id string 페이지 아이디(id)
name string 페이지 이름(name)
width number 페이지 width(width)
height number 페이지 height(height)
background string 페이지 백그라운드 컬러(background)
페이지 속성 객체 타입

페이지의 속성 변경/접근 시 사용되는 객체 타입
Type:
  • Object