@liturgical-calendar/components-js
Version:
Liturgical calendar components for javascript: an html select populated with liturgical calendars supported by the Liturgical Calendar API; form controls for parameters that are supported by the Liturgical Calendar API; a webcalendar; and liturgy of the d
53 lines • 1.67 kB
TypeScript
/**
* Manages a set of column flags for the WebCalendar.
*/
export default class ColumnSet {
/**
* Constructor for ColumnSet class.
* @param {number|Column} columnFlag The initial column flags to set
*/
constructor(columnFlag?: number | Column);
/**
* Adds a column flag to the columnFlags property.
* @param {Column} columnFlag The column flag to add
*/
add(columnFlag: Column): void;
/**
* Removes a column flag from the columnFlags property.
* @param {Column} columnFlag The column flag to remove
*/
remove(columnFlag: Column): void;
/**
* Toggles a column flag.
* @param {Column} columnFlag The column flag to toggle
*/
toggle(columnFlag: Column): void;
/**
* Resets the columnFlags property to Column.NONE
*/
clear(): void;
/**
* Sets all column flags by setting columnFlags to Column.ALL
*/
setAll(): void;
/**
* Sets the columnFlags property to the given value.
* @param {number|Column} columnFlag The column flag to set
* @throws {Error} If the column flag is invalid
*/
set(columnFlag: number | Column): void;
/**
* Checks if a given column flag is set in the columnFlags property.
* @param {Column} columnFlag The column flag to check
* @returns {boolean} True if the given column flag is set
*/
has(columnFlag: Column): boolean;
/**
* Returns the value of the columnFlags property.
* @returns {number} The value of the columnFlags property
*/
get(): number;
#private;
}
import { Column } from '../Enums.js';
//# sourceMappingURL=ColumnSet.d.ts.map