Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Implements

  • SGLineItem

Index

Constructors

constructor

Properties

Optional ariaDescription

ariaDescription?: string

Optional ariaTitle

ariaTitle?: string

channels

channels: {} = {}

Event channels are a mapping of event names to their output channel.

Type declaration

  • [name: string]: string

Optional cursor

cursor?: string

The mouse cursor used over the mark. Any valid CSS cursor type can be used.

Optional defined

defined?: boolean

Optional fill

fill?: string = 'none'

The fill color.

Optional fillOpacity

fillOpacity?: number

The fill opacity from 0 (transparent) to 1 (opaque).

Optional height

height?: number

The height of the mark in pixels, if supported.

Optional href

href?: string

A URL to load upon mouse click. If defined, the mark acts as a hyperlink.

Optional interpolate

interpolate?: Interpolation = ...

Readonly itemtype

itemtype: MarkType = ...

metadata

metadata: Metadata = ...

Metadata about this mark

nodetype

nodetype: SGNodeType = ...

Optional opacity

opacity?: number

The mark opacity from 0 (transparent) to 1 (opaque).

Optional parent

parent?: SGNode

The parent node of this scene node

Optional parentType

parentType?: SGNodeType

The type of parent we have

Optional stroke

stroke?: string = 'none'

The stroke color.

Optional strokeCap

strokeCap?: StrokeCap = ...

The stroke cap for line ending style. One of butt (default), round or square.

Optional strokeDash

strokeDash?: [number, number]

An array of [stroke, space] lengths for creating dashed or dotted lines.

Optional strokeDashOffset

strokeDashOffset?: number

The pixel offset at which to start the stroke dash array.

Optional strokeJoin

strokeJoin?: StrokeJoin = ...

The stroke line join method. One of miter (default), round or bevel.

Optional strokeMiterLimit

strokeMiterLimit?: number

The miter limit at which to bevel a line join.

Optional strokeOpacity

strokeOpacity?: number

The stroke opacity from 0 (transparent) to 1 (opaque).

Optional strokeWidth

strokeWidth?: number

The stroke width in pixels.

Optional tabIndex

tabIndex?: number

Optional tension

tension?: number

Optional tooltip

tooltip?: any

The tooltip text to show upon mouse hover. If the value is an object (other than a Date or an array), then all key-value pairs in the object will be shown in the tooltip, one per line (e.g., "key1: value1\nkey2: value2"). Array values will be shown in brackets [value1, value2, ...].

Other values will be coerced to strings. Nested object values will not be recursively printed.

Optional width

width?: number

The width of the mark in pixels, if supported.

Optional x

x?: number

The primary x-coordinate in pixels.

Optional x2

x2?: number

The secondary x-coordinate in pixels.

Optional xc

xc?: number

The center x-coordinate. Incompatible with x and x2.

Optional y

y?: number

The primary y-coordinate in pixels.

Optional y2

y2?: number

The secondary y-coordinate in pixels.

Optional yc

yc?: number

The center y-coordinate. Incompatible with y and y2.

Optional zIndex

zIndex?: number = 0

An integer z-index indicating the layering order of sibling mark items. The default value is 0. Higher values (1) will cause marks to be drawn on top of those with lower z-index values. Setting the z-index as an encoding property only affects ordering among sibling mark items; it will not change the layering relative to other mark definitions. Unlike the mark-level sort property, zindex changes the rendering order only; it does not otherwise change mark item order (such as line or area point order).

The most common use of zindex is to ensure that a mark is drawn over its siblings when selected, such as by mouse hover.

Static ITEM_TYPE

ITEM_TYPE: MarkType = ...