LegendItem

Available for:Map Panel

Legend item - both for leaves and grouping nodes

Methods

Name Summary
get_id

Returns id of the legend item

get_isVisible

Returns whether legend item is visible

get_name

Returns end user visible name of the legend item

get_opacity

Returns layer's current opacity level

get_priority

Returns priority

getId

Returns id of the legend item

getIsVisible

Returns whether legend item is visible

getName

Returns end user visible name of the legend item

getOpacity

Returns layer's current opacity level

getPriority

Returns priority

remove

Removes legend item

set_isVisible

Sets visibility of the legend item

set_name

Sets the end user visible name of the legend item

set_opacity

Sets layer's opacity level

set_priority

Sets new priority

setIsVisible

Sets visibility of the legend item

setName

Sets the end user visible name of the legend item

setOpacity

Sets layer's opacity level

setPriority

Sets new priority

Methods • Details

get_id() → {String}

deprecated
Available for:Map Panel

Returns id of the legend item

Returns

TypeDescription
String

get_isVisible() → {Boolean}

deprecated
Available for:Map Panel

Returns whether legend item is visible

Returns

TypeDescription
Boolean

get_name() → {String}

deprecated
Available for:Map Panel

Returns end user visible name of the legend item

Returns

TypeDescription
String

get_opacity() → {Number}

deprecated
Available for:Map Panel

Returns layer's current opacity level

Returns

TypeDescription
Number

opacity level

get_priority() → {Number}

deprecated
Available for:Map Panel

Returns priority

Returns

TypeDescription
Number

priority

getId() → {String}

Available for:Map Panel

Returns id of the legend item

Returns

TypeDescription
String

getIsVisible() → {Boolean}

Available for:Map Panel

Returns whether legend item is visible

Returns

TypeDescription
Boolean

getName() → {String}

Available for:Map Panel

Returns end user visible name of the legend item

Returns

TypeDescription
String

getOpacity() → {Number}

Available for:Map Panel

Returns layer's current opacity level

Returns

TypeDescription
Number

opacity level

getPriority() → {Number}

Available for:Map Panel

Returns priority

Returns

TypeDescription
Number

priority

remove(callback, errback)

Available for:Map Panel

Removes legend item

Parameters

Name Type Description
callback function optional

callback executed if operation succeeds

errback function optional

callback executed if operation fails

set_isVisible(isVisible)

deprecated
Available for:Map Panel

Sets visibility of the legend item

Parameters

Name Type Description
isVisible Boolean

undefined

set_name(name)

deprecated
Available for:Map Panel

Sets the end user visible name of the legend item

Parameters

Name Type Description
name String

undefined

set_opacity(opacity)

deprecated
Available for:Map Panel

Sets layer's opacity level

Parameters

Name Type Description
opacity Number

level

set_priority(priority)

deprecated
Available for:Map Panel

Sets new priority

Parameters

Name Type Description
priority Number

undefined

setIsVisible(isVisible)

Available for:Map Panel

Sets visibility of the legend item

Parameters

Name Type Description
isVisible Boolean

undefined

setName(name)

Available for:Map Panel

Sets the end user visible name of the legend item

Parameters

Name Type Description
name String

undefined

setOpacity(opacity)

Available for:Map Panel

Sets layer's opacity level

Parameters

Name Type Description
opacity Number

level

setPriority(priority)

Available for:Map Panel

Sets new priority

Parameters

Name Type Description
priority Number

undefined