Skip to content

Main Navigation Guide

🇬🇧 English

🇨🇳 简体中文

🇬🇧 English

🇨🇳 简体中文

Appearance

Sidebar Navigation

getDom

getSize

setStyles

getStyles

setFormatter

getFormatter

setLocale

getLocale

setTimezone

getTimezone

setThousandsSeparator

getThousandsSeparator

setDecimalFold

getDecimalFold

setOffsetRightDistance

getOffsetRightDistance

setMaxOffsetLeftDistance

setMaxOffsetRightDistance

setLeftMinVisibleBarCount

setRightMinVisibleBarCount

setBarSpace

getBarSpace

setSymbol

getSymbol

setPeriod

getPeriod

setDataLoader

resetData

getDataList

getVisibleRange

createIndicator

overrideIndicator

getIndicators

removeIndicator

createOverlay

overrideOverlay

getOverlays

removeOverlay

setPaneOptions

getPaneOptions

setZoomEnabled

isZoomEnabled

setScrollEnabled

isScrollEnabled

scrollByDistance

scrollToRealTime

scrollToDataIndex

scrollToTimestamp

zoomAtCoordinate

zoomAtDataIndex

zoomAtTimestamp

convertToPixel

convertFromPixel

executeAction

subscribeAction

unsubscribeAction

getConvertPictureUrl

resize

On this page

getOverlays(filter?)

getOverlays get overlay information.

Reference

typescript

(
  filter?: {
    id?: string
    name?: string
    groupId?: string
    paneId?: string
  }
) => Overlay[]

Parameters

filter Filter conditions.
- id Overlay id.
- name Overlay name.
- groupId Group id.
- paneId Pane id.

Returns

getOverlays returns Overlay[] .

Usage

Basic usage

Edit this page on GitHub

Last updated:

Pager

Previous pageoverrideOverlay

Next pageremoveOverlay

Released under the Apache License V2.

getOverlays(filter?) ​

Reference ​

Parameters ​

Returns ​

Usage ​