getColumnProperties
getColumnProperties(
columns):object
Defined in: metadata/actions/column/property.ts:3
Parameters
Section titled “Parameters”columns
Section titled “columns”({ name: string; property: { additionalItems?: unknown; allOf?: unknown; anyOf?: unknown; const?: unknown[]; contains?: unknown; default?: unknown[][]; description?: string; else?: unknown; enum?: unknown[]; examples?: unknown[][]; format?: undefined; if?: unknown; items?: unknown; maxContains?: number; maxItems?: number; minContains?: number; minItems?: number; missingValues?: (string | { label: string; value: string; })[]; not?: unknown; oneOf?: unknown; prefixItems?: unknown; rdfType?: string; then?: unknown; title?: string; type: "array"; uniqueItems?: boolean; }; required?: boolean; type: "array"; } | { name: string; property: { const?: string; default?: string[]; description?: string; enum?: string[]; examples?: string[]; format: "base64"; maxLength?: number; minLength?: number; missingValues?: (string | { label: string; value: string; })[]; pattern?: string; rdfType?: string; title?: string; type: "string"; }; required?: boolean; type: "base64"; } | { name: string; property: { const?: boolean; default?: boolean[]; description?: string; enum?: boolean[]; examples?: boolean[]; falseValues?: string[]; format?: undefined; missingValues?: (string | number | { label: string; value: string | number; })[]; rdfType?: string; title?: string; trueValues?: string[]; type: "boolean"; }; required?: boolean; type: "boolean"; } | { name: string; property: { categories?: (number | { label: string; value: number; })[]; const?: number; default?: number[]; description?: string; enum?: number[]; examples?: number[]; exclusiveMaximum?: number; exclusiveMinimum?: number; format: "categorical"; groupChar?: string; maximum?: number; minimum?: number; missingValues?: (string | number | { label: string; value: string | number; })[]; multipleOf?: number; rdfType?: string; title?: string; type: "integer"; withOrder?: boolean; withText?: boolean; } | { categories?: (string | { label: string; value: string; })[]; const?: string; default?: string[]; description?: string; enum?: string[]; examples?: string[]; format: "categorical"; maxLength?: number; minLength?: number; missingValues?: (string | { label: string; value: string; })[]; pattern?: string; rdfType?: string; title?: string; type: "string"; withOrder?: boolean; }; required?: boolean; type: "categorical"; } | { name: string; property: { const?: string; default?: string[]; description?: string; enum?: string[]; examples?: string[]; format: "date"; maxLength?: number; minLength?: number; missingValues?: (string | { label: string; value: string; })[]; pattern?: string; rdfType?: string; temporalFormat?: string; title?: string; type: "string"; }; required?: boolean; type: "date"; } | { name: string; property: { const?: string; default?: string[]; description?: string; enum?: string[]; examples?: string[]; format: "date-time"; maxLength?: number; minLength?: number; missingValues?: (string | { label: string; value: string; })[]; pattern?: string; rdfType?: string; temporalFormat?: string; title?: string; type: "string"; }; required?: boolean; type: "date-time"; } | { name: string; property: { const?: string; decimalChar?: string; default?: string[]; description?: string; enum?: string[]; examples?: string[]; exclusiveMaximum?: number; exclusiveMinimum?: number; format: "decimal"; groupChar?: string; maximum?: number; maxLength?: number; minimum?: number; minLength?: number; missingValues?: (string | { label: string; value: string; })[]; multipleOf?: number; pattern?: string; rdfType?: string; title?: string; type: "string"; withText?: boolean; }; required?: boolean; type: "decimal"; } | { name: string; property: { const?: string; default?: string[]; description?: string; enum?: string[]; examples?: string[]; format: "duration"; maxLength?: number; minLength?: number; missingValues?: (string | { label: string; value: string; })[]; pattern?: string; rdfType?: string; title?: string; type: "string"; }; required?: boolean; type: "duration"; } | { name: string; property: { const?: string; default?: string[]; description?: string; enum?: string[]; examples?: string[]; format: "email"; maxLength?: number; minLength?: number; missingValues?: (string | { label: string; value: string; })[]; pattern?: string; rdfType?: string; title?: string; type: "string"; }; required?: boolean; type: "email"; } | { name: string; property: { additionalProperties?: unknown; allOf?: unknown; anyOf?: unknown; const?: Record<string, unknown>; default?: Record<string, unknown>[]; dependencies?: unknown; dependentRequired?: unknown; dependentSchemas?: unknown; description?: string; else?: unknown; enum?: Record<string, unknown>[]; examples?: Record<string, unknown>[]; format: "geojson"; if?: unknown; maxProperties?: number; minProperties?: number; missingValues?: (string | { label: string; value: string; })[]; not?: unknown; oneOf?: unknown; patternProperties?: unknown; properties?: unknown; propertyNames?: unknown; rdfType?: string; required?: unknown; then?: unknown; title?: string; type: "object"; }; required?: boolean; type: "geojson"; } | { name: string; property: { const?: string; default?: string[]; description?: string; enum?: string[]; examples?: string[]; format: "hex"; maxLength?: number; minLength?: number; missingValues?: (string | { label: string; value: string; })[]; pattern?: string; rdfType?: string; title?: string; type: "string"; }; required?: boolean; type: "hex"; } | { name: string; property: { const?: number; default?: number[]; description?: string; enum?: number[]; examples?: number[]; exclusiveMaximum?: number; exclusiveMinimum?: number; format?: undefined; groupChar?: string; maximum?: number; minimum?: number; missingValues?: (string | number | { label: string; value: string | number; })[]; multipleOf?: number; rdfType?: string; title?: string; type: "integer"; withText?: boolean; }; required?: boolean; type: "integer"; } | { name: string; property: { const?: string; default?: string[]; delimiter?: string; description?: string; enum?: string[]; examples?: string[]; format: "list"; itemType?: "string" | "number" | "boolean" | "date" | "integer" | "date-time" | "time"; maxItems?: number; maxLength?: number; minItems?: number; minLength?: number; missingValues?: (string | { label: string; value: string; })[]; pattern?: string; rdfType?: string; title?: string; type: "string"; }; required?: boolean; type: "list"; } | { name: string; property: { const?: number; decimalChar?: string; default?: number[]; description?: string; enum?: number[]; examples?: number[]; exclusiveMaximum?: number; exclusiveMinimum?: number; format?: undefined; groupChar?: string; maximum?: number; minimum?: number; missingValues?: (string | number | { label: string; value: string | number; })[]; multipleOf?: number; rdfType?: string; title?: string; type: "number"; withText?: boolean; }; required?: boolean; type: "number"; } | { name: string; property: { additionalProperties?: unknown; allOf?: unknown; anyOf?: unknown; const?: Record<string, unknown>; default?: Record<string, unknown>[]; dependencies?: unknown; dependentRequired?: unknown; dependentSchemas?: unknown; description?: string; else?: unknown; enum?: Record<string, unknown>[]; examples?: Record<string, unknown>[]; format?: undefined; if?: unknown; maxProperties?: number; minProperties?: number; missingValues?: (string | { label: string; value: string; })[]; not?: unknown; oneOf?: unknown; patternProperties?: unknown; properties?: unknown; propertyNames?: unknown; rdfType?: string; required?: unknown; then?: unknown; title?: string; type: "object"; }; required?: boolean; type: "object"; } | { name: string; property: { const?: string; default?: string[]; description?: string; enum?: string[]; examples?: string[]; format?: undefined; maxLength?: number; minLength?: number; missingValues?: (string | { label: string; value: string; })[]; pattern?: string; rdfType?: string; title?: string; type: "string"; }; required?: boolean; type: "string"; } | { name: string; property: { const?: string; default?: string[]; description?: string; enum?: string[]; examples?: string[]; format: "time"; maxLength?: number; minLength?: number; missingValues?: (string | { label: string; value: string; })[]; pattern?: string; rdfType?: string; temporalFormat?: string; title?: string; type: "string"; }; required?: boolean; type: "time"; } | { name: string; property: { additionalProperties?: unknown; allOf?: unknown; anyOf?: unknown; const?: Record<string, unknown>; default?: Record<string, unknown>[]; dependencies?: unknown; dependentRequired?: unknown; dependentSchemas?: unknown; description?: string; else?: unknown; enum?: Record<string, unknown>[]; examples?: Record<string, unknown>[]; format: "topojson"; if?: unknown; maxProperties?: number; minProperties?: number; missingValues?: (string | { label: string; value: string; })[]; not?: unknown; oneOf?: unknown; patternProperties?: unknown; properties?: unknown; propertyNames?: unknown; rdfType?: string; required?: unknown; then?: unknown; title?: string; type: "object"; }; required?: boolean; type: "topojson"; } | { name: string; property: { const?: unknown[]; default?: unknown[]; description?: string; enum?: unknown[][]; examples?: unknown[][]; format?: undefined; missingValues?: (string | { label: string; value: string; })[]; rdfType?: string; title?: string; type?: "null"; }; required?: boolean; type: "unknown"; } | { name: string; property: { const?: string; default?: string[]; description?: string; enum?: string[]; examples?: string[]; format: "url"; maxLength?: number; minLength?: number; missingValues?: (string | { label: string; value: string; })[]; pattern?: string; rdfType?: string; title?: string; type: "string"; }; required?: boolean; type: "url"; } | { name: string; property: { const?: string; default?: string[]; description?: string; enum?: string[]; examples?: string[]; format: "wkb"; maxLength?: number; minLength?: number; missingValues?: (string | { label: string; value: string; })[]; pattern?: string; rdfType?: string; title?: string; type: "string"; }; required?: boolean; type: "wkb"; } | { name: string; property: { const?: string; default?: string[]; description?: string; enum?: string[]; examples?: string[]; format: "wkt"; maxLength?: number; minLength?: number; missingValues?: (string | { label: string; value: string; })[]; pattern?: string; rdfType?: string; title?: string; type: "string"; }; required?: boolean; type: "wkt"; })[]
Returns
Section titled “Returns”object