Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface BoxDataCentered

Interface for specifying properties of a box.

Non-geometry properties are explained in BoxData interface.

This interface defines the box using a center coordinate and size. For another geometry definitions, see:

Index

Properties

Optional color

color : Color

Color of this box, when the series is styled as IndividualPointFill.

Optional id

id : string | number

Identifier of this box.

Can be used to alter the boxes' properties afterwards.

Optional value

value : undefined | number

Look-up value for this box, when the series is styled as PalettedFill.

Determines the color of the box.

xCenter

xCenter : number

Center X coordinate of Box.

xSize

xSize : number

X size of Box. Applied both ways from 'xCenter' divided by 2.

yCenter

yCenter : number

Center Y coordinate of Box.

ySize

ySize : number

Y size of Box. Applied both ways from 'yCenter' divided by 2.

zCenter

zCenter : number

Center Z coordinate of Box.

zSize

zSize : number

Z size of Box. Applied both ways from 'zCenter' divided by 2.