Scrawl-canvas API
    Preparing search index...

    Interface GridInstance

    interface GridInstance {
        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;
        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;
        clearFilters?: () => EntityInstance;
        clickAnchor?: () => void;
        clickButton?: () => void;
        clone: (item?: GridFactoryInputs) => GridInstance;
        columnGutterWidth?: number;
        columnIndex: (index: number) => number;
        columns?: number;
        constantSpeedAlongPath?: boolean;
        delta?: GridFactoryDeltaInputs;
        deltaConstraints?: CommonObjectInput;
        dimensions?: CommonTwoElementArrayInput;
        dropArtefact?: () => ArtefactInstance;
        fillColumn: (CommonObjectInput: any) => GridInstance;
        fillRect: (CommonObjectInput: any) => GridInstance;
        fillRow: (CommonObjectInput: any) => GridInstance;
        fillStyle?: string | StylesInstance;
        filter?: string;
        filters?: string | FilterInstance | (string | FilterInstance)[];
        flipReverse?: boolean;
        flipUpend?: boolean;
        font?: string;
        get: (item: string) => any;
        getTileSource: (row: number, col?: number) => number;
        getTilesUsingSource: (key: number) => number[];
        globalAlpha?: number;
        globalCompositeOperation?: string;
        group?: string | CellInstance | GroupInstance;
        gutterColor?: GridTileGutterColors;
        handle?: CommonTwoElementArrayInput;
        handleX?: StringOrNumberInput;
        handleY?: StringOrNumberInput;
        height?: StringOrNumberInput;
        ignoreDragForX?: boolean;
        ignoreDragForY?: boolean;
        imageSmoothingEnabled?: boolean;
        imageSmoothingQuality?: 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;
        positionIndices: (index: number) => [number, number] | [];
        removeFilters?: (...items: (string | FilterInstance)[]) => EntityInstance;
        removeTileSource: (index: number) => GridInstance;
        reverseByDelta: () => ArtefactInstance;
        roll?: number;
        rowGutterWidth?: number;
        rowIndex: (index: number) => number;
        rows?: number;
        saveAsPacket: (item?: boolean | GridSaveInputs) => string;
        scale?: number;
        scaleOutline?: boolean;
        scaleShadow?: boolean;
        set: (item?: GridFactoryInputs) => GridInstance;
        setAllTilesTo: (index: number) => GridInstance;
        setDelta: (item?: GridFactoryDeltaInputs) => GridInstance;
        setDeltaValues: (item?: CommonObjectInput) => ArtefactInstance;
        setTileFill: (item: number[]) => GridInstance;
        setTileSourceTo: (index: number, obj: GridTileObject) => GridInstance;
        setTilesTo: (tiles: number[], val: number) => GridInstance;
        shadowBlur?: number;
        shadowColor?: string;
        shadowOffsetX?: number;
        shadowOffsetY?: number;
        sharedState?: boolean;
        simpleStamp: (host: CellInstance, items?: GridFactoryInputs) => void;
        stampOrder?: number;
        start?: CommonTwoElementArrayInput;
        startX?: StringOrNumberInput;
        startY?: StringOrNumberInput;
        strokeStyle?: string | StylesInstance;
        tileFill?: number[];
        tileIndexFromPosition: (row: number, column: number) => number;
        tileSources?: GridTileObject[];
        updateByDelta: () => ArtefactInstance;
        useMimicDimensions?: boolean;
        useMimicFlip?: boolean;
        useMimicHandle?: boolean;
        useMimicOffset?: boolean;
        useMimicRotation?: boolean;
        useMimicScale?: boolean;
        useMimicStart?: boolean;
        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? bringToFrontOnDrag? button? buttonAutofocus? buttonBlurAction? buttonClickAction? buttonDescription? buttonDisabled? buttonElementName? buttonElementType? buttonElementValue? buttonFocusAction? buttonForm? buttonFormAction? buttonFormEnctype? buttonFormMethod? buttonFormNoValidate? buttonFormTarget? buttonName? buttonPopoverTarget? buttonPopoverTargetAction? calculateOrder? checkDeltaConstraints? checkHit? clearFilters? clickAnchor? clickButton? clone columnGutterWidth? columnIndex columns? constantSpeedAlongPath? delta? deltaConstraints? dimensions? dropArtefact? fillColumn fillRect fillRow fillStyle? filter? filters? flipReverse? flipUpend? font? get getTileSource getTilesUsingSource globalAlpha? globalCompositeOperation? group? gutterColor? handle? handleX? handleY? height? ignoreDragForX? ignoreDragForY? imageSmoothingEnabled? imageSmoothingQuality? 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? positionIndices removeFilters? removeTileSource reverseByDelta roll? rowGutterWidth? rowIndex rows? saveAsPacket scale? scaleOutline? scaleShadow? set setAllTilesTo setDelta setDeltaValues setTileFill setTileSourceTo setTilesTo shadowBlur? shadowColor? shadowOffsetX? shadowOffsetY? sharedState? simpleStamp stampOrder? start? startX? startY? strokeStyle? tileFill? tileIndexFromPosition tileSources? updateByDelta useMimicDimensions? useMimicFlip? useMimicHandle? useMimicOffset? useMimicRotation? useMimicScale? useMimicStart? 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
    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
    clearFilters?: () => EntityInstance
    clickAnchor?: () => void
    clickButton?: () => void
    clone: (item?: GridFactoryInputs) => GridInstance
    columnGutterWidth?: number
    columnIndex: (index: number) => number
    columns?: number
    constantSpeedAlongPath?: boolean
    deltaConstraints?: CommonObjectInput
    dropArtefact?: () => ArtefactInstance
    fillColumn: (CommonObjectInput: any) => GridInstance
    fillRect: (CommonObjectInput: any) => GridInstance
    fillRow: (CommonObjectInput: any) => GridInstance
    fillStyle?: string | StylesInstance
    filter?: string
    filters?: string | FilterInstance | (string | FilterInstance)[]
    flipReverse?: boolean
    flipUpend?: boolean
    font?: string
    get: (item: string) => any
    getTileSource: (row: number, col?: number) => number
    getTilesUsingSource: (key: number) => number[]
    globalAlpha?: number
    globalCompositeOperation?: string
    group?: string | CellInstance | GroupInstance
    gutterColor?: GridTileGutterColors
    ignoreDragForX?: boolean
    ignoreDragForY?: boolean
    imageSmoothingEnabled?: boolean
    imageSmoothingQuality?: 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
    positionIndices: (index: number) => [number, number] | []
    removeFilters?: (...items: (string | FilterInstance)[]) => EntityInstance
    removeTileSource: (index: number) => GridInstance
    reverseByDelta: () => ArtefactInstance
    roll?: number
    rowGutterWidth?: number
    rowIndex: (index: number) => number
    rows?: number
    saveAsPacket: (item?: boolean | GridSaveInputs) => string
    scale?: number
    scaleOutline?: boolean
    scaleShadow?: boolean
    setAllTilesTo: (index: number) => GridInstance
    setDelta: (item?: GridFactoryDeltaInputs) => GridInstance
    setDeltaValues: (item?: CommonObjectInput) => ArtefactInstance
    setTileFill: (item: number[]) => GridInstance
    setTileSourceTo: (index: number, obj: GridTileObject) => GridInstance
    setTilesTo: (tiles: number[], val: number) => GridInstance
    shadowBlur?: number
    shadowColor?: string
    shadowOffsetX?: number
    shadowOffsetY?: number
    sharedState?: boolean
    simpleStamp: (host: CellInstance, items?: GridFactoryInputs) => void
    stampOrder?: number
    strokeStyle?: string | StylesInstance
    tileFill?: number[]
    tileIndexFromPosition: (row: number, column: number) => number
    tileSources?: GridTileObject[]
    updateByDelta: () => ArtefactInstance
    useMimicDimensions?: boolean
    useMimicFlip?: boolean
    useMimicHandle?: boolean
    useMimicOffset?: boolean
    useMimicRotation?: boolean
    useMimicScale?: boolean
    useMimicStart?: boolean
    visibility?: boolean
    winding?: WindingValues