RSX Code Reference
    Preparing search index...

    Class ResourceTypeMetaData

    The ResourceTypeMetaData class contains information for dynamic resource creation.

    Index
    constructor
    category description displayName fnOnConfigure? fnOnCreate helpURL icon isFavorite isProjectResource isVisible priority type variants
    isMatchingSearchQuery
    category: string

    The category of the resource.

    description: string

    The description of the resource.

    displayName: string

    The display name of the resource.

    fnOnConfigure?: (callback: (options: any) => void) => void

    Optional lambda called before the save dialog opens. Receives a continuation callback that must be invoked with the configured options to proceed. If the callback is not called (e.g. user cancels), the save dialog will not open. The options value passed to the callback will be forwarded to fnOnCreate as the options parameter.

    fnOnCreate: (
        libraryPath: LibraryPath,
        pathContainsName: boolean,
        options?: any,
    ) => Resource

    The lambda to create the resource. The options parameter contains the value passed by fnOnConfigure.

    helpURL: string

    The help URL.

    icon: Image

    The icon image.

    isFavorite: boolean

    Determines if this is a user favorite.

    isProjectResource: boolean

    Determines if the resource is created by user-code in the current project.

    isVisible: boolean

    Determines if the resource is visible in the UI.

    priority: number

    Resources will be sorted by priority. Higher priorities will come first.

    type: Type

    The type of the resource.

    variants: ResourceTypeMetaData[]

    An optional array containing variants.

    • Determines if the meta data matches the specified query.

      Parameters

      • query: string

      Returns boolean

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods