Oskari API documentation

Select request

admindown-arrow
frameworkdown-arrow
mappingdown-arrow
uidown-arrow

InfoBox.HideInfoBoxRequest RPC

Hide infobox from the map.

Use cases

  • hide specific infobox by given id
  • hide all infoboxes existing in UI

Description

Requests infobox to be hidden.

Parameters

(* means the parameter is required)

Name Type Description Default value
id String infobox's id. If not given, will hide all infoboxes existing in UI

Examples

Hide infobox with id 'myInfoBox':


var infoboxId = 'myInfoBox';
var sb = Oskari.getSandbox();
sb.postRequestByName('InfoBox.HideInfoBoxRequest', [infoboxId]);

Hide all infoboxes:


var sb = Oskari.getSandbox();
sb.postRequestByName('InfoBox.HideInfoBoxRequest');

Related api

  • ShowInfoBoxRequest
  • RefreshInfoBoxRequest
  • InfoBoxActionEvent
  • InfoBoxEvent