HED JavaScript
dev_docs_final

HED JavaScript API:

  • bids
    • Schema
    • tsvParse
      • parseTSV()
    • types
      • BidsData
        • BidsData.definitions
        • BidsData.hedIssues
        • BidsData.parsedStringMapping
      • BidsFile
        • BidsFile.file
        • BidsFile.name
      • BidsJsonFile
        • BidsJsonFile.BidsJsonFile
        • BidsJsonFile.jsonData
      • BidsTsvFile
        • BidsTsvFile.BidsTsvFile
        • BidsTsvFile.hedColumnHedStrings
        • BidsTsvFile.mergedSidecar
        • BidsTsvFile.parsedTsv
        • BidsTsvFile.potentialSidecars
        • BidsTsvFile.sidecarHedData
      • BidsEventFile
        • BidsEventFile.BidsEventFile
      • BidsTabularFile
        • BidsTabularFile.BidsTabularFile
      • BidsSidecar
    • utils
      • sidecarValueHasHed()
    • validate
      • sidecarValueHasHed()
      • validateBidsDataset()
      • validateFullDataset()
      • validateBidsTsvFile()
      • validateSidecars()
      • validateHedColumn()
      • parseTsvHed()
      • validateCombinedDataset()
      • validateStrings()
      • convertHedIssuesToBidsIssues()
  • common
    • schema
      • types
        • Schema
          • Schema.Schema
          • Schema.generation
          • Schema.library
          • Schema.prefix
          • Schema.version
          • Schema.xmlData
          • Schema.tagHasAttribute()
        • Hed2Schema
          • Hed2Schema.Hed2Schema
          • Hed2Schema.attributes
          • Hed2Schema.tagHasAttribute()
        • Hed3Schema
          • Hed3Schema.Hed3Schema
          • Hed3Schema.entries
          • Hed3Schema.mapping
          • Hed3Schema.tagHasAttribute()
        • Schemas
          • Schemas.Schemas
          • Schemas.baseSchema
          • Schemas.generation
          • Schemas.isHed3
          • Schemas.isSyntaxOnly
          • Schemas.librarySchemas
          • Schemas.schemas
          • Schemas.standardSchema
          • Schemas.getSchema()
        • SchemaSpec
          • SchemaSpec.SchemaSpec
          • SchemaSpec.library
          • SchemaSpec.localName
          • SchemaSpec.localPath
          • SchemaSpec.nickname
          • SchemaSpec.path
          • SchemaSpec.version
        • SchemasSpec
          • SchemasSpec.SchemasSpec
          • SchemasSpec.data
          • SchemasSpec.addSchemaSpec()
          • SchemasSpec.isDuplicate()
      • loader
        • loadSchema()
        • loadSchemaFromSpec()
        • loadPromise()
        • loadRemoteSchema()
        • loadLocalSchema()
        • loadBundledSchema()
        • loadSchemaFile()
        • parseSchemaXML()
      • config
    • issues
      • issues
        • Issue
          • Issue.Issue
          • Issue.code
          • Issue.hedCode
          • Issue.internalCode
          • Issue.level
          • Issue.message
          • Issue.toString()
        • generateIssue()
      • data
  • converter
    • types
      • TagEntry
        • TagEntry.TagEntry
        • TagEntry.longFormattedTag
        • TagEntry.longTag
        • TagEntry.shortTag
        • TagEntry.takesValue
      • Mapping
        • Mapping.Mapping
        • Mapping.mappingData
    • schema
      • buildMappingObject()
      • schema.buildSchema()
    • issues
    • splitHedString
      • splitHedString()
    • converter
      • removeSlashesAndSpaces()
      • convertTagToLong()
      • convertTagToShort()
      • convertPartialHedStringToLong()
      • convertHedStringToLong()
      • convertHedStringToShort()
  • utils
    • xml2js
      • setParent()
    • map
    • types
      • MemoizerMixin
      • Memoizer
    • files
      • readFile()
      • readHTTPSFile()
    • xpath
      • find()
      • parseXPath()
      • search()
    • string
      • stringIsEmpty()
      • getCharacterCount()
      • capitalizeString()
      • isClockFaceTime()
      • isDateTime()
      • isNumber()
      • stringTemplate()
    • hedData
      • getGenerationForSchemaVersion()
      • getParsedParentTags()
    • array
      • getElementCount()
      • asArray()
      • recursiveMap()
    • hedStrings
      • replaceTagNameWithPound()
      • getTagLevels()
      • hedStrings.getTagName()
      • hedStrings.getParentTag()
      • hedStringIsAGroup()
      • loadSchemaFile()
      • removeGroupParentheses()
  • validator
    • dataset
      • parseDefinitions()
      • checkGroupForTemporalOrder()
      • validateTemporalOrder()
      • validateDataset()
      • validateHedEvents()
      • validateHedDataset()
      • validateHedDatasetWithContext()
    • schema
      • init
        • isHed3Schema()
        • buildSchemaAttributesObject()
        • buildSchemaObject()
        • init.buildSchema()
        • buildSchemas()
      • types
        • SchemaEntries
          • SchemaEntries.SchemaEntries
          • SchemaEntries.SIUnitModifiers
          • SchemaEntries.SIUnitSymbolModifiers
          • SchemaEntries.allUnits
          • SchemaEntries.attributes
          • SchemaEntries.definitions
          • SchemaEntries.properties
          • SchemaEntries.unitClassMap
          • SchemaEntries.tagHasAttribute()
        • SchemaEntryManager
          • SchemaEntryManager.SchemaEntryManager
          • SchemaEntryManager._definitions
          • SchemaEntryManager.keys()
          • SchemaEntryManager.values()
        • SchemaEntry
          • SchemaEntry.SchemaEntry
          • SchemaEntry._name
          • SchemaEntry.name
          • SchemaEntry.hasAttributeName()
        • SchemaProperty
          • SchemaProperty.SchemaProperty
          • SchemaProperty._propertyType
          • SchemaProperty.isCategoryProperty
          • SchemaProperty.isRoleProperty
          • SchemaProperty.isTypeProperty
        • SchemaAttribute
          • SchemaAttribute.SchemaAttribute
          • SchemaAttribute._categoryProperties
          • SchemaAttribute._roleProperties
          • SchemaAttribute._typeProperty
          • SchemaAttribute.categoryProperty
          • SchemaAttribute.roleProperties
          • SchemaAttribute.typeProperty
        • SchemaEntryWithAttributes
          • SchemaEntryWithAttributes.booleanAttributeNames
          • SchemaEntryWithAttributes.booleanAttributes
          • SchemaEntryWithAttributes.valueAttributeNames
          • SchemaEntryWithAttributes.valueAttributes
          • SchemaEntryWithAttributes.getAttributeValue()
          • SchemaEntryWithAttributes.getNamedAttributeValue()
          • SchemaEntryWithAttributes.hasAttribute()
          • SchemaEntryWithAttributes.hasAttributeName()
        • SchemaUnit
          • SchemaUnit.SchemaUnit
          • SchemaUnit._derivativeUnits
        • SchemaUnitClass
          • SchemaUnitClass.SchemaUnitClass
          • SchemaUnitClass._units
          • SchemaUnitClass.defaultUnit
          • SchemaUnitClass.units
        • SchemaUnitModifier
          • SchemaUnitModifier.SchemaUnitModifier
        • SchemaValueClass
          • SchemaValueClass.SchemaValueClass
        • SchemaTag
          • SchemaTag.SchemaTag
          • SchemaTag._parent
          • SchemaTag._unitClasses
          • SchemaTag.hasUnitClasses
          • SchemaTag.parent
          • SchemaTag.unitClasses
      • parser
        • SchemaParser
          • SchemaParser.SchemaParser
          • SchemaParser.getElementTagName()
          • SchemaParser.getElementTagValue()
      • hed3
    • event
      • init
        • initiallyValidateHedString()
        • validateHedString()
        • validateHedEvent()
        • validateHedEventWithDefinitions()
      • validator
        • HedValidator
          • HedValidator.HedValidator
          • HedValidator.hedSchemas
          • HedValidator.issues
          • HedValidator.options
          • HedValidator.parsedString
          • HedValidator._checkForTagAttribute()
          • HedValidator.checkForDuplicateTags()
          • HedValidator.checkForMultipleUniqueTags()
          • HedValidator.checkForRequiredTags()
          • HedValidator.checkIfTagIsValid()
          • HedValidator.checkIfTagRequiresChild()
          • HedValidator.checkIfTagUnitClassUnitsAreValid()
          • HedValidator.checkValueTagSyntax()
          • HedValidator.pushIssue()
          • HedValidator.validateHedTagGroup()
          • HedValidator.validateHedTagGroups()
          • HedValidator.validateHedTagLevel()
          • HedValidator.validateHedTagLevels()
          • HedValidator.validateIndividualHedTag()
          • HedValidator.validateIndividualHedTags()
          • HedValidator.validateTopLevelTags()
      • hed3
        • Hed3Validator
          • Hed3Validator.Hed3Validator
          • Hed3Validator.definitions
          • Hed3Validator.checkDefinitionGroupSyntax()
          • Hed3Validator.checkDefinitionStringSyntax()
          • Hed3Validator.checkForInvalidTopLevelTagGroupTags()
          • Hed3Validator.checkForInvalidTopLevelTags()
          • Hed3Validator.checkForMissingDefinitions()
          • Hed3Validator.checkIfTagIsValid()
          • Hed3Validator.checkIfTagUnitClassUnitsAreValid()
          • Hed3Validator.checkPlaceholderStringSyntax()
          • Hed3Validator.checkPlaceholderTagSyntax()
          • Hed3Validator.checkTemporalSyntax()
          • Hed3Validator.checkValueTagSyntax()
          • Hed3Validator.validateFullParsedHedString()
          • Hed3Validator.validateHedTagGroup()
          • Hed3Validator.validateIndividualHedTag()
          • Hed3Validator.validateTopLevelTagGroups()
          • Hed3Validator.validateTopLevelTags()
          • Hed3Validator.validateUnits()
          • Hed3Validator.validateValue()
    • parser
      • parsedHedTag
        • ParsedHedTag
          • ParsedHedTag.ParsedHedTag
          • ParsedHedTag.allowsExtensions
          • ParsedHedTag.canonicalTag
          • ParsedHedTag.conversionIssues
          • ParsedHedTag.formattedTag
          • ParsedHedTag.schema
          • ParsedHedTag._convertTag()
          • ParsedHedTag._formatTag()
          • ParsedHedTag.toString()
          • ParsedHedTag.ancestorIterator
          • ParsedHedTag.getParentTag
          • ParsedHedTag.getTagName
        • ParsedHed3Tag
          • ParsedHed3Tag.defaultUnit
          • ParsedHed3Tag.existsInSchema
          • ParsedHed3Tag.hasUnitClass
          • ParsedHed3Tag.takesValue
          • ParsedHed3Tag.takesValueFormattedTag
          • ParsedHed3Tag.takesValueTag
          • ParsedHed3Tag.unitClasses
          • ParsedHed3Tag.validUnits
          • ParsedHed3Tag._convertTag()
      • splitHedString
        • HedStringTokenizer
          • HedStringTokenizer.tokenize()
        • checkForInvalidCharacters()
        • createParsedTags()
        • splitHedString()
      • parsedHedString
        • ParsedHedString
          • ParsedHedString.ParsedHedString
          • ParsedHedString.definitionGroups
          • ParsedHedString.hedString
          • ParsedHedString.tagGroups
          • ParsedHedString.tags
          • ParsedHedString.topLevelTagGroups
          • ParsedHedString.topLevelTags
      • parsedHedSubstring
        • ParsedHedSubstring
          • ParsedHedSubstring.ParsedHedSubstring
          • ParsedHedSubstring.originalBounds
          • ParsedHedSubstring.originalTag
          • ParsedHedSubstring.toString()
      • parsedHedGroup
        • ParsedHedGroup
          • ParsedHedGroup.ParsedHedGroup
          • ParsedHedGroup.defCount
          • ParsedHedGroup.defExpandChildren
          • ParsedHedGroup.defExpandName
          • ParsedHedGroup.defExpandNameAndValue
          • ParsedHedGroup.defExpandTag
          • ParsedHedGroup.defExpandTags
          • ParsedHedGroup.defExpandValue
          • ParsedHedGroup.defName
          • ParsedHedGroup.defNameAndValue
          • ParsedHedGroup.defTags
          • ParsedHedGroup.defValue
          • ParsedHedGroup.definitionGroup
          • ParsedHedGroup.definitionName
          • ParsedHedGroup.definitionNameAndValue
          • ParsedHedGroup.definitionTag
          • ParsedHedGroup.definitionTags
          • ParsedHedGroup.definitionValue
          • ParsedHedGroup.hasDefExpandChildren
          • ParsedHedGroup.isDefExpandGroup
          • ParsedHedGroup.isDefGroup
          • ParsedHedGroup.isDefinitionGroup
          • ParsedHedGroup.isInsetGroup
          • ParsedHedGroup.isOffsetGroup
          • ParsedHedGroup.isOnsetGroup
          • ParsedHedGroup.isTemporalGroup
          • ParsedHedGroup.specialTags
          • ParsedHedGroup.tags
          • ParsedHedGroup.temporalGroupName
          • ParsedHedGroup.nestedGroups()
          • ParsedHedGroup.subGroupArrayIterator()
          • ParsedHedGroup.subParsedGroupIterator()
          • ParsedHedGroup.tagIterator()
          • ParsedHedGroup.topLevelGroupIterator()
          • ParsedHedGroup.findDefinitionName
          • ParsedHedGroup.findGroupTags
          • ParsedHedGroup.getDefinitionTagValue
      • main
        • substituteCharacters()
        • countTagGroupParentheses()
        • isCommaMissingAfterClosingParenthesis()
        • findDelimiterIssuesInHedString()
        • validateFullUnparsedHedString()
        • parseHedString()
        • parseHedStrings()
    • hed2
      • schema
        • schemaAttributes
          • SchemaAttributes
            • SchemaAttributes.SchemaAttributes
            • SchemaAttributes.hasUnitClasses
            • SchemaAttributes.hasUnitModifiers
            • SchemaAttributes.tagAttributes
            • SchemaAttributes.tagUnitClasses
            • SchemaAttributes.tags
            • SchemaAttributes.unitAttributes
            • SchemaAttributes.unitClassAttributes
            • SchemaAttributes.unitClasses
            • SchemaAttributes.unitModifiers
            • SchemaAttributes.tagHasAttribute()
        • hed2SchemaParser
          • Hed2SchemaParser
      • event
        • hed2Validator
          • Hed2Validator
            • Hed2Validator.Hed2Validator
            • Hed2Validator.checkIfTagUnitClassUnitsAreValid()
            • Hed2Validator.checkValueTagSyntax()
            • Hed2Validator.validateValue()
        • units
          • units.validateUnits()
          • isPrefixUnit()
          • getValidDerivativeUnits()
          • getAllUnits()
      • parser
        • parsedHed2Tag
          • ParsedHed2Tag
            • ParsedHed2Tag.defaultUnit
            • ParsedHed2Tag.existsInSchema
            • ParsedHed2Tag.hasUnitClass
            • ParsedHed2Tag.takesValue
            • ParsedHed2Tag.takesValueFormattedTag
            • ParsedHed2Tag.unitClasses
            • ParsedHed2Tag.validUnits
            • ParsedHed2Tag._convertTag()
HED JavaScript
  • validator
  • hed2
  • schema
  • Edit on GitHub
Previous Next

schemaΒΆ

  • schemaAttributes
    • SchemaAttributes
      • SchemaAttributes.SchemaAttributes
      • SchemaAttributes.hasUnitClasses
      • SchemaAttributes.hasUnitModifiers
      • SchemaAttributes.tagAttributes
      • SchemaAttributes.tagUnitClasses
      • SchemaAttributes.tags
      • SchemaAttributes.unitAttributes
      • SchemaAttributes.unitClassAttributes
      • SchemaAttributes.unitClasses
      • SchemaAttributes.unitModifiers
      • SchemaAttributes.tagHasAttribute()
  • hed2SchemaParser
    • Hed2SchemaParser

© Copyright 2017-2023, HED Working Group. Revision 67c57e4a.

Built with Sphinx using a theme provided by Read the Docs.