.. highlightlang:: us

.. index:: LayerSetClip

.. _layersetclip:

LayerSetClip
============

.. us.tag  LayerSetClip NOTREADYENGLISH New300 LayerSet

:ref:`LayerSetClip` sets if datasets are clipped at the diagram borders. 

.. function::  bool = LayerSetClip(hLayer, nClip)

.. us.return

**Return Value**

If the function succeeds, the return value is TRUE (1); otherwise it is FALSE (0).

.. us.params

**Parameters**

.. uparam:: hLayer

   *hLayer* is the handle of a diagram (layer).

.. uparam:: nClip

   *nClip* is an OR combination of the following values.

   .. list-table::
      :header-rows: 1

      * - Value
        - Description
      * - G_CLIP_LEFT
        - Clip at the left border
      * - G_CLIP_RIGHT
        - Clip at the right border
      * - G_CLIP_TOP
        - Clip at the top border
      * - G_CLIP_BOTTOM
        - Clip at the bottom border

The following example set clipping for the left and right border::

   LayerSetClip(hLayer, G_CLIP_LEFT | G_CLIP_RIGHT);

The following example disables clipping::

   LayerSetClip(hLayer, 0);

.. seealso::
   :ref:`overview-diagrams`,
   :ref:`LayerGetClip`

:sub:`id-1497774`