RasterItems

app.activeDocument.rasterItems

Description

A collection of RasterItem objects.


Properties

RasterItems.length

app.activeDocument.rasterItems.length

Description

Number of elements in the collection.

Type

Number, read-only.


RasterItems.parent

app.activeDocument.rasterItems.parent

Description

The object’s container.

Type

Object, read-only.


RasterItems.typename

app.activeDocument.rasterItems.typename

Description

The class name of the object.

Type

String, read-only.


Methods

RasterItems.getByName()

app.activeDocument.rasterItems.getByName(name)

Description

Get the first element in the collection with the provided name.

Parameters

Parameter Type Description
name String Name of element to get

Returns

SymbolItem


RasterItems.index()

app.activeDocument.rasterItems.index(itemKey)

Description

Gets an element from the collection.

Parameters

Parameter Type Description
itemKey String, Number String or number key

Returns

SymbolItem


RasterItems.removeAll()

app.activeDocument.rasterItems.removeAll()

Description

Deletes all elements in the collection.

Returns

Nothing.


Example

Creating a raster item

// Creates a new raster item in a new document from a raster file
// jpgFilePath contains the full path and file name of a jpg file
function createRasterItem(jpgFilePath) {
  var rasterFile = File(jpgFilePath);
  var myDoc = app.documents.add();

  var myPlacedItem = myDoc.placedItems.add();
  myPlacedItem.file = rasterFile;
  myPlacedItem.position = Array(0, myDoc.height);
  myPlacedItem.embed();
}

Finding and examining a raster item

// Examines the color space of the first raster item in the document and displays
// result in ESTK console
if (app.documents.length > 0 && app.activeDocument.rasterItems.length > 0) {
  var rasterArt = app.activeDocument.rasterItems[0];

  switch (rasterArt.imageColorSpace) {
    case ImageColorSpace.CMYK:
      $.writeln("The color space of the first raster item is CMYK");
      break;

    case ImageColorSpace.RGB:
      $.writeln("The color space of the first raster item is RGB");
      break;

    case ImageColorSpace.GRAYSCALE:
      $.writeln("The color space of the first raster item is GRAYSCALE");
      break;
  }
}