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): 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): void

• Parameters

  • scaleFactor: number

  Returns void

template

• get template(): string | VectorClusterTemplateFunction

• Returns string | VectorClusterTemplateFunction

templateContext

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

• Returns undefined | Record<string, unknown>

• set templateContext(context): void

• Parameters

  • context: undefined | Record<string, unknown>

  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): void

• Parameters

  • zeroScaleOffset: number

  Returns void

StaticclassName

• get className(): string

• Returns string

constructor

• new VectorClusterStyleItem(options): 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): StyleFunction

• Parameters

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

      • Parameters

        • layerName: string

        Returns undefined | VectorLayer

  Returns StyleFunction

destroy

• destroy(): void

• Returns void

determineScale

• determineScale(size): 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): boolean

• Parameters

  • other: VectorClusterStyleItem

  Returns boolean

findBreakIndex

• findBreakIndex(size): number

• Finds the breaks index of a specified cluster size.

  Parameters

  • size: number

  Returns number

getClusterText

• getClusterText(size): 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): void

• Parameters

  • template: string | VectorClusterTemplateFunction

  Returns void

toJSON

• toJSON(): VectorClusterStyleItemOptions

• Returns VectorClusterStyleItemOptions

StaticgetDefaultOptions

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

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

styleChanged