[]
        
(Showing Draft Content)

Model3DViewCollection

Class: Model3DViewCollection

Defines the collection of Model3DView objects.

Extends

Accessors

count

Get Signature

get count(): number;

Gets the number of items in the collection.

Returns

number

Overrides

PdfCollection.count

id

Get Signature

get id(): number;

Gets the reference to the object.

Returns

number

Inherited from

PdfCollection.id

last

Get Signature

get last(): TItem;

Gets last item in the collection.

Returns

TItem

Inherited from

PdfCollection.last

om

Get Signature

get om(): ObjectManager;

Gets the owner ObjectManager instance.

Returns

ObjectManager

Inherited from

PdfCollection.om

Methods

add()

add(item): void;

Adds an item to the end of the collection.

Parameters

item

| Model3DViewProperties | Model3DView

The 3D view specified as Model3DViewProperties or Model3DView.

Returns

void

Overrides

PdfCollection.add

clear()

clear(): void;

Clears the collection.

Returns

void

Overrides

PdfCollection.clear

contains()

contains(item): boolean;

Determines whether the item is in the collection.

Parameters

item

Model3DView

Returns

boolean

true if the item is in the collection, false otherwise.

Overrides

PdfCollection.contains

findByName()

findByName(name): Model3DView;

Finds and returns the first Model3DView in this collection whose Model3DView.name equals the specified 'name', if Model3DView.name is empty then Model3DView.uiName is used.

Parameters

name

string

The name of the view to find.

Returns

Model3DView

The Model3DView with the specified name, or null if no matching view is found.


free()

free(): void;

Detaches the object from the ObjectManager and deallocates its memory, if possible.

Returns

void

Inherited from

PdfCollection.free

getAt()

getAt(index): Model3DView;

Gets the item with the specified index.

Parameters

index

number

The index of the item.

Returns

Model3DView

Overrides

PdfCollection.getAt

indexByName()

indexByName(name): number;

Returns the zero-based index of the first Model3DView in this collection whose Model3DView.name equals the specified 'name', if Model3DView.name is empty then Model3DView.uiName is used.

Parameters

name

string

The name of the view to locate.

Returns

number

The zero-based index of the first occurrence of a view with the specified name if found; otherwise, -1.


insert()

insert(index, item): void;

Inserts an item at a specific position in the collection.

Parameters

index

number

The position where the item will be inserted.

item

Model3DView

The item to insert.

Returns

void

Overrides

PdfCollection.insert

rebind()

rebind(omTo): void;

Rebinds the object from the current ObjectManager to the specified one.

Parameters

omTo

ObjectManager

The new ObjectManager for the object.

Returns

void

Inherited from

PdfCollection.rebind

remove()

remove(item): boolean;

Removes the specified item from the collection.

Parameters

item

Model3DView

The item to remove.

Returns

boolean

true if the item was actually removed, false otherwise.

Overrides

PdfCollection.remove

removeAt()

removeAt(index): void;

Removes the item at specified index.

Parameters

index

number

The index of the item to remove.

Returns

void

Overrides

PdfCollection.removeAt

setAt()

setAt(index, item): void;

Sets the item at the specified index.

Parameters

index

number

The index of the item, starting from 0.

item

Model3DView

The object to set.

Returns

void

Overrides

PdfCollection.setAt