primeng
Version:
PrimeNG is a premium UI library for Angular featuring a rich set of 90+ components, a theme designer, various theme alternatives such as Material, Bootstrap, Tailwind, premium templates and professional support. In addition, it integrates with PrimeBlock,
209 lines (205 loc) • 8.82 kB
TypeScript
import { MeterGroupPassThrough, MeterItem, MeterGroupOrientation, MeterGroupLabelPosition, MeterGroupLabelTemplateContext, MeterGroupMeterTemplateContext, MeterGroupIconTemplateContext } from 'primeng/types/metergroup';
export * from 'primeng/types/metergroup';
import * as _angular_core from '@angular/core';
import { TemplateRef } from '@angular/core';
import { BaseComponent } from 'primeng/basecomponent';
import * as i1 from 'primeng/bind';
import { Bind } from 'primeng/bind';
import { BaseStyle } from 'primeng/base';
import * as i2 from 'primeng/api';
/**
*
* MeterGroup is a group of process status indicators.
*
* [Live Demo](https://www.primeng.org/metergroup)
*
* @module metergroupstyle
*
*/
declare enum MeterGroupClasses {
/**
* Class name of the root element
*/
root = "p-metergroup",
/**
* Class name of the meters element
*/
meters = "p-metergroup-meters",
/**
* Class name of the meter element
*/
meter = "p-metergroup-meter",
/**
* Class name of the label list element
*/
labelList = "p-metergroup-label-list",
/**
* Class name of the label element
*/
label = "p-metergroup-label",
/**
* Class name of the label icon element
*/
labelIcon = "p-metergroup-label-icon",
/**
* Class name of the label marker element
*/
labelMarker = "p-metergroup-label-marker",
/**
* Class name of the label text element
*/
labelText = "p-metergroup-label-text"
}
declare class MeterGroupStyle extends BaseStyle {
name: string;
style: string;
classes: {
root: ({ instance }: {
instance: any;
}) => (string | {
'p-metergroup-horizontal': boolean;
'p-metergroup-vertical': boolean;
})[];
meters: string;
meter: string;
labelList: ({ instance }: {
instance: any;
}) => (string | {
'p-metergroup-label-list-vertical': boolean;
'p-metergroup-label-list-horizontal': boolean;
})[];
label: string;
labelIcon: string;
labelMarker: string;
labelText: string;
};
static ɵfac: _angular_core.ɵɵFactoryDeclaration<MeterGroupStyle, never>;
static ɵprov: _angular_core.ɵɵInjectableDeclaration<MeterGroupStyle>;
}
interface MeterGroupStyle extends BaseStyle {
}
declare class MeterGroupLabel extends BaseComponent<MeterGroupPassThrough> {
value: _angular_core.InputSignal<MeterItem[]>;
labelPosition: _angular_core.InputSignal<MeterGroupLabelPosition>;
labelOrientation: _angular_core.InputSignal<MeterGroupOrientation>;
min: _angular_core.InputSignal<number | undefined>;
max: _angular_core.InputSignal<number | undefined>;
iconTemplate: _angular_core.InputSignal<TemplateRef<MeterGroupIconTemplateContext> | undefined>;
parentInstance: MeterGroup;
_componentStyle: MeterGroupStyle;
dataP: _angular_core.Signal<string>;
getIconTemplateContext(labelItem: MeterItem): MeterGroupIconTemplateContext;
static ɵfac: _angular_core.ɵɵFactoryDeclaration<MeterGroupLabel, never>;
static ɵcmp: _angular_core.ɵɵComponentDeclaration<MeterGroupLabel, "p-metergrouplabel", never, { "value": { "alias": "value"; "required": false; "isSignal": true; }; "labelPosition": { "alias": "labelPosition"; "required": false; "isSignal": true; }; "labelOrientation": { "alias": "labelOrientation"; "required": false; "isSignal": true; }; "min": { "alias": "min"; "required": false; "isSignal": true; }; "max": { "alias": "max"; "required": false; "isSignal": true; }; "iconTemplate": { "alias": "iconTemplate"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
}
/**
* MeterGroup displays scalar measurements within a known range.
* @group Components
*/
declare class MeterGroup extends BaseComponent<MeterGroupPassThrough> {
componentName: string;
$pcMeterGroup: MeterGroup | undefined;
bindDirectiveInstance: Bind;
/**
* Current value of the metergroup.
* @group Props
*/
value: _angular_core.InputSignal<MeterItem[] | undefined>;
/**
* Mininum boundary value.
* @group Props
*/
min: _angular_core.InputSignal<number>;
/**
* Maximum boundary value.
* @group Props
*/
max: _angular_core.InputSignal<number>;
/**
* Specifies the layout of the component, valid values are 'horizontal' and 'vertical'.
* @group Props
*/
orientation: _angular_core.InputSignal<MeterGroupOrientation>;
/**
* Specifies the label position of the component, valid values are 'start' and 'end'.
* @group Props
*/
labelPosition: _angular_core.InputSignal<MeterGroupLabelPosition>;
/**
* Specifies the label orientation of the component, valid values are 'horizontal' and 'vertical'.
* @group Props
*/
labelOrientation: _angular_core.InputSignal<MeterGroupOrientation>;
/**
* Custom label template.
* @param {MeterGroupLabelTemplateContext} context - label context.
* @see {@link MeterGroupLabelTemplateContext}
* @group Templates
*/
labelTemplate: _angular_core.Signal<TemplateRef<MeterGroupLabelTemplateContext> | undefined>;
/**
* Custom meter template.
* @param {MeterGroupMeterTemplateContext} context - meter context.
* @see {@link MeterGroupMeterTemplateContext}
* @group Templates
*/
meterTemplate: _angular_core.Signal<TemplateRef<MeterGroupMeterTemplateContext> | undefined>;
/**
* Custom end template.
* @param {MeterGroupLabelTemplateContext} context - end context.
* @see {@link MeterGroupLabelTemplateContext}
* @group Templates
*/
endTemplate: _angular_core.Signal<TemplateRef<MeterGroupLabelTemplateContext> | undefined>;
/**
* Custom start template.
* @param {MeterGroupLabelTemplateContext} context - start context.
* @see {@link MeterGroupLabelTemplateContext}
* @group Templates
*/
startTemplate: _angular_core.Signal<TemplateRef<MeterGroupLabelTemplateContext> | undefined>;
/**
* Custom icon template.
* @param {MeterGroupIconTemplateContext} context - icon context.
* @see {@link MeterGroupIconTemplateContext}
* @group Templates
*/
iconTemplate: _angular_core.Signal<TemplateRef<MeterGroupIconTemplateContext> | undefined>;
onAfterViewChecked(): void;
_componentStyle: MeterGroupStyle;
vertical: _angular_core.Signal<boolean>;
totalPercent: _angular_core.Signal<number>;
percentages: _angular_core.Signal<number[]>;
labelTemplateContext: _angular_core.Signal<MeterGroupLabelTemplateContext>;
meterItems: _angular_core.Signal<MeterItem[]>;
isLabelStart: _angular_core.Signal<boolean>;
isLabelEnd: _angular_core.Signal<boolean>;
showDefaultLabel: _angular_core.Signal<boolean>;
dataP: _angular_core.Signal<string>;
constructor();
percent(meter?: number): number;
percentValue(meter?: number): string;
meterStyle(val: MeterItem): {
backgroundColor: string | undefined;
width: string | undefined;
height: string | undefined;
};
showDefaultMeter(meterItem: MeterItem): boolean;
getMeterTemplateContext(meterItem: MeterItem, index: number): {
$implicit: MeterItem;
index: number;
orientation: MeterGroupOrientation;
class: string | undefined;
size: string;
totalPercent: number;
dataP: string;
};
static ɵfac: _angular_core.ɵɵFactoryDeclaration<MeterGroup, never>;
static ɵcmp: _angular_core.ɵɵComponentDeclaration<MeterGroup, "p-metergroup, p-meter-group", never, { "value": { "alias": "value"; "required": false; "isSignal": true; }; "min": { "alias": "min"; "required": false; "isSignal": true; }; "max": { "alias": "max"; "required": false; "isSignal": true; }; "orientation": { "alias": "orientation"; "required": false; "isSignal": true; }; "labelPosition": { "alias": "labelPosition"; "required": false; "isSignal": true; }; "labelOrientation": { "alias": "labelOrientation"; "required": false; "isSignal": true; }; }, {}, ["labelTemplate", "meterTemplate", "endTemplate", "startTemplate", "iconTemplate"], never, true, [{ directive: typeof i1.Bind; inputs: {}; outputs: {}; }]>;
}
declare class MeterGroupModule {
static ɵfac: _angular_core.ɵɵFactoryDeclaration<MeterGroupModule, never>;
static ɵmod: _angular_core.ɵɵNgModuleDeclaration<MeterGroupModule, never, [typeof MeterGroup, typeof i2.SharedModule], [typeof MeterGroup, typeof i2.SharedModule]>;
static ɵinj: _angular_core.ɵɵInjectorDeclaration<MeterGroupModule>;
}
export { MeterGroup, MeterGroupClasses, MeterGroupLabel, MeterGroupModule, MeterGroupStyle };