HorizontalRendering
internal

Handles event rendering in Schedulers horizontal mode. Reacts to project/store changes to keep the UI up to date.

No results

Configs

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

bufferSize : Number150

Amount of pixels to extend the current visible range at both ends with when deciding which events to render. Only applies when using labels or for milestones

Functions

Functions are methods available for calling on the class

addTemporaryDragElement( eventRecord, resourceRecord )

private

Used by event drag features to bring into existence event elements that are outside of the rendered block.
calculateHorizontalPosition( renderData, startMS, endMS, durationMS )
: Object/null

private

Fills render data with insetInlineStart and width properties
calculateMS( eventRecord, startDateField, endDateField, useEventBuffer, resourceRecord )
: Object

private

Converts a start/endDate into a MS value used when rendering the event. If scheduler is configured with fillTicks: true the value returned will be snapped to tick start/end.
fillTimeSpanHorizontalPosition( renderData )
: Boolean

private

Populates render data with information about width and horizontal position of the wrap.
getConnectorEndSide( eventRecord )
: 'start'/'end'/'top'/'bottom'

Gets displaying item end side
getConnectorStartSide( eventRecord )
: 'start'/'end'/'top'/'bottom'

Gets displaying item start side
getRowRegion( rowRecord, startDate, endDate )
: Rectangle

Gets the Region, relative to the timeline view element, representing the passed row and optionally just for a certain date interval.
getScheduleRegion( resourceRecord, eventRecord )
: Rectangle

Gets the region, relative to the page, represented by the schedule and optionally only for a single resource. This method will call getDateConstraints to allow for additional resource/event based constraints. By overriding that method you can constrain events differently for different resources.
getTimeSpanRenderData( timeSpan, rowRecord, includeOutsidefalse )
: Object

private

Gets timespan coordinates etc. Relative to containing row. If the timespan is outside of the zone in which timespans are rendered, that is outside of the TimeAxis, or outside of the vertical zone in which timespans are rendered, then undefined is returned.
refreshEventsForResource( recordOrRow, forcetrue )

internal

Refresh events for resource record (or Row), clearing its cache and forcing DOM refresh.
refreshResources( ids, shouldAnimatetrue )

private

Clears and redraws resources directly. Respects schedulers refresh suspension
refreshResourcesWhenReady( resourceIds )

private

Clears resources directly and redraws them on next project refresh
setupRenderData( timeSpan, rowRecord )
: HorizontalRenderData

private

Returns event render data except actual position information.

Type definitions

HorizontalRenderData

private
Properties
- eventRecord : EventModel
  Event record
- start : Date
  
  Span start
- end : Date
  
  Span end
- rowId : String
  
  Id of the resource row
- children : DomConfig[]
  
  Child elements
- startMS : Number
  
  Wrap element start in milliseconds
- endMS : Number
  
  Span Wrap element end in milliseconds
- durationMS : Number
  
  Wrap duration in milliseconds (not just a difference between start and end)
- innerStartMS : Number
  
  Actual event start in milliseconds
- innerEndMS : Number
  
  Actual event end in milliseconds
- innerDurationMS : Number
  
  Actual event duration in milliseconds
- startsOutsideView : Boolean
  
  True if span starts before time axis start
- endsOutsideView : Boolean
  
  True if span ends after time axis end
- left : Number
  
  Absolute left coordinate of the wrap element
- width : Number
  Width
- top : Number
  
  Absolute top coordinate of the wrap element (can be changed by layout)
- height : Number
  Height
- clippedStart : Boolean
  
  True if start is clipped
- clippedEnd : Boolean
  
  True if end is clipped

Source path

Scheduler/view/orientation/HorizontalRendering.js

Inheritance tree1

HorizontalRendering

HorizontalRendering internal