Scrawl-canvas API
    Preparing search index...

    Interface CanvasInstance

    interface CanvasInstance {
        actionBannerShape?: DefaultInputFunction;
        actionLandscapeShape?: DefaultInputFunction;
        actionLargerArea?: DefaultInputFunction;
        actionLargestArea?: DefaultInputFunction;
        actionPacket: (item: string, override?: CommonObjectInput) => any;
        actionPortraitShape?: DefaultInputFunction;
        actionRectangleShape?: DefaultInputFunction;
        actionRegularArea?: DefaultInputFunction;
        actionSkyscraperShape?: DefaultInputFunction;
        actionSmallerArea?: DefaultInputFunction;
        actionSmallestArea?: DefaultInputFunction;
        activePadding?: number;
        addCell: (item: string | CellInstance) => 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;
        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;
        apply: () => void;
        backgroundColor?: string;
        base: CellInstance;
        baseMatchesCanvasDimensions?: boolean;
        breakToBanner?: number;
        breakToLandscape?: number;
        breakToLarger?: number;
        breakToLargest?: number;
        breakToPortrait?: number;
        breakToSkyscraper?: number;
        breakToSmaller?: number;
        breakToSmallest?: number;
        bringToFrontOnDrag?: boolean;
        buildCell: (items: CellFactoryInputs) => CellInstance;
        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;
        cascadeEventAction?: CascadeFunction;
        checkDeltaConstraints?: boolean;
        checkForEntityHover?: boolean;
        checkForResize?: boolean;
        checkHit?: (tests: HitTests) => boolean | HitOutput;
        checkHover: () => void;
        classes?: string;
        clear: () => void;
        clickAnchor?: () => void;
        clickButton?: () => void;
        clone: (item?: CanvasFactoryInputs) => CanvasInstance;
        colorSchemeDarkAction?: DefaultInputFunction;
        colorSchemeLightAction?: DefaultInputFunction;
        compile: () => void;
        composite?: string;
        constantSpeedAlongPath?: boolean;
        css?: CommonObjectInput;
        delta?: CanvasFactoryDeltaInputs;
        deltaConstraints?: CommonObjectInput;
        deltaSetBase: (items: CellFactoryInputs) => CanvasInstance;
        description?: string;
        dimensions?: CommonTwoElementArrayInput;
        domElement: any;
        dropArtefact?: () => ArtefactInstance;
        elementComputedStyles?: CommonObjectInput;
        fit?: CanvasFitValues;
        get: (item: string) => any;
        getBase: () => CellInstance;
        getBaseHere: () => CommonHereObjectInput;
        group?: string | CellInstance | GroupInstance;
        handle?: CommonTwoElementArrayInput;
        handleX?: StringOrNumberInput;
        handleY?: StringOrNumberInput;
        height?: StringOrNumberInput;
        here: CommonHereObjectInput;
        ignoreCanvasCssDimensions?: boolean;
        ignoreDragForX?: boolean;
        ignoreDragForY?: boolean;
        importPacket: (
            item: string | string[],
            override?: CommonObjectInput,
        ) => any;
        includeInTabNavigation?: boolean;
        kill: (item?: any) => void;
        killCell: (item: string | CellInstance) => CanvasInstance;
        label?: string;
        lockTo?: LockToValues | [LockToValues, LockToValues];
        lockXTo?: LockToValues;
        lockYTo?: LockToValues;
        mimic?: string | ArtefactInstance;
        moreContrastAction?: DefaultInputFunction;
        name?: string;
        navigationAriaLive?: 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;
        onEntityHover?: DefaultInputFunction;
        onEntityNoHover?: DefaultInputFunction;
        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?: CanvasPositionValues;
        reduceDataAction?: DefaultInputFunction;
        reduceMotionAction?: DefaultInputFunction;
        reduceTransparencyAction?: DefaultInputFunction;
        removeCell: (item: string | CellInstance) => CanvasInstance;
        removeClasses: (item: string) => void;
        render: () => void;
        renderOnResize?: boolean;
        reset: () => void;
        reverseByDelta: () => ArtefactInstance;
        role?: string;
        roll?: number;
        saveAsPacket: (item?: boolean | CanvasSaveInputs) => string;
        scale?: number;
        set: (item?: CanvasFactoryInputs) => CanvasInstance;
        setActionBannerShape: (item?: DefaultInputFunction) => ArtefactInstance;
        setActionLandscapeShape: (item?: DefaultInputFunction) => ArtefactInstance;
        setActionLargerArea: (item?: DefaultInputFunction) => ArtefactInstance;
        setActionLargestArea: (item?: DefaultInputFunction) => ArtefactInstance;
        setActionPortraitShape: (item?: DefaultInputFunction) => ArtefactInstance;
        setActionRectangleShape: (item?: DefaultInputFunction) => ArtefactInstance;
        setActionRegularArea: (item?: DefaultInputFunction) => ArtefactInstance;
        setActionSkyscraperShape: (item?: DefaultInputFunction) => ArtefactInstance;
        setActionSmallerArea: (item?: DefaultInputFunction) => ArtefactInstance;
        setActionSmallestArea: (item?: DefaultInputFunction) => ArtefactInstance;
        setAsCurrentCanvas: () => CanvasInstance;
        setBase: (items: CellFactoryInputs) => CanvasInstance;
        setColorSchemeDarkAction: DefaultInputFunction;
        setColorSchemeLightAction: DefaultInputFunction;
        setDelta: (item?: CanvasFactoryDeltaInputs) => CanvasInstance;
        setDeltaValues: (item?: CommonObjectInput) => ArtefactInstance;
        setDisplayShapeBreakpoints: (item?: CommonObjectInput) => ArtefactInstance;
        setMoreContrastAction: DefaultInputFunction;
        setNoPreferenceDataAction: DefaultInputFunction;
        setNoPreferenceMotionAction: DefaultInputFunction;
        setNoPreferenceTransparencyAction: DefaultInputFunction;
        setOtherContrastAction: DefaultInputFunction;
        setReduceDataAction: DefaultInputFunction;
        setReduceMotionAction: DefaultInputFunction;
        setReduceTransparencyAction: DefaultInputFunction;
        show: () => void;
        simpleStamp: () => void;
        stampOrder?: number;
        start?: CommonTwoElementArrayInput;
        startX?: StringOrNumberInput;
        startY?: StringOrNumberInput;
        title?: string;
        trackHere?: string;
        updateByDelta: () => ArtefactInstance;
        updateDisplay: () => void;
        updateDisplayArea: () => void;
        updateDisplayShape: () => void;
        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

    actionBannerShape? actionLandscapeShape? actionLargerArea? actionLargestArea? actionPacket actionPortraitShape? actionRectangleShape? actionRegularArea? actionSkyscraperShape? actionSmallerArea? actionSmallestArea? activePadding? addCell addClasses 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? apply backgroundColor? base baseMatchesCanvasDimensions? breakToBanner? breakToLandscape? breakToLarger? breakToLargest? breakToPortrait? breakToSkyscraper? breakToSmaller? breakToSmallest? bringToFrontOnDrag? buildCell button? buttonAutofocus? buttonBlurAction? buttonClickAction? buttonDescription? buttonDisabled? buttonElementName? buttonElementType? buttonElementValue? buttonFocusAction? buttonForm? buttonFormAction? buttonFormEnctype? buttonFormMethod? buttonFormNoValidate? buttonFormTarget? buttonName? buttonPopoverTarget? buttonPopoverTargetAction? calculateOrder? canvasColorSpace? cascadeEventAction? checkDeltaConstraints? checkForEntityHover? checkForResize? checkHit? checkHover classes? clear clickAnchor? clickButton? clone colorSchemeDarkAction? colorSchemeLightAction? compile composite? constantSpeedAlongPath? css? delta? deltaConstraints? deltaSetBase description? dimensions? domElement dropArtefact? elementComputedStyles? fit? get getBase getBaseHere group? handle? handleX? handleY? height? here ignoreCanvasCssDimensions? ignoreDragForX? ignoreDragForY? importPacket includeInTabNavigation? kill killCell label? lockTo? lockXTo? lockYTo? mimic? moreContrastAction? name? navigationAriaLive? noCanvasEngineUpdates? noDeltaUpdates? noFilters? noPathUpdates? noPositionDependencies? noPreferenceDataAction? noPreferenceMotionAction? noPreferenceTransparencyAction? noUserInteraction? offset? offsetX? offsetY? offsetZ? onEntityHover? onEntityNoHover? order? otherContrastAction? particle? path? pathPosition? performDeltaChecks? pickupArtefact? pitch? pivot? pivotCorner? pivotIndex? pivotPin? position? reduceDataAction? reduceMotionAction? reduceTransparencyAction? removeCell removeClasses render renderOnResize? reset reverseByDelta role? roll? saveAsPacket scale? set setActionBannerShape setActionLandscapeShape setActionLargerArea setActionLargestArea setActionPortraitShape setActionRectangleShape setActionRegularArea setActionSkyscraperShape setActionSmallerArea setActionSmallestArea setAsCurrentCanvas setBase setColorSchemeDarkAction setColorSchemeLightAction setDelta setDeltaValues setDisplayShapeBreakpoints setMoreContrastAction setNoPreferenceDataAction setNoPreferenceMotionAction setNoPreferenceTransparencyAction setOtherContrastAction setReduceDataAction setReduceMotionAction setReduceTransparencyAction show simpleStamp stampOrder? start? startX? startY? title? trackHere? updateByDelta updateDisplay updateDisplayArea updateDisplayShape useMimicDimensions? useMimicFlip? useMimicHandle? useMimicOffset? useMimicRotation? useMimicScale? useMimicStart? visibility? width? yaw?

    Properties

    actionBannerShape?: DefaultInputFunction
    actionLandscapeShape?: DefaultInputFunction
    actionLargerArea?: DefaultInputFunction
    actionLargestArea?: DefaultInputFunction
    actionPacket: (item: string, override?: CommonObjectInput) => any
    actionPortraitShape?: DefaultInputFunction
    actionRectangleShape?: DefaultInputFunction
    actionRegularArea?: DefaultInputFunction
    actionSkyscraperShape?: DefaultInputFunction
    actionSmallerArea?: DefaultInputFunction
    actionSmallestArea?: DefaultInputFunction
    activePadding?: number
    addCell: (item: string | CellInstance) => 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
    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
    apply: () => void
    backgroundColor?: string
    baseMatchesCanvasDimensions?: boolean
    breakToBanner?: number
    breakToLandscape?: number
    breakToLarger?: number
    breakToLargest?: number
    breakToPortrait?: number
    breakToSkyscraper?: number
    breakToSmaller?: number
    breakToSmallest?: number
    bringToFrontOnDrag?: boolean
    buildCell: (items: CellFactoryInputs) => CellInstance
    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
    cascadeEventAction?: CascadeFunction
    checkDeltaConstraints?: boolean
    checkForEntityHover?: boolean
    checkForResize?: boolean
    checkHit?: (tests: HitTests) => boolean | HitOutput
    checkHover: () => void
    classes?: string
    clear: () => void
    clickAnchor?: () => void
    clickButton?: () => void
    colorSchemeDarkAction?: DefaultInputFunction
    colorSchemeLightAction?: DefaultInputFunction
    compile: () => void
    composite?: string
    constantSpeedAlongPath?: boolean
    deltaConstraints?: CommonObjectInput
    deltaSetBase: (items: CellFactoryInputs) => CanvasInstance
    description?: string
    domElement: any
    dropArtefact?: () => ArtefactInstance
    elementComputedStyles?: CommonObjectInput
    get: (item: string) => any
    getBase: () => CellInstance
    getBaseHere: () => CommonHereObjectInput
    group?: string | CellInstance | GroupInstance
    ignoreCanvasCssDimensions?: boolean
    ignoreDragForX?: boolean
    ignoreDragForY?: boolean
    importPacket: (item: string | string[], override?: CommonObjectInput) => any
    includeInTabNavigation?: boolean
    kill: (item?: any) => void
    killCell: (item: string | CellInstance) => CanvasInstance
    label?: string
    lockXTo?: LockToValues
    lockYTo?: LockToValues
    mimic?: string | ArtefactInstance
    moreContrastAction?: DefaultInputFunction
    name?: string
    navigationAriaLive?: string
    noCanvasEngineUpdates?: boolean
    noDeltaUpdates?: boolean
    noFilters?: boolean
    noPathUpdates?: boolean
    noPositionDependencies?: boolean
    noPreferenceDataAction?: DefaultInputFunction
    noPreferenceMotionAction?: DefaultInputFunction
    noPreferenceTransparencyAction?: DefaultInputFunction
    noUserInteraction?: boolean
    offsetZ?: number
    onEntityHover?: DefaultInputFunction
    onEntityNoHover?: DefaultInputFunction
    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
    reduceDataAction?: DefaultInputFunction
    reduceMotionAction?: DefaultInputFunction
    reduceTransparencyAction?: DefaultInputFunction
    removeCell: (item: string | CellInstance) => CanvasInstance
    removeClasses: (item: string) => void
    render: () => void
    renderOnResize?: boolean
    reset: () => void
    reverseByDelta: () => ArtefactInstance
    role?: string
    roll?: number
    saveAsPacket: (item?: boolean | CanvasSaveInputs) => string
    scale?: number
    setActionBannerShape: (item?: DefaultInputFunction) => ArtefactInstance
    setActionLandscapeShape: (item?: DefaultInputFunction) => ArtefactInstance
    setActionLargerArea: (item?: DefaultInputFunction) => ArtefactInstance
    setActionLargestArea: (item?: DefaultInputFunction) => ArtefactInstance
    setActionPortraitShape: (item?: DefaultInputFunction) => ArtefactInstance
    setActionRectangleShape: (item?: DefaultInputFunction) => ArtefactInstance
    setActionRegularArea: (item?: DefaultInputFunction) => ArtefactInstance
    setActionSkyscraperShape: (item?: DefaultInputFunction) => ArtefactInstance
    setActionSmallerArea: (item?: DefaultInputFunction) => ArtefactInstance
    setActionSmallestArea: (item?: DefaultInputFunction) => ArtefactInstance
    setAsCurrentCanvas: () => CanvasInstance
    setBase: (items: CellFactoryInputs) => CanvasInstance
    setColorSchemeDarkAction: DefaultInputFunction
    setColorSchemeLightAction: DefaultInputFunction
    setDeltaValues: (item?: CommonObjectInput) => ArtefactInstance
    setDisplayShapeBreakpoints: (item?: CommonObjectInput) => ArtefactInstance
    setMoreContrastAction: DefaultInputFunction
    setNoPreferenceDataAction: DefaultInputFunction
    setNoPreferenceMotionAction: DefaultInputFunction
    setNoPreferenceTransparencyAction: DefaultInputFunction
    setOtherContrastAction: DefaultInputFunction
    setReduceDataAction: DefaultInputFunction
    setReduceMotionAction: DefaultInputFunction
    setReduceTransparencyAction: DefaultInputFunction
    show: () => void
    simpleStamp: () => void
    stampOrder?: number
    title?: string
    trackHere?: string
    updateByDelta: () => ArtefactInstance
    updateDisplay: () => void
    updateDisplayArea: () => void
    updateDisplayShape: () => void
    useMimicDimensions?: boolean
    useMimicFlip?: boolean
    useMimicHandle?: boolean
    useMimicOffset?: boolean
    useMimicRotation?: boolean
    useMimicScale?: boolean
    useMimicStart?: boolean
    visibility?: boolean
    yaw?: number