Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Presets

Hierarchy

  • Presets

Index

Constructors

Methods

Constructors

constructor

  • new Presets(socket: any): Presets

Methods

fieldList

  • fieldList(callback?: (error?: Error, list?: string[]) => void): Promise<string[]>

  • Retrieve a list of DICOM fields known by Dicoogle.

    This list is large and unlikely to change, so prefer keeping it in memory instead of querying it every time.

    Parameters

    • Optional callback: (error?: Error, list?: string[]) => void

      the callback function

        • (error?: Error, list?: string[]): void

        • Parameters

          • Optional error: Error
          • Optional list: string[]

          Returns void

    Returns Promise<string[]>

get

  • Obtain a list of export presets available to the user logged in.

    This operation requires the user to be authenticated.

    Parameters

    • Optional callback: (error?: Error, outcome?: ExportPreset[]) => void

      the callback function

        • Parameters

          Returns void

    Returns Promise<ExportPreset[]>

  • Obtain a list of export presets available to the given user by name.

    This operation requires the user to be authenticated. Permission to access the given user's presets is granted if the user logged in is an administrator or the same user.

    Parameters

    • username: string

      the username identifier

    • Optional callback: (error?: Error, outcome?: ExportPreset[]) => void

      the callback function

        • Parameters

          Returns void

    Returns Promise<ExportPreset[]>

save

  • save(username: string, name: string, fields: string[], callback?: (error?: Error) => void): Promise<void>

  • Save an export preset for the given user.

    This operation requires the user to be authenticated. Permission to save preset for the given user is granted if the user logged in is an administrator or the same user.

    Parameters

    • username: string

      the username identifier

    • name: string

      the unique name of the new preset

    • fields: string[]

      the list of DICOM attributes/tags in the preset

    • Optional callback: (error?: Error) => void

      the callback function

        • (error?: Error): void

        • Parameters

          • Optional error: Error

          Returns void

    Returns Promise<void>

Generated using TypeDoc