LibreOffice
LibreOffice 25.8 SDK API Reference
Loading...
Searching...
No Matches
XColorScheme Interface Reference

import "XColorScheme.idl";

Inheritance diagram for XColorScheme:
XInterface

Public Member Functions

::com::sun::star::util::Color getColorByIndex ([in] long nIndex)
 returns the default color for the nth data series.
Public Member Functions inherited from XInterface
any queryInterface ([in] type aType)
 queries for a new interface to an existing UNO object.
void acquire ()
 increases the reference counter by one.
void release ()
 decreases the reference counter by one.

Member Function Documentation

◆ getColorByIndex()

::com::sun::star::util::Color getColorByIndex ( [in] long nIndex)

returns the default color for the nth data series.

This may be a system wide color or a color coming from a color scheme.

Usually there exist a fixed number of default colors. This method should always return a valid Color. If the index (i) is higher than the number of default colors (n), the method should return the modulus (i mod n), i.e., the colors should repeat in a cyclic way.

Parameters
nIndexThe index of the series. This is used to obtain the correct default color.

The documentation for this interface was generated from the following file: