Skip to content

Class: SymbolEncode

_A set of visual encoding properties that determine the position and appearance of a 'symbol' mark. _

_In Vega, there are three primary property sets: enter, update, exit. The enter properties are evaluated when data _

_is processed for the first time and a mark instance is newly added to a scene. The update properties are evaluated _

_for all existing (non-exiting) mark instances. The exit properties are evaluated when the data backing a mark is _

removed, and so the mark is leaving the visual scene. However, in this specification we currently only support

enter and update property sets for a 'symbol' mark.

URI: vega_scverse:SymbolEncode

classDiagram class SymbolEncode click SymbolEncode href "../SymbolEncode" SymbolEncode : enter SymbolEncode --> "1" PointsEncodeEnter : enter click PointsEncodeEnter href "../PointsEncodeEnter" SymbolEncode : update SymbolEncode --> "0..1" MarkEncodeUpdate : update click MarkEncodeUpdate href "../MarkEncodeUpdate"

Slots

Name Cardinality and Range Description Inheritance
enter 1
PointsEncodeEnter
Enter properties that are evaluated when points data is processed for the fir... direct
update 0..1
MarkEncodeUpdate
Update properties that are evaluated for all existing (non-exiting) mark inst... direct

Usages

used by used in type used
PointsMark encode range SymbolEncode

Identifier and Mapping Information

Schema Source

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

Mappings

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

LinkML Source

Direct

name: SymbolEncode
description: "A set of visual encoding properties that determine the position and\
  \ appearance of a 'symbol' mark. \nIn Vega, there are three primary property sets:\
  \ enter, update, exit. The enter properties are evaluated when data \nis processed\
  \ for the first time and a mark instance is newly added to a scene. The update properties\
  \ are evaluated \nfor all existing (non-exiting) mark instances. The exit properties\
  \ are evaluated when the data backing a mark is \nremoved, and so the mark is leaving\
  \ the visual scene. However, in this specification we currently only support\nenter\
  \ and update property sets for a 'symbol' mark."
from_schema: https://w3id.org/scverse/vega-scverse/specification
attributes:
  enter:
    name: enter
    description: "Enter properties that are evaluated when points data is processed\
      \ for the first time and the points mark \nis newly added to a scene."
    from_schema: https://w3id.org/scverse/vega-scverse/encode
    domain_of:
    - ImageEncode
    - LabelEncode
    - SymbolEncode
    - PathEncode
    - TextEncode
    - GroupEncode
    range: PointsEncodeEnter
    required: true
  update:
    name: update
    description: "Update properties that are evaluated for all existing (non-exiting)\
      \ mark instances. Usually defined if the \nuser specified a color to be used\
      \ for the PointsMark."
    from_schema: https://w3id.org/scverse/vega-scverse/encode
    domain_of:
    - LabelEncode
    - SymbolEncode
    - PathEncode
    range: MarkEncodeUpdate
    required: false

Induced

name: SymbolEncode
description: "A set of visual encoding properties that determine the position and\
  \ appearance of a 'symbol' mark. \nIn Vega, there are three primary property sets:\
  \ enter, update, exit. The enter properties are evaluated when data \nis processed\
  \ for the first time and a mark instance is newly added to a scene. The update properties\
  \ are evaluated \nfor all existing (non-exiting) mark instances. The exit properties\
  \ are evaluated when the data backing a mark is \nremoved, and so the mark is leaving\
  \ the visual scene. However, in this specification we currently only support\nenter\
  \ and update property sets for a 'symbol' mark."
from_schema: https://w3id.org/scverse/vega-scverse/specification
attributes:
  enter:
    name: enter
    description: "Enter properties that are evaluated when points data is processed\
      \ for the first time and the points mark \nis newly added to a scene."
    from_schema: https://w3id.org/scverse/vega-scverse/encode
    alias: enter
    owner: SymbolEncode
    domain_of:
    - ImageEncode
    - LabelEncode
    - SymbolEncode
    - PathEncode
    - TextEncode
    - GroupEncode
    range: PointsEncodeEnter
    required: true
  update:
    name: update
    description: "Update properties that are evaluated for all existing (non-exiting)\
      \ mark instances. Usually defined if the \nuser specified a color to be used\
      \ for the PointsMark."
    from_schema: https://w3id.org/scverse/vega-scverse/encode
    alias: update
    owner: SymbolEncode
    domain_of:
    - LabelEncode
    - SymbolEncode
    - PathEncode
    range: MarkEncodeUpdate
    required: false