Last updated

API / geotoolkit / gauges / layout / GaugeLayout / GaugeLayout

Class: GaugeLayout

layout.GaugeLayout.GaugeLayout

Defines a layout for gauges

Hierarchy

Table of contents

Constructors
Methods

Contents

Constructors

new GaugeLayout(options)

new GaugeLayout(options?)

Parameters

Name Type
Optional optionsOptions
Methods

getClassName

getClassName(): string

Returns

string


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


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


removeRegion

removeRegion(name): GaugeLayout

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

Parameters

Name Type Description
namestringName of the region

Returns

GaugeLayout


setCustomRegionParams

setCustomRegionParams(name, params): GaugeLayout

Changes parameters of custom regions

Parameters

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

Returns

GaugeLayout


updateCssRegions

updateCssRegions(): void

Parser region CSS parameters and updates regions accordingly

Returns

void


getClassName

Static getClassName(): string

Returns

string