Skip to main content

metaData

Index

MetaData

addProvider

  • addProvider(provider: (type: string, imageId: string) => { any: any }, priority?: number): void
  • Adds a metadata provider with the specified priority


    Parameters

    • provider: (type: string, imageId: string) => { any: any }

      Metadata provider function

    • priority: number = 0

      0 is default/normal, > 0 is high, < 0 is low

    Returns void

get

  • get(type: string, imageId: string): any
  • Gets metadata from the registered metadata providers. Will call each one from highest priority to lowest until one responds


    Parameters

    • type: string

      The type of metadata requested from the metadata store

    • imageId: string

      The Cornerstone Image Object’s imageId

    Returns any

    The metadata retrieved from the metadata store

removeAllProviders

  • removeAllProviders(): void
  • Removes all providers


    Returns void

removeProvider

  • removeProvider(provider: (type: string, imageId: string) => { any: any }): void
  • Removes the specified provider


    Parameters

    • provider: (type: string, imageId: string) => { any: any }

      Metadata provider function

    Returns void