K4 InDesign Javascript API Documentation

LibrariesAsset

An object library asset.

Instance Properties

Name Description Access
assetType AssetType The type of object library asset. read-write
date Date The date and time the Asset was created. read-only
description string The description of the Asset. read-write
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
id number The unique ID of the Asset. read-only
index number The index of the Asset within its containing object. read-only
isValid bool Returns true if the object specifier resolves to valid objects. read-only
label string A property that can be set to any string. read-write
name string The name of the Asset. read-write
parent Library The parent of the Asset (a Library). read-only
properties Object A property that allows setting of several properties at the same time. read-write

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
extractLabel(
key)
  → string
getElements(
)
  → Asset
insertLabel(
key, value)
placeAsset(
on)
remove(
)
removeEventListener(
eventType, handler ​[, captures])
  → bool
select(
[existingSelection])
toSource(
)
  → string
toSpecifier(
)
  → string
addEventListener(
eventType, handler ​[, captures=false])
  → EventListener
Adds an event listener.
eventType string The event type.
handler The event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
extractLabel(
key)
  → string
Gets the label value associated with the specified key.
key string The key.
getElements(
)
  → Asset
Resolves the object specifier, creating an array of object references.
insertLabel(
key, value)
Sets the label to the value associated with the specified key.
key string The key.
value string The value.
placeAsset(
on)
Places the asset in the specified document or text.
on The document or text object in which to place the asset. Can accept: Document or Text.
remove(
)
Deletes the Asset.
removeEventListener(
eventType, handler ​[, captures=false])
  → bool
Removes the event listener.
eventType string The registered event type.
handler The registered event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
select(
[existingSelection=SelectionOptions.REPLACE_WITH])
Selects the object.
existingSelection SelectionOptions The selection status of the Asset in relation to previously selected objects. (Optional)
toSource(
)
  → string
Generates a string which, if executed, will return the Asset.
toSpecifier(
)
  → string
Retrieves the object specifier.