Ver. | メソッドの書式 | 戻り値 | メソッドの説明 |
---|
| | パラメータ | 値 | | パラメータの説明 |
![[12]](12e.png) ![[13]](13e.png) ![[14]](14e.png) ![[15]](15e.png)
![[16]](16e.png) ![[17]](17e.png) ![[18]](18e.png) ![[19]](19e.png) |
addEventListener(eventType, handler, [captures]) |
EventListener | EventListenerを作成 |
| eventType |
文字列値 | | |
| handler |
ファイル, JavaScript関数 | | |
| [captures] |
真偽値 | | (廃止) |
![[12]](12e.png) ![[13]](13e.png) ![[14]](14e.png) ![[15]](15e.png)
![[16]](16e.png) ![[17]](17e.png) ![[18]](18e.png) ![[19]](19e.png) |
contentPlace(pageItems, [linkPageItems], [linkStories], [mapStyles], [placePoint], [destinationLayer], [showingOptions]) |
Array( varies=any ) | リンクとして配置 |
| pageItems |
Array( PageItem ) | | 配置するページアイテム |
| [linkPageItems] |
真偽値 | | Whether to link pageItems in content placer (if true it will override link stories value) (既定値=false) |
| [linkStories] |
真偽値 | | Whether to link stories in content placer (only applicable for single story, pageItem links will also be created in case of more than one item) (既定値=false) |
| [mapStyles] |
真偽値 | | Whether to map styles in content placer (既定値=false) |
| [placePoint] |
[ x, y ] | | 配置先の座標。x, yは数値または長さ値 |
| [destinationLayer] |
Layer | | 配置するレイヤー |
| [showingOptions] |
真偽値 | | オプションのダイアログを表示させるか (既定値=false) |
![[12]](12e.png) ![[13]](13e.png) ![[14]](14e.png) ![[15]](15e.png)
![[16]](16e.png) ![[17]](17e.png) ![[18]](18e.png) ![[19]](19e.png) |
createGuides([numberOfRows], [numberOfColumns], [rowGutter], [columnGutter], [guideColor], [fitMargins], [removeExisting], [layer]) |
なし | ガイドを作成 |
| [numberOfRows] |
数値 | | 行数 (0 - 40, 既定値=0) |
| [numberOfColumns] |
数値 | | 列数 (0 - 40, 既定値=0) |
| [rowGutter] |
長さ値 | | 行の間隔 (0 - 1440 pt, 既定値=0) |
| [columnGutter] |
長さ値 | | 列の間隔 (0 - 1440 pt, 既定値=0) |
| [guideColor] |
[ r, g, b ], UIColors | | ガイドのカラー R,G,Bは0-255 |
| [fitMargins] |
真偽値 | | ページマージンに吸着させるか (既定値=false) |
| [removeExisting] |
真偽値 | | 既存のガイドを削除するかどうか (既定値=false) |
| [layer] |
Layer | | 作成するレイヤー |
![[12]](12e.png) ![[13]](13e.png) ![[14]](14e.png) ![[15]](15e.png)
![[16]](16e.png) ![[17]](17e.png) ![[18]](18e.png) ![[19]](19e.png) |
detach() |
なし | オーバーライドされたマスターページアイテムをマスターから分離 |
![[12]](12e.png) ![[13]](13e.png) ![[14]](14e.png) ![[15]](15e.png)
![[16]](16e.png) ![[17]](17e.png) ![[18]](18e.png) ![[19]](19e.png) |
duplicate([to], [reference]) |
Spread, MasterSpread | 複製。複製されたオブジェクトを返す |
| [to] |
LocationOptions
LocationOptions |
---|
Ver. | 値 | 10進数/文字列 | 説明 |
![[12]](12e.png) ![[13]](13e.png) ![[14]](14e.png) ![[15]](15e.png)
![[16]](16e.png) ![[17]](17e.png) ![[18]](18e.png) ![[19]](19e.png) | AFTER | 1634104421 afte | 後 |
![[12]](12e.png) ![[13]](13e.png) ![[14]](14e.png) ![[15]](15e.png)
![[16]](16e.png) ![[17]](17e.png) ![[18]](18e.png) ![[19]](19e.png) | AT_BEGINNING | 1650945639 bgng | 先頭 |
![[12]](12e.png) ![[13]](13e.png) ![[14]](14e.png) ![[15]](15e.png)
![[16]](16e.png) ![[17]](17e.png) ![[18]](18e.png) ![[19]](19e.png) | AT_END | 1701733408 end | 最後 |
![[12]](12e.png) ![[13]](13e.png) ![[14]](14e.png) ![[15]](15e.png)
![[16]](16e.png) ![[17]](17e.png) ![[18]](18e.png) ![[19]](19e.png) | BEFORE | 1650812527 befo | 前 |
![[12]](12e.png) ![[13]](13e.png) ![[14]](14e.png) ![[15]](15e.png)
![[16]](16e.png) ![[17]](17e.png) ![[18]](18e.png) ![[19]](19e.png) | UNKNOWN | 1433299822 Unkn | No location |
| | 複製先 (既定値=LocationOptions.AT_END) |
| [reference] |
Spread, Document, MasterSpread | | 位置の基準になるオブジェクト |
![[12]](12e.png) ![[13]](13e.png) ![[14]](14e.png) ![[15]](15e.png)
![[16]](16e.png) ![[17]](17e.png) ![[18]](18e.png) ![[19]](19e.png) |
extractLabel(key) |
文字列値 | キーに関連づけられた値を取得 |
| key |
文字列値 | | キー |
![[12]](12e.png) ![[13]](13e.png) ![[14]](14e.png) ![[15]](15e.png)
![[16]](16e.png) ![[17]](17e.png) ![[18]](18e.png) ![[19]](19e.png) |
getElements() |
Array( Spread ) | オブジェクト参照を返す |
![[12]](12e.png) ![[13]](13e.png) ![[14]](14e.png) ![[15]](15e.png)
![[16]](16e.png) ![[17]](17e.png) ![[18]](18e.png) ![[19]](19e.png) |
insertLabel(key, value) |
なし | キーに関連づけられた値を設定 |
| key |
文字列値 | | キー |
| value |
文字列値 | | 値 |
![[12]](12e.png) ![[13]](13e.png) ![[14]](14e.png) ![[15]](15e.png)
![[16]](16e.png) ![[17]](17e.png) ![[18]](18e.png) ![[19]](19e.png) |
move([to], [reference]) |
Spread | 移動 |
| [to] |
LocationOptions
LocationOptions |
---|
Ver. | 値 | 10進数/文字列 | 説明 |
![[12]](12e.png) ![[13]](13e.png) ![[14]](14e.png) ![[15]](15e.png)
![[16]](16e.png) ![[17]](17e.png) ![[18]](18e.png) ![[19]](19e.png) | AFTER | 1634104421 afte | 後 |
![[12]](12e.png) ![[13]](13e.png) ![[14]](14e.png) ![[15]](15e.png)
![[16]](16e.png) ![[17]](17e.png) ![[18]](18e.png) ![[19]](19e.png) | AT_BEGINNING | 1650945639 bgng | 先頭 |
![[12]](12e.png) ![[13]](13e.png) ![[14]](14e.png) ![[15]](15e.png)
![[16]](16e.png) ![[17]](17e.png) ![[18]](18e.png) ![[19]](19e.png) | AT_END | 1701733408 end | 最後 |
![[12]](12e.png) ![[13]](13e.png) ![[14]](14e.png) ![[15]](15e.png)
![[16]](16e.png) ![[17]](17e.png) ![[18]](18e.png) ![[19]](19e.png) | BEFORE | 1650812527 befo | 前 |
![[12]](12e.png) ![[13]](13e.png) ![[14]](14e.png) ![[15]](15e.png)
![[16]](16e.png) ![[17]](17e.png) ![[18]](18e.png) ![[19]](19e.png) | UNKNOWN | 1433299822 Unkn | No location |
| | 移動先 (既定値=LocationOptions.AT_END) |
| [reference] |
Spread, Page, Document | | 位置の基準になるオブジェクト |
![[12]](12e.png) ![[13]](13e.png) ![[14]](14e.png) ![[15]](15e.png)
![[16]](16e.png) ![[17]](17e.png) ![[18]](18e.png) ![[19]](19e.png) |
place(fileName, [placePoint], [destinationLayer], [showingOptions], [autoflowing], [withProperties]) |
Array( varies=any ) | 配置。配置されたオブジェクトを返す |
| fileName |
ファイル | | ファイル名 |
| [placePoint] |
[ x, y ] | | 配置先の座標 x, yは数値または長さ値 |
| [destinationLayer] |
Layer | | 配置するレイヤー |
| [showingOptions] |
真偽値 | | オプションのダイアログを表示させるか (既定値=false) |
| [autoflowing] |
真偽値 | | 自動流し込み (既定値=false) |
| [withProperties] |
Object | | プロパティを設定 |
![[12]](12e.png) ![[13]](13e.png) ![[14]](14e.png) ![[15]](15e.png)
![[16]](16e.png) ![[17]](17e.png) ![[18]](18e.png) ![[19]](19e.png) |
placeAndLink(parentStory, [placePoint], [destinationLayer], [showingOptions]) |
Story | リンクストーリーの配置 |
| parentStory |
Story | | 親のストーリー |
| [placePoint] |
[ x, y ] | | 配置先の座標 x, yは数値または長さ値 |
| [destinationLayer] |
Layer | | 配置するレイヤー |
| [showingOptions] |
真偽値 | | オプションのダイアログを表示させるか (既定値=false) |
![[12]](12e.png) ![[13]](13e.png) ![[14]](14e.png) ![[15]](15e.png)
![[16]](16e.png) ![[17]](17e.png) ![[18]](18e.png) ![[19]](19e.png) |
placeXML(using, placePoint, [autoflowing]) |
PageItem | Places the XML element onto a page. If the place point is above an existing page item, place the XML element into the page item. |
| using |
XMLElement | | The XML element to place. |
| placePoint |
[ x, y ] | | The point at which to place the object. |
| [autoflowing] |
真偽値 | | 自動流し込み (既定値=false) |
![[12]](12e.png) ![[13]](13e.png) ![[14]](14e.png) ![[15]](15e.png)
![[16]](16e.png) ![[17]](17e.png) ![[18]](18e.png) ![[19]](19e.png) |
remove() |
なし | 削除 |
![[12]](12e.png) ![[13]](13e.png) ![[14]](14e.png) ![[15]](15e.png)
![[16]](16e.png) ![[17]](17e.png) ![[18]](18e.png) ![[19]](19e.png) |
removeEventListener(eventType, handler, [captures]) |
真偽値 | EventListenerを削除 |
| eventType |
文字列値 | | |
| handler |
ファイル, JavaScript関数 | | |
| [captures] |
真偽値 | | (廃止) |
![[12]](12e.png) ![[13]](13e.png) ![[14]](14e.png) ![[15]](15e.png)
![[16]](16e.png) ![[17]](17e.png) ![[18]](18e.png) ![[19]](19e.png) |
removeOverride() |
なし | オーバーライドを削除 |
![[12]](12e.png) ![[13]](13e.png) ![[14]](14e.png) ![[15]](15e.png)
![[16]](16e.png) ![[17]](17e.png) ![[18]](18e.png) ![[19]](19e.png) |
resolve(location, in, [consideringRulerUnits]) |
varies=any | Get the coordinates of the given location in the specified coordinate system. |
| location |
varies=any | | The location requested. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. |
| in |
CoordinateSpaces
CoordinateSpaces |
---|
Ver. | 値 | 10進数/文字列 | 説明 |
![[12]](12e.png) ![[13]](13e.png) ![[14]](14e.png) ![[15]](15e.png)
![[16]](16e.png) ![[17]](17e.png) ![[18]](18e.png) ![[19]](19e.png) | INNER_COORDINATES | 2021222766 xyin | 自身を基準とした座標空間 |
![[12]](12e.png) ![[13]](13e.png) ![[14]](14e.png) ![[15]](15e.png)
![[16]](16e.png) ![[17]](17e.png) ![[18]](18e.png) ![[19]](19e.png) | PAGE_COORDINATES | 2021224551 xypg | ページ基準の座標空間 |
![[12]](12e.png) ![[13]](13e.png) ![[14]](14e.png) ![[15]](15e.png)
![[16]](16e.png) ![[17]](17e.png) ![[18]](18e.png) ![[19]](19e.png) | PARENT_COORDINATES | 2021224545 xypa | 親オブジェクト基準の座標空間 |
![[12]](12e.png) ![[13]](13e.png) ![[14]](14e.png) ![[15]](15e.png)
![[16]](16e.png) ![[17]](17e.png) ![[18]](18e.png) ![[19]](19e.png) | PASTEBOARD_COORDINATES | 2021224546 xypb | ペーストボード基準の座標空間 |
![[12]](12e.png) ![[13]](13e.png) ![[14]](14e.png) ![[15]](15e.png)
![[16]](16e.png) ![[17]](17e.png) ![[18]](18e.png) ![[19]](19e.png) | SPREAD_COORDINATES | 2021225328 xysp | スプレッド基準の座標空間 |
| | 使用する座標空間 |
| [consideringRulerUnits] |
真偽値 | | ルーラの単位を使うかどうか (既定値=false) |
![[12]](12e.png) ![[13]](13e.png) ![[14]](14e.png) ![[15]](15e.png)
![[16]](16e.png) ![[17]](17e.png) ![[18]](18e.png) ![[19]](19e.png) |
select([existingSelection]) |
なし | 選択状態にする |
| [existingSelection] |
SelectionOptions
SelectionOptions |
---|
Ver. | 値 | 10進数/文字列 | 説明 |
![[12]](12e.png) ![[13]](13e.png) ![[14]](14e.png) ![[15]](15e.png)
![[16]](16e.png) ![[17]](17e.png) ![[18]](18e.png) ![[19]](19e.png) | ADD_TO | 1633969202 add2 | 追加選択する |
![[12]](12e.png) ![[13]](13e.png) ![[14]](14e.png) ![[15]](15e.png)
![[16]](16e.png) ![[17]](17e.png) ![[18]](18e.png) ![[19]](19e.png) | REMOVE_FROM | 1919249734 remF | 選択から削除する |
![[12]](12e.png) ![[13]](13e.png) ![[14]](14e.png) ![[15]](15e.png)
![[16]](16e.png) ![[17]](17e.png) ![[18]](18e.png) ![[19]](19e.png) | REPLACE_WITH | 1919250519 repW | 置き換える |
![[12]](12e.png) ![[13]](13e.png) ![[14]](14e.png) ![[15]](15e.png)
![[16]](16e.png) ![[17]](17e.png) ![[18]](18e.png) ![[19]](19e.png) | SET_KEY | 1936028779 setk | 整列のキーオブジェクトにする |
| | 既に選択されているものがあった場合 (既定値=SelectionOptions.REPLACE_WITH) |
![[12]](12e.png) ![[13]](13e.png) ![[14]](14e.png) ![[15]](15e.png)
![[16]](16e.png) ![[17]](17e.png) ![[18]](18e.png) ![[19]](19e.png) |
setContent(using, [relativeBasePath]) |
PageItem | Replaces the content of XML element with content imported from a file. |
| using |
文字列値 | | フルパス名 |
| [relativeBasePath] |
文字列値 | | Base path used to resolve relative paths. |
![[12]](12e.png) ![[13]](13e.png) ![[14]](14e.png) ![[15]](15e.png)
![[16]](16e.png) ![[17]](17e.png) ![[18]](18e.png) ![[19]](19e.png) |
toSource() |
文字列値 | ソースコードを表す文字列を返す |
![[12]](12e.png) ![[13]](13e.png) ![[14]](14e.png) ![[15]](15e.png)
![[16]](16e.png) ![[17]](17e.png) ![[18]](18e.png) ![[19]](19e.png) |
toSpecifier() |
文字列値 | Retrieves the object specifier. |
![[12]](12e.png) ![[13]](13e.png) ![[14]](14e.png) ![[15]](15e.png)
![[16]](16e.png) ![[17]](17e.png) ![[18]](18e.png) ![[19]](19e.png) |
transform(in, from, withMatrix, [replacingCurrent], [consideringRulerUnits]) |
なし | 変形 |
| in |
CoordinateSpaces
CoordinateSpaces |
---|
Ver. | 値 | 10進数/文字列 | 説明 |
![[12]](12e.png) ![[13]](13e.png) ![[14]](14e.png) ![[15]](15e.png)
![[16]](16e.png) ![[17]](17e.png) ![[18]](18e.png) ![[19]](19e.png) | INNER_COORDINATES | 2021222766 xyin | 自身を基準とした座標空間 |
![[12]](12e.png) ![[13]](13e.png) ![[14]](14e.png) ![[15]](15e.png)
![[16]](16e.png) ![[17]](17e.png) ![[18]](18e.png) ![[19]](19e.png) | PAGE_COORDINATES | 2021224551 xypg | ページ基準の座標空間 |
![[12]](12e.png) ![[13]](13e.png) ![[14]](14e.png) ![[15]](15e.png)
![[16]](16e.png) ![[17]](17e.png) ![[18]](18e.png) ![[19]](19e.png) | PARENT_COORDINATES | 2021224545 xypa | 親オブジェクト基準の座標空間 |
![[12]](12e.png) ![[13]](13e.png) ![[14]](14e.png) ![[15]](15e.png)
![[16]](16e.png) ![[17]](17e.png) ![[18]](18e.png) ![[19]](19e.png) | PASTEBOARD_COORDINATES | 2021224546 xypb | ペーストボード基準の座標空間 |
![[12]](12e.png) ![[13]](13e.png) ![[14]](14e.png) ![[15]](15e.png)
![[16]](16e.png) ![[17]](17e.png) ![[18]](18e.png) ![[19]](19e.png) | SPREAD_COORDINATES | 2021225328 xysp | スプレッド基準の座標空間 |
| | 使用する座標空間 |
| from |
varies=any | | The temporary origin during the transformation. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. |
| withMatrix |
varies=any | | Transform matrix. Can accept: Array of 6 Reals or TransformationMatrix. |
| [replacingCurrent] |
MatrixContent, Array( MatrixContent ), 数値
MatrixContent |
---|
Ver. | 値 | 10進数/文字列 | 説明 |
![[12]](12e.png) ![[13]](13e.png) ![[14]](14e.png) ![[15]](15e.png)
![[16]](16e.png) ![[17]](17e.png) ![[18]](18e.png) ![[19]](19e.png) | ROTATION_VALUE | 1936746862 spin | Rotation value |
![[12]](12e.png) ![[13]](13e.png) ![[14]](14e.png) ![[15]](15e.png)
![[16]](16e.png) ![[17]](17e.png) ![[18]](18e.png) ![[19]](19e.png) | SCALE_VALUES | 1735552887 grow | Scale values |
![[12]](12e.png) ![[13]](13e.png) ![[14]](14e.png) ![[15]](15e.png)
![[16]](16e.png) ![[17]](17e.png) ![[18]](18e.png) ![[19]](19e.png) | SHEAR_VALUE | 1936486004 slnt | Shear value |
![[12]](12e.png) ![[13]](13e.png) ![[14]](14e.png) ![[15]](15e.png)
![[16]](16e.png) ![[17]](17e.png) ![[18]](18e.png) ![[19]](19e.png) | TRANSLATION_VALUES | 1936484720 slip | Translation values |
| | Transform components to consider; providing this optional parameter causes the target's existing transform components to be replaced with new values. Without this parameter, the given matrix is concatenated onto the target's existing transform combining the effect of the two. |
| [consideringRulerUnits] |
真偽値 | | ルーラの単位を使うかどうか (既定値=false) |
![[12]](12e.png) ![[13]](13e.png) ![[14]](14e.png) ![[15]](15e.png)
![[16]](16e.png) ![[17]](17e.png) ![[18]](18e.png) ![[19]](19e.png) |
transformValuesOf(in) |
Array( TransformationMatrix ) | 変形の値を取得 |
| in |
CoordinateSpaces
CoordinateSpaces |
---|
Ver. | 値 | 10進数/文字列 | 説明 |
![[12]](12e.png) ![[13]](13e.png) ![[14]](14e.png) ![[15]](15e.png)
![[16]](16e.png) ![[17]](17e.png) ![[18]](18e.png) ![[19]](19e.png) | INNER_COORDINATES | 2021222766 xyin | 自身を基準とした座標空間 |
![[12]](12e.png) ![[13]](13e.png) ![[14]](14e.png) ![[15]](15e.png)
![[16]](16e.png) ![[17]](17e.png) ![[18]](18e.png) ![[19]](19e.png) | PAGE_COORDINATES | 2021224551 xypg | ページ基準の座標空間 |
![[12]](12e.png) ![[13]](13e.png) ![[14]](14e.png) ![[15]](15e.png)
![[16]](16e.png) ![[17]](17e.png) ![[18]](18e.png) ![[19]](19e.png) | PARENT_COORDINATES | 2021224545 xypa | 親オブジェクト基準の座標空間 |
![[12]](12e.png) ![[13]](13e.png) ![[14]](14e.png) ![[15]](15e.png)
![[16]](16e.png) ![[17]](17e.png) ![[18]](18e.png) ![[19]](19e.png) | PASTEBOARD_COORDINATES | 2021224546 xypb | ペーストボード基準の座標空間 |
![[12]](12e.png) ![[13]](13e.png) ![[14]](14e.png) ![[15]](15e.png)
![[16]](16e.png) ![[17]](17e.png) ![[18]](18e.png) ![[19]](19e.png) | SPREAD_COORDINATES | 2021225328 xysp | スプレッド基準の座標空間 |
| | 使用する座標空間 |