Class Inputs

XML API Inputs

Index

Constructors

Methods

extractInputsFromXML extractPreviewInputNumber extractProgramInputNumber map mapAllowNullable mapSingle mapTallyInfo

Constructors

constructor

new Inputs(): Inputs
Returns Inputs

Methods

`Static`extractInputsFromXML

extractInputsFromXML(xmlDocument, options?): Element[]
Extract inputs (XML DOM nodes) from full XML document Using XPath
Parameters
- xmlDocument: Document
- Optionaloptions: {
  filters?: OptionsFilter;
  }
  - Optionalfilters?: OptionsFilter
Returns Element[]
- Defined in xml-api/inputs.ts:39

`Static`extractPreviewInputNumber

extractPreviewInputNumber(xmlDocument): number
Extract preview input number from full XML document using XPath
Parameters
- xmlDocument: Document
Returns number
- Defined in xml-api/inputs.ts:294

`Static`extractProgramInputNumber

extractProgramInputNumber(xmlDocument): number
Extract active program input number from full XML document using XPath
Parameters
- xmlDocument: Document
Returns number
- Defined in xml-api/inputs.ts:278

`Static`map

map(xmlInputs, includeLayers?, failOnUnknownInputType?): BaseInput[]
Map (multiple) inputs
Parameters
- xmlInputs: Element[]
- includeLayers: boolean = true
- failOnUnknownInputType: boolean = false
Returns BaseInput[]
inputs
- Defined in xml-api/inputs.ts:182

`Static`mapAllowNullable

mapAllowNullable(xmlInputs, includeLayers?, failOnUnknownInputType?): (null | BaseInput)[]
Map (multiple) inputs with allowing nullable
Parameters
- xmlInputs: Element[]
- includeLayers: boolean = true
- failOnUnknownInputType: boolean = false
Returns (null | BaseInput)[]
- Defined in xml-api/inputs.ts:210

`Static`mapSingle

mapSingle(input, includeLayers?, failOnUnknownInputType?): BaseInput
Map single input
Parameters
- input: Element
- includeLayers: boolean = true
- failOnUnknownInputType: boolean = false
Returns BaseInput
- Defined in xml-api/inputs.ts:119

`Static`mapTallyInfo

mapTallyInfo(xmlDocument): TallySummary
Map tally info including layers
Parameters
- xmlDocument: Document
Returns TallySummary
- Defined in xml-api/inputs.ts:232