Last updated

API / geotoolkit / gauges / layout / CircularLayout / CircularLayout

Class: CircularLayout

layout.CircularLayout.CircularLayout

Defines layout for circular gauges

Hierarchy

Table of contents

Constructors
Methods

Contents

Constructors

new CircularLayout(options)

new CircularLayout(options?)

Parameters

Name Type
Optional optionsOptions

Overrides

GaugeLayout.constructor

Methods

getClassName

getClassName(): string

Returns

string

Inherited from

GaugeLayout.getClassName


getCustomComponent

getCustomComponent(name): Node

Returns a custom component which was registered by provided name

Parameters

Name Type Description
namestringName of component to return

Returns

Node

Inherited from

GaugeLayout.getCustomComponent


isCustomRegion

isCustomRegion(name): boolean

Checks if the region with this name is a custom region

Parameters

Name Type Description
namestringName of the region to test

Returns

boolean

Inherited from

GaugeLayout.isCustomRegion


removeRegion

removeRegion(name): CircularLayout

Deletes a region from the layout. Only custom added regions can be removed.

Parameters

Name Type Description
namestringName of the region

Returns

CircularLayout

Inherited from

GaugeLayout.removeRegion


setCustomRegionParams

setCustomRegionParams(name, params): CircularLayout

Changes parameters of custom regions

Parameters

Name Type Description
namestringName of the custom region
paramsRegionJSON with CSS properties

Returns

CircularLayout

Inherited from

GaugeLayout.setCustomRegionParams


updateCssRegions

updateCssRegions(): void

Parser region CSS parameters and updates regions accordingly

Returns

void

Inherited from

GaugeLayout.updateCssRegions


getClassName

Static getClassName(): string

Returns

string

Inherited from

GaugeLayout.getClassName