✅ You are viewing documentation for the latest version of Compose SDK.

Version:

# Interface CalendarHeatmapStyleOptions

Configuration options that define functional style of the various elements of calendar-heatmap chart

# Properties

# cellLabels

cellLabels?: CalendarHeatmapCellLabels

Configuration for day numbers (1-31) in calendar cells

# dayLabels

dayLabels?: object

Configuration for weekday names in the header

# Type declaration

# dayLabels.enabled

enabled?: boolean

Boolean flag that defines if calendar weekday names should be shown

# Default
true
# dayLabels.style

style?: TextStyle

Style configuration for calendar weekday names

Deprecated

Please use textStyle instead

# dayLabels.textStyle

textStyle?: TextStyle

Style configuration for calendar weekday names

# height

height?: number

Total height of the component, which is considered in the following order of priority:

Value passed to this property (in pixels).
Height of the container wrapping this component
Default value of 400px (for component without header) or 425px (for component with header).

# monthLabels

monthLabels?: object

Configuration for month names in multi-month view types

# Type declaration

# monthLabels.enabled

enabled?: boolean

Boolean flag that defines if month names should be shown

# Default
true
# monthLabels.style

style?: TextStyle

Style configuration for month names

Deprecated

Please use textStyle instead

# monthLabels.textStyle

textStyle?: TextStyle

Style configuration for month names

# pagination

pagination?: object

Configuration for pagination controls in multi-month view types

# Type declaration

# pagination.enabled

enabled?: boolean

Boolean flag that defines if pagination controls should be shown

# Default
true
# pagination.startMonth

startMonth?: Date

Start month to display when the chart is first rendered

# pagination.textStyle

textStyle?: TextStyle

Style configuration for pagination controls text

# startOfWeek

startOfWeek?: CalendarDayOfWeek

Determines which day of the week to start the calendar with

# Default

'sunday'

# viewType

viewType?: CalendarHeatmapViewType

View type determines how many months to display: 'month' (1), 'quarter' (3), 'half-year' (6), 'year' (12)

# weekends

weekends?: object

Configuration for weekend days

# Type declaration

# weekends.cellColor

cellColor?: string

Calendar cell color for weekend days

# Default
'#e6e6e6'
# weekends.days

days?: CalendarDayOfWeek[]

Weekend days - defaults to ['saturday', 'sunday']

# weekends.enabled

enabled?: boolean

Boolean flag that enables/disables weekend highlighting

# Default
false
# weekends.hideValues

hideValues?: boolean

Whether to hide values in tooltip for weekend days

# Default
false

# width

width?: number

Total width of the component, which is considered in the following order of priority:

Value passed to this property (in pixels)
Width of the container wrapping this component
Default value of 400px

# Interface CalendarHeatmapStyleOptions

# Properties

# cellLabels

# dayLabels

# Type declaration

# `dayLabels.enabled`

# Default

# `dayLabels.style`

# `dayLabels.textStyle`

# height

# monthLabels

# Type declaration

# `monthLabels.enabled`

# Default

# `monthLabels.style`

# `monthLabels.textStyle`

# Type declaration

# Default

# startOfWeek

# Default

# viewType

# weekends

# Type declaration

# `weekends.cellColor`

# Default

# `weekends.days`

# `weekends.enabled`

# Default

# `weekends.hideValues`

# Default

# width

Sisense

Support

Resources

# Interface CalendarHeatmapStyleOptions

# Properties

# cellLabels

# dayLabels

# Type declaration

# dayLabels.enabled

# Default

# dayLabels.style

# dayLabels.textStyle

# height

# monthLabels

# Type declaration

# monthLabels.enabled

# Default

# monthLabels.style

# monthLabels.textStyle

# pagination

# Type declaration

# pagination.enabled

# Default

# pagination.startMonth

# pagination.textStyle

# startOfWeek

# Default

# viewType

# weekends

# Type declaration

# weekends.cellColor

# Default

# weekends.days

# weekends.enabled

# Default

# weekends.hideValues

# Default

# width

Sisense

Support

Resources

# `dayLabels.enabled`

# `dayLabels.style`

# `dayLabels.textStyle`

# `monthLabels.enabled`

# `monthLabels.style`

# `monthLabels.textStyle`

# `pagination.enabled`

# `pagination.startMonth`

# `pagination.textStyle`

# `weekends.cellColor`

# `weekends.days`

# `weekends.enabled`

# `weekends.hideValues`