@viewdo/dxp-story-cli/dist/app/models/configuration/support/DataPoint.d.ts

DXP Story Management CLI

import { DisplayType } from './DisplayType';
import { DataType } from './DataType';
import { DataTree } from './DataTree';
import { OptionItem } from './OptionItem';
export declare class DataPoint {
    constructor(dataPoint: any);
    /**
     * The input key.
     * @pattern ^[A-Za-z0-9-_]{1,30}$
     */
    key: string;
    /**
     * The input name (shown on DXP forms)
     */
    name: string;
    /**
     * The display-type when presenting this input on a page
     */
    display: DisplayType;
    /** @ignore */
    type: DataType;
    /**
     * The tooltip to display when presenting on a form.
     * @nullable
     */
    tip?: string;
    /**
     * The description to show along with the name when presenting this on a form.
     */
    description?: string;
    /** @ignore */
    order: number;
    /**
     * Mark this true to force this value be set when creating an experience.
     */
    required: boolean;
    /**
     * If the display-type is Options, these are the list of values the user will select from.
     */
    options?: Array<OptionItem>;
    /**
     * An object that describes a set of cascading options.
     * @nullable
     * */
    dataTree?: DataTree;
    /**
     * An whose name and values are assigned to the underlying HTML input.
     *
     */
    attributes?: {
        [Key: string]: string;
    };
    /**
     * This is the default value if no other value is input.
     *
     */
    value?: string | boolean | number;
}