Class VectorClusterStyleItem

breaks

• get breaks(): number[]

  An array of cluster sizes to break at. Typically the first couple of sizes are a series (meaning: not grouped). Later breaks are non sequential and used for grouping clusters larger. [2, 3, 4, 5, 10] would start grouping at clusters larger or equal 5 entries.

  Returns number[]

• set breaks(breaks: number[]): void

  Parameters

  • breaks: number[]

  Returns void

scaleFactor

• get scaleFactor(): number

  The factor by which to multiply the index of the used break grouping (subtracted by the zeroScaleOffset)

  Returns number

• set scaleFactor(scaleFactor: number): void

  Parameters

  • scaleFactor: number

  Returns void

template

• get template(): string | VectorClusterTemplateFunction

  Returns string | VectorClusterTemplateFunction

templateContext

• get templateContext(): Record<string, unknown> | undefined

  Returns Record<string, unknown> | undefined

• set templateContext(context: Record<string, unknown> | undefined): void

  Parameters

  • context: Record<string, unknown> | undefined

  Returns void

zeroScaleOffset

• get zeroScaleOffset(): number

  The index of breaks to st. for indexes [2, 3, 4, 5, 10] and a zeroScale offset of 3 would lead to icons 2, 3, 4 having the same size and no "+" attached. 5 and 10 would be scaled by the scale factor and a "+" added to the text

  Returns number

• set zeroScaleOffset(zeroScaleOffset: number): void

  Parameters

  • zeroScaleOffset: number

  Returns void

StaticclassName

• get className(): string

  Returns string

constructor

• new VectorClusterStyleItem(
      options: VectorClusterStyleItemOptions,
  ): VectorClusterStyleItem

  Parameters

  • options: VectorClusterStyleItemOptions

  Returns VectorClusterStyleItem

clearCache

• clearCache(): void

  Clears the style cache to ensure new changes can take effect.

  Returns void

  Api

createStyleFunction

• createStyleFunction(
      getLayerByName: (layerName: string) => VectorLayer | undefined,
  ): StyleFunction

  Parameters

  • getLayerByName: (layerName: string) => VectorLayer | undefined

  Returns StyleFunction

destroy

• destroy(): void

  Returns void

determineScale

• determineScale(size: number): number

  Determines the scale based on break index and zeroScaleOffset. Cluster sizes with an index less then zeroScaleOffset are not scaled.

  Parameters

  • size: number

  Returns number

equals

• equals(other: VectorClusterStyleItem): boolean

  Parameters

  • other: VectorClusterStyleItem

  Returns boolean

findBreakIndex

• findBreakIndex(size: number): number

  Finds the breaks index of a specified cluster size.

  Parameters

  • size: number

  Returns number

getClusterText

• getClusterText(size: number): string

  Gets the cluster text based on breaks and zeroScaleOffset. Adds a + to all sizes with an index larger then the zeroScaleOffset.

  Parameters

  • size: number

  Returns string

setTemplate

• setTemplate(template: string | VectorClusterTemplateFunction): void

  Parameters

  • template: string | VectorClusterTemplateFunction

  Returns void

toJSON

• toJSON(
      defaultOptions?: Required<
          Omit<VectorClusterStyleItemOptions, "templateContext">,
      > & Pick<VectorClusterStyleItemOptions, "templateContext">,
  ): VectorClusterStyleItemOptions

  Parameters

  • defaultOptions: Required<Omit<VectorClusterStyleItemOptions, "templateContext">> & Pick<
        VectorClusterStyleItemOptions,
        "templateContext",
    > = ...

  Returns VectorClusterStyleItemOptions

StaticgetDefaultOptions

• getDefaultOptions(): Required<
      Omit<VectorClusterStyleItemOptions, "templateContext">,
  > & Pick<VectorClusterStyleItemOptions, "templateContext">

  Returns Required<Omit<VectorClusterStyleItemOptions, "templateContext">> & Pick<
      VectorClusterStyleItemOptions,
      "templateContext",
  >

styleChanged