Scrawl-canvas API
    Preparing search index...

    Interface GroupInstance

    interface GroupInstance {
        actionPacket: (item: string, override?: CommonObjectInput) => any;
        addArtefactClasses: (item: string) => GroupInstance;
        addArtefacts: (...args: GroupArtifactsInput) => GroupInstance;
        addFilters?: (...items: (string | FilterInstance)[]) => EntityInstance;
        addFiltersToEntitys: (...args: GroupFiltersInput) => GroupInstance;
        artefacts?: string[];
        checkForEntityHover?: boolean;
        clearArtefacts: () => GroupInstance;
        clearFilters?: () => EntityInstance;
        clearFiltersFromEntitys: () => GroupInstance;
        clone: (item?: GroupFactoryInputs) => GroupInstance;
        delta?: GroupFactoryDeltaInputs;
        filters?: string | FilterInstance | (string | FilterInstance)[];
        get: (item: string) => any;
        getAllArtefactsAt: (items: HitTests) => HitOutput[];
        getArtefact: (name: string) => ArtefactInstance;
        getArtefactAt: (items: HitTests) => boolean | HitOutput;
        getArtefactNames: () => string[];
        host?: GroupHosts;
        importPacket: (
            item: string | string[],
            override?: CommonObjectInput,
        ) => any;
        isStencil?: boolean;
        kill: (item?: any) => void;
        killArtefacts: () => void;
        memoizeFilterOutput?: boolean;
        moveArtefactsIntoGroup: (...args: GroupArtifactsInput) => GroupInstance;
        name?: string;
        noFilters?: boolean;
        onEntityHover?: DefaultInputFunction;
        onEntityNoHover?: DefaultInputFunction;
        order?: number;
        regionRadius?: number;
        removeArtefactClasses: (item: string) => GroupInstance;
        removeArtefacts: (...args: GroupArtifactsInput) => GroupInstance;
        removeFilters?: (...items: (string | FilterInstance)[]) => EntityInstance;
        removeFiltersFromEntitys: (...args: GroupFiltersInput) => GroupInstance;
        reverseByDelta: () => GroupInstance;
        saveAsPacket: (item?: boolean | GroupSaveInputs) => string;
        set: (item?: GroupFactoryInputs) => GroupInstance;
        setArtefacts: (items: CommonObjectInput) => GroupInstance;
        setDelta: (item?: CommonObjectInput) => GroupInstance;
        setDeltaValues: (item?: CommonObjectInput) => GroupInstance;
        sortArtefacts: () => void;
        stashOutput?: boolean;
        stashOutputAsAsset?: string | boolean;
        updateArtefacts: (items: CommonObjectInput) => GroupInstance;
        updateByDelta: () => GroupInstance;
        visibility?: boolean;
    }

    Hierarchy (View Summary)

    Index

    Properties

    actionPacket: (item: string, override?: CommonObjectInput) => any
    addArtefactClasses: (item: string) => GroupInstance
    addArtefacts: (...args: GroupArtifactsInput) => GroupInstance
    addFilters?: (...items: (string | FilterInstance)[]) => EntityInstance
    addFiltersToEntitys: (...args: GroupFiltersInput) => GroupInstance
    artefacts?: string[]
    checkForEntityHover?: boolean
    clearArtefacts: () => GroupInstance
    clearFilters?: () => EntityInstance
    clearFiltersFromEntitys: () => GroupInstance
    filters?: string | FilterInstance | (string | FilterInstance)[]
    get: (item: string) => any
    getAllArtefactsAt: (items: HitTests) => HitOutput[]
    getArtefact: (name: string) => ArtefactInstance
    getArtefactAt: (items: HitTests) => boolean | HitOutput
    getArtefactNames: () => string[]
    host?: GroupHosts
    importPacket: (item: string | string[], override?: CommonObjectInput) => any
    isStencil?: boolean
    kill: (item?: any) => void
    killArtefacts: () => void
    memoizeFilterOutput?: boolean
    moveArtefactsIntoGroup: (...args: GroupArtifactsInput) => GroupInstance
    name?: string
    noFilters?: boolean
    onEntityHover?: DefaultInputFunction
    onEntityNoHover?: DefaultInputFunction
    order?: number
    regionRadius?: number
    removeArtefactClasses: (item: string) => GroupInstance
    removeArtefacts: (...args: GroupArtifactsInput) => GroupInstance
    removeFilters?: (...items: (string | FilterInstance)[]) => EntityInstance
    removeFiltersFromEntitys: (...args: GroupFiltersInput) => GroupInstance
    reverseByDelta: () => GroupInstance
    saveAsPacket: (item?: boolean | GroupSaveInputs) => string
    setArtefacts: (items: CommonObjectInput) => GroupInstance
    setDelta: (item?: CommonObjectInput) => GroupInstance
    setDeltaValues: (item?: CommonObjectInput) => GroupInstance
    sortArtefacts: () => void
    stashOutput?: boolean
    stashOutputAsAsset?: string | boolean
    updateArtefacts: (items: CommonObjectInput) => GroupInstance
    updateByDelta: () => GroupInstance
    visibility?: boolean