Scrawl-canvas API
    Preparing search index...

    Interface CellInstance

    interface CellInstance {
        actionPacket: (item: string, override?: CommonObjectInput) => any;
        addArtefactClasses: (item?: 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;
        alpha?: number;
        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;
        backgroundColor?: string;
        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;
        canvasColorSpace?: CanvasColorSpaceValues;
        checkDeltaConstraints?: boolean;
        checkForEntityHover?: boolean;
        checkHit?: (tests: HitTests) => boolean | HitOutput;
        clear: () => void;
        clearAlpha?: number;
        cleared?: boolean;
        clearFilters?: () => EntityInstance;
        clickAnchor?: () => void;
        clickButton?: () => void;
        compile: () => void;
        compiled?: boolean;
        compileOrder?: number;
        composite?: string;
        constantSpeedAlongPath?: boolean;
        delta?: CellFactoryDeltaInputs;
        deltaConstraints?: CommonObjectInput;
        dimensions?: CommonTwoElementArrayInput;
        dropArtefact?: () => ArtefactInstance;
        element: any;
        engine: any;
        filter?: string;
        filters?: string | FilterInstance | (string | FilterInstance)[];
        flipReverse?: boolean;
        flipUpend?: boolean;
        get: (item: string) => any;
        getAllArtefactsAt: (item: any) => any;
        getArtefactAt: (item: any) => any;
        getCellData: (
            args?: boolean | getCellDataObject,
        ) => EnhancedCellImageDataObject;
        group?: string | CellInstance | GroupInstance;
        handle?: CommonTwoElementArrayInput;
        handleX?: StringOrNumberInput;
        handleY?: StringOrNumberInput;
        height?: StringOrNumberInput;
        here: CommonHereObjectInput;
        ignoreDragForX?: boolean;
        ignoreDragForY?: boolean;
        importPacket: (
            item: string | string[],
            override?: CommonObjectInput,
        ) => any;
        includeInCascadeEventActions?: boolean;
        isStencil?: boolean;
        kill: (item?: any) => void;
        lockTo?: LockToValues | [LockToValues, LockToValues];
        lockXTo?: LockToValues;
        lockYTo?: LockToValues;
        memoizeFilterOutput?: boolean;
        mimic?: string | ArtefactInstance;
        name?: string;
        noCanvasEngineUpdates?: boolean;
        noDeltaUpdates?: boolean;
        noFilters?: boolean;
        noPathUpdates?: boolean;
        noPositionDependencies?: boolean;
        noUserInteraction?: boolean;
        offset?: CommonTwoElementArrayInput;
        offsetX?: StringOrNumberInput;
        offsetY?: StringOrNumberInput;
        onEntityHover?: DefaultInputFunction;
        onEntityNoHover?: DefaultInputFunction;
        order?: number;
        paintCellData: (item: EnhancedCellImageDataObject) => void;
        particle?: string | ParticleInstance;
        path?: string | ShapeBasedInstance;
        pathPosition?: number;
        patternShiftX?: number;
        patternShiftY?: number;
        patternSkewX?: number;
        patternSkewY?: number;
        patternStretchX?: number;
        patternStretchY?: number;
        performDeltaChecks?: boolean;
        pickupArtefact?: (
            items: CommonHereObjectInput | CommonTwoElementArrayInput,
        ) => ArtefactInstance;
        pivot?: string | ArtefactInstance;
        pivotCorner?: PivotCornerValues;
        pivotIndex?: number;
        pivotPin?: number;
        removeArtefactClasses: (item?: CommonObjectInput) => any;
        removeFilters?: (...items: (string | FilterInstance)[]) => EntityInstance;
        render: () => void;
        repeat?: PatternRepeatValues;
        reverseByDelta: () => ArtefactInstance;
        roll?: number;
        scale?: number;
        set: (item?: CellFactoryInputs) => CellInstance;
        setArtefacts: (item?: CommonObjectInput) => any;
        setDelta: (item?: CellFactoryDeltaInputs) => CellInstance;
        setDeltaValues: (item?: CommonObjectInput) => ArtefactInstance;
        setRelativeDimensionsUsingBase?: boolean;
        show: () => void;
        shown?: boolean;
        showOrder?: number;
        splitShift: (item: CellSplitShiftArguments) => void;
        stampOrder?: number;
        start?: CommonTwoElementArrayInput;
        startX?: StringOrNumberInput;
        startY?: StringOrNumberInput;
        stashHeight?: StringOrNumberInput;
        stashWidth?: StringOrNumberInput;
        stashX?: StringOrNumberInput;
        stashY?: StringOrNumberInput;
        updateArtefacts: (items: CommonObjectInput) => void;
        updateByDelta: () => ArtefactInstance;
        updateHere: () => void;
        useMimicDimensions?: boolean;
        useMimicFlip?: boolean;
        useMimicHandle?: boolean;
        useMimicOffset?: boolean;
        useMimicRotation?: boolean;
        useMimicScale?: boolean;
        useMimicStart?: boolean;
        visibility?: boolean;
        width?: StringOrNumberInput;
        willReadFrequently?: boolean;
    }

    Hierarchy (View Summary)

    Index

    Properties

    actionPacket addArtefactClasses addFilters? addOwnDimensionsToMimic? addOwnHandleToMimic? addOwnOffsetToMimic? addOwnRotationToMimic? addOwnScaleToMimic? addOwnStartToMimic? addPathHandle? addPathOffset? addPathRotation? addPivotHandle? addPivotOffset? addPivotRotation? alpha? anchor? anchorBlurAction? anchorClickAction? anchorDescription? anchorDownload? anchorFocusAction? anchorHref? anchorHreflang? anchorName? anchorPing? anchorReferrerPolicy? anchorRel? anchorTarget? anchorType? backgroundColor? bringToFrontOnDrag? button? buttonAutofocus? buttonBlurAction? buttonClickAction? buttonDescription? buttonDisabled? buttonElementName? buttonElementType? buttonElementValue? buttonFocusAction? buttonForm? buttonFormAction? buttonFormEnctype? buttonFormMethod? buttonFormNoValidate? buttonFormTarget? buttonName? buttonPopoverTarget? buttonPopoverTargetAction? calculateOrder? canvasColorSpace? checkDeltaConstraints? checkForEntityHover? checkHit? clear clearAlpha? cleared? clearFilters? clickAnchor? clickButton? compile compiled? compileOrder? composite? constantSpeedAlongPath? delta? deltaConstraints? dimensions? dropArtefact? element engine filter? filters? flipReverse? flipUpend? get getAllArtefactsAt getArtefactAt getCellData group? handle? handleX? handleY? height? here ignoreDragForX? ignoreDragForY? importPacket includeInCascadeEventActions? isStencil? kill lockTo? lockXTo? lockYTo? memoizeFilterOutput? mimic? name? noCanvasEngineUpdates? noDeltaUpdates? noFilters? noPathUpdates? noPositionDependencies? noUserInteraction? offset? offsetX? offsetY? onEntityHover? onEntityNoHover? order? paintCellData particle? path? pathPosition? patternShiftX? patternShiftY? patternSkewX? patternSkewY? patternStretchX? patternStretchY? performDeltaChecks? pickupArtefact? pivot? pivotCorner? pivotIndex? pivotPin? removeArtefactClasses removeFilters? render repeat? reverseByDelta roll? scale? set setArtefacts setDelta setDeltaValues setRelativeDimensionsUsingBase? show shown? showOrder? splitShift stampOrder? start? startX? startY? stashHeight? stashWidth? stashX? stashY? updateArtefacts updateByDelta updateHere useMimicDimensions? useMimicFlip? useMimicHandle? useMimicOffset? useMimicRotation? useMimicScale? useMimicStart? visibility? width? willReadFrequently?

    Properties

    actionPacket: (item: string, override?: CommonObjectInput) => any
    addArtefactClasses: (item?: 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
    alpha?: number
    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
    backgroundColor?: string
    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
    canvasColorSpace?: CanvasColorSpaceValues
    checkDeltaConstraints?: boolean
    checkForEntityHover?: boolean
    checkHit?: (tests: HitTests) => boolean | HitOutput
    clear: () => void
    clearAlpha?: number
    cleared?: boolean
    clearFilters?: () => EntityInstance
    clickAnchor?: () => void
    clickButton?: () => void
    compile: () => void
    compiled?: boolean
    compileOrder?: number
    composite?: string
    constantSpeedAlongPath?: boolean
    deltaConstraints?: CommonObjectInput
    dropArtefact?: () => ArtefactInstance
    element: any
    engine: any
    filter?: string
    filters?: string | FilterInstance | (string | FilterInstance)[]
    flipReverse?: boolean
    flipUpend?: boolean
    get: (item: string) => any
    getAllArtefactsAt: (item: any) => any
    getArtefactAt: (item: any) => any
    getCellData: (args?: boolean | getCellDataObject) => EnhancedCellImageDataObject
    group?: string | CellInstance | GroupInstance
    ignoreDragForX?: boolean
    ignoreDragForY?: boolean
    importPacket: (item: string | string[], override?: CommonObjectInput) => any
    includeInCascadeEventActions?: boolean
    isStencil?: boolean
    kill: (item?: any) => void
    lockXTo?: LockToValues
    lockYTo?: LockToValues
    memoizeFilterOutput?: boolean
    mimic?: string | ArtefactInstance
    name?: string
    noCanvasEngineUpdates?: boolean
    noDeltaUpdates?: boolean
    noFilters?: boolean
    noPathUpdates?: boolean
    noPositionDependencies?: boolean
    noUserInteraction?: boolean
    onEntityHover?: DefaultInputFunction
    onEntityNoHover?: DefaultInputFunction
    order?: number
    paintCellData: (item: EnhancedCellImageDataObject) => void
    particle?: string | ParticleInstance
    path?: string | ShapeBasedInstance
    pathPosition?: number
    patternShiftX?: number
    patternShiftY?: number
    patternSkewX?: number
    patternSkewY?: number
    patternStretchX?: number
    patternStretchY?: number
    performDeltaChecks?: boolean
    pickupArtefact?: (
        items: CommonHereObjectInput | CommonTwoElementArrayInput,
    ) => ArtefactInstance
    pivot?: string | ArtefactInstance
    pivotCorner?: PivotCornerValues
    pivotIndex?: number
    pivotPin?: number
    removeArtefactClasses: (item?: CommonObjectInput) => any
    removeFilters?: (...items: (string | FilterInstance)[]) => EntityInstance
    render: () => void
    reverseByDelta: () => ArtefactInstance
    roll?: number
    scale?: number
    setArtefacts: (item?: CommonObjectInput) => any
    setDelta: (item?: CellFactoryDeltaInputs) => CellInstance
    setDeltaValues: (item?: CommonObjectInput) => ArtefactInstance
    setRelativeDimensionsUsingBase?: boolean
    show: () => void
    shown?: boolean
    showOrder?: number
    splitShift: (item: CellSplitShiftArguments) => void
    stampOrder?: number
    stashHeight?: StringOrNumberInput
    stashWidth?: StringOrNumberInput
    updateArtefacts: (items: CommonObjectInput) => void
    updateByDelta: () => ArtefactInstance
    updateHere: () => void
    useMimicDimensions?: boolean
    useMimicFlip?: boolean
    useMimicHandle?: boolean
    useMimicOffset?: boolean
    useMimicRotation?: boolean
    useMimicScale?: boolean
    useMimicStart?: boolean
    visibility?: boolean
    willReadFrequently?: boolean