Scrawl-canvas API
    Preparing search index...

    Interface ElementInstance

    interface ElementInstance {
        actionPacket: (item: string, override?: CommonObjectInput) => any;
        activePadding?: number;
        addCanvas: (items?: CanvasFactoryInputs) => CanvasInstance;
        addClasses: (item: string) => void;
        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;
        apply: () => void;
        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;
        checkForResize?: boolean;
        checkHit?: (tests: HitTests) => boolean | HitOutput;
        classes?: string;
        clickAnchor?: () => void;
        clickButton?: () => void;
        clone: (item?: ElementFactoryInputs) => ElementInstance;
        colorSchemeDarkAction?: DefaultInputFunction;
        colorSchemeLightAction?: DefaultInputFunction;
        constantSpeedAlongPath?: boolean;
        content?: string;
        css?: CommonObjectInput;
        delta?: ElementFactoryDeltaInputs;
        deltaConstraints?: CommonObjectInput;
        dimensions?: CommonTwoElementArrayInput;
        domElement: HTMLElement;
        dropArtefact?: () => ArtefactInstance;
        elementComputedStyles?: CommonObjectInput;
        get: (item: string) => any;
        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;
        includeInTabNavigation?: boolean;
        kill: (item?: any) => void;
        lockTo?: LockToValues | [LockToValues, LockToValues];
        lockXTo?: LockToValues;
        lockYTo?: LockToValues;
        mimic?: string | ArtefactInstance;
        moreContrastAction?: DefaultInputFunction;
        name?: string;
        noCanvasEngineUpdates?: boolean;
        noDeltaUpdates?: boolean;
        noFilters?: boolean;
        noPathUpdates?: boolean;
        noPositionDependencies?: boolean;
        noPreferenceDataAction?: DefaultInputFunction;
        noPreferenceMotionAction?: DefaultInputFunction;
        noPreferenceTransparencyAction?: DefaultInputFunction;
        noUserInteraction?: boolean;
        offset?: CommonTwoElementArrayInput;
        offsetX?: StringOrNumberInput;
        offsetY?: StringOrNumberInput;
        offsetZ?: number;
        order?: number;
        otherContrastAction?: DefaultInputFunction;
        particle?: string | ParticleInstance;
        path?: string | ShapeBasedInstance;
        pathPosition?: number;
        performDeltaChecks?: boolean;
        pickupArtefact?: (
            items: CommonHereObjectInput | CommonTwoElementArrayInput,
        ) => ArtefactInstance;
        pitch?: number;
        pivot?: string | ArtefactInstance;
        pivotCorner?: PivotCornerValues;
        pivotIndex?: number;
        pivotPin?: number;
        position?: string;
        reduceDataAction?: DefaultInputFunction;
        reduceMotionAction?: DefaultInputFunction;
        reduceTransparencyAction?: DefaultInputFunction;
        removeClasses: (item: string) => void;
        reverseByDelta: () => ArtefactInstance;
        roll?: number;
        saveAsPacket: (item?: boolean | ElementSaveInputs) => string;
        scale?: number;
        set: (item?: ElementFactoryInputs) => ElementInstance;
        setColorSchemeDarkAction: DefaultInputFunction;
        setColorSchemeLightAction: DefaultInputFunction;
        setDelta: (item?: ElementFactoryDeltaInputs) => ElementInstance;
        setDeltaValues: (item?: CommonObjectInput) => ArtefactInstance;
        setMoreContrastAction: DefaultInputFunction;
        setNoPreferenceDataAction: DefaultInputFunction;
        setNoPreferenceMotionAction: DefaultInputFunction;
        setNoPreferenceTransparencyAction: DefaultInputFunction;
        setOtherContrastAction: DefaultInputFunction;
        setReduceDataAction: DefaultInputFunction;
        setReduceMotionAction: DefaultInputFunction;
        setReduceTransparencyAction: DefaultInputFunction;
        stampOrder?: number;
        start?: CommonTwoElementArrayInput;
        startX?: StringOrNumberInput;
        startY?: StringOrNumberInput;
        text?: string;
        trackHere?: string;
        updateByDelta: () => ArtefactInstance;
        useMimicDimensions?: boolean;
        useMimicFlip?: boolean;
        useMimicHandle?: boolean;
        useMimicOffset?: boolean;
        useMimicRotation?: boolean;
        useMimicScale?: boolean;
        useMimicStart?: boolean;
        visibility?: boolean;
        width?: StringOrNumberInput;
        yaw?: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    actionPacket activePadding? addCanvas addClasses 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? apply bringToFrontOnDrag? button? buttonAutofocus? buttonBlurAction? buttonClickAction? buttonDescription? buttonDisabled? buttonElementName? buttonElementType? buttonElementValue? buttonFocusAction? buttonForm? buttonFormAction? buttonFormEnctype? buttonFormMethod? buttonFormNoValidate? buttonFormTarget? buttonName? buttonPopoverTarget? buttonPopoverTargetAction? calculateOrder? checkDeltaConstraints? checkForResize? checkHit? classes? clickAnchor? clickButton? clone colorSchemeDarkAction? colorSchemeLightAction? constantSpeedAlongPath? content? css? delta? deltaConstraints? dimensions? domElement dropArtefact? elementComputedStyles? get group? handle? handleX? handleY? height? here? ignoreDragForX? ignoreDragForY? importPacket includeInTabNavigation? kill lockTo? lockXTo? lockYTo? mimic? moreContrastAction? name? noCanvasEngineUpdates? noDeltaUpdates? noFilters? noPathUpdates? noPositionDependencies? noPreferenceDataAction? noPreferenceMotionAction? noPreferenceTransparencyAction? noUserInteraction? offset? offsetX? offsetY? offsetZ? order? otherContrastAction? particle? path? pathPosition? performDeltaChecks? pickupArtefact? pitch? pivot? pivotCorner? pivotIndex? pivotPin? position? reduceDataAction? reduceMotionAction? reduceTransparencyAction? removeClasses reverseByDelta roll? saveAsPacket scale? set setColorSchemeDarkAction setColorSchemeLightAction setDelta setDeltaValues setMoreContrastAction setNoPreferenceDataAction setNoPreferenceMotionAction setNoPreferenceTransparencyAction setOtherContrastAction setReduceDataAction setReduceMotionAction setReduceTransparencyAction stampOrder? start? startX? startY? text? trackHere? updateByDelta useMimicDimensions? useMimicFlip? useMimicHandle? useMimicOffset? useMimicRotation? useMimicScale? useMimicStart? visibility? width? yaw?

    Properties

    actionPacket: (item: string, override?: CommonObjectInput) => any
    activePadding?: number
    addCanvas: (items?: CanvasFactoryInputs) => CanvasInstance
    addClasses: (item: string) => void
    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
    apply: () => void
    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
    checkForResize?: boolean
    checkHit?: (tests: HitTests) => boolean | HitOutput
    classes?: string
    clickAnchor?: () => void
    clickButton?: () => void
    colorSchemeDarkAction?: DefaultInputFunction
    colorSchemeLightAction?: DefaultInputFunction
    constantSpeedAlongPath?: boolean
    content?: string
    deltaConstraints?: CommonObjectInput
    domElement: HTMLElement
    dropArtefact?: () => ArtefactInstance
    elementComputedStyles?: CommonObjectInput
    get: (item: string) => any
    group?: string | CellInstance | GroupInstance
    ignoreDragForX?: boolean
    ignoreDragForY?: boolean
    importPacket: (item: string | string[], override?: CommonObjectInput) => any
    includeInTabNavigation?: boolean
    kill: (item?: any) => void
    lockXTo?: LockToValues
    lockYTo?: LockToValues
    mimic?: string | ArtefactInstance
    moreContrastAction?: DefaultInputFunction
    name?: string
    noCanvasEngineUpdates?: boolean
    noDeltaUpdates?: boolean
    noFilters?: boolean
    noPathUpdates?: boolean
    noPositionDependencies?: boolean
    noPreferenceDataAction?: DefaultInputFunction
    noPreferenceMotionAction?: DefaultInputFunction
    noPreferenceTransparencyAction?: DefaultInputFunction
    noUserInteraction?: boolean
    offsetZ?: number
    order?: number
    otherContrastAction?: DefaultInputFunction
    particle?: string | ParticleInstance
    path?: string | ShapeBasedInstance
    pathPosition?: number
    performDeltaChecks?: boolean
    pickupArtefact?: (
        items: CommonHereObjectInput | CommonTwoElementArrayInput,
    ) => ArtefactInstance
    pitch?: number
    pivot?: string | ArtefactInstance
    pivotCorner?: PivotCornerValues
    pivotIndex?: number
    pivotPin?: number
    position?: string
    reduceDataAction?: DefaultInputFunction
    reduceMotionAction?: DefaultInputFunction
    reduceTransparencyAction?: DefaultInputFunction
    removeClasses: (item: string) => void
    reverseByDelta: () => ArtefactInstance
    roll?: number
    saveAsPacket: (item?: boolean | ElementSaveInputs) => string
    scale?: number
    setColorSchemeDarkAction: DefaultInputFunction
    setColorSchemeLightAction: DefaultInputFunction
    setDeltaValues: (item?: CommonObjectInput) => ArtefactInstance
    setMoreContrastAction: DefaultInputFunction
    setNoPreferenceDataAction: DefaultInputFunction
    setNoPreferenceMotionAction: DefaultInputFunction
    setNoPreferenceTransparencyAction: DefaultInputFunction
    setOtherContrastAction: DefaultInputFunction
    setReduceDataAction: DefaultInputFunction
    setReduceMotionAction: DefaultInputFunction
    setReduceTransparencyAction: DefaultInputFunction
    stampOrder?: number
    text?: string
    trackHere?: string
    updateByDelta: () => ArtefactInstance
    useMimicDimensions?: boolean
    useMimicFlip?: boolean
    useMimicHandle?: boolean
    useMimicOffset?: boolean
    useMimicRotation?: boolean
    useMimicScale?: boolean
    useMimicStart?: boolean
    visibility?: boolean
    yaw?: number