Object

Methods

getObjectList(pageId) → {Array.<ObjectInfo>}

Source:
해당 페이지에 포함된 오브젝트 리스트에 접근함

페이지를 지정하여 해당 페이지에 포함된 오브젝트를 배열 형태로 가져옴
각 배열의 요소에는 오브젝트의 아이디, 이름이 표시됨
존재하지 않는 페이지에 접근할 경우 null이 반환됨
Example
getObjectList('page112432')
// [
//   {id: 'shape1', name: 'ironman 2', ...},
//   {id: 'image2', name: 'ironman 4', ...},
//   {id: 'textbox1', name: 'avengers 2', ...},
//   ...
// ]
Parameters:
Name Type Description
pageId string 페이지 아이디
Returns:
ObjectInfo[]
Type
Array.<ObjectInfo>

getObjectList(pageIndex) → {Array.<ObjectInfo>}

Source:
해당 페이지에 포함된 오브젝트 리스트에 접근함

페이지를 지정하여 해당 페이지에 포함된 오브젝트를 배열 형태로 가져옴
각 배열의 요소에는 오브젝트의 아이디, 이름이 표시됨
존재하지 않는 페이지에 접근할 경우 null이 반환됨
Example
getObjectList(2)
// -> ObjectInfo[]

getObjectList(-10)
// -> undefined
Parameters:
Name Type Description
pageIndex number 페이지 순서
Returns:
ObjectInfo[]
Type
Array.<ObjectInfo>

getObjectIdsByName(pageId, objectName) → {Array}

Source:
오브젝트의 이름으로 해당하는 오브젝트의 아이디를 가져옴
Example
getObjectIdsByName(pageId, 'objectName')
// -> ['objectId']
Parameters:
Name Type Description
pageId string 페이지 아이디
objectName string 오브젝트 이름
Returns:
오브젝트 아이디를 배열
Type
Array

getObjectProperties(pageId, objectId) → {ObjectProperties}

Source:
해당 오브젝트의 속성을 가져옴

속한 페이지의 아이디와 오브젝트의 아이디를 지정하여 해당 오브젝트의 속성을 가져옴
존재하지 않는 오브젝트에 접근할 경우 null을 반환함
Example
getObjectProperties('page22442', 'shape01')
// {
//   id: 'shape01',
//   name: 'avengers 4',
//   width: 200,
//   ...
// }

getObjectProperties(-1, null)
// -> null
Parameters:
Name Type Description
pageId string 페이지 아이디
objectId string 오브젝트 아이디
Returns:
오브젝트 속성
Type
ObjectProperties

setObjectProperties(pageId, objectId, ObjectProperties) → {void}

Source:
해당 오브젝트의 속성을 수정함

오브젝트가 속한 페이지의 아이디와 오브젝트의 아이디를 지정하고 변경하려는 속성을 객체 형태로 전달하여 속성을 수정함
존재하지 않는 오브젝트 또는 속성을 수정할 경우 무시됨
Example
setObjectProperties('page22442', 'shage01', {
  id: 'shage02',
  type: 'image',
  width: 400
})
// (id, width는 변경되지만 type은 수정할 수 없으므로 무시됨)

setObjectProperties(-1, null)
// -> (변경되지 않고 무시됨)
Parameters:
Name Type Description
pageId string 페이지 아이디
objectId string 오브젝트 아이디
ObjectProperties object 변경하려는 속성
Properties
Name Type Description
id object 변경하려는 오브젝트의 아이디
width object 변경하려는 오브젝트의 너비
height object 변경하려는 오브젝트의 높이
top object 변경하려는 오브젝트의 y 위치
left object 변경하려는 오브젝트의 x 위치
opacity object 변경하려는 오브젝트의 투명도
color object 변경하려는 오브젝트의 글자 색상
backgroundColor object 변경하려는 오브젝트의 배경색상
Returns:
Type
void

setObjectProperty(pageId, objectId, key, value) → {void}

Source:
해당 오브젝트의 속성을 수정함

오브젝트가 속한 페이지의 아이디와 오브젝트의 아이디를 지정하고 변경하려는 속성을 객체 형태로 전달하여 속성을 수정함
존재하지 않는 오브젝트 또는 속성을 수정할 경우 무시됨
Example
setObjectProperty('page22111', 'image01', 'id', 'ironman 2')

setObjectProperty('page12344', 'shape11', 'width', 200)

setObjectProperty('page22111', 'textbox11', 'type', 'image')
// (type은 수정할 수 없으므로 변경되지 않고 무시됨)
Parameters:
Name Type Description
pageId string 페이지 아이디
objectId string 오브젝트 아이디
key string 오브젝트 속성명
value * 오브젝트 속성값
Returns:
Type
void

getObjectProperty(pageId, objectId, key) → {*}

Source:
해당 오브젝트의 속성에 접근

오브젝트가 속한 페이지의 아이디와 오브젝트의 아이디를 지정하고 원하는 속성의 이름을 파라미터로 전달하여 해당 속성 값을 가져옴
존재하지 않는 오브젝트 또는 속성에 접근할 경우 null을 반환함
Example
getObjectProperty('page22111', 'image01', 'id')
// => image01

getObjectProperty('page22322', 'shape1', 'fill')
// => rgba(111, 222, 111, 1)

getObjectProperty('page221111', 'image001')
// => null
Parameters:
Name Type Description
pageId string 페이지 아이디
objectId string 오브젝트 아이디
key string 속성명
Returns:
속성값 (value)
Type
*

getObjectElementsByName(pageId, name) → {Element|void}

Source:
해당 오브젝트의 엘리먼트에 접근

오브젝트가 속한 페이지의 아이디와 오브젝트의 이름을 지정하고 이에 해당하는 오브젝트의 엘리먼트를 가져옴 존재하지 않는 오브젝트에 접근할 경우 null이 반환됨
Example
getObjectElementsByName('page22111', 'image01')
// => Element
getObjectElementsByName(-1, null)
// => null
Parameters:
Name Type Description
pageId string 페이지 아이디
name string 오브젝트 이름
Returns:
  • 속성값 (value)
    Type
    Element
  • Type
    void

generateUniqueObjectId(pageId, objectIdopt) → {string|null}

Source:
특정 페이지 내의 유일한 오브젝트 아이디를 생성

특정 페이지의 유일한 오브젝트 아이디를 생성함
존재하지 않는 페이지일 경우 null을 반환함
생성할 오브젝트 아이디를 지정할 경우 중복 여부를 검사함
Example
generateUniqueObjectId('page21112')
// => dkdS1d0a

generateUniqueObjectId('page12211', 'sample')
// => sample (유일한 경우)
// => null (중복될 경우)

generateUniqueObjectId()
// => null (생성 실패)
Parameters:
Name Type Attributes Description
pageId string 페이지 아이디
objectId string <optional>
 오브젝트 아이디
Returns:
생성된 오브젝트 아이디
Type
string | null

removeObject(pageId, objectId) → {XelfObject|null}

Source:
페이지에 포함된 오브젝트 중 특정 오브젝트를 페이지에서 제거함

페이지 아이디와 오브젝트 아이디를 파라미터로 전달하여 해당 오브젝트를 페이지에서 제거함
오브젝트 제거에 성공한 경우 해당 오브젝트를 반환함
오브젝트 제거에 실패한 경우 null을 반환함
Example
removeObject('page11111', 'shape1')
// => XelfObject (해당 오브젝트가 제거된 후 반환됨)
// => null (오브젝트가 존재하지 않을 경우 null이 반환됨)

removeObject('page11111')
// => null
Parameters:
Name Type Description
pageId string 페이지 아이디
objectId string 오브젝트 아이디
Returns:
제거 결과에 따라 변환 값이 다름
Type
XelfObject | null

setObjectPosition(pageId, objectId, position) → {void}

Source:
자신이 속한 그룹 또는 페이지를 기준으로 오브젝트의 위치를 지정함
Example
setObjectSize(pageId, objectId01, {left: 150, top: 150})
Parameters:
Name Type Description
pageId string 페이지 아이디
objectId string 오브젝트 아이디
position Object
Properties
Name Type Description
left number x 위치값
top number y 위치값
Returns:
Type
void

setObjectSize(pageId, objectId, size) → {void}

Source:
오브젝트의 크기를 지정함
Example
setObjectSize(pageId, objectId01, {width: 150, height: 150})
Parameters:
Name Type Description
pageId string 페이지 아이디
objectId string 오브젝트 아이디
size Object 위치값을 담은 객체
Properties
Name Type Description
width number 오브젝트의 너비값
height number 오브젝트의 높이값
Returns:
Type
void

setObjectScale(pageId, objectId, scale) → {void}

Source:
오브젝트의 스케일을 지정함
Example
setObjectScale(pageId, objectId02, {scaleX: 1.7, scaleY: 1.7})
Parameters:
Name Type Description
pageId string 페이지 아이디
objectId string 오브젝트 아이디
scale object 위치값을 담은 객체
Properties
Name Type Description
scaleX number 1을 기준으로 한 오브젝트의 너비 비율
scaleY number 1을 기준으로 한 오브젝트의 높이 비율
Returns:
Type
void

setObjectRotate(pageId, objectId, rotateDeg) → {void}

Source:
오브젝트의 스케일을 지정함
Example
setObjectRotate(pageId, objectId01, 45)
Parameters:
Name Type Description
pageId string 페이지 아이디
objectId string 오브젝트 아이디
rotateDeg number 회전할 각도
Returns:
Type
void

setObjectToggle(pageId, objectId) → {void}

Source:
오브젝트를 토글함
Example
setObjectToggle(pageId, objectId01)
Parameters:
Name Type Description
pageId string 페이지 아이디
objectId string 오브젝트 아이디
Returns:
Type
void

setObjectToggle(pageId, objectId) → {void}

Source:
오브젝트를 토글함
Example
setObjectToggle(pageId, objectId01)
Parameters:
Name Type Description
pageId string 페이지 아이디
objectId string 오브젝트 아이디
Returns:
Type
void

setObjectVisible(pageId, objectId, show) → {void}

Source:
오브젝트의 보임/숨김 상태를 지정함
Example
setObjectVisible(pageId, objectId04, false)
Parameters:
Name Type Description
pageId string 페이지 아이디
objectId string 오브젝트 아이디
show boolean true -> 오브젝트 보임, false -> 오브젝트 안보임
Returns:
Type
void

setObjectOpacity(pageId, objectId, opacity) → {void}

Source:
오브젝트의 보임/숨김 상태를 지정함
Example
setObjectOpacity(pageId, objectId01, 0.5)
Parameters:
Name Type Description
pageId string 페이지 아이디
objectId string 오브젝트 아이디
opacity number 0부터 1 사이의 수
Returns:
Type
void

setObjectBackgroundColor(pageId, objectId, backgroundColor) → {void}

Source:
오브젝트의 배경색을 지정함
Example
setObjectBackgroundColor(pageId, objectId04, '#000000')
Parameters:
Name Type Description
pageId string 페이지 아이디
objectId string 오브젝트 아이디
backgroundColor string 색상코드 또는 색상이름
Returns:
Type
void

setObjectFill(pageId, objectId, fill) → {void}

Source:
오브젝트의 채우기색을 지정함
Example
setObjectFill(pageId, objectId03, 'green')
Parameters:
Name Type Description
pageId string 페이지 아이디
objectId string 오브젝트 아이디
fill string 색상코드 또는 색상이름
Returns:
Type
void

setObjectStroke(pageId, objectId, stroke) → {void}

Source:
오브젝트의 선색을 지정함
Example
setObjectStroke(pageId, line06, 'red')
Parameters:
Name Type Description
pageId string 페이지 아이디
objectId string 오브젝트 아이디
stroke string 색상코드 또는 색상이름
Returns:
Type
void

setObjectFontColor(pageId, objectId, fontColor) → {void}

Source:
오브젝트의 글자색을 지정함
Example
setObjectFontColor(pageId, objectId04, '#ffffff')
Parameters:
Name Type Description
pageId string 페이지 아이디
objectId string 오브젝트 아이디
fontColor string 색상코드 또는 색상이름
Returns:
Type
void

setObjectFontSize(pageId, objectId, fontSize) → {void}

Source:
오브젝트의 글자크기를 지정함
Example
setObjectFontSize(pageId, objectId04, 9)
Parameters:
Name Type Description
pageId string 페이지 아이디
objectId string 오브젝트 아이디
fontSize number 폰트의 크기
Returns:
Type
void

setObjectFontSize(pageId, objectId, fontSize) → {void}

Source:
오브젝트의 글자크기를 지정함
Example
setObjectFontSize(pageId, objectId04, 9)
Parameters:
Name Type Description
pageId string 페이지 아이디
objectId string 오브젝트 아이디
fontSize number 폰트의 크기
Returns:
Type
void

Type Definitions

ObjectInfo

Source:
Properties:
Name Type Description
id string 오브젝트 아이디
name string 오브젝트 이름
type string 오브젝트 속성
page string 페이지 아이디
parent string 소속된 그룹 아이디
props object 오브젝트의 프로퍼티값
options object 오브젝트의 옵션값
오브젝트 정보 객체 타입

오브젝트 리스트에 접근 시 사용되는 객체 타입
Type:
  • Object

ObjectProperties

Source:
Properties:
Name Type Description
id string 오브젝트 아이디
name string 오브젝트 이름
type string 오브젝트 종류
width number 오브젝트 width
height number 오브젝트 height
left number 오브젝트 left
top number 오브젝트 top
zIndex number 오브젝트 zIndex
오브젝트 속성 객체 타입

오브젝트의 생성, 속성 변경/접근 시 사용되는 객체 타입
Type:
  • Object

XelfObject

Source:
Properties:
Name Type Description
* 사용자가 사용할 수 있는 속성 없음
오브젝트 객체 타입

오브젝트를 생성/삽입/제거 시 사용하는 객체임
사용자가 직접 수정하거나 사용하는 기능은 없음
Type:
  • Object