Skip to main content

MarkFacet

Auto-generated from the config schema in the source — see the config guide for concepts. Provided by the marks plugin. View source.

The mark display's facet: the Facet the feature and alignments displays take, one labelled section of the track per value of a field, plus the steps the facet runs separately over each section's features, after the display's transform and before every mark's transform. A pileup here packs each section into separate rows, and every mark then draws in them. A string is the field; with no field the steps run over the one section there is.

Example usage

{
  type: 'LinearMarkDisplay',
  facet: { field: 'HP', transform: [{ type: 'pileup' }] },
  marks: [{ mark: 'rect' }],
}

Config slots

A setting written to it names members one by one: a member left out stays as it is, and null resets one. One that changes field first clears sort, hidden, which name the old values, except those it states. 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
transform
MarkTransform		Steps that run separately over each section's features, after the display's transform and before any mark's transform: a pileup here packs each section into separate rows, and every mark draws in them.
Inherited from SectionFacet1 slot
hidden
stringArray of strings or numbers = []		The keys of the sections hidden from the stack, as a section chip's Hide writes them; "Show all" clears it.
Inherited from Facet2 slots
field
featureField = ''		The feature field whose values each get a labelled section of the track: a field name, a dotted path into a structured field (INFO.SVTYPE, a read's tags.HP), a jexl: expression, or strand. A feature with no value stacks last, under field: none ((no value) for a jexl: field, whose sections show the value alone). The variant display reads a sample attribute instead, and the mark displays group, their rows.groups. The alignments displays also take a read dimension here: firstOfPairStrand, pairOrientation, pairing, split, spliced, mapq, mateRefName or mateAssembly. Writing facet: "strand" sets this slot.
sort
stringArray of strings or numbers = []		The values whose sections stack first, in order, as Vega-Lite's sort lists them: the rest follow sorted, and none is dropped. Empty stacks every section sorted, and a strand facet forward, reverse, then unstranded (1, -1, 0).