Class MarkerGroup

constructor

• new MarkerGroup(
      session: EditSession,
      options?: { markerType: "fullLine" | "line" },
  ): MarkerGroup

• Parameters

  • session: EditSession
  • Optionaloptions: { markerType: "fullLine" | "line" }

    Options controlling the behvaiour of the marker. User markerType to control how the markers which are part of this group will be rendered:

    • undefined: uses text type markers where only text characters within the range will be highlighted.
    • fullLine: will fully highlight all the rows within the range, including the characters before and after the range on the respective rows.
    • line: will fully highlight the lines within the range but will only cover the characters between the start and end of the range.

  Returns MarkerGroup

markers

markerType

MAX_MARKERS

session

getMarkerAtPosition

• getMarkerAtPosition(pos: Point): MarkerGroupItem

• Finds the first marker containing pos

  Parameters

  • pos: Point

  Returns MarkerGroupItem

markersComparator

• markersComparator(a: MarkerGroupItem, b: MarkerGroupItem): number

• Comparator for Array.sort function, which sorts marker definitions by their positions

  Parameters

  • a: MarkerGroupItem

    first marker.
  • b: MarkerGroupItem

    second marker.

  Returns number

  negative number if a should be before b, positive number if b should be before a, 0 otherwise.

setMarkers

• setMarkers(markers: MarkerGroupItem[]): void

• Sets marker definitions to be rendered. Limits the number of markers at MAX_MARKERS.

  Parameters

  • markers: MarkerGroupItem[]

    an array of marker definitions.

  Returns void

update

• update(
      html: any,
      markerLayer: Marker,
      session: EditSession,
      config: LayerConfig,
  ): void

• Parameters

  • html: any
  • markerLayer: Marker
  • session: EditSession
  • config: LayerConfig

  Returns void