Set the color of the widget.

Important: This function is deprecated and may be removed in the future.  Use “$zopim.livechat.theme.setColor” instead.

Note: theme.reload must be called after setColor for changes to take effect (see example below).

Parameters

Example

<script>

  $zopim(function() {
    $zopim.livechat.window.setColor('#FFCC00');
    $zopim.livechat.theme.reload(); // apply new theme settings
  });

</script>

Set the size of the chat window.  Allowed values: small, medium, large.

Parameters

Example

Select size:
<a href="javascript:void($zopim.livechat.window.setSize('small'))">Small</a>
<a href="javascript:void($zopim.livechat.window.setSize('medium'))">Medium</a>
<a href="javascript:void($zopim.livechat.window.setSize('large'))">Large</a>

function show()

Show the chat window.

Mobile Widget (non-overlay mode only)

• If on a mobile device, attempts to open the live chat widget in a new window instead.
• May not work on some devices or configurations.
• Important: Should only be called from a user event listener callback.  See example for openPopout.

Example

<script>

  $zopim(function() {
    $zopim.livechat.window.show();
  });

</script>

function hide()

Hide the chat window.

Example

<script>

  $zopim(function() {
    $zopim.livechat.window.hide();
  });

</script>

function onShow( callback )

Register a callback to be fired when the chat window is shown.

Note: the callback will not be fired if the chat window was shown using an API call.

Parameters

function onHide( callback )

Register a callback to be fired when the chat window is hidden.

Note: the callback will not be fired if the chat window was hidden using an API call.

Parameters

function setTitle( title )

Set the title of the chat window.

Parameters

Example

<script>

  $zopim(function() {
    $zopim.livechat.window.setTitle('Zopim Chat Support');
  });

</script>

function toggle()

Toggle the visibility of the chat window.

Example

<script>

  $zopim(function() {
    $zopim.livechat.window.toggle();
  });

</script>

function getDisplay()

Get the current visibility of the chat window.

Example

<script>

  $zopim(function() {
    alert('Chat window is visible: ' + $zopim.livechat.window.getDisplay());
  });

</script>

function setOffsetVertical( distance )

Set the vertical offset of the chat window from the edge of the browser window.

Parameters

Example

<script>

  $zopim(function() {
    $zopim.livechat.window.setOffsetVertical(20);
  });

</script>

function setOffsetHorizontal( distance )

Set the horizontal offset of the chat window from the edge of the browser window.

Parameters

Example

<script>

  $zopim(function() {
    $zopim.livechat.window.setOffsetHorizontal(30);
  });

</script>

function setPosition( position )

Set position of the chat window.

Allowed values

• br (Bottom right)
• bl (Bottom left)
• tr (Top right)
• tl (Top left)

Parameters

Example

Select chat window position:
<a href="javascript:void($zopim.livechat.window.setPosition('br'))">Bottom right</a>
<a href="javascript:void($zopim.livechat.window.setPosition('bl'))">Bottom left</a>
<a href="javascript:void($zopim.livechat.window.setPosition('tr'))">Top right</a>
<a href="javascript:void($zopim.livechat.window.setPosition('tl'))">Top left</a>

function openPopout()

Attempts to open the live chat widget in a new window.  On the mobile widget, this API will ignore the “Overlay Window” setting in dashboard and open a new window/tab.  If simply showing the mobile overlay window is the intended behavior, use “$zopim.livechat.window.show” instead.

May not work on some devices or configurations.

Important: Should only be called from a user event listener callback.  See example.

Example

<a href="javascript:void($zopim.livechat.window.openPopout())">Open chat in new window</a>