본문으로 건너뛰기

Show.Line

Show.Line은 Presentation 모듈(Office.show(iframe))의 객체 타입입니다. 메서드 70개.

Generated from the SDK type definitions

Presentation · 객체 타입 10개 · 메서드 586개 · 네임스페이스 Show. 이 레퍼런스는 SDK 빌드와 함께 생성된 API 문서 아티팩트(sdk-api-doc.html)에서 생성됩니다. 설명은 게시된 편집기 API 주석 그대로입니다. SDK와 Office 버전을 함께 고정하고, 둘 중 하나가 바뀌면 다시 생성하십시오.

비고​

  • 모듈: Presentation · Office.show(iframe) · 네임스페이스 Show
  • 얻는 방법: 다른 객체 타입의 요약 표에 있는 메서드가 값으로 반환합니다
  • 모든 메서드는 Promise를 반환하며, 시그니처는 TypeScript 표기입니다.

메서드​

메서드설명
align(alignType)도형을 슬라이드 기준으로 정렬한다.
flip(direction)도형을 상하 또는 좌우로 반전한다.
getEffects()도형에 적용된 효과를 반환한다.
getFill()도형 채우기를 반환한다.
getHeadEnd()연결선의 시작 화살표(headEnd)를 반환한다.
getHeight()도형의 높이를 반환한다.
getHyperlink()도형에 설정된 하이퍼링크를 반환한다.
getLineCap()선 끝 모양(cap)을 반환한다.
getLineColor()선 색상을 반환한다.
getLineDash()선 대시 유형을 반환한다.
getLineJoin()선 연결 유형(join)을 반환한다.
getLineStyle()선 스타일을 반환한다.
getLineWidth()선 두께(pt)를 반환한다.
getPlaceholderType()도형의 placeholder 종류를 반환한다.
getPresetId()도형의 OOXML preset id (prst) 를 반환한다.
getRotation()도형의 회전 각도를 반환한다.
getTailEnd()연결선의 끝 화살표(tailEnd)를 반환한다.
getTransform()도형의 위치, 크기, 회전 정보를 반환한다.
getWidth()도형의 너비를 반환한다.
getX()도형의 X 좌표를 반환한다.
getY()도형의 Y 좌표를 반환한다.
getZOrderIndex()부모(슬라이드, 그룹 자식이면 그 그룹) 안에서 도형의 z-order 순번을 반환한다.
hasText()도형이 텍스트를 담고 있는지 반환한다.
isChart()이 핸들이 Chart 인지 판별한다 (union 좁히기용 type guard).
isControl()이 핸들이 Control 인지 판별한다 (union 좁히기용 type guard).
isDiagram()이 핸들이 Diagram 인지 판별한다 (union 좁히기용 type guard).
isFlippedH()도형이 좌우로 반전된 상태인지 반환한다.
isFlippedV()도형이 상하로 반전된 상태인지 반환한다.
isGroup()이 핸들이 Group 인지 판별한다 (union 좁히기용 type guard).
isImage()이 핸들이 Image 인지 판별한다 (union 좁히기용 type guard).
isLine()이 핸들이 Line 인지 판별한다 (union 좁히기용 type guard).
isOleObject()이 핸들이 OleObject 인지 판별한다 (union 좁히기용 type guard).
isPlaceholder()도형이 placeholder(제목 · 본문 틀 등)인지 반환한다.
isShape()이 핸들이 Shape 인지 판별한다 (union 좁히기용 type guard).
isTable()이 핸들이 Table 인지 판별한다 (union 좁히기용 type guard).
moveBy(distance)도형을 현재 위치 기준으로 x, y 만큼 상대 이동한다.
remove3d()도형의 3D 효과를 제거한다.
removeEffect(effectType)효과를 제거한다.
removeFill()채우기를 제거한다 (noFill).
removeHyperlink()도형의 하이퍼링크를 제거한다.
removeLineColor()선 색상을 제거한다 (noFill).
reorder(order)도형의 정렬 순서(앞으로/뒤로)를 변경한다.
set3d(scene3d, sp3d)도형에 3D 효과를 적용한다.
setEffects(effects)getEffects() 가 반환한 효과 객체를 그대로 적용한다.
setFill(fill)getFill() 이 반환한 채우기 객체를 그대로 적용한다.
setGlow(glow)네온(광선) 효과를 적용한다.
setGradientFill(type, stops, angle)그라데이션 채우기를 설정한다.
setHeadEnd(lineEnd)연결선의 시작 화살표(headEnd)를 설정한다.
setHeight(height)도형의 높이를 설정한다.
setHyperlink(hyperlink)도형에 하이퍼링크를 설정한다.
setImageFill(imageUrl, fillMode, alpha, detail)이미지 채우기를 설정한다.
setInnerShadow(shadow)내부 그림자를 적용한다.
setLineCap(lineCap)선 끝 모양(cap)을 설정한다.
setLineColor(color, alpha)선 색상을 설정한다.
setLineDash(lineDash)선 스타일(대시)을 설정한다.
setLineGradient(type, stops, angle)선(테두리) 그라데이션 채우기를 설정한다.
setLineJoin(lineJoin)선 연결 유형(join)을 설정한다.
setLineStyle(style)getLineStyle() 이 반환한 선 스타일 객체를 그대로 적용한다.
setLineWidth(lineWidth)선 두께를 설정한다.
setOuterShadow(shadow)외부 그림자를 적용한다.
setPatternFill(preset, foreColor, backColor, foreAlpha, backAlpha)패턴(무늬) 채우기를 설정한다.
setReflection(reflection)반사 효과를 적용한다.
setRotation(rotation)도형의 회전 각도를 절대값으로 설정한다.
setSoftEdge(softEdge)옅은 테두리(softEdge) 효과를 적용한다.
setSolidFill(color, alpha)도형 채우기를 단색으로 설정한다.
setTailEnd(lineEnd)연결선의 끝 화살표(tailEnd)를 설정한다.
setTransform(transform)도형의 위치·크기·회전을 한 번에 설정한다.
setWidth(width)도형의 너비를 설정한다.
setX(x)도형의 X 좌표를 절대값으로 설정한다.
setY(y)도형의 Y 좌표를 절대값으로 설정한다.

메서드 상세​

align(alignType)​

도형을 슬라이드 기준으로 정렬한다. 이동이 불가능한 도형이면 무시된다. 그룹 자식도 그룹 안이 아니라 슬라이드를 기준으로 움직인다(에디터와 같다). 자식이 그룹 밖으로 나가면 그룹이 자식을 담도록 함께 넓어진다.

align(alignType: AlignType): Promise<void>;

매개변수

이름타입설명
alignTypeAlignType정렬 타입

반환값

Promise<void>

flip(direction)​

도형을 상하 또는 좌우로 반전한다. 현재 반전 상태를 뒤집는 토글이며, 지금 반전돼 있는지는 isFlippedH()/isFlippedV() 로 읽는다. 회전이 불가능한 도형에서는 반전도 무시된다. 회전된 도형은 각도도 거울상으로 함께 바뀐다 (getRotation() 값이 360 - 기존 각도 로 바뀐다).

flip(direction: FlipDirection): Promise<void>;

매개변수

이름타입설명
directionFlipDirection반전 방향

반환값

Promise<void>

getEffects()​

도형에 적용된 효과를 반환한다. 적용된 효과만 키로 포함된다. 각 값은 대응 setter(setOuterShadow/setInnerShadow/setGlow/setSoftEdge/setReflection/set3d) 의 인자와 같은 형태다. 그림자·네온의 alpha 는 불투명(0)이어도 항상 포함되고, 길이(pt)·비율(%)은 소수 첫째 자리로 반올림된다. outerShadow·innerShadow 가 함께 실린 문서면 둘 다 담는다 (setter 로는 하나만 넣을 수 있다).

getEffects(): Promise<Effects | null>;

반환값

Promise<Effects | null> - 효과 정보. 적용된 효과가 없으면 빈 객체 \{\}, 대상 도형이 없으면(협업 중 삭제 등) null

getFill()​

도형 채우기를 반환한다. (setFill 대칭 - 반환 객체를 그대로 넘길 수 있다) type 별 개별 setter 는 setSolidFill/setGradientFill/setImageFill/setPatternFill/removeFill 이다.

getFill(): Promise<Fill | null>;

반환값

Promise<Fill | null> - 채우기 정보. noFill 이면 \{ type: FillType.NONE \}, 대상 도형이 없으면(협업 중 삭제 등) null

getHeadEnd()​

연결선의 시작 화살표(headEnd)를 반환한다. (setHeadEnd 대칭 - 반환 객체를 그대로 넘길 수 있다)

getHeadEnd(): Promise<LineEnd | null>;

반환값

Promise<LineEnd | null> - 시작 화살표 설정. 대상 연결선이 없으면 null. 화살표가 없는 상태는 null 이 아니라 type 이 LineEndType.NONE 인 객체다

getHeight()​

도형의 높이를 반환한다. (setHeight 대칭)

getHeight(): Promise<number | null>;

반환값

Promise<number | null> - 높이 (px 단위). 대상 도형이 없으면 null

도형에 설정된 하이퍼링크를 반환한다. 반환 객체를 그대로 setHyperlink 에 넘길 수 있다. 지원하지 않는 종류(프로그램 실행·매크로 등)가 걸려 있으면 null 이다.

getHyperlink(): Promise<Hyperlink | null>;

반환값

Promise<Hyperlink | null> - 하이퍼링크 정보. 하이퍼링크(action)가 없으면 null

getLineCap()​

선 끝 모양(cap)을 반환한다. (setLineCap 대칭)

getLineCap(): Promise<LineCap | null>;

반환값

Promise<LineCap | null> - 선 끝 모양. 설정이 없거나 대상 도형이 없으면 null

getLineColor()​

선 색상을 반환한다. (setLineColor 대칭. 투명도까지 필요하면 getLineStyle 사용)

getLineColor(): Promise<string | null>;

반환값

Promise<string | null> - 선 색상 (hex "#RRGGBB" - scheme color 도 hex 로 풀려서 나온다). 선이 없거나 대상 도형이 없으면 null

getLineDash()​

선 대시 유형을 반환한다. (setLineDash 대칭)

getLineDash(): Promise<LineDash | null>;

반환값

Promise<LineDash | null> - 선 대시 유형. LineDash enum 이 아니거나 대상 도형이 없으면 null

getLineJoin()​

선 연결 유형(join)을 반환한다. (setLineJoin 대칭)

getLineJoin(): Promise<LineJoin | null>;

반환값

Promise<LineJoin | null> - 선 연결(모서리) 유형. 설정이 없거나 대상 도형이 없으면 null

getLineStyle()​

선 스타일을 반환한다. (setLineStyle 대칭 - 반환 객체를 그대로 넘길 수 있다) 개별 setter 는 setLineColor/setLineGradient/setLineWidth/setLineDash/setLineCap/setLineJoin 이다.

getLineStyle(): Promise<LineStyle | null>;

반환값

Promise<LineStyle | null> - 선 스타일. 대상 도형이 없으면 null

getLineWidth()​

선 두께(pt)를 반환한다. (setLineWidth 대칭)

getLineWidth(): Promise<number | null>;

반환값

Promise<number | null> - 선 두께 (pt). 선 없음(noFill)이어도 두께는 그대로 반환한다. 대상 도형이 없으면 null

getPlaceholderType()​

도형의 placeholder 종류를 반환한다.

getPlaceholderType(): Promise<PlaceholderType | null>;

반환값

Promise<PlaceholderType | null> - placeholder 종류. placeholder 가 아니거나 대상 도형이 없으면 null

getPresetId()​

도형의 OOXML preset id (prst) 를 반환한다.

getPresetId(): Promise<string | null>;

반환값

Promise<string | null> - preset id (prst), 없으면 null

getRotation()​

도형의 회전 각도를 반환한다. (setRotation 대칭)

getRotation(): Promise<number | null>;

반환값

Promise<number | null> - 회전 각도 (degree). 대상 도형이 없으면 null

getTailEnd()​

연결선의 끝 화살표(tailEnd)를 반환한다. (setTailEnd 대칭 - 반환 객체를 그대로 넘길 수 있다)

getTailEnd(): Promise<LineEnd | null>;

반환값

Promise<LineEnd | null> - 끝 화살표 설정. 대상 연결선이 없으면 null. 화살표가 없는 상태는 null 이 아니라 type 이 LineEndType.NONE 인 객체다

getTransform()​

도형의 위치, 크기, 회전 정보를 반환한다. x/y 는 반전(flip) 여부와 무관하게 도형의 좌상단이라, 반환값을 다른 도형의 setTransform 에 그대로 넘기면 두 도형이 같은 자리에 놓인다. 값은 에디터 입력 단위로 반올림해 반환한다 - 크기는 소수 한 자리, 위치는 정수. setter 도 같은 단위로 넣으므로, 임포트 문서처럼 더 잘게 놓인 도형은 되넘길 때 그만큼 움직인다.

getTransform(): Promise<ShapeTransform | null>;

반환값

Promise<ShapeTransform | null> - 도형의 위치·크기·회전 정보. 대상 도형이 없으면(협업 중 삭제 등) null

getWidth()​

도형의 너비를 반환한다. (setWidth 대칭)

getWidth(): Promise<number | null>;

반환값

Promise<number | null> - 너비 (px 단위). 대상 도형이 없으면 null

getX()​

도형의 X 좌표를 반환한다. (setX 대칭)

getX(): Promise<number | null>;

반환값

Promise<number | null> - X 좌표 (px 단위). 대상 도형이 없으면 null

getY()​

도형의 Y 좌표를 반환한다. (setY 대칭)

getY(): Promise<number | null>;

반환값

Promise<number | null> - Y 좌표 (px 단위). 대상 도형이 없으면 null

getZOrderIndex()​

부모(슬라이드, 그룹 자식이면 그 그룹) 안에서 도형의 z-order 순번을 반환한다. 0 이 맨 뒤이며, 클수록 앞이다.

getZOrderIndex(): Promise<number | null>;

반환값

Promise<number | null> - z-order 순번. 대상 도형이 없으면 null

hasText()​

도형이 텍스트를 담고 있는지 반환한다. 에디터가 텍스트를 비었다고 보는 기준과 같다 - 공백만 있거나 빈 문단이 둘 이상(개행만 넣은 상태)이면 true, 빈 문단 하나뿐이면 false 다. 도형 레벨 텍스트가 없는 종류(표·그룹·차트)는 항상 false 다. (표는 셀 단위로 조회)

hasText(): Promise<boolean | null>;

반환값

Promise<boolean | null> - 텍스트 존재 여부. 대상 도형이 없으면 null

isChart()​

이 핸들이 Chart 인지 판별한다 (union 좁히기용 type guard). SDK 핸들의 내부 판별값을 동기 검사한다 - postMessage 왕복 없음, await 불필요.

isChart(): Promise<this is Chart>;

반환값

Promise<this is Chart>

isControl()​

이 핸들이 Control 인지 판별한다 (union 좁히기용 type guard). SDK 핸들의 내부 판별값을 동기 검사한다 - postMessage 왕복 없음, await 불필요.

isControl(): Promise<this is Control>;

반환값

Promise<this is Control>

isDiagram()​

이 핸들이 Diagram 인지 판별한다 (union 좁히기용 type guard). SDK 핸들의 내부 판별값을 동기 검사한다 - postMessage 왕복 없음, await 불필요.

isDiagram(): Promise<this is Diagram>;

반환값

Promise<this is Diagram>

isFlippedH()​

도형이 좌우로 반전된 상태인지 반환한다. (flip(FlipDirection.HORIZONTAL) 을 호출하면 이 값이 뒤집힌다)

isFlippedH(): Promise<boolean | null>;

반환값

Promise<boolean | null> - 좌우 반전 여부. 대상 도형이 없으면 null

isFlippedV()​

도형이 상하로 반전된 상태인지 반환한다. (flip(FlipDirection.VERTICAL) 을 호출하면 이 값이 뒤집힌다)

isFlippedV(): Promise<boolean | null>;

반환값

Promise<boolean | null> - 상하 반전 여부. 대상 도형이 없으면 null

isGroup()​

이 핸들이 Group 인지 판별한다 (union 좁히기용 type guard). SDK 핸들의 내부 판별값을 동기 검사한다 - postMessage 왕복 없음, await 불필요.

isGroup(): Promise<this is Group>;

반환값

Promise<this is Group>

isImage()​

이 핸들이 Image 인지 판별한다 (union 좁히기용 type guard). SDK 핸들의 내부 판별값을 동기 검사한다 - postMessage 왕복 없음, await 불필요.

isImage(): Promise<this is Image>;

반환값

Promise<this is Image>

isLine()​

이 핸들이 Line 인지 판별한다 (union 좁히기용 type guard). SDK 핸들의 내부 판별값을 동기 검사한다 - postMessage 왕복 없음, await 불필요.

isLine(): Promise<this is Line>;

반환값

Promise<this is Line>

isOleObject()​

이 핸들이 OleObject 인지 판별한다 (union 좁히기용 type guard). SDK 핸들의 내부 판별값을 동기 검사한다 - postMessage 왕복 없음, await 불필요.

isOleObject(): Promise<this is OleObject>;

반환값

Promise<this is OleObject>

isPlaceholder()​

도형이 placeholder(제목 · 본문 틀 등)인지 반환한다.

isPlaceholder(): Promise<boolean | null>;

반환값

Promise<boolean | null> - placeholder 여부. 대상 도형이 없으면 null

isShape()​

이 핸들이 Shape 인지 판별한다 (union 좁히기용 type guard). SDK 핸들의 내부 판별값을 동기 검사한다 - postMessage 왕복 없음, await 불필요.

isShape(): Promise<this is Shape>;

반환값

Promise<this is Shape>

isTable()​

이 핸들이 Table 인지 판별한다 (union 좁히기용 type guard). SDK 핸들의 내부 판별값을 동기 검사한다 - postMessage 왕복 없음, await 불필요.

isTable(): Promise<this is Table>;

반환값

Promise<this is Table>

moveBy(distance)​

도형을 현재 위치 기준으로 x, y 만큼 상대 이동한다. (절대 좌표 설정은 setX / setY)

moveBy(distance: ShapeMoveDistance): Promise<void>;

매개변수

이름타입설명
distanceShapeMoveDistance이동량 (px 단위)

반환값

Promise<void>

remove3d()​

도형의 3D 효과를 제거한다.

remove3d(): Promise<void>;

반환값

Promise<void>

removeEffect(effectType)​

효과를 제거한다. 그 효과가 걸려 있지 않으면 아무 일도 하지 않는다. 도형이 직접 가진 효과만 제거한다 - 도형 스타일(effectRef)에서 상속받은 효과는 제거할 수 없어, getEffects() 가 돌려주는데도 아무 일도 하지 않는 경우가 있다.

removeEffect(effectType: EffectType): Promise<void>;

매개변수

이름타입설명
effectTypeEffectType제거할 효과 타입

반환값

Promise<void>

removeFill()​

채우기를 제거한다 (noFill).

removeFill(): Promise<void>;

반환값

Promise<void>

도형의 하이퍼링크를 제거한다.

removeHyperlink(): Promise<void>;

반환값

Promise<void>

removeLineColor()​

선 색상을 제거한다 (noFill).

removeLineColor(): Promise<void>;

반환값

Promise<void>

reorder(order)​

도형의 정렬 순서(앞으로/뒤로)를 변경한다. 이미 목표 위치라 바뀔 것이 없으면 무시된다.

reorder(order: ShapeZOrder): Promise<void>;

매개변수

이름타입설명
orderShapeZOrder순서 변경 타입

반환값

Promise<void>

set3d(scene3d, sp3d)​

도형에 3D 효과를 적용한다. scene3d 와 sp3d 중 비어 있는 인자는 적용하지 않는다.

set3d(scene3d?: Scene3d, sp3d?: Sp3d): Promise<void>;

매개변수

이름타입설명
scene3d (선택)Scene3d카메라(회전) 설정. 생략하면 적용하지 않음
sp3d (선택)Sp3d입체(깊이) 설정. 생략하면 적용하지 않음

반환값

Promise<void>

setEffects(effects)​

getEffects() 가 반환한 효과 객체를 그대로 적용한다. (getEffects 대칭 - 도형→도형 효과 복사) 포함된 효과 키만 대응 setter 로 적용한다. scene3d/sp3d 는 set3d 로 함께 넘긴다. 대상의 기존 효과를 지우지는 않는다 - 완전 복사하려면 removeEffect/remove3d 로 먼저 제거한 뒤 적용한다. outerShadow 와 innerShadow 를 함께 넘기면 거부하지 않고 순서대로 적용해 나중 것만 남는다.

setEffects(effects?: Effects): Promise<void>;

매개변수

이름타입설명
effects (선택)EffectsgetEffects() 반환값. 생략하면 아무것도 변경하지 않는다

반환값

Promise<void>

setFill(fill)​

getFill() 이 반환한 채우기 객체를 그대로 적용한다. (getFill 대칭 - 도형→도형 채우기 복사) image 는 조회 결과의 embed 를 재사용하므로 같은 문서 안에서만 복원된다. embed 없는 image 는 적용할 그림이 없어 거부한다 (새 이미지는 setImageFill).

setFill(fill?: Fill): Promise<void>;

매개변수

이름타입설명
fill (선택)FillgetFill() 반환값. 생략하면 아무것도 변경하지 않는다

반환값

Promise<void>

setGlow(glow)​

네온(광선) 효과를 적용한다. (getEffects().glow 대칭 - 반환 객체를 그대로 넘길 수 있다) 생략한 필드는 기본값으로 채운다 (필드별 기본값은 Glow 참조).

setGlow(glow?: Glow): Promise<void>;

매개변수

이름타입설명
glow (선택)Glow네온(광선) 설정

반환값

Promise<void>

setGradientFill(type, stops, angle)​

그라데이션 채우기를 설정한다.

setGradientFill(
  type?: GradientType,
  stops?: { color: string; pos?: number; alpha?: number }[],
  angle?: number
): Promise<void>;

매개변수

이름타입설명
type (선택)GradientType그라데이션 유형 (lin/circle/rect/shape) (기본값: GradientType.LINEAR)
stops (선택){ color: string; pos?: number; alpha?: number }[]색상 변화점. pos 생략 시 균등 분배, alpha 는 투명도(0~100, 0=불투명) (기본값: [{ color: "accent1", pos: 0 }, { color: "bg1", pos: 100 }])
angle (선택)number그라데이션 각도 (lin 일 때만 사용) (기본값: 45)

반환값

Promise<void>

setHeadEnd(lineEnd)​

연결선의 시작 화살표(headEnd)를 설정한다. (getHeadEnd 대칭 - 반환 객체를 그대로 넘길 수 있다) 화살표를 없애려면 type 에 LineEndType.NONE 을 준다. width/length 를 생략하면 기존 크기가 아니라 기본값(MEDIUM)이 적용된다.

setHeadEnd(lineEnd: Partial<LineEnd> & {type: LineEndType}): Promise<void>;

매개변수

이름타입설명
lineEndPartial<LineEnd> & {type: LineEndType}화살표 설정

반환값

Promise<void>

setHeight(height)​

도형의 높이를 설정한다. 크기 조정이 불가능한 도형이면 무시된다.

setHeight(height: number): Promise<void>;

매개변수

이름타입설명
heightnumber높이 (px 단위, 소수 한 자리로 반올림)

반환값

Promise<void>

도형에 하이퍼링크를 설정한다. (getHyperlink 대칭 - 반환 객체를 그대로 넘겨 하이퍼링크를 복사할 수 있다) 지원하지 않는 종류나 유효하지 않은 대상(삭제된 슬라이드 등)은 무시한다.

setHyperlink(hyperlink: Hyperlink): Promise<void>;

매개변수

이름타입설명
hyperlinkHyperlinkgetHyperlink() 반환값과 같은 Hyperlink 객체. type 이 없으면 무시한다

반환값

Promise<void>

setImageFill(imageUrl, fillMode, alpha, detail)​

이미지 채우기를 설정한다.

setImageFill(
  imageUrl: string,
  fillMode?: ImageFillMode,
  alpha?: number,
  detail?: ImageFillDetail
): Promise<void>;

매개변수

이름타입설명
imageUrlstring이미지 URL
fillMode (선택)ImageFillMode이미지 채우기 방식 (기본값: ImageFillMode.STRETCH)
alpha (선택)number투명도 (0~100, 0=불투명) (기본값: 0)
detail (선택)ImageFillDetail세부 옵션. offset/scale/mirror/align 은 fillMode=ImageFillMode.TILE 일 때만 반영 (기본값: {})

반환값

Promise<void> - 이미지 업로드 후 채우기 적용이 끝나면 resolve. 대상 도형이 없으면(업로드 중 삭제 포함) SHAPE_NOT_FOUND 로 reject

setInnerShadow(shadow)​

내부 그림자를 적용한다. (getEffects().innerShadow 대칭
반환 객체를 그대로 넘길 수 있다) 생략한 필드는 기본값으로 채운다 (필드별 기본값은 InnerShadow 참조). 도형이 갖는 그림자는 하나다
외부 그림자가 걸려 있으면 내부 그림자로 바뀐다.

setInnerShadow(shadow?: InnerShadow): Promise<void>;

매개변수

이름타입설명
shadow (선택)InnerShadow그림자 설정

반환값

Promise<void>

setLineCap(lineCap)​

선 끝 모양(cap)을 설정한다.

setLineCap(lineCap: LineCap): Promise<void>;

매개변수

이름타입설명
lineCapLineCap선 끝 모양

반환값

Promise<void>

setLineColor(color, alpha)​

선 색상을 설정한다.

setLineColor(color: string, alpha?: number): Promise<void>;

매개변수

이름타입설명
colorstringhex (#RRGGBB) 또는 scheme color
alpha (선택)number투명도 (0~100, 0=불투명). 소수점 셋째 자리까지 저장된다 (기본값: 기존 값 유지)

반환값

Promise<void>

setLineDash(lineDash)​

선 스타일(대시)을 설정한다.

setLineDash(lineDash: LineDash): Promise<void>;

매개변수

이름타입설명
lineDashLineDash선 대시 스타일

반환값

Promise<void>

setLineGradient(type, stops, angle)​

선(테두리) 그라데이션 채우기를 설정한다.

setLineGradient(
  type?: GradientType,
  stops?: { color: string; pos?: number; alpha?: number }[],
  angle?: number
): Promise<void>;

매개변수

이름타입설명
type (선택)GradientType그라데이션 유형 (lin/circle/rect/shape) (기본값: GradientType.LINEAR)
stops (선택){ color: string; pos?: number; alpha?: number }[]색상 변화점. pos 생략 시 균등 분배, alpha 는 투명도(0~100, 0=불투명) (기본값: [{ color: "accent1", pos: 0 }, { color: "bg1", pos: 100 }])
angle (선택)number그라데이션 각도 (lin 일 때만 사용) (기본값: 45)

반환값

Promise<void>

setLineJoin(lineJoin)​

선 연결 유형(join)을 설정한다.

setLineJoin(lineJoin: LineJoin): Promise<void>;

매개변수

이름타입설명
lineJoinLineJoin선 연결(모서리) 유형

반환값

Promise<void>

setLineStyle(style)​

getLineStyle() 이 반환한 선 스타일 객체를 그대로 적용한다. (getLineStyle 대칭 - 도형→도형 선 복사)

setLineStyle(style?: LineStyle): Promise<void>;

매개변수

이름타입설명
style (선택)LineStylegetLineStyle() 반환값. 생략하면 아무것도 변경하지 않는다

반환값

Promise<void>

setLineWidth(lineWidth)​

선 두께를 설정한다.

setLineWidth(lineWidth: number): Promise<void>;

매개변수

이름타입설명
lineWidthnumber선 두께 (pt 단위)

반환값

Promise<void>

setOuterShadow(shadow)​

외부 그림자를 적용한다. (getEffects().outerShadow 대칭
반환 객체를 그대로 넘길 수 있다) 생략한 필드는 기본값으로 채운다 (필드별 기본값은 OuterShadow 참조). 도형이 갖는 그림자는 하나다
내부 그림자가 걸려 있으면 외부 그림자로 바뀐다.

setOuterShadow(shadow?: OuterShadow): Promise<void>;

매개변수

이름타입설명
shadow (선택)OuterShadow그림자 설정

반환값

Promise<void>

setPatternFill(preset, foreColor, backColor, foreAlpha, backAlpha)​

패턴(무늬) 채우기를 설정한다. (getFill 왕복 대칭)

setPatternFill(
  preset: PatternPreset,
  foreColor?: string,
  backColor?: string,
  foreAlpha?: number,
  backAlpha?: number
): Promise<void>;

매개변수

이름타입설명
presetPatternPreset무늬 프리셋 (apiConstants.PatternPreset)
foreColor (선택)string전경색 hex (#RRGGBB) 또는 scheme color (기본은 테마 강조색1) (기본값: "accent1")
backColor (선택)string배경색 hex (#RRGGBB) 또는 scheme color (기본은 테마 배경색1) (기본값: "bg1")
foreAlpha (선택)number전경색 투명도 (0~100, 0=불투명) (기본값: 0)
backAlpha (선택)number배경색 투명도 (0~100, 0=불투명) (기본값: 0)

반환값

Promise<void>

setReflection(reflection)​

반사 효과를 적용한다. (getEffects().reflection 대칭 - 반환 객체를 그대로 넘길 수 있다) 생략한 필드는 기본값으로 채운다 (필드별 기본값은 Reflection 참조).

setReflection(reflection?: Reflection): Promise<void>;

매개변수

이름타입설명
reflection (선택)Reflection반사 설정

반환값

Promise<void>

setRotation(rotation)​

도형의 회전 각도를 절대값으로 설정한다. 회전이 불가능한 도형이면 무시된다. (getRotation 대칭)

setRotation(rotation: number): Promise<void>;

매개변수

이름타입설명
rotationnumber회전 각도 (degree)

반환값

Promise<void>

setSoftEdge(softEdge)​

옅은 테두리(softEdge) 효과를 적용한다. (getEffects().softEdge 대칭 - 반환 객체를 그대로 넘길 수 있다) 생략한 필드는 기본값으로 채운다 (필드별 기본값은 SoftEdge 참조).

setSoftEdge(softEdge?: SoftEdge): Promise<void>;

매개변수

이름타입설명
softEdge (선택)SoftEdge옅은 테두리 설정

반환값

Promise<void>

setSolidFill(color, alpha)​

도형 채우기를 단색으로 설정한다.

setSolidFill(color: string, alpha?: number): Promise<void>;

매개변수

이름타입설명
colorstringhex (#RRGGBB) 또는 scheme color
alpha (선택)number투명도 (0~100, 0=불투명). 소수점 셋째 자리까지 저장된다 (기본값: 기존 값 유지)

반환값

Promise<void>

setTailEnd(lineEnd)​

연결선의 끝 화살표(tailEnd)를 설정한다. (getTailEnd 대칭 - 반환 객체를 그대로 넘길 수 있다) 화살표를 없애려면 type 에 LineEndType.NONE 을 준다. width/length 를 생략하면 기존 크기가 아니라 기본값(MEDIUM)이 적용된다.

setTailEnd(lineEnd: Partial<LineEnd> & {type: LineEndType}): Promise<void>;

매개변수

이름타입설명
lineEndPartial<LineEnd> & {type: LineEndType}화살표 설정

반환값

Promise<void>

setTransform(transform)​

도형의 위치·크기·회전을 한 번에 설정한다. getTransform() 반환값을 그대로 넘길 수 있다. (getTransform 대칭) 값을 준 필드만 크기→위치→회전 순으로 적용하고, 생략한 필드는 현재 값을 유지한다. 각 필드는 개별 setter 와 같이 해당 조작(크기/이동/회전)이 불가능한 도형에서 무시된다.

setTransform(transform?: Partial<ShapeTransform>): Promise<void>;

매개변수

이름타입설명
transform (선택)Partial<ShapeTransform>위치/크기 (px) · 회전 (degree)

반환값

Promise<void>

setWidth(width)​

도형의 너비를 설정한다. 크기 조정이 불가능한 도형이면 무시된다.

setWidth(width: number): Promise<void>;

매개변수

이름타입설명
widthnumber너비 (px 단위, 소수 한 자리로 반올림)

반환값

Promise<void>

setX(x)​

도형의 X 좌표를 절대값으로 설정한다. 이동이 불가능한 도형이면 무시된다. (상대 이동은 moveBy)

setX(x: number): Promise<void>;

매개변수

이름타입설명
xnumberX 좌표 (px 단위, 정수로 반올림)

반환값

Promise<void>

setY(y)​

도형의 Y 좌표를 절대값으로 설정한다. 이동이 불가능한 도형이면 무시된다.

setY(y: number): Promise<void>;

매개변수

이름타입설명
ynumberY 좌표 (px 단위, 정수로 반올림)

반환값

Promise<void>