Class Position

위치

특정 요소를 기준으로 문서 탭의 위치를 참조합니다. 사용자의 커서는 다른 용도와 함께 Position로 표시됩니다. 스크립트는 스크립트를 실행하는 사용자의 커서에만 액세스할 수 있으며, 스크립트가 문서에 바인딩된 경우에만 액세스할 수 있습니다. 

// Insert some text at the cursor position and make it bold.
const cursor = DocumentApp.getActiveDocument().getCursor();
if (cursor) {
  // Attempt to insert text at the cursor position. If the insertion returns
  // null, the cursor's containing element doesn't allow insertions, so show the
  // user an error message.
  const element = cursor.insertText('ಠ‿ಠ');
  if (element) {
    element.setBold(true);
  } else {
    DocumentApp.getUi().alert('Cannot insert text here.');
  }
} else {
  DocumentApp.getUi().alert('Cannot find a cursor.');
}

메서드

메서드반환 유형간략한 설명
getElement()Element이 Position을 포함하는 요소를 가져옵니다.
getOffset()Integer이 Position이(가) 포함된 요소 내에서의 상대적 위치를 가져옵니다.
getSurroundingText()TextPosition을 직접 또는 하위 요소 체인을 통해 포함하는 Paragraph 또는 ListItem의 텍스트와 형식을 나타내는 인공 Text 요소를 만듭니다.
getSurroundingTextOffset()IntegergetSurroundingText()에서 반환된 Text 요소 내에서 이 Position의 오프셋을 가져옵니다.
insertBookmark()Bookmark이 Position에 새 Bookmark를 만들어 삽입합니다.
insertInlineImage(image)InlineImage|null지정된 이미지 blob에서 이 Position에 새 InlineImage를 만들어 삽입합니다.
insertText(text)Text|null이 Position에 지정된 텍스트를 삽입합니다.

자세한 문서

getElement()

이 Position을 포함하는 요소를 가져옵니다. Text 요소 또는 Paragraph과 같은 컨테이너 요소가 됩니다. 어느 경우든 요소 내의 상대적 위치는 getOffset()로 확인할 수 있습니다.

리턴

Element - 이 Position 객체가 있는 컨테이너 또는 Text 요소

getOffset()

이 Position이(가) 포함된 요소 내에서의 상대적 위치를 가져옵니다. 요소가 Text 요소인 경우 오프셋은 Position 앞의 문자 수입니다 (즉, 이 Position 뒤에 있는 문자의 색인). 다른 요소의 경우 오프셋은 동일한 컨테이너 요소 내에서 이 Position 앞의 하위 요소 수입니다 (즉, Position 뒤에 있는 하위 요소의 색인).

리턴

Integer: Text 요소의 경우 이 Position 앞의 문자 수, 기타 요소의 경우 동일한 컨테이너 요소 내에서 이 Position 앞의 하위 요소 수

승인

이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getSurroundingText()

Position을 직접 또는 하위 요소 체인을 통해 포함하는 Paragraph 또는 ListItem의 텍스트와 형식을 나타내는 인공 Text 요소를 만듭니다. 반환된 Text 요소에서 Position의 오프셋을 확인하려면 getSurroundingTextOffset()를 사용합니다.

리턴

Text: Position을 직접 또는 하위 요소 체인을 통해 포함하는 Paragraph 또는 ListItem에서 editAsText()를 호출한 결과와 동일한 요소

승인

이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getSurroundingTextOffset()

getSurroundingText()에서 반환된 Text 요소 내에서 이 Position의 오프셋을 가져옵니다. 오프셋은 Position 앞의 문자 수입니다(즉, 이 Position 뒤에 오는 문자의 색인).

리턴

Integer: Position을 직접 또는 하위 요소 체인을 통해 포함하는 Paragraph 또는 ListItem에서 이 Position 앞의 문자 수

승인

이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

insertBookmark()

이 Position에 새 Bookmark를 만들어 삽입합니다.

리턴

Bookmark - 새 북마크

승인

이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

insertInlineImage(image)

지정된 이미지 blob에서 이 Position에 새 InlineImage를 만들어 삽입합니다.

매개변수

이름유형설명
imageBlobSource이 Position에 삽입할 이미지 데이터

리턴

InlineImage|null - 새 이미지 요소 또는 이 Position이 있는 요소에 이미지를 삽입할 수 없는 경우 null

승인

이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

insertText(text)

이 Position에 지정된 텍스트를 삽입합니다. 이 메서드는 문자열이 기존 Text 요소 내에 삽입되더라도 새 Text 요소를 만들어 새 요소의 스타일을 쉽게 지정할 수 있도록 합니다.

매개변수

이름유형설명
textString이 Position에 삽입할 문자열

리턴

Text|null - 새 텍스트 요소 또는 이 Position가 있는 요소에서 텍스트 삽입을 허용하지 않는 경우 null

승인

이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents