Skip to content

Class: Axis

An axis visualizes a spatial scale mapping for cartesian coordinates using ticks, grid lines and labels.

URI: vega_scverse:Axis

classDiagram class Axis click Axis href "../Axis" Axis : domain Axis : domainColor Axis : domainOpacity Axis : domainWidth Axis : grid Axis : gridCap Axis --> "0..1" CapEnum : gridCap click CapEnum href "../CapEnum" Axis : gridColor Axis : gridOpacity Axis : gridWidth Axis : labelColor Axis : labelFont Axis : labelFontSize Axis : labelFontStyle Axis --> "0..1" FontStyleEnum : labelFontStyle click FontStyleEnum href "../FontStyleEnum" Axis : labelFontWeight Axis --> "0..1" FontWeightEnum : labelFontWeight click FontWeightEnum href "../FontWeightEnum" Axis : labelOpacity Axis : orient Axis --> "1" OrientEnum : orient click OrientEnum href "../OrientEnum" Axis : scale Axis : tickCap Axis --> "0..1" CapEnum : tickCap click CapEnum href "../CapEnum" Axis : tickColor Axis : tickOpacity Axis : ticks Axis : tickSize Axis : tickWidth Axis : values Axis : zindex

Slots

Name Cardinality and Range Description Inheritance
scale 1
String		 Name of the 'AxisScale' to visualize as axis object direct
orient 1
OrientEnum		 The orientation of the axis, either 'left', 'right', 'top' or 'bottom' direct
domain 1
Boolean		 A boolean flag indicating if the domain (the axis baseline, the line that the... direct
domainOpacity 0..1
Float		 Opacity of axis domain line direct
domainColor 0..1
String		 Color of axis domain line direct
domainWidth 0..1
Float		 Stroke width of axis domain line direct
grid 0..1
Boolean		 A boolean flag indicating if grid lines should be included as part of the axi... direct
gridOpacity 0..1
Float		 Opacity of axis grid lines direct
gridCap 0..1
CapEnum		 The stroke cap for axis grid lines direct
gridColor 0..1
String		 Color of axis grid lines direct
gridWidth 0..1
Float		 Stroke width of axis grid lines direct
labelColor 0..1
String		 Text color of axis tick labels direct
labelOpacity 0..1
Float		 Opacity of axis tick labels direct
labelFont 0..1
String		 Font name for axis tick labels direct
labelFontSize 0..1
Float		 Font size of axis tick labels direct
labelFontStyle 0..1
FontStyleEnum		 Font style of axis tick labels direct
labelFontWeight 0..1
FontWeightEnum		 Font weight of axis tick labels direct
ticks 0..1
Boolean		 A boolean flag indicating if ticks should be included as part of the axis direct
tickOpacity 0..1
Float		 Opacity of axis ticks direct
tickColor 0..1
String		 Color of axis ticks direct
tickCap 0..1
CapEnum		 The stroke cap for axis tick marks direct
tickWidth 0..1
Float		 Width in pixels of axis ticks direct
tickSize 0..1
Float		 The length in pixels of axis ticks direct
values 1..*
String or 
Float or 
Integer		 Explicitly set the visible axis tick and label values direct
zindex 1
Float		 The integer z-index indicating the layering of the axis group relative to oth... direct

Usages

used by used in type used
ViewConfiguration axes range Axis
GroupMark axes range Axis

Identifier and Mapping Information

Schema Source

  • from schema: https://w3id.org/scverse/vega-scverse/specification

Mappings

Mapping Type Mapped Value
self vega_scverse:Axis
native vega_scverse:Axis

LinkML Source

Direct

name: Axis
description: An axis visualizes a spatial scale mapping for cartesian coordinates
  using ticks, grid lines and labels.
from_schema: https://w3id.org/scverse/vega-scverse/specification
attributes:
  scale:
    name: scale
    description: Name of the 'AxisScale' to visualize as axis object.
    from_schema: https://w3id.org/scverse/vega-scverse/axes
    rank: 1000
    domain_of:
    - Axis
    - ColorItem
    - AxisItem
    - ConditionalFillUpdate
    required: true
    pattern: ^[XY]_scale(_\d+)?$
  orient:
    name: orient
    description: The orientation of the axis, either 'left', 'right', 'top' or 'bottom'.
    from_schema: https://w3id.org/scverse/vega-scverse/axes
    rank: 1000
    domain_of:
    - Axis
    - Legend
    - Title
    range: OrientEnum
    required: true
  domain:
    name: domain
    description: "A boolean flag indicating if the domain (the axis baseline, the\
      \ line that the ticks connect to) should be \nincluded as part of the axis."
    from_schema: https://w3id.org/scverse/vega-scverse/axes
    domain_of:
    - BaseAxisScale
    - LinearColorScale
    - BaseCategoricalColorScale
    - Axis
    range: boolean
    required: true
  domainOpacity:
    name: domainOpacity
    description: Opacity of axis domain line. Should not be present if domain is 'false'.
    from_schema: https://w3id.org/scverse/vega-scverse/axes
    rank: 1000
    domain_of:
    - Axis
    range: float
    minimum_value: 0
    maximum_value: 1
  domainColor:
    name: domainColor
    description: Color of axis domain line. Should not be present if domain is 'false'.
    from_schema: https://w3id.org/scverse/vega-scverse/axes
    rank: 1000
    slot_uri: rgbHexSlot
    domain_of:
    - Axis
  domainWidth:
    name: domainWidth
    description: Stroke width of axis domain line. Should not be present if domain
      is 'false'.
    from_schema: https://w3id.org/scverse/vega-scverse/axes
    rank: 1000
    domain_of:
    - Axis
    range: float
  grid:
    name: grid
    description: A boolean flag indicating if grid lines should be included as part
      of the axis.
    from_schema: https://w3id.org/scverse/vega-scverse/axes
    rank: 1000
    ifabsent: 'False'
    domain_of:
    - Axis
    range: boolean
  gridOpacity:
    name: gridOpacity
    description: Opacity of axis grid lines. Should not be present if grid is 'false'.
    from_schema: https://w3id.org/scverse/vega-scverse/axes
    rank: 1000
    domain_of:
    - Axis
    range: float
    minimum_value: 0
    maximum_value: 1
  gridCap:
    name: gridCap
    description: 'The stroke cap for axis grid lines. One of ''butt'' (default), ''round''
      or ''square''.

      Should not be present if grid is ''false''.'
    from_schema: https://w3id.org/scverse/vega-scverse/axes
    rank: 1000
    domain_of:
    - Axis
    range: CapEnum
  gridColor:
    name: gridColor
    description: Color of axis grid lines. Should not be present if grid is 'false'.
    from_schema: https://w3id.org/scverse/vega-scverse/axes
    rank: 1000
    slot_uri: rgbHexSlot
    domain_of:
    - Axis
  gridWidth:
    name: gridWidth
    description: Stroke width of axis grid lines. Should not be present if grid is
      'false'.
    from_schema: https://w3id.org/scverse/vega-scverse/axes
    rank: 1000
    domain_of:
    - Axis
    range: float
  labelColor:
    name: labelColor
    description: Text color of axis tick labels.
    from_schema: https://w3id.org/scverse/vega-scverse/axes
    rank: 1000
    slot_uri: rgbHexSlot
    domain_of:
    - Axis
    - Legend
  labelOpacity:
    name: labelOpacity
    description: Opacity of axis tick labels.
    from_schema: https://w3id.org/scverse/vega-scverse/axes
    rank: 1000
    domain_of:
    - Axis
    - Legend
    range: float
    minimum_value: 0
    maximum_value: 1
  labelFont:
    name: labelFont
    description: Font name for axis tick labels.
    from_schema: https://w3id.org/scverse/vega-scverse/axes
    rank: 1000
    domain_of:
    - Axis
    - Legend
    range: string
  labelFontSize:
    name: labelFontSize
    description: Font size of axis tick labels.
    from_schema: https://w3id.org/scverse/vega-scverse/axes
    rank: 1000
    domain_of:
    - Axis
    - Legend
    range: float
  labelFontStyle:
    name: labelFontStyle
    description: Font style of axis tick labels
    from_schema: https://w3id.org/scverse/vega-scverse/axes
    rank: 1000
    domain_of:
    - Axis
    - Legend
    range: FontStyleEnum
  labelFontWeight:
    name: labelFontWeight
    description: Font weight of axis tick labels.
    from_schema: https://w3id.org/scverse/vega-scverse/axes
    rank: 1000
    domain_of:
    - Axis
    - Legend
    range: FontWeightEnum
  ticks:
    name: ticks
    description: A boolean flag indicating if ticks should be included as part of
      the axis.
    from_schema: https://w3id.org/scverse/vega-scverse/axes
    rank: 1000
    ifabsent: 'True'
    domain_of:
    - Axis
    range: boolean
  tickOpacity:
    name: tickOpacity
    description: Opacity of axis ticks.
    from_schema: https://w3id.org/scverse/vega-scverse/axes
    rank: 1000
    domain_of:
    - Axis
    range: float
    minimum_value: 0
    maximum_value: 1
  tickColor:
    name: tickColor
    description: Color of axis ticks.
    from_schema: https://w3id.org/scverse/vega-scverse/axes
    rank: 1000
    slot_uri: rgbHexSlot
    domain_of:
    - Axis
  tickCap:
    name: tickCap
    description: The stroke cap for axis tick marks. One of "butt" (default), "round"
      or "square".
    from_schema: https://w3id.org/scverse/vega-scverse/axes
    rank: 1000
    domain_of:
    - Axis
    range: CapEnum
  tickWidth:
    name: tickWidth
    description: Width in pixels of axis ticks.
    from_schema: https://w3id.org/scverse/vega-scverse/axes
    rank: 1000
    domain_of:
    - Axis
    range: float
    minimum_value: 0
  tickSize:
    name: tickSize
    description: The length in pixels of axis ticks.
    from_schema: https://w3id.org/scverse/vega-scverse/axes
    rank: 1000
    domain_of:
    - Axis
    range: float
    minimum_value: 0
  values:
    name: values
    description: "Explicitly set the visible axis tick and label values. The array\
      \ entries should be legal values in the \nbacking scale domain."
    from_schema: https://w3id.org/scverse/vega-scverse/axes
    rank: 1000
    domain_of:
    - Axis
    required: true
    multivalued: true
    any_of:
    - range: float
    - range: integer
  zindex:
    name: zindex
    description: "The integer z-index indicating the layering of the axis group relative\
      \ to other axis, mark, and legend groups. \nThe default value is 0 and axes\
      \ and grid lines are drawn behind any marks defined in the same specification\
      \ \nlevel. Higher values (1) will cause axes and grid lines to be drawn on top\
      \ of marks."
    from_schema: https://w3id.org/scverse/vega-scverse/axes
    rank: 1000
    domain_of:
    - Axis
    - Legend
    - Mark
    - TextMark
    range: float
    required: true

Induced

name: Axis
description: An axis visualizes a spatial scale mapping for cartesian coordinates
  using ticks, grid lines and labels.
from_schema: https://w3id.org/scverse/vega-scverse/specification
attributes:
  scale:
    name: scale
    description: Name of the 'AxisScale' to visualize as axis object.
    from_schema: https://w3id.org/scverse/vega-scverse/axes
    rank: 1000
    alias: scale
    owner: Axis
    domain_of:
    - Axis
    - ColorItem
    - AxisItem
    - ConditionalFillUpdate
    range: string
    required: true
    pattern: ^[XY]_scale(_\d+)?$
  orient:
    name: orient
    description: The orientation of the axis, either 'left', 'right', 'top' or 'bottom'.
    from_schema: https://w3id.org/scverse/vega-scverse/axes
    rank: 1000
    alias: orient
    owner: Axis
    domain_of:
    - Axis
    - Legend
    - Title
    range: OrientEnum
    required: true
  domain:
    name: domain
    description: "A boolean flag indicating if the domain (the axis baseline, the\
      \ line that the ticks connect to) should be \nincluded as part of the axis."
    from_schema: https://w3id.org/scverse/vega-scverse/axes
    alias: domain
    owner: Axis
    domain_of:
    - BaseAxisScale
    - LinearColorScale
    - BaseCategoricalColorScale
    - Axis
    range: boolean
    required: true
  domainOpacity:
    name: domainOpacity
    description: Opacity of axis domain line. Should not be present if domain is 'false'.
    from_schema: https://w3id.org/scverse/vega-scverse/axes
    rank: 1000
    alias: domainOpacity
    owner: Axis
    domain_of:
    - Axis
    range: float
    minimum_value: 0
    maximum_value: 1
  domainColor:
    name: domainColor
    description: Color of axis domain line. Should not be present if domain is 'false'.
    from_schema: https://w3id.org/scverse/vega-scverse/axes
    rank: 1000
    slot_uri: rgbHexSlot
    alias: domainColor
    owner: Axis
    domain_of:
    - Axis
    range: string
  domainWidth:
    name: domainWidth
    description: Stroke width of axis domain line. Should not be present if domain
      is 'false'.
    from_schema: https://w3id.org/scverse/vega-scverse/axes
    rank: 1000
    alias: domainWidth
    owner: Axis
    domain_of:
    - Axis
    range: float
  grid:
    name: grid
    description: A boolean flag indicating if grid lines should be included as part
      of the axis.
    from_schema: https://w3id.org/scverse/vega-scverse/axes
    rank: 1000
    ifabsent: 'False'
    alias: grid
    owner: Axis
    domain_of:
    - Axis
    range: boolean
  gridOpacity:
    name: gridOpacity
    description: Opacity of axis grid lines. Should not be present if grid is 'false'.
    from_schema: https://w3id.org/scverse/vega-scverse/axes
    rank: 1000
    alias: gridOpacity
    owner: Axis
    domain_of:
    - Axis
    range: float
    minimum_value: 0
    maximum_value: 1
  gridCap:
    name: gridCap
    description: 'The stroke cap for axis grid lines. One of ''butt'' (default), ''round''
      or ''square''.

      Should not be present if grid is ''false''.'
    from_schema: https://w3id.org/scverse/vega-scverse/axes
    rank: 1000
    alias: gridCap
    owner: Axis
    domain_of:
    - Axis
    range: CapEnum
  gridColor:
    name: gridColor
    description: Color of axis grid lines. Should not be present if grid is 'false'.
    from_schema: https://w3id.org/scverse/vega-scverse/axes
    rank: 1000
    slot_uri: rgbHexSlot
    alias: gridColor
    owner: Axis
    domain_of:
    - Axis
    range: string
  gridWidth:
    name: gridWidth
    description: Stroke width of axis grid lines. Should not be present if grid is
      'false'.
    from_schema: https://w3id.org/scverse/vega-scverse/axes
    rank: 1000
    alias: gridWidth
    owner: Axis
    domain_of:
    - Axis
    range: float
  labelColor:
    name: labelColor
    description: Text color of axis tick labels.
    from_schema: https://w3id.org/scverse/vega-scverse/axes
    rank: 1000
    slot_uri: rgbHexSlot
    alias: labelColor
    owner: Axis
    domain_of:
    - Axis
    - Legend
    range: string
  labelOpacity:
    name: labelOpacity
    description: Opacity of axis tick labels.
    from_schema: https://w3id.org/scverse/vega-scverse/axes
    rank: 1000
    alias: labelOpacity
    owner: Axis
    domain_of:
    - Axis
    - Legend
    range: float
    minimum_value: 0
    maximum_value: 1
  labelFont:
    name: labelFont
    description: Font name for axis tick labels.
    from_schema: https://w3id.org/scverse/vega-scverse/axes
    rank: 1000
    alias: labelFont
    owner: Axis
    domain_of:
    - Axis
    - Legend
    range: string
  labelFontSize:
    name: labelFontSize
    description: Font size of axis tick labels.
    from_schema: https://w3id.org/scverse/vega-scverse/axes
    rank: 1000
    alias: labelFontSize
    owner: Axis
    domain_of:
    - Axis
    - Legend
    range: float
  labelFontStyle:
    name: labelFontStyle
    description: Font style of axis tick labels
    from_schema: https://w3id.org/scverse/vega-scverse/axes
    rank: 1000
    alias: labelFontStyle
    owner: Axis
    domain_of:
    - Axis
    - Legend
    range: FontStyleEnum
  labelFontWeight:
    name: labelFontWeight
    description: Font weight of axis tick labels.
    from_schema: https://w3id.org/scverse/vega-scverse/axes
    rank: 1000
    alias: labelFontWeight
    owner: Axis
    domain_of:
    - Axis
    - Legend
    range: FontWeightEnum
  ticks:
    name: ticks
    description: A boolean flag indicating if ticks should be included as part of
      the axis.
    from_schema: https://w3id.org/scverse/vega-scverse/axes
    rank: 1000
    ifabsent: 'True'
    alias: ticks
    owner: Axis
    domain_of:
    - Axis
    range: boolean
  tickOpacity:
    name: tickOpacity
    description: Opacity of axis ticks.
    from_schema: https://w3id.org/scverse/vega-scverse/axes
    rank: 1000
    alias: tickOpacity
    owner: Axis
    domain_of:
    - Axis
    range: float
    minimum_value: 0
    maximum_value: 1
  tickColor:
    name: tickColor
    description: Color of axis ticks.
    from_schema: https://w3id.org/scverse/vega-scverse/axes
    rank: 1000
    slot_uri: rgbHexSlot
    alias: tickColor
    owner: Axis
    domain_of:
    - Axis
    range: string
  tickCap:
    name: tickCap
    description: The stroke cap for axis tick marks. One of "butt" (default), "round"
      or "square".
    from_schema: https://w3id.org/scverse/vega-scverse/axes
    rank: 1000
    alias: tickCap
    owner: Axis
    domain_of:
    - Axis
    range: CapEnum
  tickWidth:
    name: tickWidth
    description: Width in pixels of axis ticks.
    from_schema: https://w3id.org/scverse/vega-scverse/axes
    rank: 1000
    alias: tickWidth
    owner: Axis
    domain_of:
    - Axis
    range: float
    minimum_value: 0
  tickSize:
    name: tickSize
    description: The length in pixels of axis ticks.
    from_schema: https://w3id.org/scverse/vega-scverse/axes
    rank: 1000
    alias: tickSize
    owner: Axis
    domain_of:
    - Axis
    range: float
    minimum_value: 0
  values:
    name: values
    description: "Explicitly set the visible axis tick and label values. The array\
      \ entries should be legal values in the \nbacking scale domain."
    from_schema: https://w3id.org/scverse/vega-scverse/axes
    rank: 1000
    alias: values
    owner: Axis
    domain_of:
    - Axis
    range: string
    required: true
    multivalued: true
    any_of:
    - range: float
    - range: integer
  zindex:
    name: zindex
    description: "The integer z-index indicating the layering of the axis group relative\
      \ to other axis, mark, and legend groups. \nThe default value is 0 and axes\
      \ and grid lines are drawn behind any marks defined in the same specification\
      \ \nlevel. Higher values (1) will cause axes and grid lines to be drawn on top\
      \ of marks."
    from_schema: https://w3id.org/scverse/vega-scverse/axes
    rank: 1000
    alias: zindex
    owner: Axis
    domain_of:
    - Axis
    - Legend
    - Mark
    - TextMark
    range: float
    required: true