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.button.setColor('#FFCC00');
    $zopim.livechat.theme.reload(); // apply new theme settings
  });

</script>

function setHideWhenOffline( bool )

Configure whether the chat button is displayed when the account is offline.

This setting may be overridden by other API functions.

Parameters

function hide()

Hide the chat button.

Example

<script>

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

</script>

function show()

Show the chat button.

Example

<script>

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

</script>

function setOffsetVertical( distance )

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

Parameters

Example

<script>

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

</script>

function setOffsetVerticalMobile( distance )

Set the vertical offset of the chat button on mobile from the edge of the browser window.

Parameters

Example

<script>

  $zopim(function() {
    $zopim.livechat.button.setOffsetVerticalMobile(20);
  });

</script>

function setOffsetHorizontal( distance )

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

Parameters

Example

<script>

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

</script>

function setOffsetHorizontalMobile( distance )

Set the horizontal offset of the chat button on mobile from the edge of the browser window.

Parameters

Example

<script>

  $zopim(function() {
    $zopim.livechat.button.setOffsetHorizontalMobile(30);
  });

</script>

function setPosition( position )

Set position of the chat button.

Allowed values

• br (Bottom right)
• bm (Bottom middle)
• bl (Bottom left)
• tr (Top right)
• tm (Top middle)
• tl (Top left)

Parameters

Example

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

function setPositionMobile( position )

Set the position of the chat button on mobile devices.

Allowed values

• br (Bottom right)
• bl (Bottom left)

Parameters