Interface AsukaRenderEngineObjects

interface AsukaRenderEngineObjects {
    addDesign(input: AsukaDesignInput): AsukaMutationPromise<AsukaObjectRef>;
    addElement(input: AsukaElementInput): AsukaMutationPromise<AsukaObjectRef>;
    addImage(input: AsukaImageInput): AsukaMutationPromise<AsukaObjectRef>;
    addText(input: AsukaTextInput): AsukaMutationPromise<AsukaObjectRef>;
    bringForward(id: string, options?: AsukaObjectMutationOptions): AsukaMutationPromise<null | AsukaObjectSummary>;
    clearPreview(): void;
    duplicate(id: string, options?: AsukaObjectDuplicateOptions): AsukaMutationPromise<null | AsukaObjectRef>;
    get(id: string): null | AsukaObjectSummary;
    getBounds(id: string): null | AsukaBoundsBox;
    getTransform(id: string): null | AsukaObjectTransform;
    list(options?: AsukaObjectListOptions): AsukaObjectSummary[];
    measure(id: string, options?: AsukaLayerMeasurementOptions): null | AsukaLayerMeasurement;
    preview(id: string, options?: AsukaObjectPreviewOptions): void;
    remove(id: string): AsukaMutationPromise<null | AsukaObjectSummary>;
    removeElement(id?: string, options?: Record<string, unknown>): AsukaMutationPromise<null | AsukaObjectRef>;
    reorder(orderedIds: string[], options?: AsukaObjectOrderOptions): AsukaMutationPromise<string[]>;
    sendBackward(id: string, options?: AsukaObjectMutationOptions): AsukaMutationPromise<null | AsukaObjectSummary>;
    setLocked(id: string, locked: boolean, options?: AsukaObjectMutationOptions): AsukaMutationPromise<null | AsukaObjectSummary>;
    setVisible(id: string, visible: boolean, options?: AsukaObjectMutationOptions): AsukaMutationPromise<null | AsukaObjectSummary>;
    update(id: string, patch: AsukaObjectPatch): AsukaMutationPromise<null | AsukaObjectSummary>;
    updateTransform(id: string, patch: Partial<AsukaObjectTransform> & AsukaObjectPatch, options?: AsukaObjectMutationOptions): AsukaMutationPromise<null | AsukaObjectTransform>;
}

Methods

addDesign

addDesign(input): AsukaMutationPromise<AsukaObjectRef>
Parameters
- input: AsukaDesignInput
Returns AsukaMutationPromise<AsukaObjectRef>

addElement

addElement(input): AsukaMutationPromise<AsukaObjectRef>
Parameters
- input: AsukaElementInput
Returns AsukaMutationPromise<AsukaObjectRef>

addImage

addImage(input): AsukaMutationPromise<AsukaObjectRef>
Parameters
- input: AsukaImageInput
Returns AsukaMutationPromise<AsukaObjectRef>

addText

addText(input): AsukaMutationPromise<AsukaObjectRef>
Parameters
- input: AsukaTextInput
Returns AsukaMutationPromise<AsukaObjectRef>

bringForward

bringForward(id, options?): AsukaMutationPromise<null | AsukaObjectSummary>
Parameters
- id: string
- Optionaloptions: AsukaObjectMutationOptions
Returns AsukaMutationPromise<null | AsukaObjectSummary>

clearPreview

clearPreview(): void
Returns void

duplicate

duplicate(id, options?): AsukaMutationPromise<null | AsukaObjectRef>
Parameters
- id: string
- Optionaloptions: AsukaObjectDuplicateOptions
Returns AsukaMutationPromise<null | AsukaObjectRef>

get

get(id): null | AsukaObjectSummary
Parameters
- id: string
Returns null | AsukaObjectSummary

getBounds

getBounds(id): null | AsukaBoundsBox
Parameters
- id: string
Returns null | AsukaBoundsBox

getTransform

getTransform(id): null | AsukaObjectTransform
Parameters
- id: string
Returns null | AsukaObjectTransform

list

list(options?): AsukaObjectSummary[]
Parameters
- Optionaloptions: AsukaObjectListOptions
Returns AsukaObjectSummary[]

measure

measure(id, options?): null | AsukaLayerMeasurement
Measure one layer in native, relative and calibrated physical units.
Parameters
- id: string
- Optionaloptions: AsukaLayerMeasurementOptions
Returns null | AsukaLayerMeasurement

preview

preview(id, options?): void
Parameters
- id: string
- Optionaloptions: AsukaObjectPreviewOptions
Returns void

remove

remove(id): AsukaMutationPromise<null | AsukaObjectSummary>
Parameters
- id: string
Returns AsukaMutationPromise<null | AsukaObjectSummary>

removeElement

removeElement(id?, options?): AsukaMutationPromise<null | AsukaObjectRef>
Parameters
- Optionalid: string
- Optionaloptions: Record<string, unknown>
Returns AsukaMutationPromise<null | AsukaObjectRef>

reorder

reorder(orderedIds, options?): AsukaMutationPromise<string[]>
Parameters
- orderedIds: string[]
- Optionaloptions: AsukaObjectOrderOptions
Returns AsukaMutationPromise<string[]>

sendBackward

sendBackward(id, options?): AsukaMutationPromise<null | AsukaObjectSummary>
Parameters
- id: string
- Optionaloptions: AsukaObjectMutationOptions
Returns AsukaMutationPromise<null | AsukaObjectSummary>

setLocked

setLocked(id, locked, options?): AsukaMutationPromise<null | AsukaObjectSummary>
Parameters
- id: string
- locked: boolean
- Optionaloptions: AsukaObjectMutationOptions
Returns AsukaMutationPromise<null | AsukaObjectSummary>

setVisible

setVisible(id, visible, options?): AsukaMutationPromise<null | AsukaObjectSummary>
Parameters
- id: string
- visible: boolean
- Optionaloptions: AsukaObjectMutationOptions
Returns AsukaMutationPromise<null | AsukaObjectSummary>

update

update(id, patch): AsukaMutationPromise<null | AsukaObjectSummary>
Parameters
- id: string
- patch: AsukaObjectPatch
Returns AsukaMutationPromise<null | AsukaObjectSummary>

updateTransform

updateTransform(id, patch, options?): AsukaMutationPromise<null | AsukaObjectTransform>
Parameters
- id: string
- patch: Partial<AsukaObjectTransform> & AsukaObjectPatch
- Optionaloptions: AsukaObjectMutationOptions
Returns AsukaMutationPromise<null | AsukaObjectTransform>