vega-scverse-specification
The configuration entailing all the specification components for visualization of data in the scverse ecosystem.
URI: https://w3id.org/scverse/vega-scverse/specification
Name: vega-scverse-specification
Classes
| Class | Description |
|---|---|
| Axis | An axis visualizes a spatial scale mapping for cartesian coordinates using ti... |
| AxisItem | A axis item which for a mark can define the scale and field used for the axis... |
| BaseFormat | Format object containing the type of data as object and a string value repres... |
| ElementFormat | |
| SpatialDataFormat | |
| BaselineItem | The vertical alignment of the text relative to its y-coordinate |
| BaseScales | Vega like definition for scales which specifies a collection of mappings from... |
| CircleShape | Circle shape definition used in symbol mark |
| ColorItem | A single color item definition specifying the scale on which the color is bas... |
| ConditionalFillUpdate | Update color based on test condition |
| ContinuousColorDomain | A data domain or source for a LinearColorScale |
| ContinuousColorMapRange | Color scheme reference for a color palette |
| DataObject | Abstract class for Vega like data set definitions and transforms that define ... |
| BaseTableObject | AnnData Table object stream |
| SpatialDataElementObject | Data object pertaining to an element within the SpatialData object |
| SpatialDataObject | SpatialData object specific to the SpatialData root |
| FontItem | The name of the font to be used |
| FontSizeItem | Fontsize in pixels of text |
| FontStyleItem | Fontstyle of the text |
| FontWeightItem | Font weight of the text |
| GroupEncode | A set of visual encoding properties that determine the position of a group ma... |
| GroupEncodeEnter | Encoding for the position, width and height of a group mark |
| GroupMark | Group marks are containers for other marks, and used to create visualizations... |
| ImageEncode | A set of visual encoding properties that determine the position and appearanc... |
| ImageEncodeEnter | Enter properties that are evaluated when image data is processed for the firs... |
| LabelEncode | A set of visual encoding properties that determine the position and appearanc... |
| LabelEncodeEnter | Enter properties that are evaluated when label data is processed for the firs... |
| Legend | Vega like configuration for specifying legends in the SpatialData visualizati... |
| CategoricalLegend | Type of legend for categorical data |
| ColorBarLegend | Type of legend for continuous data |
| Mark | Graphical marks visually encode data using geometric primitives such as recta... |
| PointsMark | Graphical mark for encoding points data, using a vega like symbol mark |
| RasterImageMark | Graphical mark encoding an image |
| RasterLabelMark | Graphical mark encoding a label image |
| ShapesMark | Graphical mark for encoding shapes data, using a vega like path mark |
| MarkDataSource | Object with a data field pointing to the name of the datastream that serves a... |
| MarkEncodeUpdate | Update properties that are evaluated for all existing (non-exiting) mark inst... |
| Padding | padding defines the amount of space (in pixels) to reserve between the edge o... |
| PathEncode | A set of visual encoding properties that determine the position and appearanc... |
| PathEncodeEnter | Enter properties that are evaluated when shapes data is processed for the fir... |
| PointsEncodeEnter | Enter properties that are evaluated when points data is processed for the fir... |
| PositionItem | X or y position of an item in pixels |
| RandomRGBSignal | RGB value represented by a hexadecimal string value |
| RGBHexItem | RGB value represented by a hexadecimal string value |
| Scale | Base class for vega like scales which map from a data domain to a visual rang... |
| BaseAxisScale | A vega like scale specifically for mapping from a data domain to an axis rang... |
| ColorScale | Abstract class to map a data domain to a color range |
| BaseCategoricalColorScale | A scale to map a discrete data domain to discrete colors |
| LinearColorScale | A vega like scale specifically for mapping from a linear continuous data doma... |
| SymbolEncode | A set of visual encoding properties that determine the position and appearanc... |
| TextEncode | A set of visual encoding properties that determine the position and appearanc... |
| TextEncodeEnter | Enter properties that are evaluated when data for a text mark is processed fo... |
| TextItem | Text to be displayed |
| TextMark | Text marks can be used to annotate data and provide labels and titles for axe... |
| Title | The title directive adds a descriptive title to a chart |
| Transform | Transform of data applied to data input |
| AggregateTransform | Group and summarize an input data stream to produce a derived output stream u... |
| FilterChannelTransform | Filter on particular channels in a raster data object |
| FilterTransform | Select objects from a data stream to keep based on a filter expression |
| NormalizationFormulaTransform | A formula to transform data |
| SpreadTransform | Datashade transform expanding each pixel in a rasterized image by a specified... |
| ViewConfiguration | Viewconfiguration based on vega for the scverse visualization ecosystem |
Slots
| Slot | Description |
|---|---|
| align | The horizontal text alignment relative to the text anchor point |
| angle | The rotation angle of the text in degrees |
| as_ | The output field names to use for each aggregated field in fields |
| axes | Axes visualize spatial scale mappings using ticks, grid lines and labels |
| baseline | The baseline attribute specifies the vertical alignment (baseline) of the tex... |
| bottom | The value for padding at the bottom side of the chart in pixels |
| color | Text color of the title text |
| columnPadding | The horizontal padding in pixels between symbol legend entries |
| columns | The number of columns in which to arrange symbol legend entries |
| count | The number of colors to use in the scheme |
| data | Scverse data set definitions and transforms define the data to load and how t... |
| direction | The direction of the legend, one of 'vertical' or 'horizontal' |
| domain | The set of input data values that the scale maps from |
| domainColor | Color of axis domain line |
| domainOpacity | Opacity of axis domain line |
| domainWidth | Stroke width of axis domain line |
| encode | A set of visual encoding properties that determine the position and appearanc... |
| enter | Enter properties that are evaluated when image data is processed for the firs... |
| expr | Either the name of the element or coordinate system to filter / select |
| field | The data fields for which to compute aggregate functions |
| fill | The name of a scale that maps to a fill color |
| fillColor | Hex string representing a RGBA color, which is the background color of the le... |
| fillOpacity | Opacity value for the label fill between 0 and 1 |
| font | Font name of the title text |
| fontSize | Font size in pixels of the title text |
| fontStyle | Fontstyle of the title |
| fontWeight | Font weight of the title |
| format | Format object containing the type of data as object and a string or float val... |
| from_ | The data stream used as the source for the graphical mark |
| gradientLength | The length in pixels of the primary axis of a color gradient |
| gradientOpacity | Opacity of the color gradient |
| gradientStrokeColor | Stroke color of the color gradient border |
| gradientStrokeWidth | Stroke width of the color gradient border |
| grid | A boolean flag indicating if grid lines should be included as part of the axi... |
| gridCap | The stroke cap for axis grid lines |
| gridColor | Color of axis grid lines |
| gridOpacity | Opacity of axis grid lines |
| gridWidth | Stroke width of axis grid lines |
| height | The height of the plotting area |
| labelAlign | Horizontal text alignment for legend labels |
| labelColor | Text color of axis tick labels |
| labelFont | Font name for axis tick labels |
| labelFontSize | Font size of axis tick labels |
| labelFontStyle | Font style of axis tick labels |
| labelFontWeight | Font weight of axis tick labels |
| labelOffset | Offset in pixels between legend labels their corresponding symbol or gradient |
| labelOpacity | Opacity of axis tick labels |
| left | The value for padding at the left side of the chart in pixels |
| legends | Legends visualize scale mappings for visual values such as color, shape and s... |
| legendX | The pixel x-coordinate of the legend group |
| legendY | The pixel y-coordinate of the legend group |
| marks | Graphical marks visually encode data using geometric primitives such as recta... |
| name | The name used throughout the view configuration to refer to the data object |
| nonNegativeFloatSlot | A positive float value |
| opacity | The opacity of the image mark |
| opacityValueSlot | Opacity value between 0 and 1 |
| ops | The summary statistic to apply per field |
| orient | The orientation of the axis, either 'left', 'right', 'top' or 'bottom' |
| padding | padding defines the amount of space (in pixels) to reserve between the edge o... |
| px | The amount of pixels by which to expand each pixel to make data more visible |
| range | Defines the target visual dimension for the axis scale's output range |
| rgbaHexSlot | Hex string representing a RGBA value |
| rgbHexSlot | Hex string representing a RGB value |
| right | The value for padding at the right side of the chart in pixels |
| rowPadding | The vertical padding in pixels between symbol legend entries |
| scale | Name of the 'AxisScale' to visualize as axis object |
| scales | Scales map data values (numbers, dates, categories, etc |
| scheme | The name of the color scheme to use or an array of color values |
| shape | The type of shape |
| signal | Signal creating random RGB color for labels in a label raster |
| size | The size of points in a PointsMark |
| source | The source of the SpatialData element |
| stroke | The color of the outline of each individual label |
| strokeColor | Hex string representing a RGBA color, which is the color of the legend border |
| strokeOpacity | Opacity value for the label stroke between 0 and 1 |
| strokeWidth | The width of the outline of a labels, symbol or path mark |
| test | The condition to test on, e |
| text | The title text |
| tickCap | The stroke cap for axis tick marks |
| tickColor | Color of axis ticks |
| tickOpacity | Opacity of axis ticks |
| ticks | A boolean flag indicating if ticks should be included as part of the axis |
| tickSize | The length in pixels of axis ticks |
| tickWidth | Width in pixels of axis ticks |
| title | The title directive adds a descriptive title to a chart |
| top | The value for padding at the top side of the chart in pixels |
| transform | An array containing a single transform 'filter_element' with an expression st... |
| type | The type of transform |
| update | Update properties that are evaluated for all existing (non-exiting) mark inst... |
| url | The absolute path to the SpatialData zarr |
| value | The coordinate value |
| values | Explicitly set the visible axis tick and label values |
| version | The version of the data type that is defined |
| width | The width of the plotting area |
| x | The x coordinates |
| y | The y coordinates |
| zindex | The integer z-index indicating the layering of the axis group relative to oth... |
Enumerations
| Enumeration | Description |
|---|---|
| AggregateOpsEnum | The summary statistic to apply for an aggregation transform |
| AxisEnum | Possible values for the type of |
| AxisRangeEnum | Possible values which to map the data domain to |
| BaseLineEnum | The possible vertical alignments of the text relative to its y-coordinate |
| CapEnum | The style of the stroke end for axis tick marks |
| FontStyleEnum | Possible font styles |
| FontWeightEnum | Possible font weight values |
| HorizontalAlignEnum | The horizontal text alignment relative to the anchor point of the text |
| LegendDirections | The possible directions of the legend |
| LegendType | The valid mark types within the scverse plotting / visualization ecosystem |
| MarkTypeEnum | The valid mark types within the scverse plotting / visualization ecosystem |
| OrientEnum | The position relative to the chart for either a (sub)title or axis |
| ScaleEnum | Possible values for the type of Scale |
| TransformTypeEnum | Valid transforms on a data stream within a scverse viewconfig |
Types
| Type | Description |
|---|---|
| Boolean | A binary (true or false) value |
| Curie | a compact URI |
| Date | a date (year, month and day) in an idealized calendar |
| DateOrDatetime | Either a date or a datetime |
| Datetime | The combination of a date and time |
| Decimal | A real number with arbitrary precision that conforms to the xsd:decimal speci... |
| Double | A real number that conforms to the xsd:double specification |
| Float | A real number that conforms to the xsd:float specification |
| Integer | An integer |
| Jsonpath | A string encoding a JSON Path |
| Jsonpointer | A string encoding a JSON Pointer |
| Ncname | Prefix part of CURIE |
| Nodeidentifier | A URI, CURIE or BNODE that represents a node in a model |
| Objectidentifier | A URI or CURIE that represents an object in the model |
| Sparqlpath | A string encoding a SPARQL Property Path |
| String | A character string |
| Time | A time object represents a (local) time of day, independent of any particular... |
| Uri | a complete URI |
| Uriorcurie | a URI or a CURIE |
Subsets
| Subset | Description |
|---|---|