Class pvc.options.varia.Size
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
Describes the size
of the horizontal and vertical dimensions
of an axis aligned box.
|
| Field Attributes | Field Name and Description |
|---|---|
Class Detail
pvc.options.varia.Size
Describes the size
of the horizontal and vertical dimensions
of an axis aligned box.
It is used to describe the margins and the paddings of panels.
It is possible to specify any combination of the size properties.
All size properties support values in absolute or relative units:
- absolute
- if it is a number or a numeric string, the measure is in pixel units
- relative
- if it is a numeric string with a "%" suffix, the measure is a percentage of some reference size; usually, the reference size is the container panel's corresponding size
The special property, all, affects all unspecified properties at once.
The following is an example of a size-structured object, the hypothetical size of a title panel:
var titleSize = {width: '80%', all: 100};
It says that
the height has 100 pixels,
and that the width is 80 percent of the base panel's width.
Single number or numeric string interpretation
All chart options of type Size allow specifying a number or a string of a single number, possibly followed by a "%" sign, instead of the JSON form.The interpretation of what the number or percentage stand for depends on the specific option. In the legend and title panels, for example, it is the size of the dimension orthogonal to the anchored to side. So if a legend is anchored to the 'left' side, the number or percentage is the legend's width.
String syntax
All chart options of type Size also allow specifying a string with a fixed structure.The following shows the equivalence between the string and JSON syntax:
var size1 = '1'; // {all: '1'}
var size2 = '1 2'; // {width: '1', height: '2'}
Field Detail
{number|string}
all
{number|string}
height
{number|string}
width