Class DocItem

DocItem is a subclass of Item which provides additional helper functions for managing a Document (Items of Category DOC in a Matrix Instance).

Hierarchy

Constructors

constructor

Properties

toBeIntegrated

Methods

addDocumentOptions addDownlink addMandatoryFields addSection addUplink createTodo expandFieldMaskWithEmptyField exportTo extractData getCategory getCreationDate getDHFFieldInnerNames getDHFFields getDHFFieldsByInnerName getDocFieldHandlerClassName getDownlinks getFieldById getFieldByName getFieldMask getFieldsByType getHistory getId getInnerDHFFields getLabels getMaxVersion getNextDHFFieldName getSingleFieldByName getTitle getTodos getType getUplinks hasAllFields hasDownlink hasFieldId hasUplink insertSection isFolder isHiddenDHFField needsSave removeDownlink removeSection removeUplink setCreationDate setDownlinks setLabel setLabels setTitle setUplinks toDOCx toDocItem toHTML toPDF unsetLabel

Constructors

constructor

Properties

Protected toBeIntegrated

toBeIntegrated: IItemGet = {}

Methods

Private addDocumentOptions

addDownlink

  • addDownlink(id, title?): Item

  • Add a new downlink to the item. Does nothing if the item is already represented

    Parameters

    • id: string

      the id of the item to add.

    • Optional title: string

      optional. The title is just for convenience. It is neither saved nor representative of the actual title of the item.

    Returns Item

    the Item

    Throws

    Error if the passed id matches the id of the current item.

Private addMandatoryFields

addSection

addUplink

  • addUplink(id, title?): Item

  • Add a new uplink to the item. Does nothing if the item is already represented

    Parameters

    • id: string

      the id of the item to add.

    • Optional title: string

      optional. The title is just for convenience. It is neither saved nor representative of the actual title of the item.

    Returns Item

    the Item

    Throws

    Error if the passed id matches the id of the current item.

createTodo

  • createTodo(users, type, text, atDate): Promise<string>

  • Create a Todo attached to this item.

    Parameters

    • users: string[]

      an array of user names

    • type: TodoTypes
    • text: string
    • atDate: Date

    Returns Promise<string>

    A comma-separated list of Todo ids (integers), relative to the Item.

expandFieldMaskWithEmptyField

  • expandFieldMaskWithEmptyField(fieldId): undefined | Field

  • Sometimes you've been given an Item with a restrictive ItemFieldMask, however, you'd like to set a value for a field that was not in the mask. With this method, you can expand the field mask to include the field given by the fieldId (easily obtained from the Category object).

    This field will be added to the mask, and the associated Field object will be returned with an empty value, which you could set. The object will be marked as "dirty" at this point, because we don't know if the server has an empty value for this field or not, so we assume the pessimistic case.

    Parameters

    • fieldId: number

      a valid fieldId from the Category of the item.

    Returns undefined | Field

    the Field object

    Throws

    if the fieldId is already in the ItemFieldMask, or if the fieldId is not valid for the Category.

Private exportTo

  • exportTo(type, progressReporter?): Promise<string>

  • Parameters

    • type: "html" | "docx" | "pdf"
    • Optional progressReporter: ((jobId, jobDetails) => void)
        • (jobId, jobDetails): void

        • Parameters

          Returns void

    Returns Promise<string>

extractData

getCategory

getCreationDate

getDHFFieldInnerNames

  • getDHFFieldInnerNames(): string[]

  • It's helpful to see the names of DHF fields that would show up in the UI for the DOC. Then fields can be retrieved by these names.

    Returns string[]

    A list of DOC UI field names (not "dhf01" but "Signatures", for example).

getDHFFields

  • getDHFFields(): Field[]

  • Get the list of DHF fields. This list only includes actual DHF fields, not the "hidden" ones.

    Returns Field[]

    DHF fields sorted by name (dhf00, dhf01, etc).

getDHFFieldsByInnerName

  • getDHFFieldsByInnerName(name): Field[]

  • Retrieve an array of DOC DHF fields with the given UI name.

    Parameters

    • name: string

    Returns Field[]

    An array of Field objects from the Item.

getDocFieldHandlerClassName

  • getDocFieldHandlerClassName(handler): string

  • This method helps you know the most appropriate FieldHandler class to use to manipulate the doc field.

    Parameters

    • handler: IDocFieldHandler

    Returns string

    the name of the handler class.

getDownlinks

getFieldById

getFieldByName

  • getFieldByName(fieldName): Field[]

  • Returns all fields within the mask which match the fieldName.

    Parameters

    • fieldName: string

    Returns Field[]

    an array of Fields. Note that if the mask has limited the set of fields from the Category which are tracked for this particular item, the number of returned Field objects may be less than you expect.

getFieldMask

  • getFieldMask(): ItemFieldMask

  • Gets the ItemFieldMask which specifies which fields are loaded

    Returns ItemFieldMask

    on ItemFieldMask object

getFieldsByType

  • getFieldsByType(fieldType): Field[]

  • Returns all fields within the mask which match the fieldType.

    Parameters

    • fieldType: string

    Returns Field[]

    an array of Fields. Note that if the mask has limited the set of fields from the Category which are tracked for this particular item, the number of returned Field objects may be less than you expect.

getHistory

getId

  • getId(): string

  • Get the unique Id of the Item within the Project.

    Returns string

    a string value containing the Item Id.

getInnerDHFFields

  • getInnerDHFFields(): IDocFieldHandler[]

  • It is often convenient to work with the "inner field" of a dhf field, where the configuration and values lie.

    Returns IDocFieldHandler[]

    An array of IDocFieldHandlers[]. The length is the number of valid fields.

getLabels

getMaxVersion

  • getMaxVersion(): undefined | number

  • Read-only.

    Returns undefined | number

    The highest version reached for this item, or undefined if the item hasn't yet been saved on the server.

getNextDHFFieldName

getSingleFieldByName

  • getSingleFieldByName(fieldName): Field

  • Returns a Field matching the field name. The field should exist and be within the mask.

    Parameters

    • fieldName: string

    Returns Field

    a valid Field.

    Throws

    Error if there is no such field, either because the name is invalid or it is not within the mask for the Item.

getTitle

getTodos

  • getTodos(includeDone?, includeAllUsers?, includeFuture?): Promise<GetTodosAck>

  • Return the Todos associated with this item.

    Parameters

    • Optional includeDone: boolean

      if true, includes done todos

    • Optional includeAllUsers: boolean

      if true, includes all todos for all users.

    • Optional includeFuture: boolean

      false by default. If true, includes future todos.

    Returns Promise<GetTodosAck>

    Information on the Todos

getType

getUplinks

hasAllFields

  • hasAllFields(): boolean

  • An Item can be complete or partial, based on the ItemFieldMask passed in at construction.

    Returns boolean

    true if the item has all of its Category fields.

hasDownlink

  • hasDownlink(id): boolean

  • Check if there is a downlink to another item

    Parameters

    • id: string

    Returns boolean

    true if this item links to the item given by {id}

hasFieldId

  • hasFieldId(fieldId): boolean

  • In case the Item is masked (hasAllFields() returns false), one or more Fields may not be tracked. hasFieldId() allows you to check if the field is present.

    Parameters

    • fieldId: number

      a valid field id within the Category

    Returns boolean

    true if the Item's mask allows for this field.

    Throws

    Error if fieldId is not valid within the Category

hasUplink

  • hasUplink(id): boolean

  • Check if there is an uplink to another item

    Parameters

    • id: string

    Returns boolean

    true if this item links to the item given by {id}

insertSection

  • insertSection(number, sectionName, sectionType): DHFFieldHandler

  • insert a section at a given position

    Parameters

    • number: number

      Position of the section

    • sectionName: string

      Name of the section

    • sectionType: string

      Type of the section

    Returns DHFFieldHandler

    the DHFFieldHandler inserted.

isFolder

  • isFolder(): boolean

  • isFolder returns true if the Item is of Category FOLDER.

    Returns boolean

    true if a FOLDER, false otherwise

Private isHiddenDHFField

needsSave

  • needsSave(): boolean

  • needsSave() checks the Fields of the Category to which the Item belongs to see if they've been changed. If so it marks the Item as dirty.

    Returns boolean

    true if the Item has changes that should be propped to the server

removeDownlink

removeSection

  • removeSection(number): void

  • Remove a section at a given position

    Parameters

    • number: number

      The position of the element to remove.

    Returns void

    Throws

    Error if number is out of range.

removeUplink

setCreationDate

setDownlinks

setLabel

  • setLabel(labelToSet): Item

  • Adds one label to the item if it isn't already set. Note that if the label is in an XOR group with another set label, that label will be removed.

    Parameters

    • labelToSet: string

    Returns Item

    Item

    Throws

    throws error if the Item category doesn't allow labels

setLabels

  • setLabels(newLabels): Item

  • Sets the labels for an Item, overwriting any previous labels

    Parameters

    • newLabels: string[]

    Returns Item

    Item

    Throws

    throws error if the Item category doesn't allow labels

setTitle

setUplinks

toDOCx

  • toDOCx(progressReporter?): Promise<string>

  • Generate a docx document

    Parameters

    • Optional progressReporter: ((jobId, jobDetails) => void)
        • (jobId, jobDetails): void

        • Parameters

          Returns void

    Returns Promise<string>

    the URL of the generated document

toDocItem

toHTML

  • toHTML(progressReporter?): Promise<string>

  • Generate a html document

    Parameters

    • Optional progressReporter: ((jobId, jobDetails) => void)
        • (jobId, jobDetails): void

        • Parameters

          Returns void

    Returns Promise<string>

    the URL of the generated document

toPDF

  • toPDF(progressReporter?): Promise<string>

  • Generate a pdf document

    Parameters

    • Optional progressReporter: ((jobId, jobDetails) => void)
        • (jobId, jobDetails): void

        • Parameters

          Returns void

    Returns Promise<string>

    the URL of the generated document

unsetLabel

  • unsetLabel(labelToUnset): Item

  • Unsets one label if it exists.

    Parameters

    • labelToUnset: string

    Returns Item

    Item

    Throws

    throws error if the Item category doesn't allow labels

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc