Skip to main content

TrixTextSearchAdapter

Auto-generated config schema for the current JBrowse release — see the config guide for concepts. Provided by the trix plugin. View source.

Example usage

jbrowse text-index writes this entry into aggregateTextSearchAdapters for you. The uri shorthand points at the .ix; the sibling .ixx and _meta.json are derived from it, so all three only need spelling out when they are named against convention.

{
  type: 'TextSearchAdapter',
  trackId: 'my_track',
  name: 'My track',
  assemblyNames: ['hg38'],
  adapter: {
    type: 'TrixTextSearchAdapter',
    textSearchAdapterId: 'hg38-index',
    uri: 'trix/hg38.ix',
    assemblyNames: ['hg38'],
  },
}

See the Config slots section below for all available configuration fields.

Overview

TrixTextSearchAdapter - Identifier

Every TrixTextSearchAdapter has a unique textSearchAdapterId, a top-level field (not one of the config slots below) that identifies it; it is auto-generated when omitted.

an explicit textSearchAdapterId is still honored when given

Config slots

These slots go inside the track's adapter: "adapter": { "type": "TrixTextSearchAdapter", ... }. This adapter has no uri shorthand — give it the location slots below. Slot types (fileLocation, frozen, ...) are explained in the config slot types reference. Slots a base configuration contributes are listed here too, so this table is the whole surface.

SlotDescription
ixFilePath
fileLocation = { uri: 'out.ix', locationType: 'UriLocation' }		location of the Trix .ix index written by jbrowse text-index: the sorted term-to-feature table the search box reads.
ixxFilePath
fileLocation = { uri: 'out.ixx', locationType: 'UriLocation' }		location of the .ixx prefix index, which records where in the .ix each prefix begins. It is what makes a lookup a couple of range requests instead of a download of the whole index.
metaFilePath
fileLocation = { uri: 'meta.json', locationType: 'UriLocation' }		location of the _meta.json written beside the index, recording which tracks and assemblies it covers and the attributes it was built from.
tracks
stringArray = []		List of tracks covered by text search adapter
assemblyNames
stringArray = []		List of assemblies covered by text search adapter