ScaleColumn

A specialized column showing a graduated scale from a defined array of values and labels. This column is used in the TimelineHistogram and is not editable. Normally you should not need to interact with this class directly.

Configs

Configs are options you supply in a configuration object when creating an instance of this class

field : String"scalePoints"

The name of the data model field to read scale point values from.

Has a corresponding runtime field property.

scalePoints : ScalePoint[]

Array of objects representing scale points. If not provided the column will try reading points from the displayed record field (scalePoints field by default).

new TimelineHistogram({
    columns : {
        type        : 'scale',
        scalePoints : [
            { text : '8h', value : 8 },
            { text : '16h', value : 16 },
            { text : '24h', value : 24 }
        ]
    }
})

Has a corresponding runtime scalePoints property.

Properties

Properties are getters/setters or publicly accessible variables on this class

isScaleColumn : Booleantrue

READONLY

static

ADVANCED

Identifies an object as an instance of ScaleColumn class, or subclass thereof.

field : String"scalePoints"

READONLY

The name of the data model field to read scale point values from.

Has a corresponding field config.

scalePoints : ScalePoint[]

Array of objects representing scale points. If not provided the column will try reading points from the displayed record field (scalePoints field by default).

new TimelineHistogram({
    columns : {
        type        : 'scale',
        scalePoints : [
            { text : '8h', value : 8 },
            { text : '16h', value : 16 },
            { text : '24h', value : 24 }
        ]
    }
})

Has a corresponding scalePoints config.

isScaleColumn : Booleantrue

READONLY

ADVANCED

Identifies an object as an instance of ScaleColumn class, or subclass thereof.

Type definitions

ScalePoint
An object representing a point on the scale displayed by ScaleColumn.
Properties
- value : Number
  
  Scale point value
- text : String
  
  Scale point label (if not provided the point won't display a label)
- unit : String
  
  Scale point value unit. This is used by the resource histogram and resource utilization views to match histogram bar values expressed in milliseconds to the scale. Please note The views read a scale unit to use from the last scale point of the provided scalePoints array. All points in the array are meant to use the same unit value.

ScaleColumn

See also

Configs

Properties

Type definitions

Properties

Source path

Inheritance tree4

Mixins5

Contents