Scrawl-canvas API
    Preparing search index...

    Interface PictureInstance

    interface PictureInstance {
        actionPacket: (item: string, override?: CommonObjectInput) => any;
        addFilters?: (...items: (string | FilterInstance)[]) => EntityInstance;
        addOwnDimensionsToMimic?: boolean;
        addOwnHandleToMimic?: boolean;
        addOwnOffsetToMimic?: boolean;
        addOwnRotationToMimic?: boolean;
        addOwnScaleToMimic?: boolean;
        addOwnStartToMimic?: boolean;
        addPathHandle?: boolean;
        addPathOffset?: boolean;
        addPathRotation?: boolean;
        addPivotHandle?: boolean;
        addPivotOffset?: boolean;
        addPivotRotation?: boolean;
        anchor?: AnchorFactoryInputs;
        anchorBlurAction?: boolean;
        anchorClickAction?: DefaultOutputFunction;
        anchorDescription?: string;
        anchorDownload?: string;
        anchorFocusAction?: boolean;
        anchorHref?: string;
        anchorHreflang?: string;
        anchorName?: string;
        anchorPing?: string;
        anchorReferrerPolicy?: string;
        anchorRel?: string;
        anchorTarget?: string;
        anchorType?: string;
        asset?: string | AssetInstance;
        bringToFrontOnDrag?: boolean;
        button?: ButtonFactoryInputs;
        buttonAutofocus?: boolean;
        buttonBlurAction?: boolean;
        buttonClickAction?: DefaultOutputFunction;
        buttonDescription?: string;
        buttonDisabled?: boolean;
        buttonElementName?: string;
        buttonElementType?: string;
        buttonElementValue?: string;
        buttonFocusAction?: boolean;
        buttonForm?: string;
        buttonFormAction?: string;
        buttonFormEnctype?: string;
        buttonFormMethod?: string;
        buttonFormNoValidate?: boolean;
        buttonFormTarget?: string;
        buttonName?: string;
        buttonPopoverTarget?: string;
        buttonPopoverTargetAction?: string;
        calculateOrder?: number;
        checkDeltaConstraints?: boolean;
        checkHit?: (tests: HitTests) => boolean | HitOutput;
        checkHitIgnoreTransparency?: boolean;
        clearFilters?: () => EntityInstance;
        clickAnchor?: () => void;
        clickButton?: () => void;
        clone: (item?: PictureFactoryInputs) => PictureInstance;
        constantSpeedAlongPath?: boolean;
        copyDimensions?: CommonTwoElementArrayInput;
        copyHeight?: StringOrNumberInput;
        copyStart?: CommonTwoElementArrayInput;
        copyStartX?: StringOrNumberInput;
        copyStartY?: StringOrNumberInput;
        copyWidth?: StringOrNumberInput;
        delta?: PictureFactoryDeltaInputs;
        deltaConstraints?: CommonObjectInput;
        dimensions?: CommonTwoElementArrayInput;
        dropArtefact?: () => ArtefactInstance;
        fillStyle?: string | StylesInstance;
        filter?: string;
        filters?: string | FilterInstance | (string | FilterInstance)[];
        flipReverse?: boolean;
        flipUpend?: boolean;
        font?: string;
        get: (item: string) => any;
        globalAlpha?: number;
        globalCompositeOperation?: string;
        group?: string | CellInstance | GroupInstance;
        haltSprite: (
            speed?: number,
            loop?: boolean,
            track?: string,
            forward?: boolean,
            frame?: number,
        ) => void;
        handle?: CommonTwoElementArrayInput;
        handleX?: StringOrNumberInput;
        handleY?: StringOrNumberInput;
        height?: StringOrNumberInput;
        ignoreDragForX?: boolean;
        ignoreDragForY?: boolean;
        imageSmoothingEnabled?: boolean;
        imageSmoothingQuality?: string;
        imageSource?: string;
        importPacket: (
            item: string | string[],
            override?: CommonObjectInput,
        ) => any;
        isStencil?: boolean;
        kill: (item?: any) => void;
        lineCap?: LineCapValues;
        lineDash?: number[];
        lineDashOffset?: number;
        lineJoin?: LineJoinValues;
        lineWidth?: number;
        lockFillStyleToEntity?: boolean;
        lockStrokeStyleToEntity?: boolean;
        lockTo?: LockToValues | [LockToValues, LockToValues];
        lockXTo?: LockToValues;
        lockYTo?: LockToValues;
        memoizeFilterOutput?: boolean;
        method?: string;
        mimic?: string | ArtefactInstance;
        miterLimit?: number;
        name?: string;
        noCanvasEngineUpdates?: boolean;
        noDeltaUpdates?: boolean;
        noFilters?: boolean;
        noPathUpdates?: boolean;
        noPositionDependencies?: boolean;
        noUserInteraction?: boolean;
        offset?: CommonTwoElementArrayInput;
        offsetX?: StringOrNumberInput;
        offsetY?: StringOrNumberInput;
        onDown?: OnCascadeFunction;
        onEnter?: OnCascadeFunction;
        onLeave?: OnCascadeFunction;
        onOtherInteraction?: OnCascadeFunction;
        onUp?: OnCascadeFunction;
        order?: number;
        particle?: string | ParticleInstance;
        path?: string | ShapeBasedInstance;
        pathPosition?: number;
        performDeltaChecks?: boolean;
        pickupArtefact?: (
            items: CommonHereObjectInput | CommonTwoElementArrayInput,
        ) => ArtefactInstance;
        pivot?: string | ArtefactInstance;
        pivotCorner?: PivotCornerValues;
        pivotIndex?: number;
        pivotPin?: number;
        playSprite: (
            speed?: number,
            loop?: boolean,
            track?: string,
            forward?: boolean,
            frame?: number,
        ) => void;
        removeAssetOnKill?: string | boolean;
        removeFilters?: (...items: (string | FilterInstance)[]) => EntityInstance;
        reverseByDelta: () => ArtefactInstance;
        roll?: number;
        saveAsPacket: (item?: boolean | PictureSaveInputs) => string;
        scale?: number;
        scaleOutline?: boolean;
        scaleShadow?: boolean;
        set: (item?: PictureFactoryInputs) => PictureInstance;
        setDelta: (item?: PictureFactoryDeltaInputs) => PictureInstance;
        setDeltaValues: (item?: CommonObjectInput) => ArtefactInstance;
        shadowBlur?: number;
        shadowColor?: string;
        shadowOffsetX?: number;
        shadowOffsetY?: number;
        sharedState?: boolean;
        simpleStamp: (host: CellInstance, items?: PictureFactoryInputs) => void;
        spriteForward?: boolean;
        spriteFrameDuration?: number;
        spriteSource?: string;
        spriteTrack?: string;
        spriteWillLoop?: boolean;
        stampOrder?: number;
        start?: CommonTwoElementArrayInput;
        startX?: StringOrNumberInput;
        startY?: StringOrNumberInput;
        strokeStyle?: string | StylesInstance;
        updateByDelta: () => ArtefactInstance;
        useMimicDimensions?: boolean;
        useMimicFlip?: boolean;
        useMimicHandle?: boolean;
        useMimicOffset?: boolean;
        useMimicRotation?: boolean;
        useMimicScale?: boolean;
        useMimicStart?: boolean;
        video_autoPlay?: boolean;
        video_controller?: any;
        video_controls?: any;
        video_crossOrigin?: any;
        video_currentTime?: any;
        video_defaultMuted?: any;
        video_defaultPlaybackRate?: any;
        video_disableRemotePlayback?: any;
        video_loop?: boolean;
        video_mediaGroup?: any;
        video_muted?: boolean;
        video_playbackRate?: any;
        video_src?: any;
        video_srcObject?: any;
        video_volume?: any;
        videoAddTextTrack: (kind: any, label: any, language: any) => any;
        videoCanPlayType: (item: string) => boolean;
        videoCaptureStream: () => any;
        videoFastSeek: (item: number) => any;
        videoLoad: () => any;
        videoPause: () => any;
        videoPlay: () => any;
        videoSetMediaKeys: () => any;
        videoSetSinkId: () => any;
        videoSource?: string;
        visibility?: boolean;
        width?: StringOrNumberInput;
        winding?: WindingValues;
    }

    Hierarchy (View Summary)

    Index

    Properties

    actionPacket addFilters? addOwnDimensionsToMimic? addOwnHandleToMimic? addOwnOffsetToMimic? addOwnRotationToMimic? addOwnScaleToMimic? addOwnStartToMimic? addPathHandle? addPathOffset? addPathRotation? addPivotHandle? addPivotOffset? addPivotRotation? anchor? anchorBlurAction? anchorClickAction? anchorDescription? anchorDownload? anchorFocusAction? anchorHref? anchorHreflang? anchorName? anchorPing? anchorReferrerPolicy? anchorRel? anchorTarget? anchorType? asset? bringToFrontOnDrag? button? buttonAutofocus? buttonBlurAction? buttonClickAction? buttonDescription? buttonDisabled? buttonElementName? buttonElementType? buttonElementValue? buttonFocusAction? buttonForm? buttonFormAction? buttonFormEnctype? buttonFormMethod? buttonFormNoValidate? buttonFormTarget? buttonName? buttonPopoverTarget? buttonPopoverTargetAction? calculateOrder? checkDeltaConstraints? checkHit? checkHitIgnoreTransparency? clearFilters? clickAnchor? clickButton? clone constantSpeedAlongPath? copyDimensions? copyHeight? copyStart? copyStartX? copyStartY? copyWidth? delta? deltaConstraints? dimensions? dropArtefact? fillStyle? filter? filters? flipReverse? flipUpend? font? get globalAlpha? globalCompositeOperation? group? haltSprite handle? handleX? handleY? height? ignoreDragForX? ignoreDragForY? imageSmoothingEnabled? imageSmoothingQuality? imageSource? importPacket isStencil? kill lineCap? lineDash? lineDashOffset? lineJoin? lineWidth? lockFillStyleToEntity? lockStrokeStyleToEntity? lockTo? lockXTo? lockYTo? memoizeFilterOutput? method? mimic? miterLimit? name? noCanvasEngineUpdates? noDeltaUpdates? noFilters? noPathUpdates? noPositionDependencies? noUserInteraction? offset? offsetX? offsetY? onDown? onEnter? onLeave? onOtherInteraction? onUp? order? particle? path? pathPosition? performDeltaChecks? pickupArtefact? pivot? pivotCorner? pivotIndex? pivotPin? playSprite removeAssetOnKill? removeFilters? reverseByDelta roll? saveAsPacket scale? scaleOutline? scaleShadow? set setDelta setDeltaValues shadowBlur? shadowColor? shadowOffsetX? shadowOffsetY? sharedState? simpleStamp spriteForward? spriteFrameDuration? spriteSource? spriteTrack? spriteWillLoop? stampOrder? start? startX? startY? strokeStyle? updateByDelta useMimicDimensions? useMimicFlip? useMimicHandle? useMimicOffset? useMimicRotation? useMimicScale? useMimicStart? video_autoPlay? video_controller? video_controls? video_crossOrigin? video_currentTime? video_defaultMuted? video_defaultPlaybackRate? video_disableRemotePlayback? video_loop? video_mediaGroup? video_muted? video_playbackRate? video_src? video_srcObject? video_volume? videoAddTextTrack videoCanPlayType videoCaptureStream videoFastSeek videoLoad videoPause videoPlay videoSetMediaKeys videoSetSinkId videoSource? visibility? width? winding?

    Properties

    actionPacket: (item: string, override?: CommonObjectInput) => any
    addFilters?: (...items: (string | FilterInstance)[]) => EntityInstance
    addOwnDimensionsToMimic?: boolean
    addOwnHandleToMimic?: boolean
    addOwnOffsetToMimic?: boolean
    addOwnRotationToMimic?: boolean
    addOwnScaleToMimic?: boolean
    addOwnStartToMimic?: boolean
    addPathHandle?: boolean
    addPathOffset?: boolean
    addPathRotation?: boolean
    addPivotHandle?: boolean
    addPivotOffset?: boolean
    addPivotRotation?: boolean
    anchorBlurAction?: boolean
    anchorClickAction?: DefaultOutputFunction
    anchorDescription?: string
    anchorDownload?: string
    anchorFocusAction?: boolean
    anchorHref?: string
    anchorHreflang?: string
    anchorName?: string
    anchorPing?: string
    anchorReferrerPolicy?: string
    anchorRel?: string
    anchorTarget?: string
    anchorType?: string
    asset?: string | AssetInstance
    bringToFrontOnDrag?: boolean
    buttonAutofocus?: boolean
    buttonBlurAction?: boolean
    buttonClickAction?: DefaultOutputFunction
    buttonDescription?: string
    buttonDisabled?: boolean
    buttonElementName?: string
    buttonElementType?: string
    buttonElementValue?: string
    buttonFocusAction?: boolean
    buttonForm?: string
    buttonFormAction?: string
    buttonFormEnctype?: string
    buttonFormMethod?: string
    buttonFormNoValidate?: boolean
    buttonFormTarget?: string
    buttonName?: string
    buttonPopoverTarget?: string
    buttonPopoverTargetAction?: string
    calculateOrder?: number
    checkDeltaConstraints?: boolean
    checkHit?: (tests: HitTests) => boolean | HitOutput
    checkHitIgnoreTransparency?: boolean
    clearFilters?: () => EntityInstance
    clickAnchor?: () => void
    clickButton?: () => void
    constantSpeedAlongPath?: boolean
    copyHeight?: StringOrNumberInput
    copyStartX?: StringOrNumberInput
    copyStartY?: StringOrNumberInput
    deltaConstraints?: CommonObjectInput
    dropArtefact?: () => ArtefactInstance
    fillStyle?: string | StylesInstance
    filter?: string
    filters?: string | FilterInstance | (string | FilterInstance)[]
    flipReverse?: boolean
    flipUpend?: boolean
    font?: string
    get: (item: string) => any
    globalAlpha?: number
    globalCompositeOperation?: string
    group?: string | CellInstance | GroupInstance
    haltSprite: (
        speed?: number,
        loop?: boolean,
        track?: string,
        forward?: boolean,
        frame?: number,
    ) => void
    ignoreDragForX?: boolean
    ignoreDragForY?: boolean
    imageSmoothingEnabled?: boolean
    imageSmoothingQuality?: string
    imageSource?: string
    importPacket: (item: string | string[], override?: CommonObjectInput) => any
    isStencil?: boolean
    kill: (item?: any) => void
    lineCap?: LineCapValues
    lineDash?: number[]
    lineDashOffset?: number
    lineJoin?: LineJoinValues
    lineWidth?: number
    lockFillStyleToEntity?: boolean
    lockStrokeStyleToEntity?: boolean
    lockXTo?: LockToValues
    lockYTo?: LockToValues
    memoizeFilterOutput?: boolean
    method?: string
    mimic?: string | ArtefactInstance
    miterLimit?: number
    name?: string
    noCanvasEngineUpdates?: boolean
    noDeltaUpdates?: boolean
    noFilters?: boolean
    noPathUpdates?: boolean
    noPositionDependencies?: boolean
    noUserInteraction?: boolean
    onOtherInteraction?: OnCascadeFunction
    order?: number
    particle?: string | ParticleInstance
    path?: string | ShapeBasedInstance
    pathPosition?: number
    performDeltaChecks?: boolean
    pickupArtefact?: (
        items: CommonHereObjectInput | CommonTwoElementArrayInput,
    ) => ArtefactInstance
    pivot?: string | ArtefactInstance
    pivotCorner?: PivotCornerValues
    pivotIndex?: number
    pivotPin?: number
    playSprite: (
        speed?: number,
        loop?: boolean,
        track?: string,
        forward?: boolean,
        frame?: number,
    ) => void
    removeAssetOnKill?: string | boolean
    removeFilters?: (...items: (string | FilterInstance)[]) => EntityInstance
    reverseByDelta: () => ArtefactInstance
    roll?: number
    saveAsPacket: (item?: boolean | PictureSaveInputs) => string
    scale?: number
    scaleOutline?: boolean
    scaleShadow?: boolean
    setDeltaValues: (item?: CommonObjectInput) => ArtefactInstance
    shadowBlur?: number
    shadowColor?: string
    shadowOffsetX?: number
    shadowOffsetY?: number
    sharedState?: boolean
    simpleStamp: (host: CellInstance, items?: PictureFactoryInputs) => void
    spriteForward?: boolean
    spriteFrameDuration?: number
    spriteSource?: string
    spriteTrack?: string
    spriteWillLoop?: boolean
    stampOrder?: number
    strokeStyle?: string | StylesInstance
    updateByDelta: () => ArtefactInstance
    useMimicDimensions?: boolean
    useMimicFlip?: boolean
    useMimicHandle?: boolean
    useMimicOffset?: boolean
    useMimicRotation?: boolean
    useMimicScale?: boolean
    useMimicStart?: boolean
    video_autoPlay?: boolean
    video_controller?: any
    video_controls?: any
    video_crossOrigin?: any
    video_currentTime?: any
    video_defaultMuted?: any
    video_defaultPlaybackRate?: any
    video_disableRemotePlayback?: any
    video_loop?: boolean
    video_mediaGroup?: any
    video_muted?: boolean
    video_playbackRate?: any
    video_src?: any
    video_srcObject?: any
    video_volume?: any
    videoAddTextTrack: (kind: any, label: any, language: any) => any
    videoCanPlayType: (item: string) => boolean
    videoCaptureStream: () => any
    videoFastSeek: (item: number) => any
    videoLoad: () => any
    videoPause: () => any
    videoPlay: () => any
    videoSetMediaKeys: () => any
    videoSetSinkId: () => any
    videoSource?: string
    visibility?: boolean
    winding?: WindingValues