Class: BaseDataLayer

An identifier string that must be unique across all layers within the same panel

The type of data layer. This parameter is used in layouts to specify which class (from the registry) is created; it is also used in CSS class names.

Tags have no functional purpose, but they can be used as a semantic label for what is being displayed in this element. This makes it easy to write custom code like "find every data layer that shows association scatter plots, anywhere": even if the IDs are different, the tag can be the same. Most built-in data layers will contain a tag that describes, in human-readable terms, what kind of data is being shown. (see: LayoutRegistry.mutate_attrs)

The datum field used for unique element IDs when addressing DOM elements, mouse events, etc. This should be unique to the specified datum, and persistent across re-renders (because it is used to identify where to draw tooltips, eg, if the plot is dragged or zoomed). If no single field uniquely identifies all items, a template expression can be used to create an ID from multiple fields instead. (it is your job to assure that all of the expected fields are present in every element)

A set of key value pairs representing how to map the local usage of data ("assoc") to the globally unique name for something defined in LocusZoom.DataSources. Namespaces allow a single layout to be reused to plot many tracks of the same type: "given some form of association data, plot it". These pairs take the form of { local_name: global_name }. (and all data layer layouts provide a default) In order to reuse a layout with a new provider of data- like plotting two association studies stacked together- only the namespace section of the layout needs to be overridden. Eg, LocusZoom.Layouts.get('data_layers', 'association_pvalues', { namespace: { assoc: 'assoc_study_2' }})

A set of data operations that will be performed on the data returned from the data adapters specified in namespace. (see: module:LocusZoom_DataFunctions)

If present, restricts the list of data elements to be displayed. Typically, filters hide elements, but arrange the layer so as to leave the space those elements would have occupied. The exact details vary from one layer to the next. See the Interactivity Tutorial for details.

An object describing how to connect this data layer to other data layers in the same plot. Specifies keys send and receive containing the names of fields with data to be matched; operator specifies the name of a MatchFunction to use. If a datum matches the broadcast value, it will be marked with the special field lz_is_match=true, which can be used in any scalable layout directive to control how the item is rendered.

If true, the data in this layer will not influence the x-extent of the panel.

If provided, the region plot x-extent will be determined from plot.state rather than from the range of the data. This is the most common way of setting x-extent, as it is useful for drawing a set of panels to reflect a particular genomic region.

The low end of the x-extent, which overrides any actual data range, min_extent, or buffer options.

The high end of the x-extent, which overrides any actual data range, min_extent, or buffer options.

The smallest possible range [min, max] of the x-axis. If the actual values lie outside the extent, the actual data takes precedence.

The datum field to look at when determining data extent along the x-axis.

Amount to expand (pad) the lower end of an axis as a proportion of the extent of the data.

Amount to expand (pad) the higher end of an axis as a proportion of the extent of the data.

If true, the data in this layer will not influence the y-extent of the panel.

Which y axis to use for this data layer (left=1, right=2)

The low end of the y-extent, which overrides any actual data range, min_extent, or buffer options.

The high end of the y-extent, which overrides any actual data range, min_extent, or buffer options.

The smallest possible range [min, max] of the y-axis. Actual lower or higher data values will take precedence.

The datum field to look at when determining data extent along the y-axis.

Amount to expand (pad) the lower end of an axis as a proportion of the extent of the data.

Amount to expand (pad) the higher end of an axis as a proportion of the extent of the data.

Define when to show a tooltip in terms of interaction states, eg, { or: ['highlighted', 'selected'] }

Define when to hide a tooltip in terms of interaction states, eg, { and: ['unhighlighted', 'unselected'] }

Whether a tool tip should render a "close" button in the upper right corner.

HTML template to render inside the tool tip. The template syntax uses curly braces to allow simple expressions: eg {{sourcename:fieldname}} to insert a field value from the datum associated with the tooltip/element. Conditional tags are supported using the format: {{#if sourcename:fieldname|transforms_can_be_used_too}}render text here{{#else}}Optional else branch{{/if}}`.

Where to draw the tooltip relative to the datum. Typically tooltip positions are centered around the midpoint of the data element, subject to overflow off the edge of the plot.

LocusZoom data layers support the binding of mouse events to one or more layout-definable behaviors. Some examples of behaviors include highlighting an element on mouseover, or linking to a dynamic URL on click, etc.

Tick marks found in the panel legend

Where this layout is used