Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Inputs

XML API Inputs

Hierarchy

  • Inputs

Index

Constructors

Methods

Constructors

constructor

Methods

Static extractInputsFromXML

  • extractInputsFromXML(xmlDocument: Document, options?: { filters?: OptionsFilter }): Element[]

  • Extract inputs (XML DOM nodes) from full XML document Using XPath

    Parameters

    • xmlDocument: Document
    • Optional options: { filters?: OptionsFilter }
      • Optional filters?: OptionsFilter

    Returns Element[]

Static extractPreviewInputNumber

  • extractPreviewInputNumber(xmlDocument: Document): number

  • Extract preview input number from full XML document using XPath

    Parameters

    • xmlDocument: Document

    Returns number

Static extractProgramInputNumber

  • extractProgramInputNumber(xmlDocument: Document): number

  • Extract active program input number from full XML document using XPath

    Parameters

    • xmlDocument: Document

    Returns number

Static map

  • map(xmlInputs: Element[], includeLayers?: boolean, failOnUnknownInputType?: boolean): BaseInput[]

  • Map (multiple) inputs

    Parameters

    • xmlInputs: Element[]
    • includeLayers: boolean = true
    • failOnUnknownInputType: boolean = false

    Returns BaseInput[]

    inputs

Static mapAllowNullable

  • mapAllowNullable(xmlInputs: Element[], includeLayers?: boolean, failOnUnknownInputType?: boolean): (null | BaseInput)[]

  • Map (multiple) inputs with allowing nullable

    Parameters

    • xmlInputs: Element[]
    • includeLayers: boolean = true
    • failOnUnknownInputType: boolean = false

    Returns (null | BaseInput)[]

Static mapSingle

  • mapSingle(input: Element, includeLayers?: boolean, failOnUnknownInputType?: boolean): BaseInput

  • Map single input

    Parameters

    • input: Element
    • includeLayers: boolean = true
    • failOnUnknownInputType: boolean = false

    Returns BaseInput

Static mapTallyInfo

  • mapTallyInfo(xmlDocument: Document): TallySummary

  • Map tally info including layers

    Parameters

    • xmlDocument: Document

    Returns TallySummary

Generated using TypeDoc