TimelineHistogramScaleColumn
Mixin

Mixin of TimelineHistogram class that implements ScaleColumn automatic injection and functioning. It automatically adds and configures the scale column to display value axes alongside histogram bars.

Configs

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

scalePoints : ScalePoint[]
Array of objects representing the scale column scale points. The config basically is a mapping to the column scalePoints config.

If the config value is not provided the column will try reading it from the displayed record field (scalePoints field is expected by default).
```
new TimelineHistogram({
    scalePoints : [
        { text : '8h', value : 8 },
        { text : '16h', value : 16 },
        { text : '24h', value : 24 }
    ]
})
```
Has a corresponding runtime scalePoints property.
scaleColumn : ScaleColumnConfig
An object with configuration for the ScaleColumn.

Example:
```
new TimelineHistogram({
    scaleColumn : {
        width : 50
    },
    ...
});
```
Provide null to the config to get rid of the column completely:
```
new TimelineHistogram({
    // do not add scale column
    scaleColumn : null,
    ...
});
```
Has a corresponding runtime scaleColumn property.

Properties

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

isTimelineHistogramScaleColumn : Booleantrue

READONLY

static

ADVANCED

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

scalePoints : ScalePoint[]
Array of objects representing the scale column scale points. The config basically is a mapping to the column scalePoints config.

If the config value is not provided the column will try reading it from the displayed record field (scalePoints field is expected by default).
```
new TimelineHistogram({
    scalePoints : [
        { text : '8h', value : 8 },
        { text : '16h', value : 16 },
        { text : '24h', value : 24 }
    ]
})
```
Has a corresponding scalePoints config.
isTimelineHistogramScaleColumn : Booleantrue

READONLY

ADVANCED

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

READONLY

The locked grid scale column reference.

Has a corresponding scaleColumn config.

Functions

Functions are methods available for calling on the class

buildGroupHeader( renderData )

internal

Group feature hook triggered by the feature to render group headers
convertHistogramValueToUnits( value, unit )

internal

A hook to convert histogram values to scale point ones. In case they use different units.

Override this method in a sub-class to implement your custom application specific conversion.
convertUnitsToHistogramValue( value, unit )

internal

A hook to convert scale point values to histogram ones. In case they use different units.

Override this method in a sub-class to implement your custom application specific conversion.
renderRecordScale( record, renderData )

Renders record scale column content.

Source path

Scheduler/view/mixin/TimelineHistogramScaleColumn.js

Inheritance tree1

TimelineHistogramScaleColumn

TimelineHistogramScaleColumn
Mixin

See also

Configs

Properties

Functions

Source path

Inheritance tree1

Contents

TimelineHistogramScaleColumn Mixin

See also

Configs

Properties

Functions

Source path

Inheritance tree1

Contents

TimelineHistogramScaleColumn
Mixin