Scrawl-canvas API
    Preparing search index...

    Interface EmitterFactoryInputs

    interface EmitterFactoryInputs {
        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;
        artefact?: string | ArtefactInstance;
        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;
        constantSpeedAlongPath?: boolean;
        delta?: EmitterFactoryDeltaInputs;
        deltaConstraints?: CommonObjectInput;
        dimensions?: CommonTwoElementArrayInput;
        engine?: ParticleEngines;
        fillColor?: string;
        fillMaximumColor?: string;
        fillMinimumColor?: string;
        fillStyle?: string | StylesInstance;
        filter?: string;
        filters?: string | FilterInstance | (string | FilterInstance)[];
        flipReverse?: boolean;
        flipUpend?: boolean;
        font?: string;
        forces?: (string | ForceInstance)[];
        generateAlongPath?: string | ShapeBasedInstance;
        generateFromExistingParticleHistories?: boolean;
        generateFromExistingParticles?: boolean;
        generateInArea?: string | EntityInstance;
        generationChoke?: number;
        generationRate?: number;
        globalAlpha?: number;
        globalCompositeOperation?: string;
        group?: string | CellInstance | GroupInstance;
        handle?: CommonTwoElementArrayInput;
        handleX?: StringOrNumberInput;
        handleY?: StringOrNumberInput;
        height?: number;
        historyLength?: number;
        hitRadius?: number;
        hitRadiusColor?: string;
        ignoreDragForX?: boolean;
        ignoreDragForY?: boolean;
        imageSmoothingEnabled?: boolean;
        imageSmoothingQuality?: string;
        isStencil?: boolean;
        killAfterTime?: number;
        killAfterTimeVariation?: number;
        killBeyondCanvas?: boolean;
        killRadius?: number;
        killRadiusVariation?: number;
        limitDirectionToAngleMultiples?: number;
        lineCap?: LineCapValues;
        lineDash?: number[];
        lineDashOffset?: number;
        lineJoin?: LineJoinValues;
        lineWidth?: number;
        lockFillStyleToEntity?: boolean;
        lockStrokeStyleToEntity?: boolean;
        lockTo?: LockToValues | [LockToValues, LockToValues];
        lockXTo?: LockToValues;
        lockYTo?: LockToValues;
        mass?: number;
        massVariation?: number;
        memoizeFilterOutput?: boolean;
        method?: string;
        mimic?: string | ArtefactInstance;
        minimumVelocity?: VectorInstance;
        minimumVelocityX?: number;
        minimumVelocityY?: number;
        minimumVelocityZ?: number;
        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;
        particleCount?: number;
        path?: string | ShapeBasedInstance;
        pathPosition?: number;
        performDeltaChecks?: boolean;
        pivot?: string | ArtefactInstance;
        pivotCorner?: PivotCornerValues;
        pivotIndex?: number;
        pivotPin?: number;
        postAction?: (item: CellInstance) => void;
        preAction?: (item: CellInstance) => void;
        range?: VectorInstance;
        rangeFrom?: VectorInstance;
        rangeFromX?: number;
        rangeFromY?: number;
        rangeFromZ?: number;
        rangeX?: number;
        rangeY?: number;
        rangeZ?: number;
        resetAfterBlur?: number;
        roll?: number;
        scale?: number;
        scaleOutline?: boolean;
        scaleShadow?: boolean;
        shadowBlur?: number;
        shadowColor?: string;
        shadowOffsetX?: number;
        shadowOffsetY?: number;
        sharedState?: boolean;
        showHitRadius?: boolean;
        stampAction?: (
            artefact: EntityInstance,
            particle: ParticleInstance,
            host: CellInstance,
        ) => void;
        stampFirst?: EmitterStampFirstValues;
        stampOrder?: number;
        start?: CommonTwoElementArrayInput;
        startX?: StringOrNumberInput;
        startY?: StringOrNumberInput;
        strokeColor?: string;
        strokeMaximumColor?: string;
        strokeMinimumColor?: string;
        strokeStyle?: string | StylesInstance;
        useMimicDimensions?: boolean;
        useMimicFlip?: boolean;
        useMimicHandle?: boolean;
        useMimicOffset?: boolean;
        useMimicRotation?: boolean;
        useMimicScale?: boolean;
        useMimicStart?: boolean;
        visibility?: boolean;
        width?: number;
        winding?: WindingValues;
        world?: string | WorldInstance;
    }

    Hierarchy (View Summary)

    Index

    Properties

    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? artefact? bringToFrontOnDrag? button? buttonAutofocus? buttonBlurAction? buttonClickAction? buttonDescription? buttonDisabled? buttonElementName? buttonElementType? buttonElementValue? buttonFocusAction? buttonForm? buttonFormAction? buttonFormEnctype? buttonFormMethod? buttonFormNoValidate? buttonFormTarget? buttonName? buttonPopoverTarget? buttonPopoverTargetAction? calculateOrder? checkDeltaConstraints? constantSpeedAlongPath? delta? deltaConstraints? dimensions? engine? fillColor? fillMaximumColor? fillMinimumColor? fillStyle? filter? filters? flipReverse? flipUpend? font? forces? generateAlongPath? generateFromExistingParticleHistories? generateFromExistingParticles? generateInArea? generationChoke? generationRate? globalAlpha? globalCompositeOperation? group? handle? handleX? handleY? height? historyLength? hitRadius? hitRadiusColor? ignoreDragForX? ignoreDragForY? imageSmoothingEnabled? imageSmoothingQuality? isStencil? killAfterTime? killAfterTimeVariation? killBeyondCanvas? killRadius? killRadiusVariation? limitDirectionToAngleMultiples? lineCap? lineDash? lineDashOffset? lineJoin? lineWidth? lockFillStyleToEntity? lockStrokeStyleToEntity? lockTo? lockXTo? lockYTo? mass? massVariation? memoizeFilterOutput? method? mimic? minimumVelocity? minimumVelocityX? minimumVelocityY? minimumVelocityZ? miterLimit? name? noCanvasEngineUpdates? noDeltaUpdates? noFilters? noPathUpdates? noPositionDependencies? noUserInteraction? offset? offsetX? offsetY? onDown? onEnter? onLeave? onOtherInteraction? onUp? order? particle? particleCount? path? pathPosition? performDeltaChecks? pivot? pivotCorner? pivotIndex? pivotPin? postAction? preAction? range? rangeFrom? rangeFromX? rangeFromY? rangeFromZ? rangeX? rangeY? rangeZ? resetAfterBlur? roll? scale? scaleOutline? scaleShadow? shadowBlur? shadowColor? shadowOffsetX? shadowOffsetY? sharedState? showHitRadius? stampAction? stampFirst? stampOrder? start? startX? startY? strokeColor? strokeMaximumColor? strokeMinimumColor? strokeStyle? useMimicDimensions? useMimicFlip? useMimicHandle? useMimicOffset? useMimicRotation? useMimicScale? useMimicStart? visibility? width? winding? world?

    Properties

    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
    artefact?: string | ArtefactInstance
    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
    constantSpeedAlongPath?: boolean
    deltaConstraints?: CommonObjectInput
    fillColor?: string
    fillMaximumColor?: string
    fillMinimumColor?: string
    fillStyle?: string | StylesInstance
    filter?: string
    filters?: string | FilterInstance | (string | FilterInstance)[]
    flipReverse?: boolean
    flipUpend?: boolean
    font?: string
    forces?: (string | ForceInstance)[]
    generateAlongPath?: string | ShapeBasedInstance
    generateFromExistingParticleHistories?: boolean
    generateFromExistingParticles?: boolean
    generateInArea?: string | EntityInstance
    generationChoke?: number
    generationRate?: number
    globalAlpha?: number
    globalCompositeOperation?: string
    group?: string | CellInstance | GroupInstance
    height?: number
    historyLength?: number
    hitRadius?: number
    hitRadiusColor?: string
    ignoreDragForX?: boolean
    ignoreDragForY?: boolean
    imageSmoothingEnabled?: boolean
    imageSmoothingQuality?: string
    isStencil?: boolean
    killAfterTime?: number
    killAfterTimeVariation?: number
    killBeyondCanvas?: boolean
    killRadius?: number
    killRadiusVariation?: number
    limitDirectionToAngleMultiples?: number
    lineCap?: LineCapValues
    lineDash?: number[]
    lineDashOffset?: number
    lineJoin?: LineJoinValues
    lineWidth?: number
    lockFillStyleToEntity?: boolean
    lockStrokeStyleToEntity?: boolean
    lockXTo?: LockToValues
    lockYTo?: LockToValues
    mass?: number
    massVariation?: number
    memoizeFilterOutput?: boolean
    method?: string
    mimic?: string | ArtefactInstance
    minimumVelocity?: VectorInstance
    minimumVelocityX?: number
    minimumVelocityY?: number
    minimumVelocityZ?: number
    miterLimit?: number
    name?: string
    noCanvasEngineUpdates?: boolean
    noDeltaUpdates?: boolean
    noFilters?: boolean
    noPathUpdates?: boolean
    noPositionDependencies?: boolean
    noUserInteraction?: boolean
    onOtherInteraction?: OnCascadeFunction
    order?: number
    particle?: string | ParticleInstance
    particleCount?: number
    path?: string | ShapeBasedInstance
    pathPosition?: number
    performDeltaChecks?: boolean
    pivot?: string | ArtefactInstance
    pivotCorner?: PivotCornerValues
    pivotIndex?: number
    pivotPin?: number
    postAction?: (item: CellInstance) => void
    preAction?: (item: CellInstance) => void
    rangeFrom?: VectorInstance
    rangeFromX?: number
    rangeFromY?: number
    rangeFromZ?: number
    rangeX?: number
    rangeY?: number
    rangeZ?: number
    resetAfterBlur?: number
    roll?: number
    scale?: number
    scaleOutline?: boolean
    scaleShadow?: boolean
    shadowBlur?: number
    shadowColor?: string
    shadowOffsetX?: number
    shadowOffsetY?: number
    sharedState?: boolean
    showHitRadius?: boolean
    stampAction?: (
        artefact: EntityInstance,
        particle: ParticleInstance,
        host: CellInstance,
    ) => void
    stampOrder?: number
    strokeColor?: string
    strokeMaximumColor?: string
    strokeMinimumColor?: string
    strokeStyle?: string | StylesInstance
    useMimicDimensions?: boolean
    useMimicFlip?: boolean
    useMimicHandle?: boolean
    useMimicOffset?: boolean
    useMimicRotation?: boolean
    useMimicScale?: boolean
    useMimicStart?: boolean
    visibility?: boolean
    width?: number
    winding?: WindingValues
    world?: string | WorldInstance